Revert "MDL-39871 Find a solution to handling RTL switching in CSS"
[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 ($PAGE) {
59         $PAGE->reload_theme();
60     }
61 }
63 /**
64  * Enable or disable theme designer mode.
65  *
66  * @param bool $state
67  */
68 function theme_set_designer_mod($state) {
69     theme_reset_all_caches();
70     set_config('themedesignermode', (int)!empty($state));
71 }
73 /**
74  * Returns current theme revision number.
75  *
76  * @return int
77  */
78 function theme_get_revision() {
79     global $CFG;
81     if (empty($CFG->themedesignermode)) {
82         if (empty($CFG->themerev)) {
83             return -1;
84         } else {
85             return $CFG->themerev;
86         }
88     } else {
89         return -1;
90     }
91 }
94 /**
95  * This class represents the configuration variables of a Moodle theme.
96  *
97  * All the variables with access: public below (with a few exceptions that are marked)
98  * are the properties you can set in your themes config.php file.
99  *
100  * There are also some methods and protected variables that are part of the inner
101  * workings of Moodle's themes system. If you are just editing a themes config.php
102  * file, you can just ignore those, and the following information for developers.
103  *
104  * Normally, to create an instance of this class, you should use the
105  * {@link theme_config::load()} factory method to load a themes config.php file.
106  * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
107  * will create one for you, accessible as $PAGE->theme.
108  *
109  * @copyright 2009 Tim Hunt
110  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
111  * @since Moodle 2.0
112  * @package core
113  * @category output
114  */
115 class theme_config {
117     /**
118      * @var string Default theme, used when requested theme not found.
119      */
120     const DEFAULT_THEME = 'standard';
122     /**
123      * @var array You can base your theme on other themes by linking to the other theme as
124      * parents. This lets you use the CSS and layouts from the other themes
125      * (see {@link theme_config::$layouts}).
126      * That makes it easy to create a new theme that is similar to another one
127      * but with a few changes. In this themes CSS you only need to override
128      * those rules you want to change.
129      */
130     public $parents;
132     /**
133      * @var array The names of all the stylesheets from this theme that you would
134      * like included, in order. Give the names of the files without .css.
135      */
136     public $sheets = array();
138     /**
139      * @var array The names of all the stylesheets from parents that should be excluded.
140      * true value may be used to specify all parents or all themes from one parent.
141      * If no value specified value from parent theme used.
142      */
143     public $parents_exclude_sheets = null;
145     /**
146      * @var array List of plugin sheets to be excluded.
147      * If no value specified value from parent theme used.
148      */
149     public $plugins_exclude_sheets = null;
151     /**
152      * @var array List of style sheets that are included in the text editor bodies.
153      * Sheets from parent themes are used automatically and can not be excluded.
154      */
155     public $editor_sheets = array();
157     /**
158      * @var array The names of all the javascript files this theme that you would
159      * like included from head, in order. Give the names of the files without .js.
160      */
161     public $javascripts = array();
163     /**
164      * @var array The names of all the javascript files this theme that you would
165      * like included from footer, in order. Give the names of the files without .js.
166      */
167     public $javascripts_footer = array();
169     /**
170      * @var array The names of all the javascript files from parents that should
171      * be excluded. true value may be used to specify all parents or all themes
172      * from one parent.
173      * If no value specified value from parent theme used.
174      */
175     public $parents_exclude_javascripts = null;
177     /**
178      * @var array Which file to use for each page layout.
179      *
180      * This is an array of arrays. The keys of the outer array are the different layouts.
181      * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
182      * 'popup', 'form', .... The most reliable way to get a complete list is to look at
183      * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
184      * That file also has a good example of how to set this setting.
185      *
186      * For each layout, the value in the outer array is an array that describes
187      * how you want that type of page to look. For example
188      * <pre>
189      *   $THEME->layouts = array(
190      *       // Most pages - if we encounter an unknown or a missing page type, this one is used.
191      *       'standard' => array(
192      *           'theme' = 'mytheme',
193      *           'file' => 'normal.php',
194      *           'regions' => array('side-pre', 'side-post'),
195      *           'defaultregion' => 'side-post'
196      *       ),
197      *       // The site home page.
198      *       'home' => array(
199      *           'theme' = 'mytheme',
200      *           'file' => 'home.php',
201      *           'regions' => array('side-pre', 'side-post'),
202      *           'defaultregion' => 'side-post'
203      *       ),
204      *       // ...
205      *   );
206      * </pre>
207      *
208      * 'theme' name of the theme where is the layout located
209      * 'file' is the layout file to use for this type of page.
210      * layout files are stored in layout subfolder
211      * 'regions' This lists the regions on the page where blocks may appear. For
212      * each region you list here, your layout file must include a call to
213      * <pre>
214      *   echo $OUTPUT->blocks_for_region($regionname);
215      * </pre>
216      * or equivalent so that the blocks are actually visible.
217      *
218      * 'defaultregion' If the list of regions is non-empty, then you must pick
219      * one of the one of them as 'default'. This has two meanings. First, this is
220      * where new blocks are added. Second, if there are any blocks associated with
221      * the page, but in non-existent regions, they appear here. (Imaging, for example,
222      * that someone added blocks using a different theme that used different region
223      * names, and then switched to this theme.)
224      */
225     public $layouts = array();
227     /**
228      * @var string Name of the renderer factory class to use. Must implement the
229      * {@link renderer_factory} interface.
230      *
231      * This is an advanced feature. Moodle output is generated by 'renderers',
232      * you can customise the HTML that is output by writing custom renderers,
233      * and then you need to specify 'renderer factory' so that Moodle can find
234      * your renderers.
235      *
236      * There are some renderer factories supplied with Moodle. Please follow these
237      * links to see what they do.
238      * <ul>
239      * <li>{@link standard_renderer_factory} - the default.</li>
240      * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
241      *      your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
242      * </ul>
243      */
244     public $rendererfactory = 'standard_renderer_factory';
246     /**
247      * @var string Function to do custom CSS post-processing.
248      *
249      * This is an advanced feature. If you want to do custom post-processing on the
250      * CSS before it is output (for example, to replace certain variable names
251      * with particular values) you can give the name of a function here.
252      */
253     public $csspostprocess = null;
255     /**
256      * @var string Accessibility: Right arrow-like character is
257      * used in the breadcrumb trail, course navigation menu
258      * (previous/next activity), calendar, and search forum block.
259      * If the theme does not set characters, appropriate defaults
260      * are set automatically. Please DO NOT
261      * use &lt; &gt; &raquo; - these are confusing for blind users.
262      */
263     public $rarrow = null;
265     /**
266      * @var string Accessibility: Right arrow-like character is
267      * used in the breadcrumb trail, course navigation menu
268      * (previous/next activity), calendar, and search forum block.
269      * If the theme does not set characters, appropriate defaults
270      * are set automatically. Please DO NOT
271      * use &lt; &gt; &raquo; - these are confusing for blind users.
272      */
273     public $larrow = null;
275     /**
276      * @var bool Some themes may want to disable ajax course editing.
277      */
278     public $enablecourseajax = true;
280     /**
281      * @var string Determines served document types
282      *  - 'html5' the only officially supported doctype in Moodle
283      *  - 'xhtml5' may be used in development for validation (not intended for production servers!)
284      *  - 'xhtml' XHTML 1.0 Strict for legacy themes only
285      */
286     public $doctype = 'html5';
288     //==Following properties are not configurable from theme config.php==
290     /**
291      * @var string The name of this theme. Set automatically when this theme is
292      * loaded. This can not be set in theme config.php
293      */
294     public $name;
296     /**
297      * @var string The folder where this themes files are stored. This is set
298      * automatically. This can not be set in theme config.php
299      */
300     public $dir;
302     /**
303      * @var stdClass Theme settings stored in config_plugins table.
304      * This can not be set in theme config.php
305      */
306     public $setting = null;
308     /**
309      * @var bool If set to true and the theme enables the dock then  blocks will be able
310      * to be moved to the special dock
311      */
312     public $enable_dock = false;
314     /**
315      * @var bool If set to true then this theme will not be shown in the theme selector unless
316      * theme designer mode is turned on.
317      */
318     public $hidefromselector = false;
320     /**
321      * @var array list of YUI CSS modules to be included on each page. This may be used
322      * to remove cssreset and use cssnormalise module instead.
323      */
324     public $yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase');
326     /**
327      * An associative array of block manipulations that should be made if the user is using an rtl language.
328      * The key is the original block region, and the value is the block region to change to.
329      * This is used when displaying blocks for regions only.
330      * @var array
331      */
332     public $blockrtlmanipulations = array();
334     /**
335      * @var renderer_factory Instance of the renderer_factory implementation
336      * we are using. Implementation detail.
337      */
338     protected $rf = null;
340     /**
341      * @var array List of parent config objects.
342      **/
343     protected $parent_configs = array();
345     /**
346      * @var bool If set to true then the theme is safe to run through the optimiser (if it is enabled)
347      * If set to false then we know either the theme has already been optimised and the CSS optimiser is not needed
348      * or the theme is not compatible with the CSS optimiser. In both cases even if enabled the CSS optimiser will not
349      * be used with this theme if set to false.
350      */
351     public $supportscssoptimisation = true;
353     /**
354      * Used to determine whether we can serve SVG images or not.
355      * @var bool
356      */
357     private $usesvg = null;
359     /**
360      * Load the config.php file for a particular theme, and return an instance
361      * of this class. (That is, this is a factory method.)
362      *
363      * @param string $themename the name of the theme.
364      * @return theme_config an instance of this class.
365      */
366     public static function load($themename) {
367         global $CFG;
369         // load theme settings from db
370         try {
371             $settings = get_config('theme_'.$themename);
372         } catch (dml_exception $e) {
373             // most probably moodle tables not created yet
374             $settings = new stdClass();
375         }
377         if ($config = theme_config::find_theme_config($themename, $settings)) {
378             return new theme_config($config);
380         } else if ($themename == theme_config::DEFAULT_THEME) {
381             throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
383         } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
384             return new theme_config($config);
386         } else {
387             // bad luck, the requested theme has some problems - admin see details in theme config
388             return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
389         }
390     }
392     /**
393      * Theme diagnostic code. It is very problematic to send debug output
394      * to the actual CSS file, instead this functions is supposed to
395      * diagnose given theme and highlights all potential problems.
396      * This information should be available from the theme selection page
397      * or some other debug page for theme designers.
398      *
399      * @param string $themename
400      * @return array description of problems
401      */
402     public static function diagnose($themename) {
403         //TODO: MDL-21108
404         return array();
405     }
407     /**
408      * Private constructor, can be called only from the factory method.
409      * @param stdClass $config
410      */
411     private function __construct($config) {
412         global $CFG; //needed for included lib.php files
414         $this->settings = $config->settings;
415         $this->name     = $config->name;
416         $this->dir      = $config->dir;
418         if ($this->name != 'base') {
419             $baseconfig = theme_config::find_theme_config('base', $this->settings);
420         } else {
421             $baseconfig = $config;
422         }
424         $configurable = array('parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'javascripts', 'javascripts_footer',
425                               'parents_exclude_javascripts', 'layouts', 'enable_dock', 'enablecourseajax', 'supportscssoptimisation',
426                               'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'hidefromselector', 'doctype',
427                               'yuicssmodules', 'blockrtlmanipulations');
429         foreach ($config as $key=>$value) {
430             if (in_array($key, $configurable)) {
431                 $this->$key = $value;
432             }
433         }
435         // verify all parents and load configs and renderers
436         foreach ($this->parents as $parent) {
437             if ($parent == 'base') {
438                 $parent_config = $baseconfig;
439             } else if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
440                 // this is not good - better exclude faulty parents
441                 continue;
442             }
443             $libfile = $parent_config->dir.'/lib.php';
444             if (is_readable($libfile)) {
445                 // theme may store various function here
446                 include_once($libfile);
447             }
448             $renderersfile = $parent_config->dir.'/renderers.php';
449             if (is_readable($renderersfile)) {
450                 // may contain core and plugin renderers and renderer factory
451                 include_once($renderersfile);
452             }
453             $this->parent_configs[$parent] = $parent_config;
454             $rendererfile = $parent_config->dir.'/renderers.php';
455             if (is_readable($rendererfile)) {
456                  // may contain core and plugin renderers and renderer factory
457                 include_once($rendererfile);
458             }
459         }
460         $libfile = $this->dir.'/lib.php';
461         if (is_readable($libfile)) {
462             // theme may store various function here
463             include_once($libfile);
464         }
465         $rendererfile = $this->dir.'/renderers.php';
466         if (is_readable($rendererfile)) {
467             // may contain core and plugin renderers and renderer factory
468             include_once($rendererfile);
469         } else {
470             // check if renderers.php file is missnamed renderer.php
471             if (is_readable($this->dir.'/renderer.php')) {
472                 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
473                     See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
474             }
475         }
477         // cascade all layouts properly
478         foreach ($baseconfig->layouts as $layout=>$value) {
479             if (!isset($this->layouts[$layout])) {
480                 foreach ($this->parent_configs as $parent_config) {
481                     if (isset($parent_config->layouts[$layout])) {
482                         $this->layouts[$layout] = $parent_config->layouts[$layout];
483                         continue 2;
484                     }
485                 }
486                 $this->layouts[$layout] = $value;
487             }
488         }
490         //fix arrows if needed
491         $this->check_theme_arrows();
492     }
494     /**
495      * Let the theme initialise the page object (usually $PAGE).
496      *
497      * This may be used for example to request jQuery in add-ons.
498      *
499      * @param moodle_page $page
500      */
501     public function init_page(moodle_page $page) {
502         $themeinitfunction = 'theme_'.$this->name.'_page_init';
503         if (function_exists($themeinitfunction)) {
504             $themeinitfunction($page);
505         }
506     }
508     /**
509      * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
510      * If not it applies sensible defaults.
511      *
512      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
513      * search forum block, etc. Important: these are 'silent' in a screen-reader
514      * (unlike &gt; &raquo;), and must be accompanied by text.
515      */
516     private function check_theme_arrows() {
517         if (!isset($this->rarrow) and !isset($this->larrow)) {
518             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
519             // Also OK in Win 9x/2K/IE 5.x
520             $this->rarrow = '&#x25BA;';
521             $this->larrow = '&#x25C4;';
522             if (empty($_SERVER['HTTP_USER_AGENT'])) {
523                 $uagent = '';
524             } else {
525                 $uagent = $_SERVER['HTTP_USER_AGENT'];
526             }
527             if (false !== strpos($uagent, 'Opera')
528                 || false !== strpos($uagent, 'Mac')) {
529                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
530                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
531                 $this->rarrow = '&#x25B6;';
532                 $this->larrow = '&#x25C0;';
533             }
534             elseif ((false !== strpos($uagent, 'Konqueror'))
535                 || (false !== strpos($uagent, 'Android')))  {
536                 // The fonts on Android don't include the characters required for this to work as expected.
537                 // So we use the same ones Konqueror uses.
538                 $this->rarrow = '&rarr;';
539                 $this->larrow = '&larr;';
540             }
541             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
542                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
543                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
544                 // To be safe, non-Unicode browsers!
545                 $this->rarrow = '&gt;';
546                 $this->larrow = '&lt;';
547             }
549             // RTL support - in RTL languages, swap r and l arrows
550             if (right_to_left()) {
551                 $t = $this->rarrow;
552                 $this->rarrow = $this->larrow;
553                 $this->larrow = $t;
554             }
555         }
556     }
558     /**
559      * Returns output renderer prefixes, these are used when looking
560      * for the overridden renderers in themes.
561      *
562      * @return array
563      */
564     public function renderer_prefixes() {
565         global $CFG; // just in case the included files need it
567         $prefixes = array('theme_'.$this->name);
569         foreach ($this->parent_configs as $parent) {
570             $prefixes[] = 'theme_'.$parent->name;
571         }
573         return $prefixes;
574     }
576     /**
577      * Returns the stylesheet URL of this editor content
578      *
579      * @param bool $encoded false means use & and true use &amp; in URLs
580      * @return moodle_url
581      */
582     public function editor_css_url($encoded=true) {
583         global $CFG;
584         $rev = theme_get_revision();
585         if ($rev > -1) {
586             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
587             if (!empty($CFG->slasharguments)) {
588                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
589             } else {
590                 $url->params(array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor'));
591             }
592         } else {
593             $params = array('theme'=>$this->name, 'type'=>'editor');
594             $url = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
595         }
596         return $url;
597     }
599     /**
600      * Returns the content of the CSS to be used in editor content
601      *
602      * @return string
603      */
604     public function editor_css_files() {
605         global $CFG;
607         $files = array();
609         // first editor plugins
610         $plugins = core_component::get_plugin_list('editor');
611         foreach ($plugins as $plugin=>$fulldir) {
612             $sheetfile = "$fulldir/editor_styles.css";
613             if (is_readable($sheetfile)) {
614                 $files['plugin_'.$plugin] = $sheetfile;
615             }
616         }
617         // then parent themes
618         foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
619             if (empty($parent_config->editor_sheets)) {
620                 continue;
621             }
622             foreach ($parent_config->editor_sheets as $sheet) {
623                 $sheetfile = "$parent_config->dir/style/$sheet.css";
624                 if (is_readable($sheetfile)) {
625                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
626                 }
627             }
628         }
629         // finally this theme
630         if (!empty($this->editor_sheets)) {
631             foreach ($this->editor_sheets as $sheet) {
632                 $sheetfile = "$this->dir/style/$sheet.css";
633                 if (is_readable($sheetfile)) {
634                     $files['theme_'.$sheet] = $sheetfile;
635                 }
636             }
637         }
639         return $files;
640     }
642     /**
643      * Get the stylesheet URL of this theme
644      *
645      * @param moodle_page $page Not used... deprecated?
646      * @return array of moodle_url
647      */
648     public function css_urls(moodle_page $page) {
649         global $CFG;
651         $rev = theme_get_revision();
653         $urls = array();
655         $svg = $this->use_svg_icons();
657         if ($rev > -1) {
658             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
659             $separate = (core_useragent::check_ie_version('5') && !core_useragent::check_ie_version('10'));
660             if (!empty($CFG->slasharguments)) {
661                 $slashargs = '';
662                 if (!$svg) {
663                     // We add a simple /_s to the start of the path.
664                     // The underscore is used to ensure that it isn't a valid theme name.
665                     $slashargs .= '/_s'.$slashargs;
666                 }
667                 $slashargs .= '/'.$this->name.'/'.$rev.'/all';
668                 if ($separate) {
669                     $slashargs .= '/chunk0';
670                 }
671                 $url->set_slashargument($slashargs, 'noparam', true);
672             } else {
673                 $params = array('theme' => $this->name,'rev' => $rev, 'type' => 'all');
674                 if (!$svg) {
675                     // We add an SVG param so that we know not to serve SVG images.
676                     // We do this because all modern browsers support SVG and this param will one day be removed.
677                     $params['svg'] = '0';
678                 }
679                 if ($separate) {
680                     $params['chunk'] = '0';
681                 }
682                 $url->params($params);
683             }
684             $urls[] = $url;
686         } else {
687             // find out the current CSS and cache it now for 5 seconds
688             // the point is to construct the CSS only once and pass it through the
689             // dataroot to the script that actually serves the sheets
690             if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
691                 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
692             }
693             $candidatedir = "$CFG->cachedir/theme/$this->name";
694             if ($svg) {
695                 $candidatesheet = "$candidatedir/designer.ser";
696             } else {
697                 $candidatesheet = "$candidatedir/designer_nosvg.ser";
698             }
699             $rebuild = true;
700             if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
701                 if ($css = file_get_contents($candidatesheet)) {
702                     $css = unserialize($css);
703                     if (is_array($css)) {
704                         $rebuild = false;
705                     }
706                 }
707             }
708             if ($rebuild) {
709                 // Prepare the CSS optimiser if it is to be used,
710                 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
711                 $optimiser = null;
712                 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
713                     require_once($CFG->dirroot.'/lib/csslib.php');
714                     $optimiser = new css_optimiser;
715                 }
716                 $css = $this->css_content($optimiser);
718                 // We do not want any errors here because this may fail easily because of the concurrent access.
719                 $prevabort = ignore_user_abort(true);
720                 check_dir_exists($candidatedir);
721                 $tempfile = tempnam($candidatedir, 'tmpdesigner');
722                 file_put_contents($tempfile, serialize($css));
723                 $reporting = error_reporting(0);
724                 chmod($tempfile, $CFG->filepermissions);
725                 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
726                 rename($tempfile, $candidatesheet);
727                 error_reporting($reporting);
728                 ignore_user_abort($prevabort);
729             }
731             $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
732             if (!$svg) {
733                 // We add an SVG param so that we know not to serve SVG images.
734                 // We do this because all modern browsers support SVG and this param will one day be removed.
735                 $baseurl->param('svg', '0');
736             }
737             if (core_useragent::check_ie_version('5')) {
738                 // lalala, IE does not allow more than 31 linked CSS files from main document
739                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
740                 foreach ($css['parents'] as $parent=>$sheets) {
741                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
742                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
743                 }
744                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
746             } else {
747                 foreach ($css['plugins'] as $plugin=>$unused) {
748                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
749                 }
750                 foreach ($css['parents'] as $parent=>$sheets) {
751                     foreach ($sheets as $sheet=>$unused2) {
752                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
753                     }
754                 }
755                 foreach ($css['theme'] as $sheet=>$unused) {
756                     $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme')); // sheet first in order to make long urls easier to read
757                 }
758             }
759         }
761         return $urls;
762     }
764     /**
765      * Returns an array of organised CSS files required for this output
766      *
767      * @return array
768      */
769     public function css_files() {
770         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
772         // get all plugin sheets
773         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
774         if ($excludes !== true) {
775             foreach (core_component::get_plugin_types() as $type=>$unused) {
776                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
777                     continue;
778                 }
779                 $plugins = core_component::get_plugin_list($type);
780                 foreach ($plugins as $plugin=>$fulldir) {
781                     if (!empty($excludes[$type]) and is_array($excludes[$type])
782                         and in_array($plugin, $excludes[$type])) {
783                         continue;
784                     }
786                     $plugincontent = '';
787                     $sheetfile = "$fulldir/styles.css";
788                     if (is_readable($sheetfile)) {
789                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
790                     }
791                     $sheetthemefile = "$fulldir/styles_{$this->name}.css";
792                     if (is_readable($sheetthemefile)) {
793                         $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
794                     }
795                     }
796                 }
797             }
799         // find out wanted parent sheets
800         $excludes = $this->resolve_excludes('parents_exclude_sheets');
801         if ($excludes !== true) {
802             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
803                 $parent = $parent_config->name;
804                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
805                     continue;
806                 }
807                 foreach ($parent_config->sheets as $sheet) {
808                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
809                         and in_array($sheet, $excludes[$parent])) {
810                         continue;
811                     }
812                     $sheetfile = "$parent_config->dir/style/$sheet.css";
813                     if (is_readable($sheetfile)) {
814                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
815                     }
816                 }
817             }
818         }
820         // current theme sheets
821         if (is_array($this->sheets)) {
822             foreach ($this->sheets as $sheet) {
823                 $sheetfile = "$this->dir/style/$sheet.css";
824                 if (is_readable($sheetfile)) {
825                     $cssfiles['theme'][$sheet] = $sheetfile;
826                 }
827             }
828         }
830         return $cssfiles;
831     }
833     /**
834      * Returns the content of the one huge CSS merged from all style sheets.
835      *
836      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
837      * @return string
838      */
839     public function css_content(css_optimiser $optimiser = null) {
840         $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
841         $css = $this->css_files_get_contents($files, array(), $optimiser);
842         return $css;
843     }
845     /**
846      * Given an array of file paths or a single file path loads the contents of
847      * the CSS file, processes it then returns it in the same structure it was given.
848      *
849      * Can be used recursively on the results of {@link css_files}
850      *
851      * @param array|string $file An array of file paths or a single file path
852      * @param array $keys An array of previous array keys [recursive addition]
853      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
854      * @return The converted array or the contents of the single file ($file type)
855      */
856     protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
857         global $CFG;
858         if (is_array($file)) {
859             // We use a separate array to keep everything in the exact same order.
860             $return = array();
861             foreach ($file as $key=>$f) {
862                 $return[clean_param($key, PARAM_SAFEDIR)] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
863             }
864             return $return;
865         } else {
866             $contents = file_get_contents($file);
867             $contents = $this->post_process($contents);
868             $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
869             $stats = '';
870             if (!is_null($optimiser)) {
871                 $contents = $optimiser->process($contents);
872                 if (!empty($CFG->cssoptimiserstats)) {
873                     $stats = $optimiser->output_stats_css();
874                 }
875             }
876             return $comment.$stats.$contents;
877         }
878     }
881     /**
882      * Generate a URL to the file that serves theme JavaScript files.
883      *
884      * If we determine that the theme has no relevant files, then we return
885      * early with a null value.
886      *
887      * @param bool $inhead true means head url, false means footer
888      * @return moodle_url|null
889      */
890     public function javascript_url($inhead) {
891         global $CFG;
893         $rev = theme_get_revision();
894         $params = array('theme'=>$this->name,'rev'=>$rev);
895         $params['type'] = $inhead ? 'head' : 'footer';
897         // Return early if there are no files to serve
898         if (count($this->javascript_files($params['type'])) === 0) {
899             return null;
900         }
902         if (!empty($CFG->slasharguments) and $rev > 0) {
903             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
904             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
905             return $url;
906         } else {
907             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
908         }
909     }
911     /**
912      * Get the URL's for the JavaScript files used by this theme.
913      * They won't be served directly, instead they'll be mediated through
914      * theme/javascript.php.
915      *
916      * @param string $type Either javascripts_footer, or javascripts
917      * @return array
918      */
919     public function javascript_files($type) {
920         if ($type === 'footer') {
921             $type = 'javascripts_footer';
922         } else {
923             $type = 'javascripts';
924         }
926         $js = array();
927         // find out wanted parent javascripts
928         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
929         if ($excludes !== true) {
930             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
931                 $parent = $parent_config->name;
932                 if (empty($parent_config->$type)) {
933                     continue;
934                 }
935                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
936                     continue;
937                 }
938                 foreach ($parent_config->$type as $javascript) {
939                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
940                         and in_array($javascript, $excludes[$parent])) {
941                         continue;
942                     }
943                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
944                     if (is_readable($javascriptfile)) {
945                         $js[] = $javascriptfile;
946                     }
947                 }
948             }
949         }
951         // current theme javascripts
952         if (is_array($this->$type)) {
953             foreach ($this->$type as $javascript) {
954                 $javascriptfile = "$this->dir/javascript/$javascript.js";
955                 if (is_readable($javascriptfile)) {
956                     $js[] = $javascriptfile;
957                 }
958             }
959         }
960         return $js;
961     }
963     /**
964      * Resolves an exclude setting to the themes setting is applicable or the
965      * setting of its closest parent.
966      *
967      * @param string $variable The name of the setting the exclude setting to resolve
968      * @param string $default
969      * @return mixed
970      */
971     protected function resolve_excludes($variable, $default = null) {
972         $setting = $default;
973         if (is_array($this->{$variable}) or $this->{$variable} === true) {
974             $setting = $this->{$variable};
975         } else {
976             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
977                 if (!isset($parent_config->{$variable})) {
978                     continue;
979                 }
980                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
981                     $setting = $parent_config->{$variable};
982                     break;
983                 }
984             }
985         }
986         return $setting;
987     }
989     /**
990      * Returns the content of the one huge javascript file merged from all theme javascript files.
991      *
992      * @param bool $type
993      * @return string
994      */
995     public function javascript_content($type) {
996         $jsfiles = $this->javascript_files($type);
997         $js = '';
998         foreach ($jsfiles as $jsfile) {
999             $js .= file_get_contents($jsfile)."\n";
1000         }
1001         return $js;
1002     }
1004     /**
1005      * Post processes CSS.
1006      *
1007      * This method post processes all of the CSS before it is served for this theme.
1008      * This is done so that things such as image URL's can be swapped in and to
1009      * run any specific CSS post process method the theme has requested.
1010      * This allows themes to use CSS settings.
1011      *
1012      * @param string $css The CSS to process.
1013      * @return string The processed CSS.
1014      */
1015     public function post_process($css) {
1016         // now resolve all image locations
1017         if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1018             $replaced = array();
1019             foreach ($matches as $match) {
1020                 if (isset($replaced[$match[0]])) {
1021                     continue;
1022                 }
1023                 $replaced[$match[0]] = true;
1024                 $imagename = $match[2];
1025                 $component = rtrim($match[1], '|');
1026                 $imageurl = $this->pix_url($imagename, $component)->out(false);
1027                  // we do not need full url because the image.php is always in the same dir
1028                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
1029                 $css = str_replace($match[0], $imageurl, $css);
1030             }
1031         }
1033         // Now resolve all font locations.
1034         if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1035             $replaced = array();
1036             foreach ($matches as $match) {
1037                 if (isset($replaced[$match[0]])) {
1038                     continue;
1039                 }
1040                 $replaced[$match[0]] = true;
1041                 $fontname = $match[2];
1042                 $component = rtrim($match[1], '|');
1043                 $fonturl = $this->font_url($fontname, $component)->out(false);
1044                 // We do not need full url because the font.php is always in the same dir.
1045                 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1046                 $css = str_replace($match[0], $fonturl, $css);
1047             }
1048         }
1050         // now resolve all theme settings or do any other postprocessing
1051         $csspostprocess = $this->csspostprocess;
1052         if (function_exists($csspostprocess)) {
1053             $css = $csspostprocess($css, $this);
1054         }
1056         return $css;
1057     }
1059     /**
1060      * Return the URL for an image
1061      *
1062      * @param string $imagename the name of the icon.
1063      * @param string $component specification of one plugin like in get_string()
1064      * @return moodle_url
1065      */
1066     public function pix_url($imagename, $component) {
1067         global $CFG;
1069         $params = array('theme'=>$this->name);
1070         $svg = $this->use_svg_icons();
1072         if (empty($component) or $component === 'moodle' or $component === 'core') {
1073             $params['component'] = 'core';
1074         } else {
1075             $params['component'] = $component;
1076         }
1078         $rev = theme_get_revision();
1079         if ($rev != -1) {
1080             $params['rev'] = $rev;
1081         }
1083         $params['image'] = $imagename;
1085         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1086         if (!empty($CFG->slasharguments) and $rev > 0) {
1087             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1088             if (!$svg) {
1089                 // We add a simple /_s to the start of the path.
1090                 // The underscore is used to ensure that it isn't a valid theme name.
1091                 $path = '/_s'.$path;
1092             }
1093             $url->set_slashargument($path, 'noparam', true);
1094         } else {
1095             if (!$svg) {
1096                 // We add an SVG param so that we know not to serve SVG images.
1097                 // We do this because all modern browsers support SVG and this param will one day be removed.
1098                 $params['svg'] = '0';
1099             }
1100             $url->params($params);
1101         }
1103         return $url;
1104     }
1106     /**
1107      * Return the URL for a font
1108      *
1109      * @param string $font the name of the font (including extension).
1110      * @param string $component specification of one plugin like in get_string()
1111      * @return moodle_url
1112      */
1113     public function font_url($font, $component) {
1114         global $CFG;
1116         $params = array('theme'=>$this->name);
1118         if (empty($component) or $component === 'moodle' or $component === 'core') {
1119             $params['component'] = 'core';
1120         } else {
1121             $params['component'] = $component;
1122         }
1124         $rev = theme_get_revision();
1125         if ($rev != -1) {
1126             $params['rev'] = $rev;
1127         }
1129         $params['font'] = $font;
1131         $url = new moodle_url("$CFG->httpswwwroot/theme/font.php");
1132         if (!empty($CFG->slasharguments) and $rev > 0) {
1133             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
1134             $url->set_slashargument($path, 'noparam', true);
1135         } else {
1136             $url->params($params);
1137         }
1139         return $url;
1140     }
1142     /**
1143      * Returns URL to the stored file via pluginfile.php.
1144      *
1145      * Note the theme must also implement pluginfile.php handler,
1146      * theme revision is used instead of the itemid.
1147      *
1148      * @param string $setting
1149      * @param string $filearea
1150      * @return string protocol relative URL or null if not present
1151      */
1152     public function setting_file_url($setting, $filearea) {
1153         global $CFG;
1155         if (empty($this->settings->$setting)) {
1156             return null;
1157         }
1159         $component = 'theme_'.$this->name;
1160         $itemid = theme_get_revision();
1161         $filepath = $this->settings->$setting;
1162         $syscontext = context_system::instance();
1164         $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
1166         // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
1167         // Note: unfortunately moodle_url does not support //urls yet.
1169         $url = preg_replace('|^https?://|i', '//', $url->out(false));
1171         return $url;
1172     }
1174     /**
1175      * Serve the theme setting file.
1176      *
1177      * @param string $filearea
1178      * @param array $args
1179      * @param bool $forcedownload
1180      * @param array $options
1181      * @return bool may terminate if file not found or donotdie not specified
1182      */
1183     public function setting_file_serve($filearea, $args, $forcedownload, $options) {
1184         global $CFG;
1185         require_once("$CFG->libdir/filelib.php");
1187         $syscontext = context_system::instance();
1188         $component = 'theme_'.$this->name;
1190         $revision = array_shift($args);
1191         if ($revision < 0) {
1192             $lifetime = 0;
1193         } else {
1194             $lifetime = 60*60*24*60;
1195         }
1197         $fs = get_file_storage();
1198         $relativepath = implode('/', $args);
1200         $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
1201         $fullpath = rtrim($fullpath, '/');
1202         if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
1203             send_stored_file($file, $lifetime, 0, $forcedownload, $options);
1204             return true;
1205         } else {
1206             send_file_not_found();
1207         }
1208     }
1210     /**
1211      * Resolves the real image location.
1212      *
1213      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1214      * and we need a way in which to turn it off.
1215      * By default SVG won't be used unless asked for. This is done for two reasons:
1216      *   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
1217      *      browser supports SVG.
1218      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1219      *      by the user due to security concerns.
1220      *
1221      * @param string $image name of image, may contain relative path
1222      * @param string $component
1223      * @param bool $svg If set to true SVG images will also be looked for.
1224      * @return string full file path
1225      */
1226     public function resolve_image_location($image, $component, $svg = false) {
1227         global $CFG;
1229         if (!is_bool($svg)) {
1230             // If $svg isn't a bool then we need to decide for ourselves.
1231             $svg = $this->use_svg_icons();
1232         }
1234         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1235             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1236                 return $imagefile;
1237             }
1238             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1239                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1240                     return $imagefile;
1241                 }
1242             }
1243             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1244                 return $imagefile;
1245             }
1246             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1247                 return $imagefile;
1248             }
1249             return null;
1251         } else if ($component === 'theme') { //exception
1252             if ($image === 'favicon') {
1253                 return "$this->dir/pix/favicon.ico";
1254             }
1255             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1256                 return $imagefile;
1257             }
1258             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1259                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1260                     return $imagefile;
1261                 }
1262             }
1263             return null;
1265         } else {
1266             if (strpos($component, '_') === false) {
1267                 $component = 'mod_'.$component;
1268             }
1269             list($type, $plugin) = explode('_', $component, 2);
1271             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1272                 return $imagefile;
1273             }
1274             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1275                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1276                     return $imagefile;
1277                 }
1278             }
1279             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1280                 return $imagefile;
1281             }
1282             $dir = core_component::get_plugin_directory($type, $plugin);
1283             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1284                 return $imagefile;
1285             }
1286             return null;
1287         }
1288     }
1290     /**
1291      * Resolves the real font location.
1292      *
1293      * @param string $font name of font file
1294      * @param string $component
1295      * @return string full file path
1296      */
1297     public function resolve_font_location($font, $component) {
1298         global $CFG;
1300         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1301             if (file_exists("$this->dir/fonts_core/$font")) {
1302                 return "$this->dir/fonts_core/$font";
1303             }
1304             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1305                 if (file_exists("$parent_config->dir/fonts_core/$font")) {
1306                     return "$parent_config->dir/fonts_core/$font";
1307                 }
1308             }
1309             if (file_exists("$CFG->dataroot/fonts/$font")) {
1310                 return "$CFG->dataroot/fonts/$font";
1311             }
1312             if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
1313                 return "$CFG->dirroot/lib/fonts/$font";
1314             }
1315             return null;
1317         } else if ($component === 'theme') { // Exception.
1318             if (file_exists("$this->dir/fonts/$font")) {
1319                 return "$this->dir/fonts/$font";
1320             }
1321             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1322                 if (file_exists("$parent_config->dir/fonts/$font")) {
1323                     return "$parent_config->dir/fonts/$font";
1324                 }
1325             }
1326             return null;
1328         } else {
1329             if (strpos($component, '_') === false) {
1330                 $component = 'mod_'.$component;
1331             }
1332             list($type, $plugin) = explode('_', $component, 2);
1334             if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
1335                 return "$this->dir/fonts_plugins/$type/$plugin/$font";
1336             }
1337             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1338                 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
1339                     return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
1340                 }
1341             }
1342             if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
1343                 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
1344             }
1345             $dir = core_component::get_plugin_directory($type, $plugin);
1346             if (file_exists("$dir/fonts/$font")) {
1347                 return "$dir/fonts/$font";
1348             }
1349             return null;
1350         }
1351     }
1353     /**
1354      * Return true if we should look for SVG images as well.
1355      *
1356      * @staticvar bool $svg
1357      * @return bool
1358      */
1359     public function use_svg_icons() {
1360         global $CFG;
1361         if ($this->usesvg === null) {
1363             if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1364                 $this->usesvg = core_useragent::supports_svg();
1365             } else {
1366                 // Force them on/off depending upon the setting.
1367                 $this->usesvg = $CFG->svgicons;
1368             }
1369         }
1370         return $this->usesvg;
1371     }
1373     /**
1374      * Forces the usesvg setting to either true or false, avoiding any decision making.
1375      *
1376      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1377      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1378      *
1379      * @param bool $setting True to force the use of svg when available, null otherwise.
1380      */
1381     public function force_svg_use($setting) {
1382         $this->usesvg = (bool)$setting;
1383     }
1385     /**
1386      * Checks if file with any image extension exists.
1387      *
1388      * The order to these images was adjusted prior to the release of 2.4
1389      * At that point the were the following image counts in Moodle core:
1390      *
1391      *     - png = 667 in pix dirs (1499 total)
1392      *     - gif = 385 in pix dirs (606 total)
1393      *     - jpg = 62  in pix dirs (74 total)
1394      *     - jpeg = 0  in pix dirs (1 total)
1395      *
1396      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1397      *
1398      * @param string $filepath
1399      * @param bool $svg If set to true SVG images will also be looked for.
1400      * @return string image name with extension
1401      */
1402     private static function image_exists($filepath, $svg = false) {
1403         if ($svg && file_exists("$filepath.svg")) {
1404             return "$filepath.svg";
1405         } else  if (file_exists("$filepath.png")) {
1406             return "$filepath.png";
1407         } else if (file_exists("$filepath.gif")) {
1408             return "$filepath.gif";
1409         } else  if (file_exists("$filepath.jpg")) {
1410             return "$filepath.jpg";
1411         } else  if (file_exists("$filepath.jpeg")) {
1412             return "$filepath.jpeg";
1413         } else {
1414             return false;
1415         }
1416     }
1418     /**
1419      * Loads the theme config from config.php file.
1420      *
1421      * @param string $themename
1422      * @param stdClass $settings from config_plugins table
1423      * @return stdClass The theme configuration
1424      */
1425     private static function find_theme_config($themename, $settings) {
1426         // We have to use the variable name $THEME (upper case) because that
1427         // is what is used in theme config.php files.
1429         if (!$dir = theme_config::find_theme_location($themename)) {
1430             return null;
1431         }
1433         $THEME = new stdClass();
1434         $THEME->name     = $themename;
1435         $THEME->dir      = $dir;
1436         $THEME->settings = $settings;
1438         global $CFG; // just in case somebody tries to use $CFG in theme config
1439         include("$THEME->dir/config.php");
1441         // verify the theme configuration is OK
1442         if (!is_array($THEME->parents)) {
1443             // parents option is mandatory now
1444             return null;
1445         }
1447         return $THEME;
1448     }
1450     /**
1451      * Finds the theme location and verifies the theme has all needed files
1452      * and is not obsoleted.
1453      *
1454      * @param string $themename
1455      * @return string full dir path or null if not found
1456      */
1457     private static function find_theme_location($themename) {
1458         global $CFG;
1460         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1461             $dir = "$CFG->dirroot/theme/$themename";
1463         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1464             $dir = "$CFG->themedir/$themename";
1466         } else {
1467             return null;
1468         }
1470         if (file_exists("$dir/styles.php")) {
1471             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1472             return null;
1473         }
1475         return $dir;
1476     }
1478     /**
1479      * Get the renderer for a part of Moodle for this theme.
1480      *
1481      * @param moodle_page $page the page we are rendering
1482      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
1483      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
1484      * @param string $target one of rendering target constants
1485      * @return renderer_base the requested renderer.
1486      */
1487     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
1488         if (is_null($this->rf)) {
1489             $classname = $this->rendererfactory;
1490             $this->rf = new $classname($this);
1491         }
1493         return $this->rf->get_renderer($page, $component, $subtype, $target);
1494     }
1496     /**
1497      * Get the information from {@link $layouts} for this type of page.
1498      *
1499      * @param string $pagelayout the the page layout name.
1500      * @return array the appropriate part of {@link $layouts}.
1501      */
1502     protected function layout_info_for_page($pagelayout) {
1503         if (array_key_exists($pagelayout, $this->layouts)) {
1504             return $this->layouts[$pagelayout];
1505         } else {
1506             debugging('Invalid page layout specified: ' . $pagelayout);
1507             return $this->layouts['standard'];
1508         }
1509     }
1511     /**
1512      * Given the settings of this theme, and the page pagelayout, return the
1513      * full path of the page layout file to use.
1514      *
1515      * Used by {@link core_renderer::header()}.
1516      *
1517      * @param string $pagelayout the the page layout name.
1518      * @return string Full path to the lyout file to use
1519      */
1520     public function layout_file($pagelayout) {
1521         global $CFG;
1523         $layoutinfo = $this->layout_info_for_page($pagelayout);
1524         $layoutfile = $layoutinfo['file'];
1526         if (array_key_exists('theme', $layoutinfo)) {
1527             $themes = array($layoutinfo['theme']);
1528         } else {
1529             $themes = array_merge(array($this->name),$this->parents);
1530         }
1532         foreach ($themes as $theme) {
1533             if ($dir = $this->find_theme_location($theme)) {
1534                 $path = "$dir/layout/$layoutfile";
1536                 // Check the template exists, return general base theme template if not.
1537                 if (is_readable($path)) {
1538                     return $path;
1539                 }
1540             }
1541         }
1543         debugging('Can not find layout file for: ' . $pagelayout);
1544         // fallback to standard normal layout
1545         return "$CFG->dirroot/theme/base/layout/general.php";
1546     }
1548     /**
1549      * Returns auxiliary page layout options specified in layout configuration array.
1550      *
1551      * @param string $pagelayout
1552      * @return array
1553      */
1554     public function pagelayout_options($pagelayout) {
1555         $info = $this->layout_info_for_page($pagelayout);
1556         if (!empty($info['options'])) {
1557             return $info['options'];
1558         }
1559         return array();
1560     }
1562     /**
1563      * Inform a block_manager about the block regions this theme wants on this
1564      * page layout.
1565      *
1566      * @param string $pagelayout the general type of the page.
1567      * @param block_manager $blockmanager the block_manger to set up.
1568      */
1569     public function setup_blocks($pagelayout, $blockmanager) {
1570         $layoutinfo = $this->layout_info_for_page($pagelayout);
1571         if (!empty($layoutinfo['regions'])) {
1572             $blockmanager->add_regions($layoutinfo['regions']);
1573             $blockmanager->set_default_region($layoutinfo['defaultregion']);
1574         }
1575     }
1577     /**
1578      * Gets the visible name for the requested block region.
1579      *
1580      * @param string $region The region name to get
1581      * @param string $theme The theme the region belongs to (may come from the parent theme)
1582      * @return string
1583      */
1584     protected function get_region_name($region, $theme) {
1585         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1586         // A name exists in this theme, so use it
1587         if (substr($regionstring, 0, 1) != '[') {
1588             return $regionstring;
1589         }
1591         // Otherwise, try to find one elsewhere
1592         // Check parents, if any
1593         foreach ($this->parents as $parentthemename) {
1594             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1595             if (substr($regionstring, 0, 1) != '[') {
1596                 return $regionstring;
1597             }
1598         }
1600         // Last resort, try the base theme for names
1601         return get_string('region-' . $region, 'theme_base');
1602     }
1604     /**
1605      * Get the list of all block regions known to this theme in all templates.
1606      *
1607      * @return array internal region name => human readable name.
1608      */
1609     public function get_all_block_regions() {
1610         $regions = array();
1611         foreach ($this->layouts as $layoutinfo) {
1612             foreach ($layoutinfo['regions'] as $region) {
1613                 $regions[$region] = $this->get_region_name($region, $this->name);
1614             }
1615         }
1616         return $regions;
1617     }
1619     /**
1620      * Returns the human readable name of the theme
1621      *
1622      * @return string
1623      */
1624     public function get_theme_name() {
1625         return get_string('pluginname', 'theme_'.$this->name);
1626     }
1629 /**
1630  * This class keeps track of which HTML tags are currently open.
1631  *
1632  * This makes it much easier to always generate well formed XHTML output, even
1633  * if execution terminates abruptly. Any time you output some opening HTML
1634  * without the matching closing HTML, you should push the necessary close tags
1635  * onto the stack.
1636  *
1637  * @copyright 2009 Tim Hunt
1638  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1639  * @since Moodle 2.0
1640  * @package core
1641  * @category output
1642  */
1643 class xhtml_container_stack {
1645     /**
1646      * @var array Stores the list of open containers.
1647      */
1648     protected $opencontainers = array();
1650     /**
1651      * @var array In developer debug mode, stores a stack trace of all opens and
1652      * closes, so we can output helpful error messages when there is a mismatch.
1653      */
1654     protected $log = array();
1656     /**
1657      * @var boolean Store whether we are developer debug mode. We need this in
1658      * several places including in the destructor where we may not have access to $CFG.
1659      */
1660     protected $isdebugging;
1662     /**
1663      * Constructor
1664      */
1665     public function __construct() {
1666         global $CFG;
1667         $this->isdebugging = $CFG->debugdeveloper;
1668     }
1670     /**
1671      * Push the close HTML for a recently opened container onto the stack.
1672      *
1673      * @param string $type The type of container. This is checked when {@link pop()}
1674      *      is called and must match, otherwise a developer debug warning is output.
1675      * @param string $closehtml The HTML required to close the container.
1676      */
1677     public function push($type, $closehtml) {
1678         $container = new stdClass;
1679         $container->type = $type;
1680         $container->closehtml = $closehtml;
1681         if ($this->isdebugging) {
1682             $this->log('Open', $type);
1683         }
1684         array_push($this->opencontainers, $container);
1685     }
1687     /**
1688      * Pop the HTML for the next closing container from the stack. The $type
1689      * must match the type passed when the container was opened, otherwise a
1690      * warning will be output.
1691      *
1692      * @param string $type The type of container.
1693      * @return string the HTML required to close the container.
1694      */
1695     public function pop($type) {
1696         if (empty($this->opencontainers)) {
1697             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1698                     $this->output_log(), DEBUG_DEVELOPER);
1699             return;
1700         }
1702         $container = array_pop($this->opencontainers);
1703         if ($container->type != $type) {
1704             debugging('<p>The type of container to be closed (' . $container->type .
1705                     ') does not match the type of the next open container (' . $type .
1706                     '). This suggests there is a nesting problem.</p>' .
1707                     $this->output_log(), DEBUG_DEVELOPER);
1708         }
1709         if ($this->isdebugging) {
1710             $this->log('Close', $type);
1711         }
1712         return $container->closehtml;
1713     }
1715     /**
1716      * Close all but the last open container. This is useful in places like error
1717      * handling, where you want to close all the open containers (apart from <body>)
1718      * before outputting the error message.
1719      *
1720      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1721      *      developer debug warning if it isn't.
1722      * @return string the HTML required to close any open containers inside <body>.
1723      */
1724     public function pop_all_but_last($shouldbenone = false) {
1725         if ($shouldbenone && count($this->opencontainers) != 1) {
1726             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1727                     $this->output_log(), DEBUG_DEVELOPER);
1728         }
1729         $output = '';
1730         while (count($this->opencontainers) > 1) {
1731             $container = array_pop($this->opencontainers);
1732             $output .= $container->closehtml;
1733         }
1734         return $output;
1735     }
1737     /**
1738      * You can call this function if you want to throw away an instance of this
1739      * class without properly emptying the stack (for example, in a unit test).
1740      * Calling this method stops the destruct method from outputting a developer
1741      * debug warning. After calling this method, the instance can no longer be used.
1742      */
1743     public function discard() {
1744         $this->opencontainers = null;
1745     }
1747     /**
1748      * Adds an entry to the log.
1749      *
1750      * @param string $action The name of the action
1751      * @param string $type The type of action
1752      */
1753     protected function log($action, $type) {
1754         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1755                 format_backtrace(debug_backtrace()) . '</li>';
1756     }
1758     /**
1759      * Outputs the log's contents as a HTML list.
1760      *
1761      * @return string HTML list of the log
1762      */
1763     protected function output_log() {
1764         return '<ul>' . implode("\n", $this->log) . '</ul>';
1765     }