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