MDL-56602 themes: Use version number as base themerev
[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  * Invalidate all server and client side caches.
39  *
40  * This method deletes the physical directory that is used to cache the theme
41  * files used for serving.
42  * Because it deletes the main theme cache directory all themes are reset by
43  * this function.
44  */
45 function theme_reset_all_caches() {
46     global $CFG, $PAGE;
48     $next = time();
49     if (isset($CFG->themerev) and $next <= $CFG->themerev and $CFG->themerev - $next < 60*60) {
50         // This resolves problems when reset is requested repeatedly within 1s,
51         // the < 1h condition prevents accidental switching to future dates
52         // because we might not recover from it.
53         $next = $CFG->themerev+1;
54     }
56     set_config('themerev', $next); // time is unique even when you reset/switch database
58     if (!empty($CFG->themedesignermode)) {
59         $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner');
60         $cache->purge();
61     }
63     if ($PAGE) {
64         $PAGE->reload_theme();
65     }
66 }
68 /**
69  * Enable or disable theme designer mode.
70  *
71  * @param bool $state
72  */
73 function theme_set_designer_mod($state) {
74     set_config('themedesignermode', (int)!empty($state));
75     // Reset caches after switching mode so that any designer mode caches get purged too.
76     theme_reset_all_caches();
77 }
79 /**
80  * Returns current theme revision number.
81  *
82  * @return int
83  */
84 function theme_get_revision() {
85     global $CFG;
87     if (empty($CFG->themedesignermode)) {
88         if (empty($CFG->themerev)) {
89             // If theme designer mode is not set, and there is no themerev, this is almost certainly part of the installation.
90             // We attempt to set a themerev based on the Moodle version number to avoid costly rebuilds of the dynamic
91             // theme files between each page load.
92             $version = null;
93             require("{$CFG->dirroot}/version.php");
95             return version_to_timestamp($version);
96         } else {
97             return $CFG->themerev;
98         }
100     } else {
101         return -1;
102     }
105 /**
106  * Checks if the given device has a theme defined in config.php.
107  *
108  * @return bool
109  */
110 function theme_is_device_locked($device) {
111     global $CFG;
112     $themeconfigname = core_useragent::get_device_type_cfg_var_name($device);
113     return isset($CFG->config_php_settings[$themeconfigname]);
116 /**
117  * Returns the theme named defined in config.php for the given device.
118  *
119  * @return string or null
120  */
121 function theme_get_locked_theme_for_device($device) {
122     global $CFG;
124     if (!theme_is_device_locked($device)) {
125         return null;
126     }
128     $themeconfigname = core_useragent::get_device_type_cfg_var_name($device);
129     return $CFG->config_php_settings[$themeconfigname];
132 /**
133  * This class represents the configuration variables of a Moodle theme.
134  *
135  * All the variables with access: public below (with a few exceptions that are marked)
136  * are the properties you can set in your themes config.php file.
137  *
138  * There are also some methods and protected variables that are part of the inner
139  * workings of Moodle's themes system. If you are just editing a themes config.php
140  * file, you can just ignore those, and the following information for developers.
141  *
142  * Normally, to create an instance of this class, you should use the
143  * {@link theme_config::load()} factory method to load a themes config.php file.
144  * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
145  * will create one for you, accessible as $PAGE->theme.
146  *
147  * @copyright 2009 Tim Hunt
148  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
149  * @since Moodle 2.0
150  * @package core
151  * @category output
152  */
153 class theme_config {
155     /**
156      * @var string Default theme, used when requested theme not found.
157      */
158     const DEFAULT_THEME = 'boost';
160     /**
161      * @var array You can base your theme on other themes by linking to the other theme as
162      * parents. This lets you use the CSS and layouts from the other themes
163      * (see {@link theme_config::$layouts}).
164      * That makes it easy to create a new theme that is similar to another one
165      * but with a few changes. In this themes CSS you only need to override
166      * those rules you want to change.
167      */
168     public $parents;
170     /**
171      * @var array The names of all the stylesheets from this theme that you would
172      * like included, in order. Give the names of the files without .css.
173      */
174     public $sheets = array();
176     /**
177      * @var array The names of all the stylesheets from parents that should be excluded.
178      * true value may be used to specify all parents or all themes from one parent.
179      * If no value specified value from parent theme used.
180      */
181     public $parents_exclude_sheets = null;
183     /**
184      * @var array List of plugin sheets to be excluded.
185      * If no value specified value from parent theme used.
186      */
187     public $plugins_exclude_sheets = null;
189     /**
190      * @var array List of style sheets that are included in the text editor bodies.
191      * Sheets from parent themes are used automatically and can not be excluded.
192      */
193     public $editor_sheets = array();
195     /**
196      * @var array The names of all the javascript files this theme that you would
197      * like included from head, in order. Give the names of the files without .js.
198      */
199     public $javascripts = array();
201     /**
202      * @var array The names of all the javascript files this theme that you would
203      * like included from footer, in order. Give the names of the files without .js.
204      */
205     public $javascripts_footer = array();
207     /**
208      * @var array The names of all the javascript files from parents that should
209      * be excluded. true value may be used to specify all parents or all themes
210      * from one parent.
211      * If no value specified value from parent theme used.
212      */
213     public $parents_exclude_javascripts = null;
215     /**
216      * @var array Which file to use for each page layout.
217      *
218      * This is an array of arrays. The keys of the outer array are the different layouts.
219      * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
220      * 'popup', 'form', .... The most reliable way to get a complete list is to look at
221      * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
222      * That file also has a good example of how to set this setting.
223      *
224      * For each layout, the value in the outer array is an array that describes
225      * how you want that type of page to look. For example
226      * <pre>
227      *   $THEME->layouts = array(
228      *       // Most pages - if we encounter an unknown or a missing page type, this one is used.
229      *       'standard' => array(
230      *           'theme' = 'mytheme',
231      *           'file' => 'normal.php',
232      *           'regions' => array('side-pre', 'side-post'),
233      *           'defaultregion' => 'side-post'
234      *       ),
235      *       // The site home page.
236      *       'home' => array(
237      *           'theme' = 'mytheme',
238      *           'file' => 'home.php',
239      *           'regions' => array('side-pre', 'side-post'),
240      *           'defaultregion' => 'side-post'
241      *       ),
242      *       // ...
243      *   );
244      * </pre>
245      *
246      * 'theme' name of the theme where is the layout located
247      * 'file' is the layout file to use for this type of page.
248      * layout files are stored in layout subfolder
249      * 'regions' This lists the regions on the page where blocks may appear. For
250      * each region you list here, your layout file must include a call to
251      * <pre>
252      *   echo $OUTPUT->blocks_for_region($regionname);
253      * </pre>
254      * or equivalent so that the blocks are actually visible.
255      *
256      * 'defaultregion' If the list of regions is non-empty, then you must pick
257      * one of the one of them as 'default'. This has two meanings. First, this is
258      * where new blocks are added. Second, if there are any blocks associated with
259      * the page, but in non-existent regions, they appear here. (Imaging, for example,
260      * that someone added blocks using a different theme that used different region
261      * names, and then switched to this theme.)
262      */
263     public $layouts = array();
265     /**
266      * @var string Name of the renderer factory class to use. Must implement the
267      * {@link renderer_factory} interface.
268      *
269      * This is an advanced feature. Moodle output is generated by 'renderers',
270      * you can customise the HTML that is output by writing custom renderers,
271      * and then you need to specify 'renderer factory' so that Moodle can find
272      * your renderers.
273      *
274      * There are some renderer factories supplied with Moodle. Please follow these
275      * links to see what they do.
276      * <ul>
277      * <li>{@link standard_renderer_factory} - the default.</li>
278      * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
279      *      your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
280      * </ul>
281      */
282     public $rendererfactory = 'standard_renderer_factory';
284     /**
285      * @var string Function to do custom CSS post-processing.
286      *
287      * This is an advanced feature. If you want to do custom post-processing on the
288      * CSS before it is output (for example, to replace certain variable names
289      * with particular values) you can give the name of a function here.
290      */
291     public $csspostprocess = null;
293     /**
294      * @var string Function to do custom CSS post-processing on a parsed CSS tree.
295      *
296      * This is an advanced feature. If you want to do custom post-processing on the
297      * CSS before it is output, you can provide the name of the function here. The
298      * function will receive a CSS tree document as first parameter, and the theme_config
299      * object as second parameter. A return value is not required, the tree can
300      * be edited in place.
301      */
302     public $csstreepostprocess = null;
304     /**
305      * @var string Accessibility: Right arrow-like character is
306      * used in the breadcrumb trail, course navigation menu
307      * (previous/next activity), calendar, and search forum block.
308      * If the theme does not set characters, appropriate defaults
309      * are set automatically. Please DO NOT
310      * use &lt; &gt; &raquo; - these are confusing for blind users.
311      */
312     public $rarrow = null;
314     /**
315      * @var string Accessibility: Left arrow-like character is
316      * used in the breadcrumb trail, course navigation menu
317      * (previous/next activity), calendar, and search forum block.
318      * If the theme does not set characters, appropriate defaults
319      * are set automatically. Please DO NOT
320      * use &lt; &gt; &raquo; - these are confusing for blind users.
321      */
322     public $larrow = null;
324     /**
325      * @var string Accessibility: Up arrow-like character is used in
326      * the book heirarchical navigation.
327      * If the theme does not set characters, appropriate defaults
328      * are set automatically. Please DO NOT
329      * use ^ - this is confusing for blind users.
330      */
331     public $uarrow = null;
333     /**
334      * @var string Accessibility: Down arrow-like character.
335      * If the theme does not set characters, appropriate defaults
336      * are set automatically.
337      */
338     public $darrow = null;
340     /**
341      * @var bool Some themes may want to disable ajax course editing.
342      */
343     public $enablecourseajax = true;
345     /**
346      * @var string Determines served document types
347      *  - 'html5' the only officially supported doctype in Moodle
348      *  - 'xhtml5' may be used in development for validation (not intended for production servers!)
349      *  - 'xhtml' XHTML 1.0 Strict for legacy themes only
350      */
351     public $doctype = 'html5';
353     /**
354      * @var string undeletableblocktypes If set to a string, will list the block types that cannot be deleted. Defaults to
355      *                                   navigation and settings.
356      */
357     public $undeletableblocktypes = false;
359     //==Following properties are not configurable from theme config.php==
361     /**
362      * @var string The name of this theme. Set automatically when this theme is
363      * loaded. This can not be set in theme config.php
364      */
365     public $name;
367     /**
368      * @var string The folder where this themes files are stored. This is set
369      * automatically. This can not be set in theme config.php
370      */
371     public $dir;
373     /**
374      * @var stdClass Theme settings stored in config_plugins table.
375      * This can not be set in theme config.php
376      */
377     public $setting = null;
379     /**
380      * @var bool If set to true and the theme enables the dock then  blocks will be able
381      * to be moved to the special dock
382      */
383     public $enable_dock = false;
385     /**
386      * @var bool If set to true then this theme will not be shown in the theme selector unless
387      * theme designer mode is turned on.
388      */
389     public $hidefromselector = false;
391     /**
392      * @var array list of YUI CSS modules to be included on each page. This may be used
393      * to remove cssreset and use cssnormalise module instead.
394      */
395     public $yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase');
397     /**
398      * An associative array of block manipulations that should be made if the user is using an rtl language.
399      * The key is the original block region, and the value is the block region to change to.
400      * This is used when displaying blocks for regions only.
401      * @var array
402      */
403     public $blockrtlmanipulations = array();
405     /**
406      * @var renderer_factory Instance of the renderer_factory implementation
407      * we are using. Implementation detail.
408      */
409     protected $rf = null;
411     /**
412      * @var array List of parent config objects.
413      **/
414     protected $parent_configs = array();
416     /**
417      * Used to determine whether we can serve SVG images or not.
418      * @var bool
419      */
420     private $usesvg = null;
422     /**
423      * Whether in RTL mode or not.
424      * @var bool
425      */
426     protected $rtlmode = false;
428     /**
429      * The LESS file to compile. When set, the theme will attempt to compile the file itself.
430      * @var bool
431      */
432     public $lessfile = false;
434     /**
435      * The SCSS file to compile. This takes precedence over the LESS file.
436      * @var string
437      */
438     public $scssfile = false;
440     /**
441      * The name of the function to call to get the LESS code to inject.
442      * @var string
443      */
444     public $extralesscallback = null;
446     /**
447      * The name of the function to call to get the SCSS code to inject.
448      * @var string
449      */
450     public $extrascsscallback = null;
452     /**
453      * The name of the function to call to get extra LESS variables.
454      * @var string
455      */
456     public $lessvariablescallback = null;
458     /**
459      * The name of the function to call to get SCSS to prepend.
460      * @var string
461      */
462     public $prescsscallback = null;
464     /**
465      * Sets the render method that should be used for rendering custom block regions by scripts such as my/index.php
466      * Defaults to {@link core_renderer::blocks_for_region()}
467      * @var string
468      */
469     public $blockrendermethod = null;
471     /**
472      * Load the config.php file for a particular theme, and return an instance
473      * of this class. (That is, this is a factory method.)
474      *
475      * @param string $themename the name of the theme.
476      * @return theme_config an instance of this class.
477      */
478     public static function load($themename) {
479         global $CFG;
481         // load theme settings from db
482         try {
483             $settings = get_config('theme_'.$themename);
484         } catch (dml_exception $e) {
485             // most probably moodle tables not created yet
486             $settings = new stdClass();
487         }
489         if ($config = theme_config::find_theme_config($themename, $settings)) {
490             return new theme_config($config);
492         } else if ($themename == theme_config::DEFAULT_THEME) {
493             throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
495         } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
496             return new theme_config($config);
498         } else {
499             // bad luck, the requested theme has some problems - admin see details in theme config
500             return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
501         }
502     }
504     /**
505      * Theme diagnostic code. It is very problematic to send debug output
506      * to the actual CSS file, instead this functions is supposed to
507      * diagnose given theme and highlights all potential problems.
508      * This information should be available from the theme selection page
509      * or some other debug page for theme designers.
510      *
511      * @param string $themename
512      * @return array description of problems
513      */
514     public static function diagnose($themename) {
515         //TODO: MDL-21108
516         return array();
517     }
519     /**
520      * Private constructor, can be called only from the factory method.
521      * @param stdClass $config
522      */
523     private function __construct($config) {
524         global $CFG; //needed for included lib.php files
526         $this->settings = $config->settings;
527         $this->name     = $config->name;
528         $this->dir      = $config->dir;
530         if ($this->name != 'bootstrapbase') {
531             $baseconfig = theme_config::find_theme_config('bootstrapbase', $this->settings);
532         } else {
533             $baseconfig = $config;
534         }
536         $configurable = array(
537             'parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets',
538             'javascripts', 'javascripts_footer', 'parents_exclude_javascripts',
539             'layouts', 'enable_dock', 'enablecourseajax', 'undeletableblocktypes',
540             'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'uarrow', 'darrow',
541             'hidefromselector', 'doctype', 'yuicssmodules', 'blockrtlmanipulations',
542             'lessfile', 'extralesscallback', 'lessvariablescallback', 'blockrendermethod',
543             'scssfile', 'extrascsscallback', 'prescsscallback', 'csstreepostprocessor');
545         foreach ($config as $key=>$value) {
546             if (in_array($key, $configurable)) {
547                 $this->$key = $value;
548             }
549         }
551         // verify all parents and load configs and renderers
552         foreach ($this->parents as $parent) {
553             if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
554                 // this is not good - better exclude faulty parents
555                 continue;
556             }
557             $libfile = $parent_config->dir.'/lib.php';
558             if (is_readable($libfile)) {
559                 // theme may store various function here
560                 include_once($libfile);
561             }
562             $renderersfile = $parent_config->dir.'/renderers.php';
563             if (is_readable($renderersfile)) {
564                 // may contain core and plugin renderers and renderer factory
565                 include_once($renderersfile);
566             }
567             $this->parent_configs[$parent] = $parent_config;
568         }
569         $libfile = $this->dir.'/lib.php';
570         if (is_readable($libfile)) {
571             // theme may store various function here
572             include_once($libfile);
573         }
574         $rendererfile = $this->dir.'/renderers.php';
575         if (is_readable($rendererfile)) {
576             // may contain core and plugin renderers and renderer factory
577             include_once($rendererfile);
578         } else {
579             // check if renderers.php file is missnamed renderer.php
580             if (is_readable($this->dir.'/renderer.php')) {
581                 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
582                     See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
583             }
584         }
586         // cascade all layouts properly
587         foreach ($baseconfig->layouts as $layout=>$value) {
588             if (!isset($this->layouts[$layout])) {
589                 foreach ($this->parent_configs as $parent_config) {
590                     if (isset($parent_config->layouts[$layout])) {
591                         $this->layouts[$layout] = $parent_config->layouts[$layout];
592                         continue 2;
593                     }
594                 }
595                 $this->layouts[$layout] = $value;
596             }
597         }
599         //fix arrows if needed
600         $this->check_theme_arrows();
601     }
603     /**
604      * Let the theme initialise the page object (usually $PAGE).
605      *
606      * This may be used for example to request jQuery in add-ons.
607      *
608      * @param moodle_page $page
609      */
610     public function init_page(moodle_page $page) {
611         $themeinitfunction = 'theme_'.$this->name.'_page_init';
612         if (function_exists($themeinitfunction)) {
613             $themeinitfunction($page);
614         }
615     }
617     /**
618      * Checks if arrows $THEME->rarrow, $THEME->larrow, $THEME->uarrow, $THEME->darrow have been set (theme/-/config.php).
619      * If not it applies sensible defaults.
620      *
621      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
622      * search forum block, etc. Important: these are 'silent' in a screen-reader
623      * (unlike &gt; &raquo;), and must be accompanied by text.
624      */
625     private function check_theme_arrows() {
626         if (!isset($this->rarrow) and !isset($this->larrow)) {
627             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
628             // Also OK in Win 9x/2K/IE 5.x
629             $this->rarrow = '&#x25BA;';
630             $this->larrow = '&#x25C4;';
631             $this->uarrow = '&#x25B2;';
632             $this->darrow = '&#x25BC;';
633             if (empty($_SERVER['HTTP_USER_AGENT'])) {
634                 $uagent = '';
635             } else {
636                 $uagent = $_SERVER['HTTP_USER_AGENT'];
637             }
638             if (false !== strpos($uagent, 'Opera')
639                 || false !== strpos($uagent, 'Mac')) {
640                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
641                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
642                 $this->rarrow = '&#x25B6;&#xFE0E;';
643                 $this->larrow = '&#x25C0;&#xFE0E;';
644             }
645             elseif ((false !== strpos($uagent, 'Konqueror'))
646                 || (false !== strpos($uagent, 'Android')))  {
647                 // The fonts on Android don't include the characters required for this to work as expected.
648                 // So we use the same ones Konqueror uses.
649                 $this->rarrow = '&rarr;';
650                 $this->larrow = '&larr;';
651                 $this->uarrow = '&uarr;';
652                 $this->darrow = '&darr;';
653             }
654             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
655                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
656                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
657                 // To be safe, non-Unicode browsers!
658                 $this->rarrow = '&gt;';
659                 $this->larrow = '&lt;';
660                 $this->uarrow = '^';
661                 $this->darrow = 'v';
662             }
664             // RTL support - in RTL languages, swap r and l arrows
665             if (right_to_left()) {
666                 $t = $this->rarrow;
667                 $this->rarrow = $this->larrow;
668                 $this->larrow = $t;
669             }
670         }
671     }
673     /**
674      * Returns output renderer prefixes, these are used when looking
675      * for the overridden renderers in themes.
676      *
677      * @return array
678      */
679     public function renderer_prefixes() {
680         global $CFG; // just in case the included files need it
682         $prefixes = array('theme_'.$this->name);
684         foreach ($this->parent_configs as $parent) {
685             $prefixes[] = 'theme_'.$parent->name;
686         }
688         return $prefixes;
689     }
691     /**
692      * Returns the stylesheet URL of this editor content
693      *
694      * @param bool $encoded false means use & and true use &amp; in URLs
695      * @return moodle_url
696      */
697     public function editor_css_url($encoded=true) {
698         global $CFG;
699         $rev = theme_get_revision();
700         if ($rev > -1) {
701             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
702             if (!empty($CFG->slasharguments)) {
703                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
704             } else {
705                 $url->params(array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor'));
706             }
707         } else {
708             $params = array('theme'=>$this->name, 'type'=>'editor');
709             $url = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
710         }
711         return $url;
712     }
714     /**
715      * Returns the content of the CSS to be used in editor content
716      *
717      * @return array
718      */
719     public function editor_css_files() {
720         $files = array();
722         // First editor plugins.
723         $plugins = core_component::get_plugin_list('editor');
724         foreach ($plugins as $plugin=>$fulldir) {
725             $sheetfile = "$fulldir/editor_styles.css";
726             if (is_readable($sheetfile)) {
727                 $files['plugin_'.$plugin] = $sheetfile;
728             }
729         }
730         // Then parent themes - base first, the immediate parent last.
731         foreach (array_reverse($this->parent_configs) as $parent_config) {
732             if (empty($parent_config->editor_sheets)) {
733                 continue;
734             }
735             foreach ($parent_config->editor_sheets as $sheet) {
736                 $sheetfile = "$parent_config->dir/style/$sheet.css";
737                 if (is_readable($sheetfile)) {
738                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
739                 }
740             }
741         }
742         // Finally this theme.
743         if (!empty($this->editor_sheets)) {
744             foreach ($this->editor_sheets as $sheet) {
745                 $sheetfile = "$this->dir/style/$sheet.css";
746                 if (is_readable($sheetfile)) {
747                     $files['theme_'.$sheet] = $sheetfile;
748                 }
749             }
750         }
752         return $files;
753     }
755     /**
756      * Get the stylesheet URL of this theme.
757      *
758      * @param moodle_page $page Not used... deprecated?
759      * @return moodle_url[]
760      */
761     public function css_urls(moodle_page $page) {
762         global $CFG;
764         $rev = theme_get_revision();
766         $urls = array();
768         $svg = $this->use_svg_icons();
769         $separate = (core_useragent::is_ie() && !core_useragent::check_ie_version('10'));
771         if ($rev > -1) {
772             $filename = right_to_left() ? 'all-rtl' : 'all';
773             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
774             if (!empty($CFG->slasharguments)) {
775                 $slashargs = '';
776                 if (!$svg) {
777                     // We add a simple /_s to the start of the path.
778                     // The underscore is used to ensure that it isn't a valid theme name.
779                     $slashargs .= '/_s'.$slashargs;
780                 }
781                 $slashargs .= '/'.$this->name.'/'.$rev.'/'.$filename;
782                 if ($separate) {
783                     $slashargs .= '/chunk0';
784                 }
785                 $url->set_slashargument($slashargs, 'noparam', true);
786             } else {
787                 $params = array('theme' => $this->name, 'rev' => $rev, 'type' => $filename);
788                 if (!$svg) {
789                     // We add an SVG param so that we know not to serve SVG images.
790                     // We do this because all modern browsers support SVG and this param will one day be removed.
791                     $params['svg'] = '0';
792                 }
793                 if ($separate) {
794                     $params['chunk'] = '0';
795                 }
796                 $url->params($params);
797             }
798             $urls[] = $url;
800         } else {
801             $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
803             $css = $this->get_css_files(true);
804             if (!$svg) {
805                 // We add an SVG param so that we know not to serve SVG images.
806                 // We do this because all modern browsers support SVG and this param will one day be removed.
807                 $baseurl->param('svg', '0');
808             }
809             if (right_to_left()) {
810                 $baseurl->param('rtl', 1);
811             }
812             if ($separate) {
813                 // We might need to chunk long files.
814                 $baseurl->param('chunk', '0');
815             }
816             if (core_useragent::is_ie()) {
817                 // Lalala, IE does not allow more than 31 linked CSS files from main document.
818                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
819                 foreach ($css['parents'] as $parent=>$sheets) {
820                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096).
821                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
822                 }
823                 if (!empty($this->scssfile)) {
824                     // No need to define the type as IE here.
825                     $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
826                 } else if (!empty($this->lessfile)) {
827                     // No need to define the type as IE here.
828                     $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
829                 }
830                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
832             } else {
833                 foreach ($css['plugins'] as $plugin=>$unused) {
834                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
835                 }
836                 foreach ($css['parents'] as $parent=>$sheets) {
837                     foreach ($sheets as $sheet=>$unused2) {
838                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
839                     }
840                 }
841                 foreach ($css['theme'] as $sheet => $filename) {
842                     if ($sheet === $this->scssfile) {
843                         // This is the theme SCSS file.
844                         $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
845                     } else if ($sheet === $this->lessfile) {
846                         // This is the theme LESS file.
847                         $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
848                     } else {
849                         // Sheet first in order to make long urls easier to read.
850                         $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme'));
851                     }
852                 }
853             }
854         }
856         return $urls;
857     }
859     /**
860      * Get the whole css stylesheet for production mode.
861      *
862      * NOTE: this method is not expected to be used from any addons.
863      *
864      * @return string CSS markup compressed
865      */
866     public function get_css_content() {
868         $csscontent = '';
869         foreach ($this->get_css_files(false) as $type => $value) {
870             foreach ($value as $identifier => $val) {
871                 if (is_array($val)) {
872                     foreach ($val as $v) {
873                         $csscontent .= file_get_contents($v) . "\n";
874                     }
875                 } else {
876                     if ($type === 'theme' && $identifier === $this->scssfile) {
877                         // We need the content from SCSS because this is the SCSS file from the theme.
878                         $csscontent .= $this->get_css_content_from_scss(false);
879                     } else if ($type === 'theme' && $identifier === $this->lessfile) {
880                         // We need the content from LESS because this is the LESS file from the theme.
881                         $csscontent .= $this->get_css_content_from_less(false);
882                     } else {
883                         $csscontent .= file_get_contents($val) . "\n";
884                     }
885                 }
886             }
887         }
888         $csscontent = $this->post_process($csscontent);
889         $csscontent = core_minify::css($csscontent);
891         return $csscontent;
892     }
894     /**
895      * Get the theme designer css markup,
896      * the parameters are coming from css_urls().
897      *
898      * NOTE: this method is not expected to be used from any addons.
899      *
900      * @param string $type
901      * @param string $subtype
902      * @param string $sheet
903      * @return string CSS markup
904      */
905     public function get_css_content_debug($type, $subtype, $sheet) {
907         if ($type === 'scss') {
908             // The SCSS file of the theme is requested.
909             $csscontent = $this->get_css_content_from_scss(true);
910             if ($csscontent !== false) {
911                 return $this->post_process($csscontent);
912             }
913             return '';
914         } else if ($type === 'less') {
915             // The LESS file of the theme is requested.
916             $csscontent = $this->get_css_content_from_less(true);
917             if ($csscontent !== false) {
918                 return $this->post_process($csscontent);
919             }
920             return '';
921         }
923         $cssfiles = array();
924         $css = $this->get_css_files(true);
926         if ($type === 'ie') {
927             // IE is a sloppy browser with weird limits, sorry.
928             if ($subtype === 'plugins') {
929                 $cssfiles = $css['plugins'];
931             } else if ($subtype === 'parents') {
932                 if (empty($sheet)) {
933                     // Do not bother with the empty parent here.
934                 } else {
935                     // Build up the CSS for that parent so we can serve it as one file.
936                     foreach ($css[$subtype][$sheet] as $parent => $css) {
937                         $cssfiles[] = $css;
938                     }
939                 }
940             } else if ($subtype === 'theme') {
941                 $cssfiles = $css['theme'];
942                 foreach ($cssfiles as $key => $value) {
943                     if (in_array($key, [$this->lessfile, $this->scssfile])) {
944                         // Remove the LESS/SCSS file from the theme CSS files.
945                         // The LESS/SCSS files use the type 'less' or 'scss', not 'ie'.
946                         unset($cssfiles[$key]);
947                     }
948                 }
949             }
951         } else if ($type === 'plugin') {
952             if (isset($css['plugins'][$subtype])) {
953                 $cssfiles[] = $css['plugins'][$subtype];
954             }
956         } else if ($type === 'parent') {
957             if (isset($css['parents'][$subtype][$sheet])) {
958                 $cssfiles[] = $css['parents'][$subtype][$sheet];
959             }
961         } else if ($type === 'theme') {
962             if (isset($css['theme'][$sheet])) {
963                 $cssfiles[] = $css['theme'][$sheet];
964             }
965         }
967         $csscontent = '';
968         foreach ($cssfiles as $file) {
969             $contents = file_get_contents($file);
970             $contents = $this->post_process($contents);
971             $comment = "/** Path: $type $subtype $sheet.' **/\n";
972             $stats = '';
973             $csscontent .= $comment.$stats.$contents."\n\n";
974         }
976         return $csscontent;
977     }
979     /**
980      * Get the whole css stylesheet for editor iframe.
981      *
982      * NOTE: this method is not expected to be used from any addons.
983      *
984      * @return string CSS markup
985      */
986     public function get_css_content_editor() {
987         // Do not bother to optimise anything here, just very basic stuff.
988         $cssfiles = $this->editor_css_files();
989         $css = '';
990         foreach ($cssfiles as $file) {
991             $css .= file_get_contents($file)."\n";
992         }
993         return $this->post_process($css);
994     }
996     /**
997      * Returns an array of organised CSS files required for this output.
998      *
999      * @param bool $themedesigner
1000      * @return array nested array of file paths
1001      */
1002     protected function get_css_files($themedesigner) {
1003         global $CFG;
1005         $cache = null;
1006         $cachekey = 'cssfiles';
1007         if ($themedesigner) {
1008             require_once($CFG->dirroot.'/lib/csslib.php');
1009             // We need some kind of caching here because otherwise the page navigation becomes
1010             // way too slow in theme designer mode. Feel free to create full cache definition later...
1011             $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner', array('theme' => $this->name));
1012             if ($files = $cache->get($cachekey)) {
1013                 if ($files['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME) {
1014                     unset($files['created']);
1015                     return $files;
1016                 }
1017             }
1018         }
1020         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
1022         // Get all plugin sheets.
1023         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
1024         if ($excludes !== true) {
1025             foreach (core_component::get_plugin_types() as $type=>$unused) {
1026                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
1027                     continue;
1028                 }
1029                 $plugins = core_component::get_plugin_list($type);
1030                 foreach ($plugins as $plugin=>$fulldir) {
1031                     if (!empty($excludes[$type]) and is_array($excludes[$type])
1032                             and in_array($plugin, $excludes[$type])) {
1033                         continue;
1034                     }
1036                     // Get the CSS from the plugin.
1037                     $sheetfile = "$fulldir/styles.css";
1038                     if (is_readable($sheetfile)) {
1039                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
1040                     }
1042                     // Create a list of candidate sheets from parents (direct parent last) and current theme.
1043                     $candidates = array();
1044                     foreach (array_reverse($this->parent_configs) as $parent_config) {
1045                         $candidates[] = $parent_config->name;
1046                     }
1047                     $candidates[] = $this->name;
1049                     // Add the sheets found.
1050                     foreach ($candidates as $candidate) {
1051                         $sheetthemefile = "$fulldir/styles_{$candidate}.css";
1052                         if (is_readable($sheetthemefile)) {
1053                             $cssfiles['plugins'][$type.'_'.$plugin.'_'.$candidate] = $sheetthemefile;
1054                         }
1055                     }
1056                 }
1057             }
1058         }
1060         // Find out wanted parent sheets.
1061         $excludes = $this->resolve_excludes('parents_exclude_sheets');
1062         if ($excludes !== true) {
1063             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1064                 $parent = $parent_config->name;
1065                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
1066                     continue;
1067                 }
1068                 foreach ($parent_config->sheets as $sheet) {
1069                     if (!empty($excludes[$parent]) && is_array($excludes[$parent])
1070                             && in_array($sheet, $excludes[$parent])) {
1071                         continue;
1072                     }
1074                     // We never refer to the parent LESS files.
1075                     $sheetfile = "$parent_config->dir/style/$sheet.css";
1076                     if (is_readable($sheetfile)) {
1077                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
1078                     }
1079                 }
1080             }
1081         }
1083         // Current theme sheets and less file.
1084         // We first add the SCSS, or LESS file because we want the CSS ones to
1085         // be included after the SCSS/LESS code. However, if both the SCSS/LESS file
1086         // and a CSS file share the same name, the CSS file is ignored.
1087         if (!empty($this->scssfile)) {
1088             $sheetfile = "{$this->dir}/scss/{$this->scssfile}.scss";
1089             if (is_readable($sheetfile)) {
1090                 $cssfiles['theme'][$this->scssfile] = $sheetfile;
1091             }
1092         } else if (!empty($this->lessfile)) {
1093             $sheetfile = "{$this->dir}/less/{$this->lessfile}.less";
1094             if (is_readable($sheetfile)) {
1095                 $cssfiles['theme'][$this->lessfile] = $sheetfile;
1096             }
1097         }
1098         if (is_array($this->sheets)) {
1099             foreach ($this->sheets as $sheet) {
1100                 $sheetfile = "$this->dir/style/$sheet.css";
1101                 if (is_readable($sheetfile) && !isset($cssfiles['theme'][$sheet])) {
1102                     $cssfiles['theme'][$sheet] = $sheetfile;
1103                 }
1104             }
1105         }
1107         if ($cache) {
1108             $files = $cssfiles;
1109             $files['created'] = time();
1110             $cache->set($cachekey, $files);
1111         }
1112         return $cssfiles;
1113     }
1115     /**
1116      * Return the CSS content generated from LESS the file.
1117      *
1118      * @param bool $themedesigner True if theme designer is enabled.
1119      * @return bool|string Return false when the compilation failed. Else the compiled string.
1120      */
1121     protected function get_css_content_from_less($themedesigner) {
1122         global $CFG;
1124         $lessfile = $this->lessfile;
1125         if (!$lessfile || !is_readable($this->dir . '/less/' . $lessfile . '.less')) {
1126             throw new coding_exception('The theme did not define a LESS file, or it is not readable.');
1127         }
1129         // We might need more memory to do this, so let's play safe.
1130         raise_memory_limit(MEMORY_EXTRA);
1132         // Files list.
1133         $files = $this->get_css_files($themedesigner);
1135         // Get the LESS file path.
1136         $themelessfile = $files['theme'][$lessfile];
1138         // Setup compiler options.
1139         $options = array(
1140             // We need to set the import directory to where $lessfile is.
1141             'import_dirs' => array(dirname($themelessfile) => '/'),
1142             // Always disable default caching.
1143             'cache_method' => false,
1144             // Disable the relative URLs, we have post_process() to handle that.
1145             'relativeUrls' => false,
1146         );
1148         if ($themedesigner) {
1149             // Add the sourceMap inline to ensure that it is atomically generated.
1150             $options['sourceMap'] = true;
1151             $options['sourceMapBasepath'] = $CFG->dirroot;
1152             $options['sourceMapRootpath'] = $CFG->wwwroot;
1153         }
1155         // Instantiate the compiler.
1156         $compiler = new core_lessc($options);
1158         try {
1159             $compiler->parse_file_content($themelessfile);
1161             // Get the callbacks.
1162             $compiler->parse($this->get_extra_less_code());
1163             $compiler->ModifyVars($this->get_less_variables());
1165             // Compile the CSS.
1166             $compiled = $compiler->getCss();
1168         } catch (Less_Exception_Parser $e) {
1169             $compiled = false;
1170             debugging('Error while compiling LESS ' . $lessfile . ' file: ' . $e->getMessage(), DEBUG_DEVELOPER);
1171         }
1173         // Try to save memory.
1174         $compiler = null;
1175         unset($compiler);
1177         return $compiled;
1178     }
1180     /**
1181      * Return the CSS content generated from the SCSS file.
1182      *
1183      * @param bool $themedesigner True if theme designer is enabled.
1184      * @return bool|string Return false when the compilation failed. Else the compiled string.
1185      */
1186     protected function get_css_content_from_scss($themedesigner) {
1187         global $CFG;
1189         $scssfile = $this->scssfile;
1190         if (!$scssfile || !is_readable($this->dir . '/scss/' . $scssfile . '.scss')) {
1191             throw new coding_exception('The theme did not define a SCSS file, or it is not readable.');
1192         }
1194         // We might need more memory to do this, so let's play safe.
1195         raise_memory_limit(MEMORY_EXTRA);
1197         // Files list.
1198         $files = $this->get_css_files($themedesigner);
1200         // Get the SCSS file path.
1201         $themescssfile = $files['theme'][$scssfile];
1203         // Set-up the compiler.
1204         $compiler = new core_scss();
1205         $compiler->prepend_raw_scss($this->get_pre_scss_code());
1206         $compiler->set_file($themescssfile);
1207         $compiler->append_raw_scss($this->get_extra_scss_code());
1209         try {
1210             // Compile!
1211             $compiled = $compiler->to_css();
1213         } catch (\Leafo\ScssPhp\Exception $e) {
1214             $compiled = false;
1215             debugging('Error while compiling SCSS ' . $scssfile . ' file: ' . $e->getMessage(), DEBUG_DEVELOPER);
1216         }
1218         // Try to save memory.
1219         $compiler = null;
1220         unset($compiler);
1222         return $compiled;
1223     }
1225     /**
1226      * Return extra LESS variables to use when compiling.
1227      *
1228      * @return array Where keys are the variable names (omitting the @), and the values are the value.
1229      */
1230     protected function get_less_variables() {
1231         $variables = array();
1233         // Getting all the candidate functions.
1234         $candidates = array();
1235         foreach ($this->parent_configs as $parent_config) {
1236             if (!isset($parent_config->lessvariablescallback)) {
1237                 continue;
1238             }
1239             $candidates[] = $parent_config->lessvariablescallback;
1240         }
1241         $candidates[] = $this->lessvariablescallback;
1243         // Calling the functions.
1244         foreach ($candidates as $function) {
1245             if (function_exists($function)) {
1246                 $vars = $function($this);
1247                 if (!is_array($vars)) {
1248                     debugging('Callback ' . $function . ' did not return an array() as expected', DEBUG_DEVELOPER);
1249                     continue;
1250                 }
1251                 $variables = array_merge($variables, $vars);
1252             }
1253         }
1255         return $variables;
1256     }
1258     /**
1259      * Return extra LESS code to add when compiling.
1260      *
1261      * This is intended to be used by themes to inject some LESS code
1262      * before it gets compiled. If you want to inject variables you
1263      * should use {@link self::get_less_variables()}.
1264      *
1265      * @return string The LESS code to inject.
1266      */
1267     protected function get_extra_less_code() {
1268         $content = '';
1270         // Getting all the candidate functions.
1271         $candidates = array();
1272         foreach ($this->parent_configs as $parent_config) {
1273             if (!isset($parent_config->extralesscallback)) {
1274                 continue;
1275             }
1276             $candidates[] = $parent_config->extralesscallback;
1277         }
1278         $candidates[] = $this->extralesscallback;
1280         // Calling the functions.
1281         foreach ($candidates as $function) {
1282             if (function_exists($function)) {
1283                 $content .= "\n/** Extra LESS from $function **/\n" . $function($this) . "\n";
1284             }
1285         }
1287         return $content;
1288     }
1290     /**
1291      * Return extra SCSS code to add when compiling.
1292      *
1293      * This is intended to be used by themes to inject some SCSS code
1294      * before it gets compiled. If you want to inject variables you
1295      * should use {@link self::get_scss_variables()}.
1296      *
1297      * @return string The SCSS code to inject.
1298      */
1299     protected function get_extra_scss_code() {
1300         $content = '';
1302         // Getting all the candidate functions.
1303         $candidates = array();
1304         foreach ($this->parent_configs as $parent_config) {
1305             if (!isset($parent_config->extrascsscallback)) {
1306                 continue;
1307             }
1308             $candidates[] = $parent_config->extrascsscallback;
1309         }
1310         $candidates[] = $this->extrascsscallback;
1312         // Calling the functions.
1313         foreach ($candidates as $function) {
1314             if (function_exists($function)) {
1315                 $content .= "\n/** Extra SCSS from $function **/\n" . $function($this) . "\n";
1316             }
1317         }
1319         return $content;
1320     }
1322     /**
1323      * SCSS code to prepend when compiling.
1324      *
1325      * This is intended to be used by themes to inject SCSS code before it gets compiled.
1326      *
1327      * @return string The SCSS code to inject.
1328      */
1329     protected function get_pre_scss_code() {
1330         $content = '';
1332         // Getting all the candidate functions.
1333         $candidates = array();
1334         foreach ($this->parent_configs as $parent_config) {
1335             if (!isset($parent_config->prescsscallback)) {
1336                 continue;
1337             }
1338             $candidates[] = $parent_config->prescsscallback;
1339         }
1340         $candidates[] = $this->prescsscallback;
1342         // Calling the functions.
1343         foreach ($candidates as $function) {
1344             if (function_exists($function)) {
1345                 $content .= "\n/** Pre-SCSS from $function **/\n" . $function($this) . "\n";
1346             }
1347         }
1349         return $content;
1350     }
1352     /**
1353      * Generate a URL to the file that serves theme JavaScript files.
1354      *
1355      * If we determine that the theme has no relevant files, then we return
1356      * early with a null value.
1357      *
1358      * @param bool $inhead true means head url, false means footer
1359      * @return moodle_url|null
1360      */
1361     public function javascript_url($inhead) {
1362         global $CFG;
1364         $rev = theme_get_revision();
1365         $params = array('theme'=>$this->name,'rev'=>$rev);
1366         $params['type'] = $inhead ? 'head' : 'footer';
1368         // Return early if there are no files to serve
1369         if (count($this->javascript_files($params['type'])) === 0) {
1370             return null;
1371         }
1373         if (!empty($CFG->slasharguments) and $rev > 0) {
1374             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
1375             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
1376             return $url;
1377         } else {
1378             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
1379         }
1380     }
1382     /**
1383      * Get the URL's for the JavaScript files used by this theme.
1384      * They won't be served directly, instead they'll be mediated through
1385      * theme/javascript.php.
1386      *
1387      * @param string $type Either javascripts_footer, or javascripts
1388      * @return array
1389      */
1390     public function javascript_files($type) {
1391         if ($type === 'footer') {
1392             $type = 'javascripts_footer';
1393         } else {
1394             $type = 'javascripts';
1395         }
1397         $js = array();
1398         // find out wanted parent javascripts
1399         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
1400         if ($excludes !== true) {
1401             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1402                 $parent = $parent_config->name;
1403                 if (empty($parent_config->$type)) {
1404                     continue;
1405                 }
1406                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
1407                     continue;
1408                 }
1409                 foreach ($parent_config->$type as $javascript) {
1410                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
1411                         and in_array($javascript, $excludes[$parent])) {
1412                         continue;
1413                     }
1414                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
1415                     if (is_readable($javascriptfile)) {
1416                         $js[] = $javascriptfile;
1417                     }
1418                 }
1419             }
1420         }
1422         // current theme javascripts
1423         if (is_array($this->$type)) {
1424             foreach ($this->$type as $javascript) {
1425                 $javascriptfile = "$this->dir/javascript/$javascript.js";
1426                 if (is_readable($javascriptfile)) {
1427                     $js[] = $javascriptfile;
1428                 }
1429             }
1430         }
1431         return $js;
1432     }
1434     /**
1435      * Resolves an exclude setting to the themes setting is applicable or the
1436      * setting of its closest parent.
1437      *
1438      * @param string $variable The name of the setting the exclude setting to resolve
1439      * @param string $default
1440      * @return mixed
1441      */
1442     protected function resolve_excludes($variable, $default = null) {
1443         $setting = $default;
1444         if (is_array($this->{$variable}) or $this->{$variable} === true) {
1445             $setting = $this->{$variable};
1446         } else {
1447             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
1448                 if (!isset($parent_config->{$variable})) {
1449                     continue;
1450                 }
1451                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
1452                     $setting = $parent_config->{$variable};
1453                     break;
1454                 }
1455             }
1456         }
1457         return $setting;
1458     }
1460     /**
1461      * Returns the content of the one huge javascript file merged from all theme javascript files.
1462      *
1463      * @param bool $type
1464      * @return string
1465      */
1466     public function javascript_content($type) {
1467         $jsfiles = $this->javascript_files($type);
1468         $js = '';
1469         foreach ($jsfiles as $jsfile) {
1470             $js .= file_get_contents($jsfile)."\n";
1471         }
1472         return $js;
1473     }
1475     /**
1476      * Post processes CSS.
1477      *
1478      * This method post processes all of the CSS before it is served for this theme.
1479      * This is done so that things such as image URL's can be swapped in and to
1480      * run any specific CSS post process method the theme has requested.
1481      * This allows themes to use CSS settings.
1482      *
1483      * @param string $css The CSS to process.
1484      * @return string The processed CSS.
1485      */
1486     public function post_process($css) {
1487         // now resolve all image locations
1488         if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1489             $replaced = array();
1490             foreach ($matches as $match) {
1491                 if (isset($replaced[$match[0]])) {
1492                     continue;
1493                 }
1494                 $replaced[$match[0]] = true;
1495                 $imagename = $match[2];
1496                 $component = rtrim($match[1], '|');
1497                 $imageurl = $this->pix_url($imagename, $component)->out(false);
1498                  // we do not need full url because the image.php is always in the same dir
1499                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
1500                 $css = str_replace($match[0], $imageurl, $css);
1501             }
1502         }
1504         // Now resolve all font locations.
1505         if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1506             $replaced = array();
1507             foreach ($matches as $match) {
1508                 if (isset($replaced[$match[0]])) {
1509                     continue;
1510                 }
1511                 $replaced[$match[0]] = true;
1512                 $fontname = $match[2];
1513                 $component = rtrim($match[1], '|');
1514                 $fonturl = $this->font_url($fontname, $component)->out(false);
1515                 // We do not need full url because the font.php is always in the same dir.
1516                 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1517                 $css = str_replace($match[0], $fonturl, $css);
1518             }
1519         }
1521         // Post processing using an object representation of CSS.
1522         $hastreeprocessor = !empty($this->csstreepostprocessor) && function_exists($this->csstreepostprocessor);
1523         $needsparsing = $hastreeprocessor || !empty($this->rtlmode);
1524         if ($needsparsing) {
1525             $parser = new core_cssparser($css);
1526             $csstree = $parser->parse();
1527             unset($parser);
1529             if ($this->rtlmode) {
1530                 $this->rtlize($csstree);
1531             }
1533             if ($hastreeprocessor) {
1534                 $fn = $this->csstreepostprocessor;
1535                 $fn($csstree, $this);
1536             }
1538             $css = $csstree->render();
1539             unset($csstree);
1540         }
1542         // now resolve all theme settings or do any other postprocessing
1543         $csspostprocess = $this->csspostprocess;
1544         if (function_exists($csspostprocess)) {
1545             $css = $csspostprocess($css, $this);
1546         }
1548         return $css;
1549     }
1551     /**
1552      * Flip a stylesheet to RTL.
1553      *
1554      * @param Object $csstree The parsed CSS tree structure to flip.
1555      * @return void
1556      */
1557     protected function rtlize($csstree) {
1558         $rtlcss = new core_rtlcss($csstree);
1559         $rtlcss->flip();
1560     }
1562     /**
1563      * Return the URL for an image
1564      *
1565      * @param string $imagename the name of the icon.
1566      * @param string $component specification of one plugin like in get_string()
1567      * @return moodle_url
1568      */
1569     public function pix_url($imagename, $component) {
1570         global $CFG;
1572         $params = array('theme'=>$this->name);
1573         $svg = $this->use_svg_icons();
1575         if (empty($component) or $component === 'moodle' or $component === 'core') {
1576             $params['component'] = 'core';
1577         } else {
1578             $params['component'] = $component;
1579         }
1581         $rev = theme_get_revision();
1582         if ($rev != -1) {
1583             $params['rev'] = $rev;
1584         }
1586         $params['image'] = $imagename;
1588         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1589         if (!empty($CFG->slasharguments) and $rev > 0) {
1590             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1591             if (!$svg) {
1592                 // We add a simple /_s to the start of the path.
1593                 // The underscore is used to ensure that it isn't a valid theme name.
1594                 $path = '/_s'.$path;
1595             }
1596             $url->set_slashargument($path, 'noparam', true);
1597         } else {
1598             if (!$svg) {
1599                 // We add an SVG param so that we know not to serve SVG images.
1600                 // We do this because all modern browsers support SVG and this param will one day be removed.
1601                 $params['svg'] = '0';
1602             }
1603             $url->params($params);
1604         }
1606         return $url;
1607     }
1609     /**
1610      * Return the URL for a font
1611      *
1612      * @param string $font the name of the font (including extension).
1613      * @param string $component specification of one plugin like in get_string()
1614      * @return moodle_url
1615      */
1616     public function font_url($font, $component) {
1617         global $CFG;
1619         $params = array('theme'=>$this->name);
1621         if (empty($component) or $component === 'moodle' or $component === 'core') {
1622             $params['component'] = 'core';
1623         } else {
1624             $params['component'] = $component;
1625         }
1627         $rev = theme_get_revision();
1628         if ($rev != -1) {
1629             $params['rev'] = $rev;
1630         }
1632         $params['font'] = $font;
1634         $url = new moodle_url("$CFG->httpswwwroot/theme/font.php");
1635         if (!empty($CFG->slasharguments) and $rev > 0) {
1636             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
1637             $url->set_slashargument($path, 'noparam', true);
1638         } else {
1639             $url->params($params);
1640         }
1642         return $url;
1643     }
1645     /**
1646      * Returns URL to the stored file via pluginfile.php.
1647      *
1648      * Note the theme must also implement pluginfile.php handler,
1649      * theme revision is used instead of the itemid.
1650      *
1651      * @param string $setting
1652      * @param string $filearea
1653      * @return string protocol relative URL or null if not present
1654      */
1655     public function setting_file_url($setting, $filearea) {
1656         global $CFG;
1658         if (empty($this->settings->$setting)) {
1659             return null;
1660         }
1662         $component = 'theme_'.$this->name;
1663         $itemid = theme_get_revision();
1664         $filepath = $this->settings->$setting;
1665         $syscontext = context_system::instance();
1667         $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
1669         // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
1670         // Note: unfortunately moodle_url does not support //urls yet.
1672         $url = preg_replace('|^https?://|i', '//', $url->out(false));
1674         return $url;
1675     }
1677     /**
1678      * Serve the theme setting file.
1679      *
1680      * @param string $filearea
1681      * @param array $args
1682      * @param bool $forcedownload
1683      * @param array $options
1684      * @return bool may terminate if file not found or donotdie not specified
1685      */
1686     public function setting_file_serve($filearea, $args, $forcedownload, $options) {
1687         global $CFG;
1688         require_once("$CFG->libdir/filelib.php");
1690         $syscontext = context_system::instance();
1691         $component = 'theme_'.$this->name;
1693         $revision = array_shift($args);
1694         if ($revision < 0) {
1695             $lifetime = 0;
1696         } else {
1697             $lifetime = 60*60*24*60;
1698             // By default, theme files must be cache-able by both browsers and proxies.
1699             if (!array_key_exists('cacheability', $options)) {
1700                 $options['cacheability'] = 'public';
1701             }
1702         }
1704         $fs = get_file_storage();
1705         $relativepath = implode('/', $args);
1707         $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
1708         $fullpath = rtrim($fullpath, '/');
1709         if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
1710             send_stored_file($file, $lifetime, 0, $forcedownload, $options);
1711             return true;
1712         } else {
1713             send_file_not_found();
1714         }
1715     }
1717     /**
1718      * Resolves the real image location.
1719      *
1720      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1721      * and we need a way in which to turn it off.
1722      * By default SVG won't be used unless asked for. This is done for two reasons:
1723      *   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
1724      *      browser supports SVG.
1725      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1726      *      by the user due to security concerns.
1727      *
1728      * @param string $image name of image, may contain relative path
1729      * @param string $component
1730      * @param bool $svg If set to true SVG images will also be looked for.
1731      * @return string full file path
1732      */
1733     public function resolve_image_location($image, $component, $svg = false) {
1734         global $CFG;
1736         if (!is_bool($svg)) {
1737             // If $svg isn't a bool then we need to decide for ourselves.
1738             $svg = $this->use_svg_icons();
1739         }
1741         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1742             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1743                 return $imagefile;
1744             }
1745             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1746                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1747                     return $imagefile;
1748                 }
1749             }
1750             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1751                 return $imagefile;
1752             }
1753             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1754                 return $imagefile;
1755             }
1756             return null;
1758         } else if ($component === 'theme') { //exception
1759             if ($image === 'favicon') {
1760                 return "$this->dir/pix/favicon.ico";
1761             }
1762             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1763                 return $imagefile;
1764             }
1765             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1766                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1767                     return $imagefile;
1768                 }
1769             }
1770             return null;
1772         } else {
1773             if (strpos($component, '_') === false) {
1774                 $component = 'mod_'.$component;
1775             }
1776             list($type, $plugin) = explode('_', $component, 2);
1778             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1779                 return $imagefile;
1780             }
1781             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1782                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1783                     return $imagefile;
1784                 }
1785             }
1786             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1787                 return $imagefile;
1788             }
1789             $dir = core_component::get_plugin_directory($type, $plugin);
1790             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1791                 return $imagefile;
1792             }
1793             return null;
1794         }
1795     }
1797     /**
1798      * Resolves the real font location.
1799      *
1800      * @param string $font name of font file
1801      * @param string $component
1802      * @return string full file path
1803      */
1804     public function resolve_font_location($font, $component) {
1805         global $CFG;
1807         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1808             if (file_exists("$this->dir/fonts_core/$font")) {
1809                 return "$this->dir/fonts_core/$font";
1810             }
1811             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1812                 if (file_exists("$parent_config->dir/fonts_core/$font")) {
1813                     return "$parent_config->dir/fonts_core/$font";
1814                 }
1815             }
1816             if (file_exists("$CFG->dataroot/fonts/$font")) {
1817                 return "$CFG->dataroot/fonts/$font";
1818             }
1819             if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
1820                 return "$CFG->dirroot/lib/fonts/$font";
1821             }
1822             return null;
1824         } else if ($component === 'theme') { // Exception.
1825             if (file_exists("$this->dir/fonts/$font")) {
1826                 return "$this->dir/fonts/$font";
1827             }
1828             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1829                 if (file_exists("$parent_config->dir/fonts/$font")) {
1830                     return "$parent_config->dir/fonts/$font";
1831                 }
1832             }
1833             return null;
1835         } else {
1836             if (strpos($component, '_') === false) {
1837                 $component = 'mod_'.$component;
1838             }
1839             list($type, $plugin) = explode('_', $component, 2);
1841             if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
1842                 return "$this->dir/fonts_plugins/$type/$plugin/$font";
1843             }
1844             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1845                 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
1846                     return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
1847                 }
1848             }
1849             if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
1850                 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
1851             }
1852             $dir = core_component::get_plugin_directory($type, $plugin);
1853             if (file_exists("$dir/fonts/$font")) {
1854                 return "$dir/fonts/$font";
1855             }
1856             return null;
1857         }
1858     }
1860     /**
1861      * Return true if we should look for SVG images as well.
1862      *
1863      * @return bool
1864      */
1865     public function use_svg_icons() {
1866         global $CFG;
1867         if ($this->usesvg === null) {
1869             if (!isset($CFG->svgicons)) {
1870                 $this->usesvg = core_useragent::supports_svg();
1871             } else {
1872                 // Force them on/off depending upon the setting.
1873                 $this->usesvg = (bool)$CFG->svgicons;
1874             }
1875         }
1876         return $this->usesvg;
1877     }
1879     /**
1880      * Forces the usesvg setting to either true or false, avoiding any decision making.
1881      *
1882      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1883      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1884      *
1885      * @param bool $setting True to force the use of svg when available, null otherwise.
1886      */
1887     public function force_svg_use($setting) {
1888         $this->usesvg = (bool)$setting;
1889     }
1891     /**
1892      * Set to be in RTL mode.
1893      *
1894      * This will likely be used when post processing the CSS before serving it.
1895      *
1896      * @param bool $inrtl True when in RTL mode.
1897      */
1898     public function set_rtl_mode($inrtl = true) {
1899         $this->rtlmode = $inrtl;
1900     }
1902     /**
1903      * Checks if file with any image extension exists.
1904      *
1905      * The order to these images was adjusted prior to the release of 2.4
1906      * At that point the were the following image counts in Moodle core:
1907      *
1908      *     - png = 667 in pix dirs (1499 total)
1909      *     - gif = 385 in pix dirs (606 total)
1910      *     - jpg = 62  in pix dirs (74 total)
1911      *     - jpeg = 0  in pix dirs (1 total)
1912      *
1913      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1914      *
1915      * @param string $filepath
1916      * @param bool $svg If set to true SVG images will also be looked for.
1917      * @return string image name with extension
1918      */
1919     private static function image_exists($filepath, $svg = false) {
1920         if ($svg && file_exists("$filepath.svg")) {
1921             return "$filepath.svg";
1922         } else  if (file_exists("$filepath.png")) {
1923             return "$filepath.png";
1924         } else if (file_exists("$filepath.gif")) {
1925             return "$filepath.gif";
1926         } else  if (file_exists("$filepath.jpg")) {
1927             return "$filepath.jpg";
1928         } else  if (file_exists("$filepath.jpeg")) {
1929             return "$filepath.jpeg";
1930         } else {
1931             return false;
1932         }
1933     }
1935     /**
1936      * Loads the theme config from config.php file.
1937      *
1938      * @param string $themename
1939      * @param stdClass $settings from config_plugins table
1940      * @param boolean $parentscheck true to also check the parents.    .
1941      * @return stdClass The theme configuration
1942      */
1943     private static function find_theme_config($themename, $settings, $parentscheck = true) {
1944         // We have to use the variable name $THEME (upper case) because that
1945         // is what is used in theme config.php files.
1947         if (!$dir = theme_config::find_theme_location($themename)) {
1948             return null;
1949         }
1951         $THEME = new stdClass();
1952         $THEME->name     = $themename;
1953         $THEME->dir      = $dir;
1954         $THEME->settings = $settings;
1956         global $CFG; // just in case somebody tries to use $CFG in theme config
1957         include("$THEME->dir/config.php");
1959         // verify the theme configuration is OK
1960         if (!is_array($THEME->parents)) {
1961             // parents option is mandatory now
1962             return null;
1963         } else {
1964             // We use $parentscheck to only check the direct parents (avoid infinite loop).
1965             if ($parentscheck) {
1966                 // Find all parent theme configs.
1967                 foreach ($THEME->parents as $parent) {
1968                     $parentconfig = theme_config::find_theme_config($parent, $settings, false);
1969                     if (empty($parentconfig)) {
1970                         return null;
1971                     }
1972                 }
1973             }
1974         }
1976         return $THEME;
1977     }
1979     /**
1980      * Finds the theme location and verifies the theme has all needed files
1981      * and is not obsoleted.
1982      *
1983      * @param string $themename
1984      * @return string full dir path or null if not found
1985      */
1986     private static function find_theme_location($themename) {
1987         global $CFG;
1989         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1990             $dir = "$CFG->dirroot/theme/$themename";
1992         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1993             $dir = "$CFG->themedir/$themename";
1995         } else {
1996             return null;
1997         }
1999         if (file_exists("$dir/styles.php")) {
2000             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
2001             return null;
2002         }
2004         return $dir;
2005     }
2007     /**
2008      * Get the renderer for a part of Moodle for this theme.
2009      *
2010      * @param moodle_page $page the page we are rendering
2011      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
2012      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
2013      * @param string $target one of rendering target constants
2014      * @return renderer_base the requested renderer.
2015      */
2016     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
2017         if (is_null($this->rf)) {
2018             $classname = $this->rendererfactory;
2019             $this->rf = new $classname($this);
2020         }
2022         return $this->rf->get_renderer($page, $component, $subtype, $target);
2023     }
2025     /**
2026      * Get the information from {@link $layouts} for this type of page.
2027      *
2028      * @param string $pagelayout the the page layout name.
2029      * @return array the appropriate part of {@link $layouts}.
2030      */
2031     protected function layout_info_for_page($pagelayout) {
2032         if (array_key_exists($pagelayout, $this->layouts)) {
2033             return $this->layouts[$pagelayout];
2034         } else {
2035             debugging('Invalid page layout specified: ' . $pagelayout);
2036             return $this->layouts['standard'];
2037         }
2038     }
2040     /**
2041      * Given the settings of this theme, and the page pagelayout, return the
2042      * full path of the page layout file to use.
2043      *
2044      * Used by {@link core_renderer::header()}.
2045      *
2046      * @param string $pagelayout the the page layout name.
2047      * @return string Full path to the lyout file to use
2048      */
2049     public function layout_file($pagelayout) {
2050         global $CFG;
2052         $layoutinfo = $this->layout_info_for_page($pagelayout);
2053         $layoutfile = $layoutinfo['file'];
2055         if (array_key_exists('theme', $layoutinfo)) {
2056             $themes = array($layoutinfo['theme']);
2057         } else {
2058             $themes = array_merge(array($this->name),$this->parents);
2059         }
2061         foreach ($themes as $theme) {
2062             if ($dir = $this->find_theme_location($theme)) {
2063                 $path = "$dir/layout/$layoutfile";
2065                 // Check the template exists, return general base theme template if not.
2066                 if (is_readable($path)) {
2067                     return $path;
2068                 }
2069             }
2070         }
2072         debugging('Can not find layout file for: ' . $pagelayout);
2073         // fallback to standard normal layout
2074         return "$CFG->dirroot/theme/base/layout/general.php";
2075     }
2077     /**
2078      * Returns auxiliary page layout options specified in layout configuration array.
2079      *
2080      * @param string $pagelayout
2081      * @return array
2082      */
2083     public function pagelayout_options($pagelayout) {
2084         $info = $this->layout_info_for_page($pagelayout);
2085         if (!empty($info['options'])) {
2086             return $info['options'];
2087         }
2088         return array();
2089     }
2091     /**
2092      * Inform a block_manager about the block regions this theme wants on this
2093      * page layout.
2094      *
2095      * @param string $pagelayout the general type of the page.
2096      * @param block_manager $blockmanager the block_manger to set up.
2097      */
2098     public function setup_blocks($pagelayout, $blockmanager) {
2099         $layoutinfo = $this->layout_info_for_page($pagelayout);
2100         if (!empty($layoutinfo['regions'])) {
2101             $blockmanager->add_regions($layoutinfo['regions'], false);
2102             $blockmanager->set_default_region($layoutinfo['defaultregion']);
2103         }
2104     }
2106     /**
2107      * Gets the visible name for the requested block region.
2108      *
2109      * @param string $region The region name to get
2110      * @param string $theme The theme the region belongs to (may come from the parent theme)
2111      * @return string
2112      */
2113     protected function get_region_name($region, $theme) {
2114         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
2115         // A name exists in this theme, so use it
2116         if (substr($regionstring, 0, 1) != '[') {
2117             return $regionstring;
2118         }
2120         // Otherwise, try to find one elsewhere
2121         // Check parents, if any
2122         foreach ($this->parents as $parentthemename) {
2123             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
2124             if (substr($regionstring, 0, 1) != '[') {
2125                 return $regionstring;
2126             }
2127         }
2129         // Last resort, try the bootstrapbase theme for names
2130         return get_string('region-' . $region, 'theme_bootstrapbase');
2131     }
2133     /**
2134      * Get the list of all block regions known to this theme in all templates.
2135      *
2136      * @return array internal region name => human readable name.
2137      */
2138     public function get_all_block_regions() {
2139         $regions = array();
2140         foreach ($this->layouts as $layoutinfo) {
2141             foreach ($layoutinfo['regions'] as $region) {
2142                 $regions[$region] = $this->get_region_name($region, $this->name);
2143             }
2144         }
2145         return $regions;
2146     }
2148     /**
2149      * Returns the human readable name of the theme
2150      *
2151      * @return string
2152      */
2153     public function get_theme_name() {
2154         return get_string('pluginname', 'theme_'.$this->name);
2155     }
2157     /**
2158      * Returns the block render method.
2159      *
2160      * It is set by the theme via:
2161      *     $THEME->blockrendermethod = '...';
2162      *
2163      * It can be one of two values, blocks or blocks_for_region.
2164      * It should be set to the method being used by the theme layouts.
2165      *
2166      * @return string
2167      */
2168     public function get_block_render_method() {
2169         if ($this->blockrendermethod) {
2170             // Return the specified block render method.
2171             return $this->blockrendermethod;
2172         }
2173         // Its not explicitly set, check the parent theme configs.
2174         foreach ($this->parent_configs as $config) {
2175             if (isset($config->blockrendermethod)) {
2176                 return $config->blockrendermethod;
2177             }
2178         }
2179         // Default it to blocks.
2180         return 'blocks';
2181     }
2184 /**
2185  * This class keeps track of which HTML tags are currently open.
2186  *
2187  * This makes it much easier to always generate well formed XHTML output, even
2188  * if execution terminates abruptly. Any time you output some opening HTML
2189  * without the matching closing HTML, you should push the necessary close tags
2190  * onto the stack.
2191  *
2192  * @copyright 2009 Tim Hunt
2193  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2194  * @since Moodle 2.0
2195  * @package core
2196  * @category output
2197  */
2198 class xhtml_container_stack {
2200     /**
2201      * @var array Stores the list of open containers.
2202      */
2203     protected $opencontainers = array();
2205     /**
2206      * @var array In developer debug mode, stores a stack trace of all opens and
2207      * closes, so we can output helpful error messages when there is a mismatch.
2208      */
2209     protected $log = array();
2211     /**
2212      * @var boolean Store whether we are developer debug mode. We need this in
2213      * several places including in the destructor where we may not have access to $CFG.
2214      */
2215     protected $isdebugging;
2217     /**
2218      * Constructor
2219      */
2220     public function __construct() {
2221         global $CFG;
2222         $this->isdebugging = $CFG->debugdeveloper;
2223     }
2225     /**
2226      * Push the close HTML for a recently opened container onto the stack.
2227      *
2228      * @param string $type The type of container. This is checked when {@link pop()}
2229      *      is called and must match, otherwise a developer debug warning is output.
2230      * @param string $closehtml The HTML required to close the container.
2231      */
2232     public function push($type, $closehtml) {
2233         $container = new stdClass;
2234         $container->type = $type;
2235         $container->closehtml = $closehtml;
2236         if ($this->isdebugging) {
2237             $this->log('Open', $type);
2238         }
2239         array_push($this->opencontainers, $container);
2240     }
2242     /**
2243      * Pop the HTML for the next closing container from the stack. The $type
2244      * must match the type passed when the container was opened, otherwise a
2245      * warning will be output.
2246      *
2247      * @param string $type The type of container.
2248      * @return string the HTML required to close the container.
2249      */
2250     public function pop($type) {
2251         if (empty($this->opencontainers)) {
2252             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
2253                     $this->output_log(), DEBUG_DEVELOPER);
2254             return;
2255         }
2257         $container = array_pop($this->opencontainers);
2258         if ($container->type != $type) {
2259             debugging('<p>The type of container to be closed (' . $container->type .
2260                     ') does not match the type of the next open container (' . $type .
2261                     '). This suggests there is a nesting problem.</p>' .
2262                     $this->output_log(), DEBUG_DEVELOPER);
2263         }
2264         if ($this->isdebugging) {
2265             $this->log('Close', $type);
2266         }
2267         return $container->closehtml;
2268     }
2270     /**
2271      * Close all but the last open container. This is useful in places like error
2272      * handling, where you want to close all the open containers (apart from <body>)
2273      * before outputting the error message.
2274      *
2275      * @param bool $shouldbenone assert that the stack should be empty now - causes a
2276      *      developer debug warning if it isn't.
2277      * @return string the HTML required to close any open containers inside <body>.
2278      */
2279     public function pop_all_but_last($shouldbenone = false) {
2280         if ($shouldbenone && count($this->opencontainers) != 1) {
2281             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
2282                     $this->output_log(), DEBUG_DEVELOPER);
2283         }
2284         $output = '';
2285         while (count($this->opencontainers) > 1) {
2286             $container = array_pop($this->opencontainers);
2287             $output .= $container->closehtml;
2288         }
2289         return $output;
2290     }
2292     /**
2293      * You can call this function if you want to throw away an instance of this
2294      * class without properly emptying the stack (for example, in a unit test).
2295      * Calling this method stops the destruct method from outputting a developer
2296      * debug warning. After calling this method, the instance can no longer be used.
2297      */
2298     public function discard() {
2299         $this->opencontainers = null;
2300     }
2302     /**
2303      * Adds an entry to the log.
2304      *
2305      * @param string $action The name of the action
2306      * @param string $type The type of action
2307      */
2308     protected function log($action, $type) {
2309         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
2310                 format_backtrace(debug_backtrace()) . '</li>';
2311     }
2313     /**
2314      * Outputs the log's contents as a HTML list.
2315      *
2316      * @return string HTML list of the log
2317      */
2318     protected function output_log() {
2319         return '<ul>' . implode("\n", $this->log) . '</ul>';
2320     }