MDL-64506 theme: Update BSB references and upgrade texts
[moodle.git] / lib / outputlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * 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  *
23  * @copyright 2009 Tim Hunt
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  * @package core
26  * @category output
27  */
29 defined('MOODLE_INTERNAL') || die();
31 require_once($CFG->libdir.'/outputcomponents.php');
32 require_once($CFG->libdir.'/outputactions.php');
33 require_once($CFG->libdir.'/outputfactories.php');
34 require_once($CFG->libdir.'/outputrenderers.php');
35 require_once($CFG->libdir.'/outputrequirementslib.php');
37 /**
38  * Returns current theme revision number.
39  *
40  * @return int
41  */
42 function theme_get_revision() {
43     global $CFG;
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         }
53     } else {
54         return -1;
55     }
56 }
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  */
65 function theme_get_sub_revision_for_theme($themename) {
66     global $CFG;
68     if (empty($CFG->themedesignermode)) {
69         $pluginname = "theme_{$themename}";
70         $revision = during_initial_install() ? null : get_config($pluginname, 'themerev');
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 }
83 /**
84  * Calculates and returns the next theme revision number.
85  *
86  * @return int
87  */
88 function theme_get_next_revision() {
89     global $CFG;
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     }
99     return $next;
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  */
108 function theme_get_next_sub_revision_for_theme($themename) {
109     global $CFG;
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     }
120     return $next;
123 /**
124  * Sets the current theme revision number.
125  *
126  * @param int $revision The new theme revision number
127  */
128 function theme_set_revision($revision) {
129     set_config('themerev', $revision);
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  */
139 function theme_set_sub_revision_for_theme($themename, $revision) {
140     set_config('themerev', $revision, "theme_{$themename}");
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  */
148 function theme_get_config_file_path($themename) {
149     global $CFG;
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     }
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  */
168 function theme_get_css_filename($themename, $globalrevision, $themerevision, $direction) {
169     global $CFG;
171     $path = "{$CFG->localcachedir}/theme/{$globalrevision}/{$themename}/css";
172     $filename = $direction == 'rtl' ? "all-rtl_{$themerevision}" : "all_{$themerevision}";
173     return "{$path}/{$filename}.css";
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  */
183 function theme_build_css_for_themes($themeconfigs = [], $directions = ['rtl', 'ltr'], $cache = true) {
184     global $CFG;
186     if (empty($themeconfigs)) {
187         return;
188     }
190     require_once("{$CFG->libdir}/csslib.php");
192     $themescss = [];
193     $themerev = theme_get_revision();
194     // Make sure the local cache directory exists.
195     make_localcache_directory('theme');
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);
202         // First generate all the new css.
203         foreach ($directions as $direction) {
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);
206             $themeconfig->set_rtl_mode(($direction === 'rtl'));
208             $themecss[$direction] = $themeconfig->get_css_content();
209             if ($cache) {
210                 $themeconfig->set_css_content_cache($themecss[$direction]);
211                 $filename = theme_get_css_filename($themeconfig->name, $themerev, $newrevision, $direction);
212                 css_store_css($themeconfig, $filename, $themecss[$direction]);
213             }
214         }
215         $themescss[] = $themecss;
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);
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     }
235     return $themescss;
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  */
246 function theme_reset_all_caches() {
247     global $CFG, $PAGE;
248     require_once("{$CFG->libdir}/filelib.php");
250     $next = theme_get_next_revision();
251     theme_set_revision($next);
253     if (!empty($CFG->themedesignermode)) {
254         $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner');
255         $cache->purge();
256     }
258     // Purge compiled post processed css.
259     cache::make('core', 'postprocessedcss')->purge();
261     // Delete all old theme localcaches.
262     $themecachedirs = glob("{$CFG->localcachedir}/theme/*", GLOB_ONLYDIR);
263     foreach ($themecachedirs as $localcachedir) {
264         fulldelete($localcachedir);
265     }
267     if ($PAGE) {
268         $PAGE->reload_theme();
269     }
272 /**
273  * Enable or disable theme designer mode.
274  *
275  * @param bool $state
276  */
277 function theme_set_designer_mod($state) {
278     set_config('themedesignermode', (int)!empty($state));
279     // Reset caches after switching mode so that any designer mode caches get purged too.
280     theme_reset_all_caches();
283 /**
284  * Checks if the given device has a theme defined in config.php.
285  *
286  * @return bool
287  */
288 function 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]);
294 /**
295  * Returns the theme named defined in config.php for the given device.
296  *
297  * @return string or null
298  */
299 function theme_get_locked_theme_for_device($device) {
300     global $CFG;
302     if (!theme_is_device_locked($device)) {
303         return null;
304     }
306     $themeconfigname = core_useragent::get_device_type_cfg_var_name($device);
307     return $CFG->config_php_settings[$themeconfigname];
310 /**
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)
314  * are the properties you can set in your themes config.php file.
315  *
316  * There are also some methods and protected variables that are part of the inner
317  * workings of Moodle's themes system. If you are just editing a themes config.php
318  * file, you can just ignore those, and the following information for developers.
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.
322  * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
323  * will create one for you, accessible as $PAGE->theme.
324  *
325  * @copyright 2009 Tim Hunt
326  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
327  * @since Moodle 2.0
328  * @package core
329  * @category output
330  */
331 class theme_config {
333     /**
334      * @var string Default theme, used when requested theme not found.
335      */
336     const DEFAULT_THEME = 'boost';
338     /** The key under which the SCSS file is stored amongst the CSS files. */
339     const SCSS_KEY = '__SCSS__';
341     /**
342      * @var array You can base your theme on other themes by linking to the other theme as
343      * parents. This lets you use the CSS and layouts from the other themes
344      * (see {@link theme_config::$layouts}).
345      * That makes it easy to create a new theme that is similar to another one
346      * but with a few changes. In this themes CSS you only need to override
347      * those rules you want to change.
348      */
349     public $parents;
351     /**
352      * @var array The names of all the stylesheets from this theme that you would
353      * like included, in order. Give the names of the files without .css.
354      */
355     public $sheets = array();
357     /**
358      * @var array The names of all the stylesheets from parents that should be excluded.
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.
361      */
362     public $parents_exclude_sheets = null;
364     /**
365      * @var array List of plugin sheets to be excluded.
366      * If no value specified value from parent theme used.
367      */
368     public $plugins_exclude_sheets = null;
370     /**
371      * @var array List of style sheets that are included in the text editor bodies.
372      * Sheets from parent themes are used automatically and can not be excluded.
373      */
374     public $editor_sheets = array();
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;
382     /**
383      * @var array The names of all the javascript files this theme that you would
384      * like included from head, in order. Give the names of the files without .js.
385      */
386     public $javascripts = array();
388     /**
389      * @var array The names of all the javascript files this theme that you would
390      * like included from footer, in order. Give the names of the files without .js.
391      */
392     public $javascripts_footer = array();
394     /**
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.
398      * If no value specified value from parent theme used.
399      */
400     public $parents_exclude_javascripts = null;
402     /**
403      * @var array Which file to use for each page layout.
404      *
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}.
409      * That file also has a good example of how to set this setting.
410      *
411      * For each layout, the value in the outer array is an array that describes
412      * how you want that type of page to look. For example
413      * <pre>
414      *   $THEME->layouts = array(
415      *       // Most pages - if we encounter an unknown or a missing page type, this one is used.
416      *       'standard' => array(
417      *           'theme' = 'mytheme',
418      *           'file' => 'normal.php',
419      *           'regions' => array('side-pre', 'side-post'),
420      *           'defaultregion' => 'side-post'
421      *       ),
422      *       // The site home page.
423      *       'home' => array(
424      *           'theme' = 'mytheme',
425      *           'file' => 'home.php',
426      *           'regions' => array('side-pre', 'side-post'),
427      *           'defaultregion' => 'side-post'
428      *       ),
429      *       // ...
430      *   );
431      * </pre>
432      *
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
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.
442      *
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
446      * the page, but in non-existent regions, they appear here. (Imaging, for example,
447      * that someone added blocks using a different theme that used different region
448      * names, and then switched to this theme.)
449      */
450     public $layouts = array();
452     /**
453      * @var string Name of the renderer factory class to use. Must implement the
454      * {@link renderer_factory} interface.
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
466      *      your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
467      * </ul>
468      */
469     public $rendererfactory = 'standard_renderer_factory';
471     /**
472      * @var string Function to do custom CSS post-processing.
473      *
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.
477      */
478     public $csspostprocess = null;
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      */
489     public $csstreepostprocessor = null;
491     /**
492      * @var string Accessibility: Right arrow-like character is
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.
498      */
499     public $rarrow = null;
501     /**
502      * @var string Accessibility: Left arrow-like character is
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.
508      */
509     public $larrow = null;
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;
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;
527     /**
528      * @var bool Some themes may want to disable ajax course editing.
529      */
530     public $enablecourseajax = true;
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';
540     /**
541      * @var string requiredblocks If set to a string, will list the block types that cannot be deleted. Defaults to
542      *                                   navigation and settings.
543      */
544     public $requiredblocks = false;
546     //==Following properties are not configurable from theme config.php==
548     /**
549      * @var string The name of this theme. Set automatically when this theme is
550      * loaded. This can not be set in theme config.php
551      */
552     public $name;
554     /**
555      * @var string The folder where this themes files are stored. This is set
556      * automatically. This can not be set in theme config.php
557      */
558     public $dir;
560     /**
561      * @var stdClass Theme settings stored in config_plugins table.
562      * This can not be set in theme config.php
563      */
564     public $settings = null;
566     /**
567      * @var bool If set to true and the theme enables the dock then  blocks will be able
568      * to be moved to the special dock
569      */
570     public $enable_dock = false;
572     /**
573      * @var bool If set to true then this theme will not be shown in the theme selector unless
574      * theme designer mode is turned on.
575      */
576     public $hidefromselector = false;
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');
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      */
590     public $blockrtlmanipulations = array();
592     /**
593      * @var renderer_factory Instance of the renderer_factory implementation
594      * we are using. Implementation detail.
595      */
596     protected $rf = null;
598     /**
599      * @var array List of parent config objects.
600      **/
601     protected $parent_configs = array();
603     /**
604      * Used to determine whether we can serve SVG images or not.
605      * @var bool
606      */
607     private $usesvg = null;
609     /**
610      * Whether in RTL mode or not.
611      * @var bool
612      */
613     protected $rtlmode = false;
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;
621     /**
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;
629     /**
630      * Local cache of the SCSS property.
631      * @var false|array
632      */
633     protected $scsscache = null;
635     /**
636      * The name of the function to call to get the LESS code to inject.
637      * @var string
638      */
639     public $extralesscallback = null;
641     /**
642      * The name of the function to call to get the SCSS code to inject.
643      * @var string
644      */
645     public $extrascsscallback = null;
647     /**
648      * The name of the function to call to get extra LESS variables.
649      * @var string
650      */
651     public $lessvariablescallback = null;
653     /**
654      * The name of the function to call to get SCSS to prepend.
655      * @var string
656      */
657     public $prescsscallback = null;
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;
666     /**
667      * Remember the results of icon remapping for the current page.
668      * @var array
669      */
670     public $remapiconcache = [];
672     /**
673      * The name of the function to call to get precompiled CSS.
674      * @var string
675      */
676     public $precompiledcsscallback = null;
678     /**
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.
684      */
685     public static function load($themename) {
686         global $CFG;
688         // load theme settings from db
689         try {
690             $settings = get_config('theme_'.$themename);
691         } catch (dml_exception $e) {
692             // most probably moodle tables not created yet
693             $settings = new stdClass();
694         }
696         if ($config = theme_config::find_theme_config($themename, $settings)) {
697             return new theme_config($config);
699         } else if ($themename == theme_config::DEFAULT_THEME) {
700             throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
702         } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
703             debugging('This page should be using theme ' . $themename .
704                     ' which cannot be initialised. Falling back to the site theme ' . $CFG->theme, DEBUG_NORMAL);
705             return new theme_config($config);
707         } else {
708             // bad luck, the requested theme has some problems - admin see details in theme config
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);
712             return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
713         }
714     }
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
719      * diagnose given theme and highlights all potential problems.
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) {
727         //TODO: MDL-21108
728         return array();
729     }
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
738         $this->settings = $config->settings;
739         $this->name     = $config->name;
740         $this->dir      = $config->dir;
742         $baseconfig = $config;
744         $configurable = array(
745             'parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'usefallback',
746             'javascripts', 'javascripts_footer', 'parents_exclude_javascripts',
747             'layouts', 'enable_dock', 'enablecourseajax', 'requiredblocks',
748             'rendererfactory', 'csspostprocess', 'editor_sheets', 'editor_scss', 'rarrow', 'larrow', 'uarrow', 'darrow',
749             'hidefromselector', 'doctype', 'yuicssmodules', 'blockrtlmanipulations',
750             'lessfile', 'extralesscallback', 'lessvariablescallback', 'blockrendermethod',
751             'scss', 'extrascsscallback', 'prescsscallback', 'csstreepostprocessor', 'addblockposition',
752             'iconsystem', 'precompiledcsscallback');
754         foreach ($config as $key=>$value) {
755             if (in_array($key, $configurable)) {
756                 $this->$key = $value;
757             }
758         }
760         // verify all parents and load configs and renderers
761         foreach ($this->parents as $parent) {
762             if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
763                 // this is not good - better exclude faulty parents
764                 continue;
765             }
766             $libfile = $parent_config->dir.'/lib.php';
767             if (is_readable($libfile)) {
768                 // theme may store various function here
769                 include_once($libfile);
770             }
771             $renderersfile = $parent_config->dir.'/renderers.php';
772             if (is_readable($renderersfile)) {
773                 // may contain core and plugin renderers and renderer factory
774                 include_once($renderersfile);
775             }
776             $this->parent_configs[$parent] = $parent_config;
777         }
778         $libfile = $this->dir.'/lib.php';
779         if (is_readable($libfile)) {
780             // theme may store various function here
781             include_once($libfile);
782         }
783         $rendererfile = $this->dir.'/renderers.php';
784         if (is_readable($rendererfile)) {
785             // may contain core and plugin renderers and renderer factory
786             include_once($rendererfile);
787         } else {
788             // check if renderers.php file is missnamed renderer.php
789             if (is_readable($this->dir.'/renderer.php')) {
790                 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
791                     See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
792             }
793         }
795         // cascade all layouts properly
796         foreach ($baseconfig->layouts as $layout=>$value) {
797             if (!isset($this->layouts[$layout])) {
798                 foreach ($this->parent_configs as $parent_config) {
799                     if (isset($parent_config->layouts[$layout])) {
800                         $this->layouts[$layout] = $parent_config->layouts[$layout];
801                         continue 2;
802                     }
803                 }
804                 $this->layouts[$layout] = $value;
805             }
806         }
808         //fix arrows if needed
809         $this->check_theme_arrows();
810     }
812     /**
813      * Let the theme initialise the page object (usually $PAGE).
814      *
815      * This may be used for example to request jQuery in add-ons.
816      *
817      * @param moodle_page $page
818      */
819     public function init_page(moodle_page $page) {
820         $themeinitfunction = 'theme_'.$this->name.'_page_init';
821         if (function_exists($themeinitfunction)) {
822             $themeinitfunction($page);
823         }
824     }
826     /**
827      * Checks if arrows $THEME->rarrow, $THEME->larrow, $THEME->uarrow, $THEME->darrow have been set (theme/-/config.php).
828      * If not it applies sensible defaults.
829      *
830      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
831      * search forum block, etc. Important: these are 'silent' in a screen-reader
832      * (unlike &gt; &raquo;), and must be accompanied by text.
833      */
834     private function check_theme_arrows() {
835         if (!isset($this->rarrow) and !isset($this->larrow)) {
836             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
837             // Also OK in Win 9x/2K/IE 5.x
838             $this->rarrow = '&#x25BA;';
839             $this->larrow = '&#x25C4;';
840             $this->uarrow = '&#x25B2;';
841             $this->darrow = '&#x25BC;';
842             if (empty($_SERVER['HTTP_USER_AGENT'])) {
843                 $uagent = '';
844             } else {
845                 $uagent = $_SERVER['HTTP_USER_AGENT'];
846             }
847             if (false !== strpos($uagent, 'Opera')
848                 || false !== strpos($uagent, 'Mac')) {
849                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
850                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
851                 $this->rarrow = '&#x25B6;&#xFE0E;';
852                 $this->larrow = '&#x25C0;&#xFE0E;';
853             }
854             elseif ((false !== strpos($uagent, 'Konqueror'))
855                 || (false !== strpos($uagent, 'Android')))  {
856                 // The fonts on Android don't include the characters required for this to work as expected.
857                 // So we use the same ones Konqueror uses.
858                 $this->rarrow = '&rarr;';
859                 $this->larrow = '&larr;';
860                 $this->uarrow = '&uarr;';
861                 $this->darrow = '&darr;';
862             }
863             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
864                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
865                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
866                 // To be safe, non-Unicode browsers!
867                 $this->rarrow = '&gt;';
868                 $this->larrow = '&lt;';
869                 $this->uarrow = '^';
870                 $this->darrow = 'v';
871             }
873             // RTL support - in RTL languages, swap r and l arrows
874             if (right_to_left()) {
875                 $t = $this->rarrow;
876                 $this->rarrow = $this->larrow;
877                 $this->larrow = $t;
878             }
879         }
880     }
882     /**
883      * Returns output renderer prefixes, these are used when looking
884      * for the overridden renderers in themes.
885      *
886      * @return array
887      */
888     public function renderer_prefixes() {
889         global $CFG; // just in case the included files need it
891         $prefixes = array('theme_'.$this->name);
893         foreach ($this->parent_configs as $parent) {
894             $prefixes[] = 'theme_'.$parent->name;
895         }
897         return $prefixes;
898     }
900     /**
901      * Returns the stylesheet URL of this editor content
902      *
903      * @param bool $encoded false means use & and true use &amp; in URLs
904      * @return moodle_url
905      */
906     public function editor_css_url($encoded=true) {
907         global $CFG;
908         $rev = theme_get_revision();
909         if ($rev > -1) {
910             $themesubrevision = theme_get_sub_revision_for_theme($this->name);
912             // Provide the sub revision to allow us to invalidate cached theme CSS
913             // on a per theme basis, rather than globally.
914             if ($themesubrevision && $themesubrevision > 0) {
915                 $rev .= "_{$themesubrevision}";
916             }
918             $url = new moodle_url("/theme/styles.php");
919             if (!empty($CFG->slasharguments)) {
920                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
921             } else {
922                 $url->params(array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor'));
923             }
924         } else {
925             $params = array('theme'=>$this->name, 'type'=>'editor');
926             $url = new moodle_url('/theme/styles_debug.php', $params);
927         }
928         return $url;
929     }
931     /**
932      * Returns the content of the CSS to be used in editor content
933      *
934      * @return array
935      */
936     public function editor_css_files() {
937         $files = array();
939         // First editor plugins.
940         $plugins = core_component::get_plugin_list('editor');
941         foreach ($plugins as $plugin=>$fulldir) {
942             $sheetfile = "$fulldir/editor_styles.css";
943             if (is_readable($sheetfile)) {
944                 $files['plugin_'.$plugin] = $sheetfile;
945             }
946         }
947         // Then parent themes - base first, the immediate parent last.
948         foreach (array_reverse($this->parent_configs) as $parent_config) {
949             if (empty($parent_config->editor_sheets)) {
950                 continue;
951             }
952             foreach ($parent_config->editor_sheets as $sheet) {
953                 $sheetfile = "$parent_config->dir/style/$sheet.css";
954                 if (is_readable($sheetfile)) {
955                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
956                 }
957             }
958         }
959         // Finally this theme.
960         if (!empty($this->editor_sheets)) {
961             foreach ($this->editor_sheets as $sheet) {
962                 $sheetfile = "$this->dir/style/$sheet.css";
963                 if (is_readable($sheetfile)) {
964                     $files['theme_'.$sheet] = $sheetfile;
965                 }
966             }
967         }
969         return $files;
970     }
972     /**
973      * Compiles and returns the content of the SCSS to be used in editor content
974      *
975      * @return string Compiled CSS from the editor SCSS
976      */
977     public function editor_scss_to_css() {
978         $css = '';
980         if (!empty($this->editor_scss)) {
981             $compiler = new core_scss();
983             foreach ($this->editor_scss as $filename) {
984                 $compiler->set_file("{$this->dir}/scss/{$filename}.scss");
986                 try {
987                     $css .= $compiler->to_css();
988                 } catch (\Exception $e) {
989                     debugging('Error while compiling editor SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER);
990                 }
991             }
992         }
994         return $css;
995     }
997     /**
998      * Get the stylesheet URL of this theme.
999      *
1000      * @param moodle_page $page Not used... deprecated?
1001      * @return moodle_url[]
1002      */
1003     public function css_urls(moodle_page $page) {
1004         global $CFG;
1006         $rev = theme_get_revision();
1008         $urls = array();
1010         $svg = $this->use_svg_icons();
1011         $separate = (core_useragent::is_ie() && !core_useragent::check_ie_version('10'));
1013         if ($rev > -1) {
1014             $filename = right_to_left() ? 'all-rtl' : 'all';
1015             $url = new moodle_url("/theme/styles.php");
1016             $themesubrevision = theme_get_sub_revision_for_theme($this->name);
1018             // Provide the sub revision to allow us to invalidate cached theme CSS
1019             // on a per theme basis, rather than globally.
1020             if ($themesubrevision && $themesubrevision > 0) {
1021                 $rev .= "_{$themesubrevision}";
1022             }
1024             if (!empty($CFG->slasharguments)) {
1025                 $slashargs = '';
1026                 if (!$svg) {
1027                     // We add a simple /_s to the start of the path.
1028                     // The underscore is used to ensure that it isn't a valid theme name.
1029                     $slashargs .= '/_s'.$slashargs;
1030                 }
1031                 $slashargs .= '/'.$this->name.'/'.$rev.'/'.$filename;
1032                 if ($separate) {
1033                     $slashargs .= '/chunk0';
1034                 }
1035                 $url->set_slashargument($slashargs, 'noparam', true);
1036             } else {
1037                 $params = array('theme' => $this->name, 'rev' => $rev, 'type' => $filename);
1038                 if (!$svg) {
1039                     // We add an SVG param so that we know not to serve SVG images.
1040                     // We do this because all modern browsers support SVG and this param will one day be removed.
1041                     $params['svg'] = '0';
1042                 }
1043                 if ($separate) {
1044                     $params['chunk'] = '0';
1045                 }
1046                 $url->params($params);
1047             }
1048             $urls[] = $url;
1050         } else {
1051             $baseurl = new moodle_url('/theme/styles_debug.php');
1053             $css = $this->get_css_files(true);
1054             if (!$svg) {
1055                 // We add an SVG param so that we know not to serve SVG images.
1056                 // We do this because all modern browsers support SVG and this param will one day be removed.
1057                 $baseurl->param('svg', '0');
1058             }
1059             if (right_to_left()) {
1060                 $baseurl->param('rtl', 1);
1061             }
1062             if ($separate) {
1063                 // We might need to chunk long files.
1064                 $baseurl->param('chunk', '0');
1065             }
1066             if (core_useragent::is_ie()) {
1067                 // Lalala, IE does not allow more than 31 linked CSS files from main document.
1068                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
1069                 foreach ($css['parents'] as $parent=>$sheets) {
1070                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096).
1071                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
1072                 }
1073                 if ($this->get_scss_property()) {
1074                     // No need to define the type as IE here.
1075                     $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
1076                 } else if (!empty($this->lessfile)) {
1077                     // No need to define the type as IE here.
1078                     $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
1079                 }
1080                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
1082             } else {
1083                 foreach ($css['plugins'] as $plugin=>$unused) {
1084                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
1085                 }
1086                 foreach ($css['parents'] as $parent=>$sheets) {
1087                     foreach ($sheets as $sheet=>$unused2) {
1088                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
1089                     }
1090                 }
1091                 foreach ($css['theme'] as $sheet => $filename) {
1092                     if ($sheet === self::SCSS_KEY) {
1093                         // This is the theme SCSS file.
1094                         $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
1095                     } else if ($sheet === $this->lessfile) {
1096                         // This is the theme LESS file.
1097                         $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
1098                     } else {
1099                         // Sheet first in order to make long urls easier to read.
1100                         $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme'));
1101                     }
1102                 }
1103             }
1104         }
1106         return $urls;
1107     }
1109     /**
1110      * Get the whole css stylesheet for production mode.
1111      *
1112      * NOTE: this method is not expected to be used from any addons.
1113      *
1114      * @return string CSS markup compressed
1115      */
1116     public function get_css_content() {
1118         $csscontent = '';
1119         foreach ($this->get_css_files(false) as $type => $value) {
1120             foreach ($value as $identifier => $val) {
1121                 if (is_array($val)) {
1122                     foreach ($val as $v) {
1123                         $csscontent .= file_get_contents($v) . "\n";
1124                     }
1125                 } else {
1126                     if ($type === 'theme' && $identifier === self::SCSS_KEY) {
1127                         // We need the content from SCSS because this is the SCSS file from the theme.
1128                         if ($compiled = $this->get_css_content_from_scss(false)) {
1129                             $csscontent .= $compiled;
1130                         } else {
1131                             // The compiler failed so default back to any precompiled css that might
1132                             // exist.
1133                             $csscontent .= $this->get_precompiled_css_content();
1134                         }
1135                     } else if ($type === 'theme' && $identifier === $this->lessfile) {
1136                         // We need the content from LESS because this is the LESS file from the theme.
1137                         $csscontent .= $this->get_css_content_from_less(false);
1138                     } else {
1139                         $csscontent .= file_get_contents($val) . "\n";
1140                     }
1141                 }
1142             }
1143         }
1144         $csscontent = $this->post_process($csscontent);
1145         $csscontent = core_minify::css($csscontent);
1147         return $csscontent;
1148     }
1149     /**
1150      * Set post processed CSS content cache.
1151      *
1152      * @param string $csscontent The post processed CSS content.
1153      * @return bool True if the content was successfully cached.
1154      */
1155     public function set_css_content_cache($csscontent) {
1157         $cache = cache::make('core', 'postprocessedcss');
1158         $key = $this->get_css_cache_key();
1160         return $cache->set($key, $csscontent);
1161     }
1163     /**
1164      * Return whether the post processed CSS content has been cached.
1165      *
1166      * @return bool Whether the post-processed CSS is available in the cache.
1167      */
1168     public function has_css_cached_content() {
1170         $key = $this->get_css_cache_key();
1171         $cache = cache::make('core', 'postprocessedcss');
1173         return $cache->has($key);
1174     }
1176     /**
1177      * Return cached post processed CSS content.
1178      *
1179      * @return bool|string The cached css content or false if not found.
1180      */
1181     public function get_css_cached_content() {
1183         $key = $this->get_css_cache_key();
1184         $cache = cache::make('core', 'postprocessedcss');
1186         return $cache->get($key);
1187     }
1189     /**
1190      * Generate the css content cache key.
1191      *
1192      * @return string The post processed css cache key.
1193      */
1194     public function get_css_cache_key() {
1195         $nosvg = (!$this->use_svg_icons()) ? 'nosvg_' : '';
1196         $rtlmode = ($this->rtlmode == true) ? 'rtl' : 'ltr';
1198         return $nosvg . $this->name . '_' . $rtlmode;
1199     }
1201     /**
1202      * Get the theme designer css markup,
1203      * the parameters are coming from css_urls().
1204      *
1205      * NOTE: this method is not expected to be used from any addons.
1206      *
1207      * @param string $type
1208      * @param string $subtype
1209      * @param string $sheet
1210      * @return string CSS markup
1211      */
1212     public function get_css_content_debug($type, $subtype, $sheet) {
1214         if ($type === 'scss') {
1215             // The SCSS file of the theme is requested.
1216             $csscontent = $this->get_css_content_from_scss(true);
1217             if ($csscontent !== false) {
1218                 return $this->post_process($csscontent);
1219             }
1220             return '';
1221         } else if ($type === 'less') {
1222             // The LESS file of the theme is requested.
1223             $csscontent = $this->get_css_content_from_less(true);
1224             if ($csscontent !== false) {
1225                 return $this->post_process($csscontent);
1226             }
1227             return '';
1228         }
1230         $cssfiles = array();
1231         $css = $this->get_css_files(true);
1233         if ($type === 'ie') {
1234             // IE is a sloppy browser with weird limits, sorry.
1235             if ($subtype === 'plugins') {
1236                 $cssfiles = $css['plugins'];
1238             } else if ($subtype === 'parents') {
1239                 if (empty($sheet)) {
1240                     // Do not bother with the empty parent here.
1241                 } else {
1242                     // Build up the CSS for that parent so we can serve it as one file.
1243                     foreach ($css[$subtype][$sheet] as $parent => $css) {
1244                         $cssfiles[] = $css;
1245                     }
1246                 }
1247             } else if ($subtype === 'theme') {
1248                 $cssfiles = $css['theme'];
1249                 foreach ($cssfiles as $key => $value) {
1250                     if (in_array($key, [$this->lessfile, self::SCSS_KEY])) {
1251                         // Remove the LESS/SCSS file from the theme CSS files.
1252                         // The LESS/SCSS files use the type 'less' or 'scss', not 'ie'.
1253                         unset($cssfiles[$key]);
1254                     }
1255                 }
1256             }
1258         } else if ($type === 'plugin') {
1259             if (isset($css['plugins'][$subtype])) {
1260                 $cssfiles[] = $css['plugins'][$subtype];
1261             }
1263         } else if ($type === 'parent') {
1264             if (isset($css['parents'][$subtype][$sheet])) {
1265                 $cssfiles[] = $css['parents'][$subtype][$sheet];
1266             }
1268         } else if ($type === 'theme') {
1269             if (isset($css['theme'][$sheet])) {
1270                 $cssfiles[] = $css['theme'][$sheet];
1271             }
1272         }
1274         $csscontent = '';
1275         foreach ($cssfiles as $file) {
1276             $contents = file_get_contents($file);
1277             $contents = $this->post_process($contents);
1278             $comment = "/** Path: $type $subtype $sheet.' **/\n";
1279             $stats = '';
1280             $csscontent .= $comment.$stats.$contents."\n\n";
1281         }
1283         return $csscontent;
1284     }
1286     /**
1287      * Get the whole css stylesheet for editor iframe.
1288      *
1289      * NOTE: this method is not expected to be used from any addons.
1290      *
1291      * @return string CSS markup
1292      */
1293     public function get_css_content_editor() {
1294         $css = '';
1295         $cssfiles = $this->editor_css_files();
1297         // If editor has static CSS, include it.
1298         foreach ($cssfiles as $file) {
1299             $css .= file_get_contents($file)."\n";
1300         }
1302         // If editor has SCSS, compile and include it.
1303         if (($convertedscss = $this->editor_scss_to_css())) {
1304             $css .= $convertedscss;
1305         }
1307         $output = $this->post_process($css);
1309         return $output;
1310     }
1312     /**
1313      * Returns an array of organised CSS files required for this output.
1314      *
1315      * @param bool $themedesigner
1316      * @return array nested array of file paths
1317      */
1318     protected function get_css_files($themedesigner) {
1319         global $CFG;
1321         $cache = null;
1322         $cachekey = 'cssfiles';
1323         if ($themedesigner) {
1324             require_once($CFG->dirroot.'/lib/csslib.php');
1325             // We need some kind of caching here because otherwise the page navigation becomes
1326             // way too slow in theme designer mode. Feel free to create full cache definition later...
1327             $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner', array('theme' => $this->name));
1328             if ($files = $cache->get($cachekey)) {
1329                 if ($files['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME) {
1330                     unset($files['created']);
1331                     return $files;
1332                 }
1333             }
1334         }
1336         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
1338         // Get all plugin sheets.
1339         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
1340         if ($excludes !== true) {
1341             foreach (core_component::get_plugin_types() as $type=>$unused) {
1342                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
1343                     continue;
1344                 }
1345                 $plugins = core_component::get_plugin_list($type);
1346                 foreach ($plugins as $plugin=>$fulldir) {
1347                     if (!empty($excludes[$type]) and is_array($excludes[$type])
1348                             and in_array($plugin, $excludes[$type])) {
1349                         continue;
1350                     }
1352                     // Get the CSS from the plugin.
1353                     $sheetfile = "$fulldir/styles.css";
1354                     if (is_readable($sheetfile)) {
1355                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
1356                     }
1358                     // Create a list of candidate sheets from parents (direct parent last) and current theme.
1359                     $candidates = array();
1360                     foreach (array_reverse($this->parent_configs) as $parent_config) {
1361                         $candidates[] = $parent_config->name;
1362                     }
1363                     $candidates[] = $this->name;
1365                     // Add the sheets found.
1366                     foreach ($candidates as $candidate) {
1367                         $sheetthemefile = "$fulldir/styles_{$candidate}.css";
1368                         if (is_readable($sheetthemefile)) {
1369                             $cssfiles['plugins'][$type.'_'.$plugin.'_'.$candidate] = $sheetthemefile;
1370                         }
1371                     }
1372                 }
1373             }
1374         }
1376         // Find out wanted parent sheets.
1377         $excludes = $this->resolve_excludes('parents_exclude_sheets');
1378         if ($excludes !== true) {
1379             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1380                 $parent = $parent_config->name;
1381                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
1382                     continue;
1383                 }
1384                 foreach ($parent_config->sheets as $sheet) {
1385                     if (!empty($excludes[$parent]) && is_array($excludes[$parent])
1386                             && in_array($sheet, $excludes[$parent])) {
1387                         continue;
1388                     }
1390                     // We never refer to the parent LESS files.
1391                     $sheetfile = "$parent_config->dir/style/$sheet.css";
1392                     if (is_readable($sheetfile)) {
1393                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
1394                     }
1395                 }
1396             }
1397         }
1400         // Current theme sheets and less file.
1401         // We first add the SCSS, or LESS file because we want the CSS ones to
1402         // be included after the SCSS/LESS code. However, if both the LESS file
1403         // and a CSS file share the same name, the CSS file is ignored.
1404         if ($this->get_scss_property()) {
1405             $cssfiles['theme'][self::SCSS_KEY] = true;
1406         } else if (!empty($this->lessfile)) {
1407             $sheetfile = "{$this->dir}/less/{$this->lessfile}.less";
1408             if (is_readable($sheetfile)) {
1409                 $cssfiles['theme'][$this->lessfile] = $sheetfile;
1410             }
1411         }
1412         if (is_array($this->sheets)) {
1413             foreach ($this->sheets as $sheet) {
1414                 $sheetfile = "$this->dir/style/$sheet.css";
1415                 if (is_readable($sheetfile) && !isset($cssfiles['theme'][$sheet])) {
1416                     $cssfiles['theme'][$sheet] = $sheetfile;
1417                 }
1418             }
1419         }
1421         if ($cache) {
1422             $files = $cssfiles;
1423             $files['created'] = time();
1424             $cache->set($cachekey, $files);
1425         }
1426         return $cssfiles;
1427     }
1429     /**
1430      * Return the CSS content generated from LESS the file.
1431      *
1432      * @param bool $themedesigner True if theme designer is enabled.
1433      * @return bool|string Return false when the compilation failed. Else the compiled string.
1434      */
1435     protected function get_css_content_from_less($themedesigner) {
1436         global $CFG;
1438         $lessfile = $this->lessfile;
1439         if (!$lessfile || !is_readable($this->dir . '/less/' . $lessfile . '.less')) {
1440             throw new coding_exception('The theme did not define a LESS file, or it is not readable.');
1441         }
1443         // We might need more memory/time to do this, so let's play safe.
1444         raise_memory_limit(MEMORY_EXTRA);
1445         core_php_time_limit::raise(300);
1447         // Files list.
1448         $files = $this->get_css_files($themedesigner);
1450         // Get the LESS file path.
1451         $themelessfile = $files['theme'][$lessfile];
1453         // Setup compiler options.
1454         $options = array(
1455             // We need to set the import directory to where $lessfile is.
1456             'import_dirs' => array(dirname($themelessfile) => '/'),
1457             // Always disable default caching.
1458             'cache_method' => false,
1459             // Disable the relative URLs, we have post_process() to handle that.
1460             'relativeUrls' => false,
1461         );
1463         if ($themedesigner) {
1464             // Add the sourceMap inline to ensure that it is atomically generated.
1465             $options['sourceMap'] = true;
1466             $options['sourceMapBasepath'] = $CFG->dirroot;
1467             $options['sourceMapRootpath'] = $CFG->wwwroot;
1468         }
1470         // Instantiate the compiler.
1471         $compiler = new core_lessc($options);
1473         try {
1474             $compiler->parse_file_content($themelessfile);
1476             // Get the callbacks.
1477             $compiler->parse($this->get_extra_less_code());
1478             $compiler->ModifyVars($this->get_less_variables());
1480             // Compile the CSS.
1481             $compiled = $compiler->getCss();
1483         } catch (Less_Exception_Parser $e) {
1484             $compiled = false;
1485             debugging('Error while compiling LESS ' . $lessfile . ' file: ' . $e->getMessage(), DEBUG_DEVELOPER);
1486         }
1488         // Try to save memory.
1489         $compiler = null;
1490         unset($compiler);
1492         return $compiled;
1493     }
1495     /**
1496      * Return the CSS content generated from the SCSS file.
1497      *
1498      * @param bool $themedesigner True if theme designer is enabled.
1499      * @return bool|string Return false when the compilation failed. Else the compiled string.
1500      */
1501     protected function get_css_content_from_scss($themedesigner) {
1502         global $CFG;
1504         list($paths, $scss) = $this->get_scss_property();
1505         if (!$scss) {
1506             throw new coding_exception('The theme did not define a SCSS file, or it is not readable.');
1507         }
1509         // We might need more memory/time to do this, so let's play safe.
1510         raise_memory_limit(MEMORY_EXTRA);
1511         core_php_time_limit::raise(300);
1513         // Set-up the compiler.
1514         $compiler = new core_scss();
1515         $compiler->prepend_raw_scss($this->get_pre_scss_code());
1516         if (is_string($scss)) {
1517             $compiler->set_file($scss);
1518         } else {
1519             $compiler->append_raw_scss($scss($this));
1520             $compiler->setImportPaths($paths);
1521         }
1522         $compiler->append_raw_scss($this->get_extra_scss_code());
1524         try {
1525             // Compile!
1526             $compiled = $compiler->to_css();
1528         } catch (\Exception $e) {
1529             $compiled = false;
1530             debugging('Error while compiling SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER);
1531         }
1533         // Try to save memory.
1534         $compiler = null;
1535         unset($compiler);
1537         return $compiled;
1538     }
1540     /**
1541      * Return the precompiled CSS if the precompiledcsscallback exists.
1542      *
1543      * @return string Return compiled css.
1544      */
1545     public function get_precompiled_css_content() {
1546         $configs = [$this] + $this->parent_configs;
1547         $css = '';
1549         foreach ($configs as $config) {
1550             if (isset($config->precompiledcsscallback)) {
1551                 $function = $config->precompiledcsscallback;
1552                 if (function_exists($function)) {
1553                     $css .= $function($this);
1554                 }
1555             }
1556         }
1557         return $css;
1558     }
1560     /**
1561      * Get the icon system to use.
1562      *
1563      * @return string
1564      */
1565     public function get_icon_system() {
1567         // Getting all the candidate functions.
1568         $system = false;
1569         if (isset($this->iconsystem) && \core\output\icon_system::is_valid_system($this->iconsystem)) {
1570             return $this->iconsystem;
1571         }
1572         foreach ($this->parent_configs as $parent_config) {
1573             if (isset($parent_config->iconsystem) && \core\output\icon_system::is_valid_system($parent_config->iconsystem)) {
1574                 return $parent_config->iconsystem;
1575             }
1576         }
1577         return \core\output\icon_system::STANDARD;
1578     }
1580     /**
1581      * Return extra LESS variables to use when compiling.
1582      *
1583      * @return array Where keys are the variable names (omitting the @), and the values are the value.
1584      */
1585     protected function get_less_variables() {
1586         $variables = array();
1588         // Getting all the candidate functions.
1589         $candidates = array();
1590         foreach ($this->parent_configs as $parent_config) {
1591             if (!isset($parent_config->lessvariablescallback)) {
1592                 continue;
1593             }
1594             $candidates[] = $parent_config->lessvariablescallback;
1595         }
1596         $candidates[] = $this->lessvariablescallback;
1598         // Calling the functions.
1599         foreach ($candidates as $function) {
1600             if (function_exists($function)) {
1601                 $vars = $function($this);
1602                 if (!is_array($vars)) {
1603                     debugging('Callback ' . $function . ' did not return an array() as expected', DEBUG_DEVELOPER);
1604                     continue;
1605                 }
1606                 $variables = array_merge($variables, $vars);
1607             }
1608         }
1610         return $variables;
1611     }
1613     /**
1614      * Return extra LESS code to add when compiling.
1615      *
1616      * This is intended to be used by themes to inject some LESS code
1617      * before it gets compiled. If you want to inject variables you
1618      * should use {@link self::get_less_variables()}.
1619      *
1620      * @return string The LESS code to inject.
1621      */
1622     protected function get_extra_less_code() {
1623         $content = '';
1625         // Getting all the candidate functions.
1626         $candidates = array();
1627         foreach ($this->parent_configs as $parent_config) {
1628             if (!isset($parent_config->extralesscallback)) {
1629                 continue;
1630             }
1631             $candidates[] = $parent_config->extralesscallback;
1632         }
1633         $candidates[] = $this->extralesscallback;
1635         // Calling the functions.
1636         foreach ($candidates as $function) {
1637             if (function_exists($function)) {
1638                 $content .= "\n/** Extra LESS from $function **/\n" . $function($this) . "\n";
1639             }
1640         }
1642         return $content;
1643     }
1645     /**
1646      * Return extra SCSS code to add when compiling.
1647      *
1648      * This is intended to be used by themes to inject some SCSS code
1649      * before it gets compiled. If you want to inject variables you
1650      * should use {@link self::get_scss_variables()}.
1651      *
1652      * @return string The SCSS code to inject.
1653      */
1654     protected function get_extra_scss_code() {
1655         $content = '';
1657         // Getting all the candidate functions.
1658         $candidates = array();
1659         foreach ($this->parent_configs as $parent_config) {
1660             if (!isset($parent_config->extrascsscallback)) {
1661                 continue;
1662             }
1663             $candidates[] = $parent_config->extrascsscallback;
1664         }
1665         $candidates[] = $this->extrascsscallback;
1667         // Calling the functions.
1668         foreach ($candidates as $function) {
1669             if (function_exists($function)) {
1670                 $content .= "\n/** Extra SCSS from $function **/\n" . $function($this) . "\n";
1671             }
1672         }
1674         return $content;
1675     }
1677     /**
1678      * SCSS code to prepend when compiling.
1679      *
1680      * This is intended to be used by themes to inject SCSS code before it gets compiled.
1681      *
1682      * @return string The SCSS code to inject.
1683      */
1684     protected function get_pre_scss_code() {
1685         $content = '';
1687         // Getting all the candidate functions.
1688         $candidates = array();
1689         foreach ($this->parent_configs as $parent_config) {
1690             if (!isset($parent_config->prescsscallback)) {
1691                 continue;
1692             }
1693             $candidates[] = $parent_config->prescsscallback;
1694         }
1695         $candidates[] = $this->prescsscallback;
1697         // Calling the functions.
1698         foreach ($candidates as $function) {
1699             if (function_exists($function)) {
1700                 $content .= "\n/** Pre-SCSS from $function **/\n" . $function($this) . "\n";
1701             }
1702         }
1704         return $content;
1705     }
1707     /**
1708      * Get the SCSS property.
1709      *
1710      * This resolves whether a SCSS file (or content) has to be used when generating
1711      * the stylesheet for the theme. It will look at parents themes and check the
1712      * SCSS properties there.
1713      *
1714      * @return False when SCSS is not used.
1715      *         An array with the import paths, and the path to the SCSS file or Closure as second.
1716      */
1717     public function get_scss_property() {
1718         if ($this->scsscache === null) {
1719             $configs = [$this] + $this->parent_configs;
1720             $scss = null;
1722             foreach ($configs as $config) {
1723                 $path = "{$config->dir}/scss";
1725                 // We collect the SCSS property until we've found one.
1726                 if (empty($scss) && !empty($config->scss)) {
1727                     $candidate = is_string($config->scss) ? "{$path}/{$config->scss}.scss" : $config->scss;
1728                     if ($candidate instanceof Closure) {
1729                         $scss = $candidate;
1730                     } else if (is_string($candidate) && is_readable($candidate)) {
1731                         $scss = $candidate;
1732                     }
1733                 }
1735                 // We collect the import paths once we've found a SCSS property.
1736                 if ($scss && is_dir($path)) {
1737                     $paths[] = $path;
1738                 }
1740             }
1742             $this->scsscache = $scss !== null ? [$paths, $scss] : false;
1743         }
1745         return $this->scsscache;
1746     }
1748     /**
1749      * Generate a URL to the file that serves theme JavaScript files.
1750      *
1751      * If we determine that the theme has no relevant files, then we return
1752      * early with a null value.
1753      *
1754      * @param bool $inhead true means head url, false means footer
1755      * @return moodle_url|null
1756      */
1757     public function javascript_url($inhead) {
1758         global $CFG;
1760         $rev = theme_get_revision();
1761         $params = array('theme'=>$this->name,'rev'=>$rev);
1762         $params['type'] = $inhead ? 'head' : 'footer';
1764         // Return early if there are no files to serve
1765         if (count($this->javascript_files($params['type'])) === 0) {
1766             return null;
1767         }
1769         if (!empty($CFG->slasharguments) and $rev > 0) {
1770             $url = new moodle_url("/theme/javascript.php");
1771             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
1772             return $url;
1773         } else {
1774             return new moodle_url('/theme/javascript.php', $params);
1775         }
1776     }
1778     /**
1779      * Get the URL's for the JavaScript files used by this theme.
1780      * They won't be served directly, instead they'll be mediated through
1781      * theme/javascript.php.
1782      *
1783      * @param string $type Either javascripts_footer, or javascripts
1784      * @return array
1785      */
1786     public function javascript_files($type) {
1787         if ($type === 'footer') {
1788             $type = 'javascripts_footer';
1789         } else {
1790             $type = 'javascripts';
1791         }
1793         $js = array();
1794         // find out wanted parent javascripts
1795         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
1796         if ($excludes !== true) {
1797             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1798                 $parent = $parent_config->name;
1799                 if (empty($parent_config->$type)) {
1800                     continue;
1801                 }
1802                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
1803                     continue;
1804                 }
1805                 foreach ($parent_config->$type as $javascript) {
1806                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
1807                         and in_array($javascript, $excludes[$parent])) {
1808                         continue;
1809                     }
1810                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
1811                     if (is_readable($javascriptfile)) {
1812                         $js[] = $javascriptfile;
1813                     }
1814                 }
1815             }
1816         }
1818         // current theme javascripts
1819         if (is_array($this->$type)) {
1820             foreach ($this->$type as $javascript) {
1821                 $javascriptfile = "$this->dir/javascript/$javascript.js";
1822                 if (is_readable($javascriptfile)) {
1823                     $js[] = $javascriptfile;
1824                 }
1825             }
1826         }
1827         return $js;
1828     }
1830     /**
1831      * Resolves an exclude setting to the themes setting is applicable or the
1832      * setting of its closest parent.
1833      *
1834      * @param string $variable The name of the setting the exclude setting to resolve
1835      * @param string $default
1836      * @return mixed
1837      */
1838     protected function resolve_excludes($variable, $default = null) {
1839         $setting = $default;
1840         if (is_array($this->{$variable}) or $this->{$variable} === true) {
1841             $setting = $this->{$variable};
1842         } else {
1843             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
1844                 if (!isset($parent_config->{$variable})) {
1845                     continue;
1846                 }
1847                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
1848                     $setting = $parent_config->{$variable};
1849                     break;
1850                 }
1851             }
1852         }
1853         return $setting;
1854     }
1856     /**
1857      * Returns the content of the one huge javascript file merged from all theme javascript files.
1858      *
1859      * @param bool $type
1860      * @return string
1861      */
1862     public function javascript_content($type) {
1863         $jsfiles = $this->javascript_files($type);
1864         $js = '';
1865         foreach ($jsfiles as $jsfile) {
1866             $js .= file_get_contents($jsfile)."\n";
1867         }
1868         return $js;
1869     }
1871     /**
1872      * Post processes CSS.
1873      *
1874      * This method post processes all of the CSS before it is served for this theme.
1875      * This is done so that things such as image URL's can be swapped in and to
1876      * run any specific CSS post process method the theme has requested.
1877      * This allows themes to use CSS settings.
1878      *
1879      * @param string $css The CSS to process.
1880      * @return string The processed CSS.
1881      */
1882     public function post_process($css) {
1883         // now resolve all image locations
1884         if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1885             $replaced = array();
1886             foreach ($matches as $match) {
1887                 if (isset($replaced[$match[0]])) {
1888                     continue;
1889                 }
1890                 $replaced[$match[0]] = true;
1891                 $imagename = $match[2];
1892                 $component = rtrim($match[1], '|');
1893                 $imageurl = $this->image_url($imagename, $component)->out(false);
1894                  // we do not need full url because the image.php is always in the same dir
1895                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
1896                 $css = str_replace($match[0], $imageurl, $css);
1897             }
1898         }
1900         // Now resolve all font locations.
1901         if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1902             $replaced = array();
1903             foreach ($matches as $match) {
1904                 if (isset($replaced[$match[0]])) {
1905                     continue;
1906                 }
1907                 $replaced[$match[0]] = true;
1908                 $fontname = $match[2];
1909                 $component = rtrim($match[1], '|');
1910                 $fonturl = $this->font_url($fontname, $component)->out(false);
1911                 // We do not need full url because the font.php is always in the same dir.
1912                 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1913                 $css = str_replace($match[0], $fonturl, $css);
1914             }
1915         }
1917         // Now resolve all theme settings or do any other postprocessing.
1918         // This needs to be done before calling core parser, since the parser strips [[settings]] tags.
1919         $csspostprocess = $this->csspostprocess;
1920         if (function_exists($csspostprocess)) {
1921             $css = $csspostprocess($css, $this);
1922         }
1924         // Post processing using an object representation of CSS.
1925         $treeprocessor = $this->get_css_tree_post_processor();
1926         $needsparsing = !empty($treeprocessor) || !empty($this->rtlmode);
1927         if ($needsparsing) {
1929             // We might need more memory/time to do this, so let's play safe.
1930             raise_memory_limit(MEMORY_EXTRA);
1931             core_php_time_limit::raise(300);
1933             $parser = new core_cssparser($css);
1934             $csstree = $parser->parse();
1935             unset($parser);
1937             if ($this->rtlmode) {
1938                 $this->rtlize($csstree);
1939             }
1941             if ($treeprocessor) {
1942                 $treeprocessor($csstree, $this);
1943             }
1945             $css = $csstree->render();
1946             unset($csstree);
1947         }
1949         return $css;
1950     }
1952     /**
1953      * Flip a stylesheet to RTL.
1954      *
1955      * @param Object $csstree The parsed CSS tree structure to flip.
1956      * @return void
1957      */
1958     protected function rtlize($csstree) {
1959         $rtlcss = new core_rtlcss($csstree);
1960         $rtlcss->flip();
1961     }
1963     /**
1964      * Return the direct URL for an image from the pix folder.
1965      *
1966      * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
1967      *
1968      * @deprecated since Moodle 3.3
1969      * @param string $imagename the name of the icon.
1970      * @param string $component specification of one plugin like in get_string()
1971      * @return moodle_url
1972      */
1973     public function pix_url($imagename, $component) {
1974         debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
1975         return $this->image_url($imagename, $component);
1976     }
1978     /**
1979      * Return the direct URL for an image from the pix folder.
1980      *
1981      * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
1982      *
1983      * @param string $imagename the name of the icon.
1984      * @param string $component specification of one plugin like in get_string()
1985      * @return moodle_url
1986      */
1987     public function image_url($imagename, $component) {
1988         global $CFG;
1990         $params = array('theme'=>$this->name);
1991         $svg = $this->use_svg_icons();
1993         if (empty($component) or $component === 'moodle' or $component === 'core') {
1994             $params['component'] = 'core';
1995         } else {
1996             $params['component'] = $component;
1997         }
1999         $rev = theme_get_revision();
2000         if ($rev != -1) {
2001             $params['rev'] = $rev;
2002         }
2004         $params['image'] = $imagename;
2006         $url = new moodle_url("/theme/image.php");
2007         if (!empty($CFG->slasharguments) and $rev > 0) {
2008             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
2009             if (!$svg) {
2010                 // We add a simple /_s to the start of the path.
2011                 // The underscore is used to ensure that it isn't a valid theme name.
2012                 $path = '/_s'.$path;
2013             }
2014             $url->set_slashargument($path, 'noparam', true);
2015         } else {
2016             if (!$svg) {
2017                 // We add an SVG param so that we know not to serve SVG images.
2018                 // We do this because all modern browsers support SVG and this param will one day be removed.
2019                 $params['svg'] = '0';
2020             }
2021             $url->params($params);
2022         }
2024         return $url;
2025     }
2027     /**
2028      * Return the URL for a font
2029      *
2030      * @param string $font the name of the font (including extension).
2031      * @param string $component specification of one plugin like in get_string()
2032      * @return moodle_url
2033      */
2034     public function font_url($font, $component) {
2035         global $CFG;
2037         $params = array('theme'=>$this->name);
2039         if (empty($component) or $component === 'moodle' or $component === 'core') {
2040             $params['component'] = 'core';
2041         } else {
2042             $params['component'] = $component;
2043         }
2045         $rev = theme_get_revision();
2046         if ($rev != -1) {
2047             $params['rev'] = $rev;
2048         }
2050         $params['font'] = $font;
2052         $url = new moodle_url("/theme/font.php");
2053         if (!empty($CFG->slasharguments) and $rev > 0) {
2054             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
2055             $url->set_slashargument($path, 'noparam', true);
2056         } else {
2057             $url->params($params);
2058         }
2060         return $url;
2061     }
2063     /**
2064      * Returns URL to the stored file via pluginfile.php.
2065      *
2066      * Note the theme must also implement pluginfile.php handler,
2067      * theme revision is used instead of the itemid.
2068      *
2069      * @param string $setting
2070      * @param string $filearea
2071      * @return string protocol relative URL or null if not present
2072      */
2073     public function setting_file_url($setting, $filearea) {
2074         global $CFG;
2076         if (empty($this->settings->$setting)) {
2077             return null;
2078         }
2080         $component = 'theme_'.$this->name;
2081         $itemid = theme_get_revision();
2082         $filepath = $this->settings->$setting;
2083         $syscontext = context_system::instance();
2085         $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
2087         // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
2088         // Note: unfortunately moodle_url does not support //urls yet.
2090         $url = preg_replace('|^https?://|i', '//', $url->out(false));
2092         return $url;
2093     }
2095     /**
2096      * Serve the theme setting file.
2097      *
2098      * @param string $filearea
2099      * @param array $args
2100      * @param bool $forcedownload
2101      * @param array $options
2102      * @return bool may terminate if file not found or donotdie not specified
2103      */
2104     public function setting_file_serve($filearea, $args, $forcedownload, $options) {
2105         global $CFG;
2106         require_once("$CFG->libdir/filelib.php");
2108         $syscontext = context_system::instance();
2109         $component = 'theme_'.$this->name;
2111         $revision = array_shift($args);
2112         if ($revision < 0) {
2113             $lifetime = 0;
2114         } else {
2115             $lifetime = 60*60*24*60;
2116             // By default, theme files must be cache-able by both browsers and proxies.
2117             if (!array_key_exists('cacheability', $options)) {
2118                 $options['cacheability'] = 'public';
2119             }
2120         }
2122         $fs = get_file_storage();
2123         $relativepath = implode('/', $args);
2125         $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
2126         $fullpath = rtrim($fullpath, '/');
2127         if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
2128             send_stored_file($file, $lifetime, 0, $forcedownload, $options);
2129             return true;
2130         } else {
2131             send_file_not_found();
2132         }
2133     }
2135     /**
2136      * Resolves the real image location.
2137      *
2138      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
2139      * and we need a way in which to turn it off.
2140      * By default SVG won't be used unless asked for. This is done for two reasons:
2141      *   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
2142      *      browser supports SVG.
2143      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
2144      *      by the user due to security concerns.
2145      *
2146      * @param string $image name of image, may contain relative path
2147      * @param string $component
2148      * @param bool $svg|null Should SVG images also be looked for? If null, resorts to $CFG->svgicons if that is set; falls back to
2149      * auto-detection of browser support otherwise
2150      * @return string full file path
2151      */
2152     public function resolve_image_location($image, $component, $svg = false) {
2153         global $CFG;
2155         if (!is_bool($svg)) {
2156             // If $svg isn't a bool then we need to decide for ourselves.
2157             $svg = $this->use_svg_icons();
2158         }
2160         if ($component === 'moodle' or $component === 'core' or empty($component)) {
2161             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
2162                 return $imagefile;
2163             }
2164             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
2165                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
2166                     return $imagefile;
2167                 }
2168             }
2169             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
2170                 return $imagefile;
2171             }
2172             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
2173                 return $imagefile;
2174             }
2175             return null;
2177         } else if ($component === 'theme') { //exception
2178             if ($image === 'favicon') {
2179                 return "$this->dir/pix/favicon.ico";
2180             }
2181             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
2182                 return $imagefile;
2183             }
2184             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
2185                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
2186                     return $imagefile;
2187                 }
2188             }
2189             return null;
2191         } else {
2192             if (strpos($component, '_') === false) {
2193                 $component = 'mod_'.$component;
2194             }
2195             list($type, $plugin) = explode('_', $component, 2);
2197             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
2198                 return $imagefile;
2199             }
2200             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
2201                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
2202                     return $imagefile;
2203                 }
2204             }
2205             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
2206                 return $imagefile;
2207             }
2208             $dir = core_component::get_plugin_directory($type, $plugin);
2209             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
2210                 return $imagefile;
2211             }
2212             return null;
2213         }
2214     }
2216     /**
2217      * Resolves the real font location.
2218      *
2219      * @param string $font name of font file
2220      * @param string $component
2221      * @return string full file path
2222      */
2223     public function resolve_font_location($font, $component) {
2224         global $CFG;
2226         if ($component === 'moodle' or $component === 'core' or empty($component)) {
2227             if (file_exists("$this->dir/fonts_core/$font")) {
2228                 return "$this->dir/fonts_core/$font";
2229             }
2230             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2231                 if (file_exists("$parent_config->dir/fonts_core/$font")) {
2232                     return "$parent_config->dir/fonts_core/$font";
2233                 }
2234             }
2235             if (file_exists("$CFG->dataroot/fonts/$font")) {
2236                 return "$CFG->dataroot/fonts/$font";
2237             }
2238             if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
2239                 return "$CFG->dirroot/lib/fonts/$font";
2240             }
2241             return null;
2243         } else if ($component === 'theme') { // Exception.
2244             if (file_exists("$this->dir/fonts/$font")) {
2245                 return "$this->dir/fonts/$font";
2246             }
2247             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2248                 if (file_exists("$parent_config->dir/fonts/$font")) {
2249                     return "$parent_config->dir/fonts/$font";
2250                 }
2251             }
2252             return null;
2254         } else {
2255             if (strpos($component, '_') === false) {
2256                 $component = 'mod_'.$component;
2257             }
2258             list($type, $plugin) = explode('_', $component, 2);
2260             if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
2261                 return "$this->dir/fonts_plugins/$type/$plugin/$font";
2262             }
2263             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2264                 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
2265                     return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
2266                 }
2267             }
2268             if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
2269                 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
2270             }
2271             $dir = core_component::get_plugin_directory($type, $plugin);
2272             if (file_exists("$dir/fonts/$font")) {
2273                 return "$dir/fonts/$font";
2274             }
2275             return null;
2276         }
2277     }
2279     /**
2280      * Return true if we should look for SVG images as well.
2281      *
2282      * @return bool
2283      */
2284     public function use_svg_icons() {
2285         global $CFG;
2286         if ($this->usesvg === null) {
2288             if (!isset($CFG->svgicons)) {
2289                 $this->usesvg = core_useragent::supports_svg();
2290             } else {
2291                 // Force them on/off depending upon the setting.
2292                 $this->usesvg = (bool)$CFG->svgicons;
2293             }
2294         }
2295         return $this->usesvg;
2296     }
2298     /**
2299      * Forces the usesvg setting to either true or false, avoiding any decision making.
2300      *
2301      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
2302      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
2303      *
2304      * @param bool $setting True to force the use of svg when available, null otherwise.
2305      */
2306     public function force_svg_use($setting) {
2307         $this->usesvg = (bool)$setting;
2308     }
2310     /**
2311      * Set to be in RTL mode.
2312      *
2313      * This will likely be used when post processing the CSS before serving it.
2314      *
2315      * @param bool $inrtl True when in RTL mode.
2316      */
2317     public function set_rtl_mode($inrtl = true) {
2318         $this->rtlmode = $inrtl;
2319     }
2321     /**
2322      * Whether the theme is being served in RTL mode.
2323      *
2324      * @return bool True when in RTL mode.
2325      */
2326     public function get_rtl_mode() {
2327         return $this->rtlmode;
2328     }
2330     /**
2331      * Checks if file with any image extension exists.
2332      *
2333      * The order to these images was adjusted prior to the release of 2.4
2334      * At that point the were the following image counts in Moodle core:
2335      *
2336      *     - png = 667 in pix dirs (1499 total)
2337      *     - gif = 385 in pix dirs (606 total)
2338      *     - jpg = 62  in pix dirs (74 total)
2339      *     - jpeg = 0  in pix dirs (1 total)
2340      *
2341      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
2342      *
2343      * @param string $filepath
2344      * @param bool $svg If set to true SVG images will also be looked for.
2345      * @return string image name with extension
2346      */
2347     private static function image_exists($filepath, $svg = false) {
2348         if ($svg && file_exists("$filepath.svg")) {
2349             return "$filepath.svg";
2350         } else  if (file_exists("$filepath.png")) {
2351             return "$filepath.png";
2352         } else if (file_exists("$filepath.gif")) {
2353             return "$filepath.gif";
2354         } else  if (file_exists("$filepath.jpg")) {
2355             return "$filepath.jpg";
2356         } else  if (file_exists("$filepath.jpeg")) {
2357             return "$filepath.jpeg";
2358         } else {
2359             return false;
2360         }
2361     }
2363     /**
2364      * Loads the theme config from config.php file.
2365      *
2366      * @param string $themename
2367      * @param stdClass $settings from config_plugins table
2368      * @param boolean $parentscheck true to also check the parents.    .
2369      * @return stdClass The theme configuration
2370      */
2371     private static function find_theme_config($themename, $settings, $parentscheck = true) {
2372         // We have to use the variable name $THEME (upper case) because that
2373         // is what is used in theme config.php files.
2375         if (!$dir = theme_config::find_theme_location($themename)) {
2376             return null;
2377         }
2379         $THEME = new stdClass();
2380         $THEME->name     = $themename;
2381         $THEME->dir      = $dir;
2382         $THEME->settings = $settings;
2384         global $CFG; // just in case somebody tries to use $CFG in theme config
2385         include("$THEME->dir/config.php");
2387         // verify the theme configuration is OK
2388         if (!is_array($THEME->parents)) {
2389             // parents option is mandatory now
2390             return null;
2391         } else {
2392             // We use $parentscheck to only check the direct parents (avoid infinite loop).
2393             if ($parentscheck) {
2394                 // Find all parent theme configs.
2395                 foreach ($THEME->parents as $parent) {
2396                     $parentconfig = theme_config::find_theme_config($parent, $settings, false);
2397                     if (empty($parentconfig)) {
2398                         return null;
2399                     }
2400                 }
2401             }
2402         }
2404         return $THEME;
2405     }
2407     /**
2408      * Finds the theme location and verifies the theme has all needed files
2409      * and is not obsoleted.
2410      *
2411      * @param string $themename
2412      * @return string full dir path or null if not found
2413      */
2414     private static function find_theme_location($themename) {
2415         global $CFG;
2417         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
2418             $dir = "$CFG->dirroot/theme/$themename";
2420         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
2421             $dir = "$CFG->themedir/$themename";
2423         } else {
2424             return null;
2425         }
2427         if (file_exists("$dir/styles.php")) {
2428             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
2429             return null;
2430         }
2432         return $dir;
2433     }
2435     /**
2436      * Get the renderer for a part of Moodle for this theme.
2437      *
2438      * @param moodle_page $page the page we are rendering
2439      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
2440      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
2441      * @param string $target one of rendering target constants
2442      * @return renderer_base the requested renderer.
2443      */
2444     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
2445         if (is_null($this->rf)) {
2446             $classname = $this->rendererfactory;
2447             $this->rf = new $classname($this);
2448         }
2450         return $this->rf->get_renderer($page, $component, $subtype, $target);
2451     }
2453     /**
2454      * Get the information from {@link $layouts} for this type of page.
2455      *
2456      * @param string $pagelayout the the page layout name.
2457      * @return array the appropriate part of {@link $layouts}.
2458      */
2459     protected function layout_info_for_page($pagelayout) {
2460         if (array_key_exists($pagelayout, $this->layouts)) {
2461             return $this->layouts[$pagelayout];
2462         } else {
2463             debugging('Invalid page layout specified: ' . $pagelayout);
2464             return $this->layouts['standard'];
2465         }
2466     }
2468     /**
2469      * Given the settings of this theme, and the page pagelayout, return the
2470      * full path of the page layout file to use.
2471      *
2472      * Used by {@link core_renderer::header()}.
2473      *
2474      * @param string $pagelayout the the page layout name.
2475      * @return string Full path to the lyout file to use
2476      */
2477     public function layout_file($pagelayout) {
2478         global $CFG;
2480         $layoutinfo = $this->layout_info_for_page($pagelayout);
2481         $layoutfile = $layoutinfo['file'];
2483         if (array_key_exists('theme', $layoutinfo)) {
2484             $themes = array($layoutinfo['theme']);
2485         } else {
2486             $themes = array_merge(array($this->name),$this->parents);
2487         }
2489         foreach ($themes as $theme) {
2490             if ($dir = $this->find_theme_location($theme)) {
2491                 $path = "$dir/layout/$layoutfile";
2493                 // Check the template exists, return general base theme template if not.
2494                 if (is_readable($path)) {
2495                     return $path;
2496                 }
2497             }
2498         }
2500         debugging('Can not find layout file for: ' . $pagelayout);
2501         // fallback to standard normal layout
2502         return "$CFG->dirroot/theme/base/layout/general.php";
2503     }
2505     /**
2506      * Returns auxiliary page layout options specified in layout configuration array.
2507      *
2508      * @param string $pagelayout
2509      * @return array
2510      */
2511     public function pagelayout_options($pagelayout) {
2512         $info = $this->layout_info_for_page($pagelayout);
2513         if (!empty($info['options'])) {
2514             return $info['options'];
2515         }
2516         return array();
2517     }
2519     /**
2520      * Inform a block_manager about the block regions this theme wants on this
2521      * page layout.
2522      *
2523      * @param string $pagelayout the general type of the page.
2524      * @param block_manager $blockmanager the block_manger to set up.
2525      */
2526     public function setup_blocks($pagelayout, $blockmanager) {
2527         $layoutinfo = $this->layout_info_for_page($pagelayout);
2528         if (!empty($layoutinfo['regions'])) {
2529             $blockmanager->add_regions($layoutinfo['regions'], false);
2530             $blockmanager->set_default_region($layoutinfo['defaultregion']);
2531         }
2532     }
2534     /**
2535      * Gets the visible name for the requested block region.
2536      *
2537      * @param string $region The region name to get
2538      * @param string $theme The theme the region belongs to (may come from the parent theme)
2539      * @return string
2540      */
2541     protected function get_region_name($region, $theme) {
2542         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
2543         // A name exists in this theme, so use it
2544         if (substr($regionstring, 0, 1) != '[') {
2545             return $regionstring;
2546         }
2548         // Otherwise, try to find one elsewhere
2549         // Check parents, if any
2550         foreach ($this->parents as $parentthemename) {
2551             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
2552             if (substr($regionstring, 0, 1) != '[') {
2553                 return $regionstring;
2554             }
2555         }
2557         // Last resort, try the boost theme for names
2558         return get_string('region-' . $region, 'theme_boost');
2559     }
2561     /**
2562      * Get the list of all block regions known to this theme in all templates.
2563      *
2564      * @return array internal region name => human readable name.
2565      */
2566     public function get_all_block_regions() {
2567         $regions = array();
2568         foreach ($this->layouts as $layoutinfo) {
2569             foreach ($layoutinfo['regions'] as $region) {
2570                 $regions[$region] = $this->get_region_name($region, $this->name);
2571             }
2572         }
2573         return $regions;
2574     }
2576     /**
2577      * Returns the human readable name of the theme
2578      *
2579      * @return string
2580      */
2581     public function get_theme_name() {
2582         return get_string('pluginname', 'theme_'.$this->name);
2583     }
2585     /**
2586      * Returns the block render method.
2587      *
2588      * It is set by the theme via:
2589      *     $THEME->blockrendermethod = '...';
2590      *
2591      * It can be one of two values, blocks or blocks_for_region.
2592      * It should be set to the method being used by the theme layouts.
2593      *
2594      * @return string
2595      */
2596     public function get_block_render_method() {
2597         if ($this->blockrendermethod) {
2598             // Return the specified block render method.
2599             return $this->blockrendermethod;
2600         }
2601         // Its not explicitly set, check the parent theme configs.
2602         foreach ($this->parent_configs as $config) {
2603             if (isset($config->blockrendermethod)) {
2604                 return $config->blockrendermethod;
2605             }
2606         }
2607         // Default it to blocks.
2608         return 'blocks';
2609     }
2611     /**
2612      * Get the callable for CSS tree post processing.
2613      *
2614      * @return string|null
2615      */
2616     public function get_css_tree_post_processor() {
2617         $configs = [$this] + $this->parent_configs;
2618         foreach ($configs as $config) {
2619             if (!empty($config->csstreepostprocessor) && is_callable($config->csstreepostprocessor)) {
2620                 return $config->csstreepostprocessor;
2621             }
2622         }
2623         return null;
2624     }
2628 /**
2629  * This class keeps track of which HTML tags are currently open.
2630  *
2631  * This makes it much easier to always generate well formed XHTML output, even
2632  * if execution terminates abruptly. Any time you output some opening HTML
2633  * without the matching closing HTML, you should push the necessary close tags
2634  * onto the stack.
2635  *
2636  * @copyright 2009 Tim Hunt
2637  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2638  * @since Moodle 2.0
2639  * @package core
2640  * @category output
2641  */
2642 class xhtml_container_stack {
2644     /**
2645      * @var array Stores the list of open containers.
2646      */
2647     protected $opencontainers = array();
2649     /**
2650      * @var array In developer debug mode, stores a stack trace of all opens and
2651      * closes, so we can output helpful error messages when there is a mismatch.
2652      */
2653     protected $log = array();
2655     /**
2656      * @var boolean Store whether we are developer debug mode. We need this in
2657      * several places including in the destructor where we may not have access to $CFG.
2658      */
2659     protected $isdebugging;
2661     /**
2662      * Constructor
2663      */
2664     public function __construct() {
2665         global $CFG;
2666         $this->isdebugging = $CFG->debugdeveloper;
2667     }
2669     /**
2670      * Push the close HTML for a recently opened container onto the stack.
2671      *
2672      * @param string $type The type of container. This is checked when {@link pop()}
2673      *      is called and must match, otherwise a developer debug warning is output.
2674      * @param string $closehtml The HTML required to close the container.
2675      */
2676     public function push($type, $closehtml) {
2677         $container = new stdClass;
2678         $container->type = $type;
2679         $container->closehtml = $closehtml;
2680         if ($this->isdebugging) {
2681             $this->log('Open', $type);
2682         }
2683         array_push($this->opencontainers, $container);
2684     }
2686     /**
2687      * Pop the HTML for the next closing container from the stack. The $type
2688      * must match the type passed when the container was opened, otherwise a
2689      * warning will be output.
2690      *
2691      * @param string $type The type of container.
2692      * @return string the HTML required to close the container.
2693      */
2694     public function pop($type) {
2695         if (empty($this->opencontainers)) {
2696             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
2697                     $this->output_log(), DEBUG_DEVELOPER);
2698             return;
2699         }
2701         $container = array_pop($this->opencontainers);
2702         if ($container->type != $type) {
2703             debugging('<p>The type of container to be closed (' . $container->type .
2704                     ') does not match the type of the next open container (' . $type .
2705                     '). This suggests there is a nesting problem.</p>' .
2706                     $this->output_log(), DEBUG_DEVELOPER);
2707         }
2708         if ($this->isdebugging) {
2709             $this->log('Close', $type);
2710         }
2711         return $container->closehtml;
2712     }
2714     /**
2715      * Close all but the last open container. This is useful in places like error
2716      * handling, where you want to close all the open containers (apart from <body>)
2717      * before outputting the error message.
2718      *
2719      * @param bool $shouldbenone assert that the stack should be empty now - causes a
2720      *      developer debug warning if it isn't.
2721      * @return string the HTML required to close any open containers inside <body>.
2722      */
2723     public function pop_all_but_last($shouldbenone = false) {
2724         if ($shouldbenone && count($this->opencontainers) != 1) {
2725             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
2726                     $this->output_log(), DEBUG_DEVELOPER);
2727         }
2728         $output = '';
2729         while (count($this->opencontainers) > 1) {
2730             $container = array_pop($this->opencontainers);
2731             $output .= $container->closehtml;
2732         }
2733         return $output;
2734     }
2736     /**
2737      * You can call this function if you want to throw away an instance of this
2738      * class without properly emptying the stack (for example, in a unit test).
2739      * Calling this method stops the destruct method from outputting a developer
2740      * debug warning. After calling this method, the instance can no longer be used.
2741      */
2742     public function discard() {
2743         $this->opencontainers = null;
2744     }
2746     /**
2747      * Adds an entry to the log.
2748      *
2749      * @param string $action The name of the action
2750      * @param string $type The type of action
2751      */
2752     protected function log($action, $type) {
2753         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
2754                 format_backtrace(debug_backtrace()) . '</li>';
2755     }
2757     /**
2758      * Outputs the log's contents as a HTML list.
2759      *
2760      * @return string HTML list of the log
2761      */
2762     protected function output_log() {
2763         return '<ul>' . implode("\n", $this->log) . '</ul>';
2764     }