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