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