26f51d2e6bc1daa79a4997ed0455ee19b83e007b
[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         // Use parent theme's "blockrtlmanipulations" if it was defined and if it was not defined on current theme.
491         if (empty($this->blockrtlmanipulations)) {
492             foreach ($this->parent_configs as $parent_config) {
493                 if (!empty($parent_config->blockrtlmanipulations)) {
494                     $this->blockrtlmanipulations = $parent_config->blockrtlmanipulations;
495                     continue;
496                 }
497             }
498         }
500         //fix arrows if needed
501         $this->check_theme_arrows();
502     }
504     /**
505      * Let the theme initialise the page object (usually $PAGE).
506      *
507      * This may be used for example to request jQuery in add-ons.
508      *
509      * @param moodle_page $page
510      */
511     public function init_page(moodle_page $page) {
512         $themeinitfunction = 'theme_'.$this->name.'_page_init';
513         if (function_exists($themeinitfunction)) {
514             $themeinitfunction($page);
515         }
516     }
518     /**
519      * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
520      * If not it applies sensible defaults.
521      *
522      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
523      * search forum block, etc. Important: these are 'silent' in a screen-reader
524      * (unlike &gt; &raquo;), and must be accompanied by text.
525      */
526     private function check_theme_arrows() {
527         if (!isset($this->rarrow) and !isset($this->larrow)) {
528             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
529             // Also OK in Win 9x/2K/IE 5.x
530             $this->rarrow = '&#x25BA;';
531             $this->larrow = '&#x25C4;';
532             if (empty($_SERVER['HTTP_USER_AGENT'])) {
533                 $uagent = '';
534             } else {
535                 $uagent = $_SERVER['HTTP_USER_AGENT'];
536             }
537             if (false !== strpos($uagent, 'Opera')
538                 || false !== strpos($uagent, 'Mac')) {
539                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
540                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
541                 $this->rarrow = '&#x25B6;';
542                 $this->larrow = '&#x25C0;';
543             }
544             elseif ((false !== strpos($uagent, 'Konqueror'))
545                 || (false !== strpos($uagent, 'Android')))  {
546                 // The fonts on Android don't include the characters required for this to work as expected.
547                 // So we use the same ones Konqueror uses.
548                 $this->rarrow = '&rarr;';
549                 $this->larrow = '&larr;';
550             }
551             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
552                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
553                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
554                 // To be safe, non-Unicode browsers!
555                 $this->rarrow = '&gt;';
556                 $this->larrow = '&lt;';
557             }
559             // RTL support - in RTL languages, swap r and l arrows
560             if (right_to_left()) {
561                 $t = $this->rarrow;
562                 $this->rarrow = $this->larrow;
563                 $this->larrow = $t;
564             }
565         }
566     }
568     /**
569      * Returns output renderer prefixes, these are used when looking
570      * for the overridden renderers in themes.
571      *
572      * @return array
573      */
574     public function renderer_prefixes() {
575         global $CFG; // just in case the included files need it
577         $prefixes = array('theme_'.$this->name);
579         foreach ($this->parent_configs as $parent) {
580             $prefixes[] = 'theme_'.$parent->name;
581         }
583         return $prefixes;
584     }
586     /**
587      * Returns the stylesheet URL of this editor content
588      *
589      * @param bool $encoded false means use & and true use &amp; in URLs
590      * @return moodle_url
591      */
592     public function editor_css_url($encoded=true) {
593         global $CFG;
594         $rev = theme_get_revision();
595         if ($rev > -1) {
596             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
597             if (!empty($CFG->slasharguments)) {
598                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
599             } else {
600                 $url->params(array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor'));
601             }
602         } else {
603             $params = array('theme'=>$this->name, 'type'=>'editor');
604             $url = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
605         }
606         return $url;
607     }
609     /**
610      * Returns the content of the CSS to be used in editor content
611      *
612      * @return string
613      */
614     public function editor_css_files() {
615         global $CFG;
617         $files = array();
619         // first editor plugins
620         $plugins = core_component::get_plugin_list('editor');
621         foreach ($plugins as $plugin=>$fulldir) {
622             $sheetfile = "$fulldir/editor_styles.css";
623             if (is_readable($sheetfile)) {
624                 $files['plugin_'.$plugin] = $sheetfile;
625             }
626         }
627         // then parent themes
628         foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
629             if (empty($parent_config->editor_sheets)) {
630                 continue;
631             }
632             foreach ($parent_config->editor_sheets as $sheet) {
633                 $sheetfile = "$parent_config->dir/style/$sheet.css";
634                 if (is_readable($sheetfile)) {
635                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
636                 }
637             }
638         }
639         // finally this theme
640         if (!empty($this->editor_sheets)) {
641             foreach ($this->editor_sheets as $sheet) {
642                 $sheetfile = "$this->dir/style/$sheet.css";
643                 if (is_readable($sheetfile)) {
644                     $files['theme_'.$sheet] = $sheetfile;
645                 }
646             }
647         }
649         return $files;
650     }
652     /**
653      * Get the stylesheet URL of this theme
654      *
655      * @param moodle_page $page Not used... deprecated?
656      * @return array of moodle_url
657      */
658     public function css_urls(moodle_page $page) {
659         global $CFG;
661         $rev = theme_get_revision();
663         $urls = array();
665         $svg = $this->use_svg_icons();
667         if ($rev > -1) {
668             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
669             $separate = (core_useragent::check_ie_version('5') && !core_useragent::check_ie_version('10'));
670             if (!empty($CFG->slasharguments)) {
671                 $slashargs = '';
672                 if (!$svg) {
673                     // We add a simple /_s to the start of the path.
674                     // The underscore is used to ensure that it isn't a valid theme name.
675                     $slashargs .= '/_s'.$slashargs;
676                 }
677                 $slashargs .= '/'.$this->name.'/'.$rev.'/all';
678                 if ($separate) {
679                     $slashargs .= '/chunk0';
680                 }
681                 $url->set_slashargument($slashargs, 'noparam', true);
682             } else {
683                 $params = array('theme' => $this->name,'rev' => $rev, 'type' => 'all');
684                 if (!$svg) {
685                     // We add an SVG param so that we know not to serve SVG images.
686                     // We do this because all modern browsers support SVG and this param will one day be removed.
687                     $params['svg'] = '0';
688                 }
689                 if ($separate) {
690                     $params['chunk'] = '0';
691                 }
692                 $url->params($params);
693             }
694             $urls[] = $url;
696         } else {
697             // find out the current CSS and cache it now for 5 seconds
698             // the point is to construct the CSS only once and pass it through the
699             // dataroot to the script that actually serves the sheets
700             if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
701                 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
702             }
703             $candidatedir = "$CFG->cachedir/theme/$this->name";
704             if ($svg) {
705                 $candidatesheet = "$candidatedir/designer.ser";
706             } else {
707                 $candidatesheet = "$candidatedir/designer_nosvg.ser";
708             }
709             $rebuild = true;
710             if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
711                 if ($css = file_get_contents($candidatesheet)) {
712                     $css = unserialize($css);
713                     if (is_array($css)) {
714                         $rebuild = false;
715                     }
716                 }
717             }
718             if ($rebuild) {
719                 // Prepare the CSS optimiser if it is to be used,
720                 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
721                 $optimiser = null;
722                 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
723                     require_once($CFG->dirroot.'/lib/csslib.php');
724                     $optimiser = new css_optimiser;
725                 }
726                 $css = $this->css_content($optimiser);
728                 // We do not want any errors here because this may fail easily because of the concurrent access.
729                 $prevabort = ignore_user_abort(true);
730                 check_dir_exists($candidatedir);
731                 $tempfile = tempnam($candidatedir, 'tmpdesigner');
732                 file_put_contents($tempfile, serialize($css));
733                 $reporting = error_reporting(0);
734                 chmod($tempfile, $CFG->filepermissions);
735                 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
736                 rename($tempfile, $candidatesheet);
737                 error_reporting($reporting);
738                 ignore_user_abort($prevabort);
739             }
741             $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
742             if (!$svg) {
743                 // We add an SVG param so that we know not to serve SVG images.
744                 // We do this because all modern browsers support SVG and this param will one day be removed.
745                 $baseurl->param('svg', '0');
746             }
747             if (core_useragent::check_ie_version('5')) {
748                 // lalala, IE does not allow more than 31 linked CSS files from main document
749                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
750                 foreach ($css['parents'] as $parent=>$sheets) {
751                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
752                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
753                 }
754                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
756             } else {
757                 foreach ($css['plugins'] as $plugin=>$unused) {
758                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
759                 }
760                 foreach ($css['parents'] as $parent=>$sheets) {
761                     foreach ($sheets as $sheet=>$unused2) {
762                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
763                     }
764                 }
765                 foreach ($css['theme'] as $sheet=>$unused) {
766                     $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme')); // sheet first in order to make long urls easier to read
767                 }
768             }
769         }
771         return $urls;
772     }
774     /**
775      * Returns an array of organised CSS files required for this output
776      *
777      * @return array
778      */
779     public function css_files() {
780         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
782         // get all plugin sheets
783         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
784         if ($excludes !== true) {
785             foreach (core_component::get_plugin_types() as $type=>$unused) {
786                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
787                     continue;
788                 }
789                 $plugins = core_component::get_plugin_list($type);
790                 foreach ($plugins as $plugin=>$fulldir) {
791                     if (!empty($excludes[$type]) and is_array($excludes[$type])
792                         and in_array($plugin, $excludes[$type])) {
793                         continue;
794                     }
796                     $plugincontent = '';
797                     $sheetfile = "$fulldir/styles.css";
798                     if (is_readable($sheetfile)) {
799                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
800                     }
801                     $sheetthemefile = "$fulldir/styles_{$this->name}.css";
802                     if (is_readable($sheetthemefile)) {
803                         $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
804                     }
805                     }
806                 }
807             }
809         // find out wanted parent sheets
810         $excludes = $this->resolve_excludes('parents_exclude_sheets');
811         if ($excludes !== true) {
812             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
813                 $parent = $parent_config->name;
814                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
815                     continue;
816                 }
817                 foreach ($parent_config->sheets as $sheet) {
818                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
819                         and in_array($sheet, $excludes[$parent])) {
820                         continue;
821                     }
822                     $sheetfile = "$parent_config->dir/style/$sheet.css";
823                     if (is_readable($sheetfile)) {
824                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
825                     }
826                 }
827             }
828         }
830         // current theme sheets
831         if (is_array($this->sheets)) {
832             foreach ($this->sheets as $sheet) {
833                 $sheetfile = "$this->dir/style/$sheet.css";
834                 if (is_readable($sheetfile)) {
835                     $cssfiles['theme'][$sheet] = $sheetfile;
836                 }
837             }
838         }
840         return $cssfiles;
841     }
843     /**
844      * Returns the content of the one huge CSS merged from all style sheets.
845      *
846      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
847      * @return string
848      */
849     public function css_content(css_optimiser $optimiser = null) {
850         $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
851         $css = $this->css_files_get_contents($files, array(), $optimiser);
852         return $css;
853     }
855     /**
856      * Given an array of file paths or a single file path loads the contents of
857      * the CSS file, processes it then returns it in the same structure it was given.
858      *
859      * Can be used recursively on the results of {@link css_files}
860      *
861      * @param array|string $file An array of file paths or a single file path
862      * @param array $keys An array of previous array keys [recursive addition]
863      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
864      * @return The converted array or the contents of the single file ($file type)
865      */
866     protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
867         global $CFG;
868         if (is_array($file)) {
869             // We use a separate array to keep everything in the exact same order.
870             $return = array();
871             foreach ($file as $key=>$f) {
872                 $return[clean_param($key, PARAM_SAFEDIR)] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
873             }
874             return $return;
875         } else {
876             $contents = file_get_contents($file);
877             $contents = $this->post_process($contents);
878             $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
879             $stats = '';
880             if (!is_null($optimiser)) {
881                 $contents = $optimiser->process($contents);
882                 if (!empty($CFG->cssoptimiserstats)) {
883                     $stats = $optimiser->output_stats_css();
884                 }
885             }
886             return $comment.$stats.$contents;
887         }
888     }
891     /**
892      * Generate a URL to the file that serves theme JavaScript files.
893      *
894      * If we determine that the theme has no relevant files, then we return
895      * early with a null value.
896      *
897      * @param bool $inhead true means head url, false means footer
898      * @return moodle_url|null
899      */
900     public function javascript_url($inhead) {
901         global $CFG;
903         $rev = theme_get_revision();
904         $params = array('theme'=>$this->name,'rev'=>$rev);
905         $params['type'] = $inhead ? 'head' : 'footer';
907         // Return early if there are no files to serve
908         if (count($this->javascript_files($params['type'])) === 0) {
909             return null;
910         }
912         if (!empty($CFG->slasharguments) and $rev > 0) {
913             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
914             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
915             return $url;
916         } else {
917             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
918         }
919     }
921     /**
922      * Get the URL's for the JavaScript files used by this theme.
923      * They won't be served directly, instead they'll be mediated through
924      * theme/javascript.php.
925      *
926      * @param string $type Either javascripts_footer, or javascripts
927      * @return array
928      */
929     public function javascript_files($type) {
930         if ($type === 'footer') {
931             $type = 'javascripts_footer';
932         } else {
933             $type = 'javascripts';
934         }
936         $js = array();
937         // find out wanted parent javascripts
938         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
939         if ($excludes !== true) {
940             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
941                 $parent = $parent_config->name;
942                 if (empty($parent_config->$type)) {
943                     continue;
944                 }
945                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
946                     continue;
947                 }
948                 foreach ($parent_config->$type as $javascript) {
949                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
950                         and in_array($javascript, $excludes[$parent])) {
951                         continue;
952                     }
953                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
954                     if (is_readable($javascriptfile)) {
955                         $js[] = $javascriptfile;
956                     }
957                 }
958             }
959         }
961         // current theme javascripts
962         if (is_array($this->$type)) {
963             foreach ($this->$type as $javascript) {
964                 $javascriptfile = "$this->dir/javascript/$javascript.js";
965                 if (is_readable($javascriptfile)) {
966                     $js[] = $javascriptfile;
967                 }
968             }
969         }
970         return $js;
971     }
973     /**
974      * Resolves an exclude setting to the themes setting is applicable or the
975      * setting of its closest parent.
976      *
977      * @param string $variable The name of the setting the exclude setting to resolve
978      * @param string $default
979      * @return mixed
980      */
981     protected function resolve_excludes($variable, $default = null) {
982         $setting = $default;
983         if (is_array($this->{$variable}) or $this->{$variable} === true) {
984             $setting = $this->{$variable};
985         } else {
986             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
987                 if (!isset($parent_config->{$variable})) {
988                     continue;
989                 }
990                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
991                     $setting = $parent_config->{$variable};
992                     break;
993                 }
994             }
995         }
996         return $setting;
997     }
999     /**
1000      * Returns the content of the one huge javascript file merged from all theme javascript files.
1001      *
1002      * @param bool $type
1003      * @return string
1004      */
1005     public function javascript_content($type) {
1006         $jsfiles = $this->javascript_files($type);
1007         $js = '';
1008         foreach ($jsfiles as $jsfile) {
1009             $js .= file_get_contents($jsfile)."\n";
1010         }
1011         return $js;
1012     }
1014     /**
1015      * Post processes CSS.
1016      *
1017      * This method post processes all of the CSS before it is served for this theme.
1018      * This is done so that things such as image URL's can be swapped in and to
1019      * run any specific CSS post process method the theme has requested.
1020      * This allows themes to use CSS settings.
1021      *
1022      * @param string $css The CSS to process.
1023      * @return string The processed CSS.
1024      */
1025     public function post_process($css) {
1026         // now resolve all image locations
1027         if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1028             $replaced = array();
1029             foreach ($matches as $match) {
1030                 if (isset($replaced[$match[0]])) {
1031                     continue;
1032                 }
1033                 $replaced[$match[0]] = true;
1034                 $imagename = $match[2];
1035                 $component = rtrim($match[1], '|');
1036                 $imageurl = $this->pix_url($imagename, $component)->out(false);
1037                  // we do not need full url because the image.php is always in the same dir
1038                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
1039                 $css = str_replace($match[0], $imageurl, $css);
1040             }
1041         }
1043         // Now resolve all font locations.
1044         if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
1045             $replaced = array();
1046             foreach ($matches as $match) {
1047                 if (isset($replaced[$match[0]])) {
1048                     continue;
1049                 }
1050                 $replaced[$match[0]] = true;
1051                 $fontname = $match[2];
1052                 $component = rtrim($match[1], '|');
1053                 $fonturl = $this->font_url($fontname, $component)->out(false);
1054                 // We do not need full url because the font.php is always in the same dir.
1055                 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1056                 $css = str_replace($match[0], $fonturl, $css);
1057             }
1058         }
1060         // now resolve all theme settings or do any other postprocessing
1061         $csspostprocess = $this->csspostprocess;
1062         if (function_exists($csspostprocess)) {
1063             $css = $csspostprocess($css, $this);
1064         }
1066         return $css;
1067     }
1069     /**
1070      * Return the URL for an image
1071      *
1072      * @param string $imagename the name of the icon.
1073      * @param string $component specification of one plugin like in get_string()
1074      * @return moodle_url
1075      */
1076     public function pix_url($imagename, $component) {
1077         global $CFG;
1079         $params = array('theme'=>$this->name);
1080         $svg = $this->use_svg_icons();
1082         if (empty($component) or $component === 'moodle' or $component === 'core') {
1083             $params['component'] = 'core';
1084         } else {
1085             $params['component'] = $component;
1086         }
1088         $rev = theme_get_revision();
1089         if ($rev != -1) {
1090             $params['rev'] = $rev;
1091         }
1093         $params['image'] = $imagename;
1095         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1096         if (!empty($CFG->slasharguments) and $rev > 0) {
1097             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1098             if (!$svg) {
1099                 // We add a simple /_s to the start of the path.
1100                 // The underscore is used to ensure that it isn't a valid theme name.
1101                 $path = '/_s'.$path;
1102             }
1103             $url->set_slashargument($path, 'noparam', true);
1104         } else {
1105             if (!$svg) {
1106                 // We add an SVG param so that we know not to serve SVG images.
1107                 // We do this because all modern browsers support SVG and this param will one day be removed.
1108                 $params['svg'] = '0';
1109             }
1110             $url->params($params);
1111         }
1113         return $url;
1114     }
1116     /**
1117      * Return the URL for a font
1118      *
1119      * @param string $font the name of the font (including extension).
1120      * @param string $component specification of one plugin like in get_string()
1121      * @return moodle_url
1122      */
1123     public function font_url($font, $component) {
1124         global $CFG;
1126         $params = array('theme'=>$this->name);
1128         if (empty($component) or $component === 'moodle' or $component === 'core') {
1129             $params['component'] = 'core';
1130         } else {
1131             $params['component'] = $component;
1132         }
1134         $rev = theme_get_revision();
1135         if ($rev != -1) {
1136             $params['rev'] = $rev;
1137         }
1139         $params['font'] = $font;
1141         $url = new moodle_url("$CFG->httpswwwroot/theme/font.php");
1142         if (!empty($CFG->slasharguments) and $rev > 0) {
1143             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
1144             $url->set_slashargument($path, 'noparam', true);
1145         } else {
1146             $url->params($params);
1147         }
1149         return $url;
1150     }
1152     /**
1153      * Returns URL to the stored file via pluginfile.php.
1154      *
1155      * Note the theme must also implement pluginfile.php handler,
1156      * theme revision is used instead of the itemid.
1157      *
1158      * @param string $setting
1159      * @param string $filearea
1160      * @return string protocol relative URL or null if not present
1161      */
1162     public function setting_file_url($setting, $filearea) {
1163         global $CFG;
1165         if (empty($this->settings->$setting)) {
1166             return null;
1167         }
1169         $component = 'theme_'.$this->name;
1170         $itemid = theme_get_revision();
1171         $filepath = $this->settings->$setting;
1172         $syscontext = context_system::instance();
1174         $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
1176         // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
1177         // Note: unfortunately moodle_url does not support //urls yet.
1179         $url = preg_replace('|^https?://|i', '//', $url->out(false));
1181         return $url;
1182     }
1184     /**
1185      * Serve the theme setting file.
1186      *
1187      * @param string $filearea
1188      * @param array $args
1189      * @param bool $forcedownload
1190      * @param array $options
1191      * @return bool may terminate if file not found or donotdie not specified
1192      */
1193     public function setting_file_serve($filearea, $args, $forcedownload, $options) {
1194         global $CFG;
1195         require_once("$CFG->libdir/filelib.php");
1197         $syscontext = context_system::instance();
1198         $component = 'theme_'.$this->name;
1200         $revision = array_shift($args);
1201         if ($revision < 0) {
1202             $lifetime = 0;
1203         } else {
1204             $lifetime = 60*60*24*60;
1205         }
1207         $fs = get_file_storage();
1208         $relativepath = implode('/', $args);
1210         $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
1211         $fullpath = rtrim($fullpath, '/');
1212         if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
1213             send_stored_file($file, $lifetime, 0, $forcedownload, $options);
1214             return true;
1215         } else {
1216             send_file_not_found();
1217         }
1218     }
1220     /**
1221      * Resolves the real image location.
1222      *
1223      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1224      * and we need a way in which to turn it off.
1225      * By default SVG won't be used unless asked for. This is done for two reasons:
1226      *   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
1227      *      browser supports SVG.
1228      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1229      *      by the user due to security concerns.
1230      *
1231      * @param string $image name of image, may contain relative path
1232      * @param string $component
1233      * @param bool $svg If set to true SVG images will also be looked for.
1234      * @return string full file path
1235      */
1236     public function resolve_image_location($image, $component, $svg = false) {
1237         global $CFG;
1239         if (!is_bool($svg)) {
1240             // If $svg isn't a bool then we need to decide for ourselves.
1241             $svg = $this->use_svg_icons();
1242         }
1244         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1245             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1246                 return $imagefile;
1247             }
1248             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1249                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1250                     return $imagefile;
1251                 }
1252             }
1253             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1254                 return $imagefile;
1255             }
1256             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1257                 return $imagefile;
1258             }
1259             return null;
1261         } else if ($component === 'theme') { //exception
1262             if ($image === 'favicon') {
1263                 return "$this->dir/pix/favicon.ico";
1264             }
1265             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1266                 return $imagefile;
1267             }
1268             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1269                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1270                     return $imagefile;
1271                 }
1272             }
1273             return null;
1275         } else {
1276             if (strpos($component, '_') === false) {
1277                 $component = 'mod_'.$component;
1278             }
1279             list($type, $plugin) = explode('_', $component, 2);
1281             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1282                 return $imagefile;
1283             }
1284             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1285                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1286                     return $imagefile;
1287                 }
1288             }
1289             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1290                 return $imagefile;
1291             }
1292             $dir = core_component::get_plugin_directory($type, $plugin);
1293             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1294                 return $imagefile;
1295             }
1296             return null;
1297         }
1298     }
1300     /**
1301      * Resolves the real font location.
1302      *
1303      * @param string $font name of font file
1304      * @param string $component
1305      * @return string full file path
1306      */
1307     public function resolve_font_location($font, $component) {
1308         global $CFG;
1310         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1311             if (file_exists("$this->dir/fonts_core/$font")) {
1312                 return "$this->dir/fonts_core/$font";
1313             }
1314             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1315                 if (file_exists("$parent_config->dir/fonts_core/$font")) {
1316                     return "$parent_config->dir/fonts_core/$font";
1317                 }
1318             }
1319             if (file_exists("$CFG->dataroot/fonts/$font")) {
1320                 return "$CFG->dataroot/fonts/$font";
1321             }
1322             if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
1323                 return "$CFG->dirroot/lib/fonts/$font";
1324             }
1325             return null;
1327         } else if ($component === 'theme') { // Exception.
1328             if (file_exists("$this->dir/fonts/$font")) {
1329                 return "$this->dir/fonts/$font";
1330             }
1331             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1332                 if (file_exists("$parent_config->dir/fonts/$font")) {
1333                     return "$parent_config->dir/fonts/$font";
1334                 }
1335             }
1336             return null;
1338         } else {
1339             if (strpos($component, '_') === false) {
1340                 $component = 'mod_'.$component;
1341             }
1342             list($type, $plugin) = explode('_', $component, 2);
1344             if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
1345                 return "$this->dir/fonts_plugins/$type/$plugin/$font";
1346             }
1347             foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
1348                 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
1349                     return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
1350                 }
1351             }
1352             if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
1353                 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
1354             }
1355             $dir = core_component::get_plugin_directory($type, $plugin);
1356             if (file_exists("$dir/fonts/$font")) {
1357                 return "$dir/fonts/$font";
1358             }
1359             return null;
1360         }
1361     }
1363     /**
1364      * Return true if we should look for SVG images as well.
1365      *
1366      * @staticvar bool $svg
1367      * @return bool
1368      */
1369     public function use_svg_icons() {
1370         global $CFG;
1371         if ($this->usesvg === null) {
1373             if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1374                 $this->usesvg = core_useragent::supports_svg();
1375             } else {
1376                 // Force them on/off depending upon the setting.
1377                 $this->usesvg = $CFG->svgicons;
1378             }
1379         }
1380         return $this->usesvg;
1381     }
1383     /**
1384      * Forces the usesvg setting to either true or false, avoiding any decision making.
1385      *
1386      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1387      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1388      *
1389      * @param bool $setting True to force the use of svg when available, null otherwise.
1390      */
1391     public function force_svg_use($setting) {
1392         $this->usesvg = (bool)$setting;
1393     }
1395     /**
1396      * Checks if file with any image extension exists.
1397      *
1398      * The order to these images was adjusted prior to the release of 2.4
1399      * At that point the were the following image counts in Moodle core:
1400      *
1401      *     - png = 667 in pix dirs (1499 total)
1402      *     - gif = 385 in pix dirs (606 total)
1403      *     - jpg = 62  in pix dirs (74 total)
1404      *     - jpeg = 0  in pix dirs (1 total)
1405      *
1406      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1407      *
1408      * @param string $filepath
1409      * @param bool $svg If set to true SVG images will also be looked for.
1410      * @return string image name with extension
1411      */
1412     private static function image_exists($filepath, $svg = false) {
1413         if ($svg && file_exists("$filepath.svg")) {
1414             return "$filepath.svg";
1415         } else  if (file_exists("$filepath.png")) {
1416             return "$filepath.png";
1417         } else if (file_exists("$filepath.gif")) {
1418             return "$filepath.gif";
1419         } else  if (file_exists("$filepath.jpg")) {
1420             return "$filepath.jpg";
1421         } else  if (file_exists("$filepath.jpeg")) {
1422             return "$filepath.jpeg";
1423         } else {
1424             return false;
1425         }
1426     }
1428     /**
1429      * Loads the theme config from config.php file.
1430      *
1431      * @param string $themename
1432      * @param stdClass $settings from config_plugins table
1433      * @return stdClass The theme configuration
1434      */
1435     private static function find_theme_config($themename, $settings) {
1436         // We have to use the variable name $THEME (upper case) because that
1437         // is what is used in theme config.php files.
1439         if (!$dir = theme_config::find_theme_location($themename)) {
1440             return null;
1441         }
1443         $THEME = new stdClass();
1444         $THEME->name     = $themename;
1445         $THEME->dir      = $dir;
1446         $THEME->settings = $settings;
1448         global $CFG; // just in case somebody tries to use $CFG in theme config
1449         include("$THEME->dir/config.php");
1451         // verify the theme configuration is OK
1452         if (!is_array($THEME->parents)) {
1453             // parents option is mandatory now
1454             return null;
1455         }
1457         return $THEME;
1458     }
1460     /**
1461      * Finds the theme location and verifies the theme has all needed files
1462      * and is not obsoleted.
1463      *
1464      * @param string $themename
1465      * @return string full dir path or null if not found
1466      */
1467     private static function find_theme_location($themename) {
1468         global $CFG;
1470         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1471             $dir = "$CFG->dirroot/theme/$themename";
1473         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1474             $dir = "$CFG->themedir/$themename";
1476         } else {
1477             return null;
1478         }
1480         if (file_exists("$dir/styles.php")) {
1481             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1482             return null;
1483         }
1485         return $dir;
1486     }
1488     /**
1489      * Get the renderer for a part of Moodle for this theme.
1490      *
1491      * @param moodle_page $page the page we are rendering
1492      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
1493      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
1494      * @param string $target one of rendering target constants
1495      * @return renderer_base the requested renderer.
1496      */
1497     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
1498         if (is_null($this->rf)) {
1499             $classname = $this->rendererfactory;
1500             $this->rf = new $classname($this);
1501         }
1503         return $this->rf->get_renderer($page, $component, $subtype, $target);
1504     }
1506     /**
1507      * Get the information from {@link $layouts} for this type of page.
1508      *
1509      * @param string $pagelayout the the page layout name.
1510      * @return array the appropriate part of {@link $layouts}.
1511      */
1512     protected function layout_info_for_page($pagelayout) {
1513         if (array_key_exists($pagelayout, $this->layouts)) {
1514             return $this->layouts[$pagelayout];
1515         } else {
1516             debugging('Invalid page layout specified: ' . $pagelayout);
1517             return $this->layouts['standard'];
1518         }
1519     }
1521     /**
1522      * Given the settings of this theme, and the page pagelayout, return the
1523      * full path of the page layout file to use.
1524      *
1525      * Used by {@link core_renderer::header()}.
1526      *
1527      * @param string $pagelayout the the page layout name.
1528      * @return string Full path to the lyout file to use
1529      */
1530     public function layout_file($pagelayout) {
1531         global $CFG;
1533         $layoutinfo = $this->layout_info_for_page($pagelayout);
1534         $layoutfile = $layoutinfo['file'];
1536         if (array_key_exists('theme', $layoutinfo)) {
1537             $themes = array($layoutinfo['theme']);
1538         } else {
1539             $themes = array_merge(array($this->name),$this->parents);
1540         }
1542         foreach ($themes as $theme) {
1543             if ($dir = $this->find_theme_location($theme)) {
1544                 $path = "$dir/layout/$layoutfile";
1546                 // Check the template exists, return general base theme template if not.
1547                 if (is_readable($path)) {
1548                     return $path;
1549                 }
1550             }
1551         }
1553         debugging('Can not find layout file for: ' . $pagelayout);
1554         // fallback to standard normal layout
1555         return "$CFG->dirroot/theme/base/layout/general.php";
1556     }
1558     /**
1559      * Returns auxiliary page layout options specified in layout configuration array.
1560      *
1561      * @param string $pagelayout
1562      * @return array
1563      */
1564     public function pagelayout_options($pagelayout) {
1565         $info = $this->layout_info_for_page($pagelayout);
1566         if (!empty($info['options'])) {
1567             return $info['options'];
1568         }
1569         return array();
1570     }
1572     /**
1573      * Inform a block_manager about the block regions this theme wants on this
1574      * page layout.
1575      *
1576      * @param string $pagelayout the general type of the page.
1577      * @param block_manager $blockmanager the block_manger to set up.
1578      */
1579     public function setup_blocks($pagelayout, $blockmanager) {
1580         $layoutinfo = $this->layout_info_for_page($pagelayout);
1581         if (!empty($layoutinfo['regions'])) {
1582             $blockmanager->add_regions($layoutinfo['regions']);
1583             $blockmanager->set_default_region($layoutinfo['defaultregion']);
1584         }
1585     }
1587     /**
1588      * Gets the visible name for the requested block region.
1589      *
1590      * @param string $region The region name to get
1591      * @param string $theme The theme the region belongs to (may come from the parent theme)
1592      * @return string
1593      */
1594     protected function get_region_name($region, $theme) {
1595         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1596         // A name exists in this theme, so use it
1597         if (substr($regionstring, 0, 1) != '[') {
1598             return $regionstring;
1599         }
1601         // Otherwise, try to find one elsewhere
1602         // Check parents, if any
1603         foreach ($this->parents as $parentthemename) {
1604             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1605             if (substr($regionstring, 0, 1) != '[') {
1606                 return $regionstring;
1607             }
1608         }
1610         // Last resort, try the base theme for names
1611         return get_string('region-' . $region, 'theme_base');
1612     }
1614     /**
1615      * Get the list of all block regions known to this theme in all templates.
1616      *
1617      * @return array internal region name => human readable name.
1618      */
1619     public function get_all_block_regions() {
1620         $regions = array();
1621         foreach ($this->layouts as $layoutinfo) {
1622             foreach ($layoutinfo['regions'] as $region) {
1623                 $regions[$region] = $this->get_region_name($region, $this->name);
1624             }
1625         }
1626         return $regions;
1627     }
1629     /**
1630      * Returns the human readable name of the theme
1631      *
1632      * @return string
1633      */
1634     public function get_theme_name() {
1635         return get_string('pluginname', 'theme_'.$this->name);
1636     }
1639 /**
1640  * This class keeps track of which HTML tags are currently open.
1641  *
1642  * This makes it much easier to always generate well formed XHTML output, even
1643  * if execution terminates abruptly. Any time you output some opening HTML
1644  * without the matching closing HTML, you should push the necessary close tags
1645  * onto the stack.
1646  *
1647  * @copyright 2009 Tim Hunt
1648  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1649  * @since Moodle 2.0
1650  * @package core
1651  * @category output
1652  */
1653 class xhtml_container_stack {
1655     /**
1656      * @var array Stores the list of open containers.
1657      */
1658     protected $opencontainers = array();
1660     /**
1661      * @var array In developer debug mode, stores a stack trace of all opens and
1662      * closes, so we can output helpful error messages when there is a mismatch.
1663      */
1664     protected $log = array();
1666     /**
1667      * @var boolean Store whether we are developer debug mode. We need this in
1668      * several places including in the destructor where we may not have access to $CFG.
1669      */
1670     protected $isdebugging;
1672     /**
1673      * Constructor
1674      */
1675     public function __construct() {
1676         global $CFG;
1677         $this->isdebugging = $CFG->debugdeveloper;
1678     }
1680     /**
1681      * Push the close HTML for a recently opened container onto the stack.
1682      *
1683      * @param string $type The type of container. This is checked when {@link pop()}
1684      *      is called and must match, otherwise a developer debug warning is output.
1685      * @param string $closehtml The HTML required to close the container.
1686      */
1687     public function push($type, $closehtml) {
1688         $container = new stdClass;
1689         $container->type = $type;
1690         $container->closehtml = $closehtml;
1691         if ($this->isdebugging) {
1692             $this->log('Open', $type);
1693         }
1694         array_push($this->opencontainers, $container);
1695     }
1697     /**
1698      * Pop the HTML for the next closing container from the stack. The $type
1699      * must match the type passed when the container was opened, otherwise a
1700      * warning will be output.
1701      *
1702      * @param string $type The type of container.
1703      * @return string the HTML required to close the container.
1704      */
1705     public function pop($type) {
1706         if (empty($this->opencontainers)) {
1707             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1708                     $this->output_log(), DEBUG_DEVELOPER);
1709             return;
1710         }
1712         $container = array_pop($this->opencontainers);
1713         if ($container->type != $type) {
1714             debugging('<p>The type of container to be closed (' . $container->type .
1715                     ') does not match the type of the next open container (' . $type .
1716                     '). This suggests there is a nesting problem.</p>' .
1717                     $this->output_log(), DEBUG_DEVELOPER);
1718         }
1719         if ($this->isdebugging) {
1720             $this->log('Close', $type);
1721         }
1722         return $container->closehtml;
1723     }
1725     /**
1726      * Close all but the last open container. This is useful in places like error
1727      * handling, where you want to close all the open containers (apart from <body>)
1728      * before outputting the error message.
1729      *
1730      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1731      *      developer debug warning if it isn't.
1732      * @return string the HTML required to close any open containers inside <body>.
1733      */
1734     public function pop_all_but_last($shouldbenone = false) {
1735         if ($shouldbenone && count($this->opencontainers) != 1) {
1736             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1737                     $this->output_log(), DEBUG_DEVELOPER);
1738         }
1739         $output = '';
1740         while (count($this->opencontainers) > 1) {
1741             $container = array_pop($this->opencontainers);
1742             $output .= $container->closehtml;
1743         }
1744         return $output;
1745     }
1747     /**
1748      * You can call this function if you want to throw away an instance of this
1749      * class without properly emptying the stack (for example, in a unit test).
1750      * Calling this method stops the destruct method from outputting a developer
1751      * debug warning. After calling this method, the instance can no longer be used.
1752      */
1753     public function discard() {
1754         $this->opencontainers = null;
1755     }
1757     /**
1758      * Adds an entry to the log.
1759      *
1760      * @param string $action The name of the action
1761      * @param string $type The type of action
1762      */
1763     protected function log($action, $type) {
1764         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1765                 format_backtrace(debug_backtrace()) . '</li>';
1766     }
1768     /**
1769      * Outputs the log's contents as a HTML list.
1770      *
1771      * @return string HTML list of the log
1772      */
1773     protected function output_log() {
1774         return '<ul>' . implode("\n", $this->log) . '</ul>';
1775     }