Merge branch 'wip-MDL-38000-m25' of git://github.com/samhemelryk/moodle
[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;
47     require_once("$CFG->libdir/filelib.php");
49     $next = time();
50     if (isset($CFG->themerev) and $next <= $CFG->themerev and $CFG->themerev - $next < 60*60) {
51         // This resolves problems when reset is requested repeatedly within 1s,
52         // the < 1h condition prevents accidental switching to future dates
53         // because we might not recover from it.
54         $next = $CFG->themerev+1;
55     }
57     set_config('themerev', $next); // time is unique even when you reset/switch database
58     fulldelete("$CFG->cachedir/theme");
59 }
61 /**
62  * Enable or disable theme designer mode.
63  *
64  * @param bool $state
65  */
66 function theme_set_designer_mod($state) {
67     theme_reset_all_caches();
68     set_config('themedesignermode', (int)!empty($state));
69 }
71 /**
72  * Returns current theme revision number.
73  *
74  * @return int
75  */
76 function theme_get_revision() {
77     global $CFG;
79     if (empty($CFG->themedesignermode)) {
80         if (empty($CFG->themerev)) {
81             return -1;
82         } else {
83             return $CFG->themerev;
84         }
86     } else {
87         return -1;
88     }
89 }
92 /**
93  * This class represents the configuration variables of a Moodle theme.
94  *
95  * All the variables with access: public below (with a few exceptions that are marked)
96  * are the properties you can set in your themes config.php file.
97  *
98  * There are also some methods and protected variables that are part of the inner
99  * workings of Moodle's themes system. If you are just editing a themes config.php
100  * file, you can just ignore those, and the following information for developers.
101  *
102  * Normally, to create an instance of this class, you should use the
103  * {@link theme_config::load()} factory method to load a themes config.php file.
104  * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
105  * will create one for you, accessible as $PAGE->theme.
106  *
107  * @copyright 2009 Tim Hunt
108  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
109  * @since Moodle 2.0
110  * @package core
111  * @category output
112  */
113 class theme_config {
115     /**
116      * @var string Default theme, used when requested theme not found.
117      */
118     const DEFAULT_THEME = 'standard';
120     /**
121      * @var array You can base your theme on other themes by linking to the other theme as
122      * parents. This lets you use the CSS and layouts from the other themes
123      * (see {@link theme_config::$layouts}).
124      * That makes it easy to create a new theme that is similar to another one
125      * but with a few changes. In this themes CSS you only need to override
126      * those rules you want to change.
127      */
128     public $parents;
130     /**
131      * @var array The names of all the stylesheets from this theme that you would
132      * like included, in order. Give the names of the files without .css.
133      */
134     public $sheets = array();
136     /**
137      * @var array The names of all the stylesheets from parents that should be excluded.
138      * true value may be used to specify all parents or all themes from one parent.
139      * If no value specified value from parent theme used.
140      */
141     public $parents_exclude_sheets = null;
143     /**
144      * @var array List of plugin sheets to be excluded.
145      * If no value specified value from parent theme used.
146      */
147     public $plugins_exclude_sheets = null;
149     /**
150      * @var array List of style sheets that are included in the text editor bodies.
151      * Sheets from parent themes are used automatically and can not be excluded.
152      */
153     public $editor_sheets = array();
155     /**
156      * @var array The names of all the javascript files this theme that you would
157      * like included from head, in order. Give the names of the files without .js.
158      */
159     public $javascripts = array();
161     /**
162      * @var array The names of all the javascript files this theme that you would
163      * like included from footer, in order. Give the names of the files without .js.
164      */
165     public $javascripts_footer = array();
167     /**
168      * @var array The names of all the javascript files from parents that should
169      * be excluded. true value may be used to specify all parents or all themes
170      * from one parent.
171      * If no value specified value from parent theme used.
172      */
173     public $parents_exclude_javascripts = null;
175     /**
176      * @var array Which file to use for each page layout.
177      *
178      * This is an array of arrays. The keys of the outer array are the different layouts.
179      * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
180      * 'popup', 'form', .... The most reliable way to get a complete list is to look at
181      * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
182      * That file also has a good example of how to set this setting.
183      *
184      * For each layout, the value in the outer array is an array that describes
185      * how you want that type of page to look. For example
186      * <pre>
187      *   $THEME->layouts = array(
188      *       // Most pages - if we encounter an unknown or a missing page type, this one is used.
189      *       'standard' => array(
190      *           'theme' = 'mytheme',
191      *           'file' => 'normal.php',
192      *           'regions' => array('side-pre', 'side-post'),
193      *           'defaultregion' => 'side-post'
194      *       ),
195      *       // The site home page.
196      *       'home' => array(
197      *           'theme' = 'mytheme',
198      *           'file' => 'home.php',
199      *           'regions' => array('side-pre', 'side-post'),
200      *           'defaultregion' => 'side-post'
201      *       ),
202      *       // ...
203      *   );
204      * </pre>
205      *
206      * 'theme' name of the theme where is the layout located
207      * 'file' is the layout file to use for this type of page.
208      * layout files are stored in layout subfolder
209      * 'regions' This lists the regions on the page where blocks may appear. For
210      * each region you list here, your layout file must include a call to
211      * <pre>
212      *   echo $OUTPUT->blocks_for_region($regionname);
213      * </pre>
214      * or equivalent so that the blocks are actually visible.
215      *
216      * 'defaultregion' If the list of regions is non-empty, then you must pick
217      * one of the one of them as 'default'. This has two meanings. First, this is
218      * where new blocks are added. Second, if there are any blocks associated with
219      * the page, but in non-existent regions, they appear here. (Imaging, for example,
220      * that someone added blocks using a different theme that used different region
221      * names, and then switched to this theme.)
222      */
223     public $layouts = array();
225     /**
226      * @var string Name of the renderer factory class to use. Must implement the
227      * {@link renderer_factory} interface.
228      *
229      * This is an advanced feature. Moodle output is generated by 'renderers',
230      * you can customise the HTML that is output by writing custom renderers,
231      * and then you need to specify 'renderer factory' so that Moodle can find
232      * your renderers.
233      *
234      * There are some renderer factories supplied with Moodle. Please follow these
235      * links to see what they do.
236      * <ul>
237      * <li>{@link standard_renderer_factory} - the default.</li>
238      * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
239      *      your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
240      * </ul>
241      */
242     public $rendererfactory = 'standard_renderer_factory';
244     /**
245      * @var string Function to do custom CSS post-processing.
246      *
247      * This is an advanced feature. If you want to do custom post-processing on the
248      * CSS before it is output (for example, to replace certain variable names
249      * with particular values) you can give the name of a function here.
250      */
251     public $csspostprocess = null;
253     /**
254      * @var string Accessibility: Right arrow-like character is
255      * used in the breadcrumb trail, course navigation menu
256      * (previous/next activity), calendar, and search forum block.
257      * If the theme does not set characters, appropriate defaults
258      * are set automatically. Please DO NOT
259      * use &lt; &gt; &raquo; - these are confusing for blind users.
260      */
261     public $rarrow = null;
263     /**
264      * @var string Accessibility: Right arrow-like character is
265      * used in the breadcrumb trail, course navigation menu
266      * (previous/next activity), calendar, and search forum block.
267      * If the theme does not set characters, appropriate defaults
268      * are set automatically. Please DO NOT
269      * use &lt; &gt; &raquo; - these are confusing for blind users.
270      */
271     public $larrow = null;
273     /**
274      * @var bool Some themes may want to disable ajax course editing.
275      */
276     public $enablecourseajax = true;
278     /**
279      * @var string Determines served document types
280      *  - 'html5' the only officially supported doctype in Moodle
281      *  - 'xhtml5' may be used in development for validation (not intended for production servers!)
282      *  - 'xhtml' XHTML 1.0 Strict for legacy themes only
283      */
284     public $doctype = 'html5';
286     //==Following properties are not configurable from theme config.php==
288     /**
289      * @var string The name of this theme. Set automatically when this theme is
290      * loaded. This can not be set in theme config.php
291      */
292     public $name;
294     /**
295      * @var string The folder where this themes files are stored. This is set
296      * automatically. This can not be set in theme config.php
297      */
298     public $dir;
300     /**
301      * @var stdClass Theme settings stored in config_plugins table.
302      * This can not be set in theme config.php
303      */
304     public $setting = null;
306     /**
307      * @var bool If set to true and the theme enables the dock then  blocks will be able
308      * to be moved to the special dock
309      */
310     public $enable_dock = false;
312     /**
313      * @var bool If set to true then this theme will not be shown in the theme selector unless
314      * theme designer mode is turned on.
315      */
316     public $hidefromselector = false;
318     /**
319      * @var renderer_factory Instance of the renderer_factory implementation
320      * we are using. Implementation detail.
321      */
322     protected $rf = null;
324     /**
325      * @var array List of parent config objects.
326      **/
327     protected $parent_configs = array();
329     /**
330      * @var bool If set to true then the theme is safe to run through the optimiser (if it is enabled)
331      * If set to false then we know either the theme has already been optimised and the CSS optimiser is not needed
332      * or the theme is not compatible with the CSS optimiser. In both cases even if enabled the CSS optimiser will not
333      * be used with this theme if set to false.
334      */
335     public $supportscssoptimisation = true;
337     /**
338      * Used to determine whether we can serve SVG images or not.
339      * @var bool
340      */
341     private $usesvg = null;
343     /**
344      * Load the config.php file for a particular theme, and return an instance
345      * of this class. (That is, this is a factory method.)
346      *
347      * @param string $themename the name of the theme.
348      * @return theme_config an instance of this class.
349      */
350     public static function load($themename) {
351         global $CFG;
353         // load theme settings from db
354         try {
355             $settings = get_config('theme_'.$themename);
356         } catch (dml_exception $e) {
357             // most probably moodle tables not created yet
358             $settings = new stdClass();
359         }
361         if ($config = theme_config::find_theme_config($themename, $settings)) {
362             return new theme_config($config);
364         } else if ($themename == theme_config::DEFAULT_THEME) {
365             throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
367         } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
368             return new theme_config($config);
370         } else {
371             // bad luck, the requested theme has some problems - admin see details in theme config
372             return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
373         }
374     }
376     /**
377      * Theme diagnostic code. It is very problematic to send debug output
378      * to the actual CSS file, instead this functions is supposed to
379      * diagnose given theme and highlights all potential problems.
380      * This information should be available from the theme selection page
381      * or some other debug page for theme designers.
382      *
383      * @param string $themename
384      * @return array description of problems
385      */
386     public static function diagnose($themename) {
387         //TODO: MDL-21108
388         return array();
389     }
391     /**
392      * Private constructor, can be called only from the factory method.
393      * @param stdClass $config
394      */
395     private function __construct($config) {
396         global $CFG; //needed for included lib.php files
398         $this->settings = $config->settings;
399         $this->name     = $config->name;
400         $this->dir      = $config->dir;
402         if ($this->name != 'base') {
403             $baseconfig = theme_config::find_theme_config('base', $this->settings);
404         } else {
405             $baseconfig = $config;
406         }
408         $configurable = array('parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'javascripts', 'javascripts_footer',
409                               'parents_exclude_javascripts', 'layouts', 'enable_dock', 'enablecourseajax', 'supportscssoptimisation',
410                               'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'hidefromselector', 'doctype');
412         foreach ($config as $key=>$value) {
413             if (in_array($key, $configurable)) {
414                 $this->$key = $value;
415             }
416         }
418         // verify all parents and load configs and renderers
419         foreach ($this->parents as $parent) {
420             if ($parent == 'base') {
421                 $parent_config = $baseconfig;
422             } else if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
423                 // this is not good - better exclude faulty parents
424                 continue;
425             }
426             $libfile = $parent_config->dir.'/lib.php';
427             if (is_readable($libfile)) {
428                 // theme may store various function here
429                 include_once($libfile);
430             }
431             $renderersfile = $parent_config->dir.'/renderers.php';
432             if (is_readable($renderersfile)) {
433                 // may contain core and plugin renderers and renderer factory
434                 include_once($renderersfile);
435             }
436             $this->parent_configs[$parent] = $parent_config;
437             $rendererfile = $parent_config->dir.'/renderers.php';
438             if (is_readable($rendererfile)) {
439                  // may contain core and plugin renderers and renderer factory
440                 include_once($rendererfile);
441             }
442         }
443         $libfile = $this->dir.'/lib.php';
444         if (is_readable($libfile)) {
445             // theme may store various function here
446             include_once($libfile);
447         }
448         $rendererfile = $this->dir.'/renderers.php';
449         if (is_readable($rendererfile)) {
450             // may contain core and plugin renderers and renderer factory
451             include_once($rendererfile);
452         } else {
453             // check if renderers.php file is missnamed renderer.php
454             if (is_readable($this->dir.'/renderer.php')) {
455                 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
456                     See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
457             }
458         }
460         // cascade all layouts properly
461         foreach ($baseconfig->layouts as $layout=>$value) {
462             if (!isset($this->layouts[$layout])) {
463                 foreach ($this->parent_configs as $parent_config) {
464                     if (isset($parent_config->layouts[$layout])) {
465                         $this->layouts[$layout] = $parent_config->layouts[$layout];
466                         continue 2;
467                     }
468                 }
469                 $this->layouts[$layout] = $value;
470             }
471         }
473         //fix arrows if needed
474         $this->check_theme_arrows();
475     }
477     /**
478      * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
479      * If not it applies sensible defaults.
480      *
481      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
482      * search forum block, etc. Important: these are 'silent' in a screen-reader
483      * (unlike &gt; &raquo;), and must be accompanied by text.
484      */
485     private function check_theme_arrows() {
486         if (!isset($this->rarrow) and !isset($this->larrow)) {
487             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
488             // Also OK in Win 9x/2K/IE 5.x
489             $this->rarrow = '&#x25BA;';
490             $this->larrow = '&#x25C4;';
491             if (empty($_SERVER['HTTP_USER_AGENT'])) {
492                 $uagent = '';
493             } else {
494                 $uagent = $_SERVER['HTTP_USER_AGENT'];
495             }
496             if (false !== strpos($uagent, 'Opera')
497                 || false !== strpos($uagent, 'Mac')) {
498                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
499                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
500                 $this->rarrow = '&#x25B6;';
501                 $this->larrow = '&#x25C0;';
502             }
503             elseif (false !== strpos($uagent, 'Konqueror')) {
504                 $this->rarrow = '&rarr;';
505                 $this->larrow = '&larr;';
506             }
507             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
508                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
509                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
510                 // To be safe, non-Unicode browsers!
511                 $this->rarrow = '&gt;';
512                 $this->larrow = '&lt;';
513             }
515             // RTL support - in RTL languages, swap r and l arrows
516             if (right_to_left()) {
517                 $t = $this->rarrow;
518                 $this->rarrow = $this->larrow;
519                 $this->larrow = $t;
520             }
521         }
522     }
524     /**
525      * Returns output renderer prefixes, these are used when looking
526      * for the overridden renderers in themes.
527      *
528      * @return array
529      */
530     public function renderer_prefixes() {
531         global $CFG; // just in case the included files need it
533         $prefixes = array('theme_'.$this->name);
535         foreach ($this->parent_configs as $parent) {
536             $prefixes[] = 'theme_'.$parent->name;
537         }
539         return $prefixes;
540     }
542     /**
543      * Returns the stylesheet URL of this editor content
544      *
545      * @param bool $encoded false means use & and true use &amp; in URLs
546      * @return string
547      */
548     public function editor_css_url($encoded=true) {
549         global $CFG;
551         $rev = theme_get_revision();
553         if ($rev > -1) {
554             if (!empty($CFG->slasharguments)) {
555                 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
556                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
557                 return $url;
558             } else {
559                 $params = array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor');
560                 return new moodle_url($CFG->httpswwwroot.'/theme/styles.php', $params);
561             }
562         } else {
563             $params = array('theme'=>$this->name, 'type'=>'editor');
564             return new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
565         }
566     }
568     /**
569      * Returns the content of the CSS to be used in editor content
570      *
571      * @return string
572      */
573     public function editor_css_files() {
574         global $CFG;
576         $files = array();
578         // first editor plugins
579         $plugins = get_plugin_list('editor');
580         foreach ($plugins as $plugin=>$fulldir) {
581             $sheetfile = "$fulldir/editor_styles.css";
582             if (is_readable($sheetfile)) {
583                 $files['plugin_'.$plugin] = $sheetfile;
584             }
585         }
586         // then parent themes
587         foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
588             if (empty($parent_config->editor_sheets)) {
589                 continue;
590             }
591             foreach ($parent_config->editor_sheets as $sheet) {
592                 $sheetfile = "$parent_config->dir/style/$sheet.css";
593                 if (is_readable($sheetfile)) {
594                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
595                 }
596             }
597         }
598         // finally this theme
599         if (!empty($this->editor_sheets)) {
600             foreach ($this->editor_sheets as $sheet) {
601                 $sheetfile = "$this->dir/style/$sheet.css";
602                 if (is_readable($sheetfile)) {
603                     $files['theme_'.$sheet] = $sheetfile;
604                 }
605             }
606         }
608         return $files;
609     }
611     /**
612      * Get the stylesheet URL of this theme
613      *
614      * @param moodle_page $page Not used... deprecated?
615      * @return array of moodle_url
616      */
617     public function css_urls(moodle_page $page) {
618         global $CFG;
620         $rev = theme_get_revision();
622         $urls = array();
624         $svg = $this->use_svg_icons();
626         if ($rev > -1) {
627             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
628             if (check_browser_version('MSIE', 5)) {
629                 // We need to split the CSS files for IE
630                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'plugins', 'svg' => '0'));
631                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'parents', 'svg' => '0'));
632                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'theme', 'svg' => '0'));
633             } else {
634                 if (!empty($CFG->slasharguments)) {
635                     $slashargs = '/'.$this->name.'/'.$rev.'/all';
636                     if (!$svg) {
637                         // We add a simple /_s to the start of the path.
638                         // The underscore is used to ensure that it isn't a valid theme name.
639                         $slashargs = '/_s'.$slashargs;
640                     }
641                     $url->set_slashargument($slashargs, 'noparam', true);
642                 } else {
643                     $params = array('theme' => $this->name,'rev' => $rev, 'type' => 'all');
644                     if (!$svg) {
645                         // We add an SVG param so that we know not to serve SVG images.
646                         // We do this because all modern browsers support SVG and this param will one day be removed.
647                         $params['svg'] = '0';
648                     }
649                     $url->params($params);
650                 }
651                 $urls[] = $url;
652             }
653         } else {
654             // find out the current CSS and cache it now for 5 seconds
655             // the point is to construct the CSS only once and pass it through the
656             // dataroot to the script that actually serves the sheets
657             if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
658                 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
659             }
660             $candidatedir = "$CFG->cachedir/theme/$this->name";
661             if ($svg) {
662                 $candidatesheet = "$candidatedir/designer.ser";
663             } else {
664                 $candidatesheet = "$candidatedir/designer_nosvg.ser";
665             }
666             $rebuild = true;
667             if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
668                 if ($css = file_get_contents($candidatesheet)) {
669                     $css = unserialize($css);
670                     if (is_array($css)) {
671                         $rebuild = false;
672                     }
673                 }
674             }
675             if ($rebuild) {
676                 // Prepare the CSS optimiser if it is to be used,
677                 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
678                 $optimiser = null;
679                 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
680                     require_once($CFG->dirroot.'/lib/csslib.php');
681                     $optimiser = new css_optimiser;
682                 }
683                 $css = $this->css_content($optimiser);
685                 // We do not want any errors here because this may fail easily because of the concurrent access.
686                 $prevabort = ignore_user_abort(true);
687                 check_dir_exists($candidatedir);
688                 $tempfile = tempnam($candidatedir, 'tmpdesigner');
689                 file_put_contents($tempfile, serialize($css));
690                 $reporting = error_reporting(0);
691                 chmod($tempfile, $CFG->filepermissions);
692                 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
693                 rename($tempfile, $candidatesheet);
694                 error_reporting($reporting);
695                 ignore_user_abort($prevabort);
696             }
698             $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
699             if (!$svg) {
700                 // We add an SVG param so that we know not to serve SVG images.
701                 // We do this because all modern browsers support SVG and this param will one day be removed.
702                 $baseurl->param('svg', '0');
703             }
704             if (check_browser_version('MSIE', 5)) {
705                 // lalala, IE does not allow more than 31 linked CSS files from main document
706                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
707                 foreach ($css['parents'] as $parent=>$sheets) {
708                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
709                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
710                 }
711                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
713             } else {
714                 foreach ($css['plugins'] as $plugin=>$unused) {
715                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
716                 }
717                 foreach ($css['parents'] as $parent=>$sheets) {
718                     foreach ($sheets as $sheet=>$unused2) {
719                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
720                     }
721                 }
722                 foreach ($css['theme'] as $sheet=>$unused) {
723                     $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme')); // sheet first in order to make long urls easier to read
724                 }
725             }
726         }
728         return $urls;
729     }
731     /**
732      * Returns an array of organised CSS files required for this output
733      *
734      * @return array
735      */
736     public function css_files() {
737         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
739         // get all plugin sheets
740         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
741         if ($excludes !== true) {
742             foreach (get_plugin_types() as $type=>$unused) {
743                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
744                     continue;
745                 }
746                 $plugins = get_plugin_list($type);
747                 foreach ($plugins as $plugin=>$fulldir) {
748                     if (!empty($excludes[$type]) and is_array($excludes[$type])
749                         and in_array($plugin, $excludes[$type])) {
750                         continue;
751                     }
753                     $plugincontent = '';
754                     $sheetfile = "$fulldir/styles.css";
755                     if (is_readable($sheetfile)) {
756                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
757                     }
758                     $sheetthemefile = "$fulldir/styles_{$this->name}.css";
759                     if (is_readable($sheetthemefile)) {
760                         $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
761                     }
762                     }
763                 }
764             }
766         // find out wanted parent sheets
767         $excludes = $this->resolve_excludes('parents_exclude_sheets');
768         if ($excludes !== true) {
769             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
770                 $parent = $parent_config->name;
771                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
772                     continue;
773                 }
774                 foreach ($parent_config->sheets as $sheet) {
775                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
776                         and in_array($sheet, $excludes[$parent])) {
777                         continue;
778                     }
779                     $sheetfile = "$parent_config->dir/style/$sheet.css";
780                     if (is_readable($sheetfile)) {
781                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
782                     }
783                 }
784             }
785         }
787         // current theme sheets
788         if (is_array($this->sheets)) {
789             foreach ($this->sheets as $sheet) {
790                 $sheetfile = "$this->dir/style/$sheet.css";
791                 if (is_readable($sheetfile)) {
792                     $cssfiles['theme'][$sheet] = $sheetfile;
793                 }
794             }
795         }
797         return $cssfiles;
798     }
800     /**
801      * Returns the content of the one huge CSS merged from all style sheets.
802      *
803      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
804      * @return string
805      */
806     public function css_content(css_optimiser $optimiser = null) {
807         $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
808         $css = $this->css_files_get_contents($files, array(), $optimiser);
809         return $css;
810     }
812     /**
813      * Given an array of file paths or a single file path loads the contents of
814      * the CSS file, processes it then returns it in the same structure it was given.
815      *
816      * Can be used recursively on the results of {@link css_files}
817      *
818      * @param array|string $file An array of file paths or a single file path
819      * @param array $keys An array of previous array keys [recursive addition]
820      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
821      * @return The converted array or the contents of the single file ($file type)
822      */
823     protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
824         global $CFG;
825         if (is_array($file)) {
826             // We use a separate array to keep everything in the exact same order.
827             $return = array();
828             foreach ($file as $key=>$f) {
829                 $return[clean_param($key, PARAM_SAFEDIR)] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
830             }
831             return $return;
832         } else {
833             $contents = file_get_contents($file);
834             $contents = $this->post_process($contents);
835             $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
836             $stats = '';
837             if (!is_null($optimiser)) {
838                 $contents = $optimiser->process($contents);
839                 if (!empty($CFG->cssoptimiserstats)) {
840                     $stats = $optimiser->output_stats_css();
841                 }
842             }
843             return $comment.$stats.$contents;
844         }
845     }
848     /**
849      * Generate a URL to the file that serves theme JavaScript files.
850      *
851      * If we determine that the theme has no relevant files, then we return
852      * early with a null value.
853      *
854      * @param bool $inhead true means head url, false means footer
855      * @return moodle_url|null
856      */
857     public function javascript_url($inhead) {
858         global $CFG;
860         $rev = theme_get_revision();
861         $params = array('theme'=>$this->name,'rev'=>$rev);
862         $params['type'] = $inhead ? 'head' : 'footer';
864         // Return early if there are no files to serve
865         if (count($this->javascript_files($params['type'])) === 0) {
866             return null;
867         }
869         if (!empty($CFG->slasharguments) and $rev > 0) {
870             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
871             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
872             return $url;
873         } else {
874             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
875         }
876     }
878     /**
879      * Get the URL's for the JavaScript files used by this theme.
880      * They won't be served directly, instead they'll be mediated through
881      * theme/javascript.php.
882      *
883      * @param string $type Either javascripts_footer, or javascripts
884      * @return array
885      */
886     public function javascript_files($type) {
887         if ($type === 'footer') {
888             $type = 'javascripts_footer';
889         } else {
890             $type = 'javascripts';
891         }
893         $js = array();
894         // find out wanted parent javascripts
895         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
896         if ($excludes !== true) {
897             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
898                 $parent = $parent_config->name;
899                 if (empty($parent_config->$type)) {
900                     continue;
901                 }
902                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
903                     continue;
904                 }
905                 foreach ($parent_config->$type as $javascript) {
906                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
907                         and in_array($javascript, $excludes[$parent])) {
908                         continue;
909                     }
910                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
911                     if (is_readable($javascriptfile)) {
912                         $js[] = $javascriptfile;
913                     }
914                 }
915             }
916         }
918         // current theme javascripts
919         if (is_array($this->$type)) {
920             foreach ($this->$type as $javascript) {
921                 $javascriptfile = "$this->dir/javascript/$javascript.js";
922                 if (is_readable($javascriptfile)) {
923                     $js[] = $javascriptfile;
924                 }
925             }
926         }
927         return $js;
928     }
930     /**
931      * Resolves an exclude setting to the themes setting is applicable or the
932      * setting of its closest parent.
933      *
934      * @param string $variable The name of the setting the exclude setting to resolve
935      * @param string $default
936      * @return mixed
937      */
938     protected function resolve_excludes($variable, $default = null) {
939         $setting = $default;
940         if (is_array($this->{$variable}) or $this->{$variable} === true) {
941             $setting = $this->{$variable};
942         } else {
943             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
944                 if (!isset($parent_config->{$variable})) {
945                     continue;
946                 }
947                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
948                     $setting = $parent_config->{$variable};
949                     break;
950                 }
951             }
952         }
953         return $setting;
954     }
956     /**
957      * Returns the content of the one huge javascript file merged from all theme javascript files.
958      *
959      * @param bool $type
960      * @return string
961      */
962     public function javascript_content($type) {
963         $jsfiles = $this->javascript_files($type);
964         $js = '';
965         foreach ($jsfiles as $jsfile) {
966             $js .= file_get_contents($jsfile)."\n";
967         }
968         return $js;
969     }
971     /**
972      * Post processes CSS.
973      *
974      * This method post processes all of the CSS before it is served for this theme.
975      * This is done so that things such as image URL's can be swapped in and to
976      * run any specific CSS post process method the theme has requested.
977      * This allows themes to use CSS settings.
978      *
979      * @param string $css The CSS to process.
980      * @return string The processed CSS.
981      */
982     public function post_process($css) {
983         // now resolve all image locations
984         if (preg_match_all('/\[\[pix:([a-z_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
985             $replaced = array();
986             foreach ($matches as $match) {
987                 if (isset($replaced[$match[0]])) {
988                     continue;
989                 }
990                 $replaced[$match[0]] = true;
991                 $imagename = $match[2];
992                 $component = rtrim($match[1], '|');
993                 $imageurl = $this->pix_url($imagename, $component)->out(false);
994                  // we do not need full url because the image.php is always in the same dir
995                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
996                 $css = str_replace($match[0], $imageurl, $css);
997             }
998         }
1000         // now resolve all theme settings or do any other postprocessing
1001         $csspostprocess = $this->csspostprocess;
1002         if (function_exists($csspostprocess)) {
1003             $css = $csspostprocess($css, $this);
1004         }
1006         return $css;
1007     }
1009     /**
1010      * Return the URL for an image
1011      *
1012      * @param string $imagename the name of the icon.
1013      * @param string $component specification of one plugin like in get_string()
1014      * @return moodle_url
1015      */
1016     public function pix_url($imagename, $component) {
1017         global $CFG;
1019         $params = array('theme'=>$this->name);
1020         $svg = $this->use_svg_icons();
1022         if (empty($component) or $component === 'moodle' or $component === 'core') {
1023             $params['component'] = 'core';
1024         } else {
1025             $params['component'] = $component;
1026         }
1028         $rev = theme_get_revision();
1029         if ($rev != -1) {
1030             $params['rev'] = $rev;
1031         }
1033         $params['image'] = $imagename;
1035         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1036         if (!empty($CFG->slasharguments) and $rev > 0) {
1037             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1038             if (!$svg) {
1039                 // We add a simple /_s to the start of the path.
1040                 // The underscore is used to ensure that it isn't a valid theme name.
1041                 $path = '/_s'.$path;
1042             }
1043             $url->set_slashargument($path, 'noparam', true);
1044         } else {
1045             if (!$svg) {
1046                 // We add an SVG param so that we know not to serve SVG images.
1047                 // We do this because all modern browsers support SVG and this param will one day be removed.
1048                 $params['svg'] = '0';
1049             }
1050             $url->params($params);
1051         }
1053         return $url;
1054     }
1056     /**
1057      * Resolves the real image location.
1058      *
1059      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1060      * and we need a way in which to turn it off.
1061      * By default SVG won't be used unless asked for. This is done for two reasons:
1062      *   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
1063      *      browser supports SVG.
1064      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1065      *      by the user due to security concerns.
1066      *
1067      * @param string $image name of image, may contain relative path
1068      * @param string $component
1069      * @param bool $svg If set to true SVG images will also be looked for.
1070      * @return string full file path
1071      */
1072     public function resolve_image_location($image, $component, $svg = false) {
1073         global $CFG;
1075         if (!is_bool($svg)) {
1076             // If $svg isn't a bool then we need to decide for ourselves.
1077             $svg = $this->use_svg_icons();
1078         }
1080         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1081             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1082                 return $imagefile;
1083             }
1084             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1085                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1086                     return $imagefile;
1087                 }
1088             }
1089             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1090                 return $imagefile;
1091             }
1092             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1093                 return $imagefile;
1094             }
1095             return null;
1097         } else if ($component === 'theme') { //exception
1098             if ($image === 'favicon') {
1099                 return "$this->dir/pix/favicon.ico";
1100             }
1101             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1102                 return $imagefile;
1103             }
1104             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1105                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1106                     return $imagefile;
1107                 }
1108             }
1109             return null;
1111         } else {
1112             if (strpos($component, '_') === false) {
1113                 $component = 'mod_'.$component;
1114             }
1115             list($type, $plugin) = explode('_', $component, 2);
1117             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1118                 return $imagefile;
1119             }
1120             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1121                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1122                     return $imagefile;
1123                 }
1124             }
1125             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1126                 return $imagefile;
1127             }
1128             $dir = get_plugin_directory($type, $plugin);
1129             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1130                 return $imagefile;
1131             }
1132             return null;
1133         }
1134     }
1136     /**
1137      * Return true if we should look for SVG images as well.
1138      *
1139      * @staticvar bool $svg
1140      * @return bool
1141      */
1142     public function use_svg_icons() {
1143         global $CFG;
1144         if ($this->usesvg === null) {
1145             if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1146                 // IE 5 - 8 don't support SVG at all.
1147                 if (empty($_SERVER['HTTP_USER_AGENT'])) {
1148                     // Can't be sure, just say no.
1149                     $this->usesvg = false;
1150                 } else if (check_browser_version('MSIE', 0) and !check_browser_version('MSIE', 9)) {
1151                     // IE < 9 doesn't support SVG. Say no.
1152                     $this->usesvg = false;
1153                 } else if (preg_match('#Android +[0-2]\.#', $_SERVER['HTTP_USER_AGENT'])) {
1154                     // Android < 3 doesn't support SVG. Say no.
1155                     $this->usesvg = false;
1156                 } else if (check_browser_version('Opera', 0)) {
1157                     // Opera 12 still does not support SVG well enough. Say no.
1158                     $this->usesvg = false;
1159                 } else {
1160                     // Presumed fine.
1161                     $this->usesvg = true;
1162                 }
1163             } else {
1164                 // Force them on/off depending upon the setting.
1165                 $this->usesvg = $CFG->svgicons;
1166             }
1167         }
1168         return $this->usesvg;
1169     }
1171     /**
1172      * Forces the usesvg setting to either true or false, avoiding any decision making.
1173      *
1174      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1175      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1176      *
1177      * @param bool $setting True to force the use of svg when available, null otherwise.
1178      */
1179     public function force_svg_use($setting) {
1180         $this->usesvg = (bool)$setting;
1181     }
1183     /**
1184      * Checks if file with any image extension exists.
1185      *
1186      * The order to these images was adjusted prior to the release of 2.4
1187      * At that point the were the following image counts in Moodle core:
1188      *
1189      *     - png = 667 in pix dirs (1499 total)
1190      *     - gif = 385 in pix dirs (606 total)
1191      *     - jpg = 62  in pix dirs (74 total)
1192      *     - jpeg = 0  in pix dirs (1 total)
1193      *
1194      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1195      *
1196      * @param string $filepath
1197      * @param bool $svg If set to true SVG images will also be looked for.
1198      * @return string image name with extension
1199      */
1200     private static function image_exists($filepath, $svg = false) {
1201         if ($svg && file_exists("$filepath.svg")) {
1202             return "$filepath.svg";
1203         } else  if (file_exists("$filepath.png")) {
1204             return "$filepath.png";
1205         } else if (file_exists("$filepath.gif")) {
1206             return "$filepath.gif";
1207         } else  if (file_exists("$filepath.jpg")) {
1208             return "$filepath.jpg";
1209         } else  if (file_exists("$filepath.jpeg")) {
1210             return "$filepath.jpeg";
1211         } else {
1212             return false;
1213         }
1214     }
1216     /**
1217      * Loads the theme config from config.php file.
1218      *
1219      * @param string $themename
1220      * @param stdClass $settings from config_plugins table
1221      * @return stdClass The theme configuration
1222      */
1223     private static function find_theme_config($themename, $settings) {
1224         // We have to use the variable name $THEME (upper case) because that
1225         // is what is used in theme config.php files.
1227         if (!$dir = theme_config::find_theme_location($themename)) {
1228             return null;
1229         }
1231         $THEME = new stdClass();
1232         $THEME->name     = $themename;
1233         $THEME->dir      = $dir;
1234         $THEME->settings = $settings;
1236         global $CFG; // just in case somebody tries to use $CFG in theme config
1237         include("$THEME->dir/config.php");
1239         // verify the theme configuration is OK
1240         if (!is_array($THEME->parents)) {
1241             // parents option is mandatory now
1242             return null;
1243         }
1245         return $THEME;
1246     }
1248     /**
1249      * Finds the theme location and verifies the theme has all needed files
1250      * and is not obsoleted.
1251      *
1252      * @param string $themename
1253      * @return string full dir path or null if not found
1254      */
1255     private static function find_theme_location($themename) {
1256         global $CFG;
1258         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1259             $dir = "$CFG->dirroot/theme/$themename";
1261         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1262             $dir = "$CFG->themedir/$themename";
1264         } else {
1265             return null;
1266         }
1268         if (file_exists("$dir/styles.php")) {
1269             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1270             return null;
1271         }
1273         return $dir;
1274     }
1276     /**
1277      * Get the renderer for a part of Moodle for this theme.
1278      *
1279      * @param moodle_page $page the page we are rendering
1280      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
1281      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
1282      * @param string $target one of rendering target constants
1283      * @return renderer_base the requested renderer.
1284      */
1285     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
1286         if (is_null($this->rf)) {
1287             $classname = $this->rendererfactory;
1288             $this->rf = new $classname($this);
1289         }
1291         return $this->rf->get_renderer($page, $component, $subtype, $target);
1292     }
1294     /**
1295      * Get the information from {@link $layouts} for this type of page.
1296      *
1297      * @param string $pagelayout the the page layout name.
1298      * @return array the appropriate part of {@link $layouts}.
1299      */
1300     protected function layout_info_for_page($pagelayout) {
1301         if (array_key_exists($pagelayout, $this->layouts)) {
1302             return $this->layouts[$pagelayout];
1303         } else {
1304             debugging('Invalid page layout specified: ' . $pagelayout);
1305             return $this->layouts['standard'];
1306         }
1307     }
1309     /**
1310      * Given the settings of this theme, and the page pagelayout, return the
1311      * full path of the page layout file to use.
1312      *
1313      * Used by {@link core_renderer::header()}.
1314      *
1315      * @param string $pagelayout the the page layout name.
1316      * @return string Full path to the lyout file to use
1317      */
1318     public function layout_file($pagelayout) {
1319         global $CFG;
1321         $layoutinfo = $this->layout_info_for_page($pagelayout);
1322         $layoutfile = $layoutinfo['file'];
1324         if (array_key_exists('theme', $layoutinfo)) {
1325             $themes = array($layoutinfo['theme']);
1326         } else {
1327             $themes = array_merge(array($this->name),$this->parents);
1328         }
1330         foreach ($themes as $theme) {
1331             if ($dir = $this->find_theme_location($theme)) {
1332                 $path = "$dir/layout/$layoutfile";
1334                 // Check the template exists, return general base theme template if not.
1335                 if (is_readable($path)) {
1336                     return $path;
1337                 }
1338             }
1339         }
1341         debugging('Can not find layout file for: ' . $pagelayout);
1342         // fallback to standard normal layout
1343         return "$CFG->dirroot/theme/base/layout/general.php";
1344     }
1346     /**
1347      * Returns auxiliary page layout options specified in layout configuration array.
1348      *
1349      * @param string $pagelayout
1350      * @return array
1351      */
1352     public function pagelayout_options($pagelayout) {
1353         $info = $this->layout_info_for_page($pagelayout);
1354         if (!empty($info['options'])) {
1355             return $info['options'];
1356         }
1357         return array();
1358     }
1360     /**
1361      * Inform a block_manager about the block regions this theme wants on this
1362      * page layout.
1363      *
1364      * @param string $pagelayout the general type of the page.
1365      * @param block_manager $blockmanager the block_manger to set up.
1366      */
1367     public function setup_blocks($pagelayout, $blockmanager) {
1368         $layoutinfo = $this->layout_info_for_page($pagelayout);
1369         if (!empty($layoutinfo['regions'])) {
1370             $blockmanager->add_regions($layoutinfo['regions']);
1371             $blockmanager->set_default_region($layoutinfo['defaultregion']);
1372         }
1373     }
1375     /**
1376      * Gets the visible name for the requested block region.
1377      *
1378      * @param string $region The region name to get
1379      * @param string $theme The theme the region belongs to (may come from the parent theme)
1380      * @return string
1381      */
1382     protected function get_region_name($region, $theme) {
1383         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1384         // A name exists in this theme, so use it
1385         if (substr($regionstring, 0, 1) != '[') {
1386             return $regionstring;
1387         }
1389         // Otherwise, try to find one elsewhere
1390         // Check parents, if any
1391         foreach ($this->parents as $parentthemename) {
1392             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1393             if (substr($regionstring, 0, 1) != '[') {
1394                 return $regionstring;
1395             }
1396         }
1398         // Last resort, try the base theme for names
1399         return get_string('region-' . $region, 'theme_base');
1400     }
1402     /**
1403      * Get the list of all block regions known to this theme in all templates.
1404      *
1405      * @return array internal region name => human readable name.
1406      */
1407     public function get_all_block_regions() {
1408         $regions = array();
1409         foreach ($this->layouts as $layoutinfo) {
1410             foreach ($layoutinfo['regions'] as $region) {
1411                 $regions[$region] = $this->get_region_name($region, $this->name);
1412             }
1413         }
1414         return $regions;
1415     }
1417     /**
1418      * Returns the human readable name of the theme
1419      *
1420      * @return string
1421      */
1422     public function get_theme_name() {
1423         return get_string('pluginname', 'theme_'.$this->name);
1424     }
1427 /**
1428  * This class keeps track of which HTML tags are currently open.
1429  *
1430  * This makes it much easier to always generate well formed XHTML output, even
1431  * if execution terminates abruptly. Any time you output some opening HTML
1432  * without the matching closing HTML, you should push the necessary close tags
1433  * onto the stack.
1434  *
1435  * @copyright 2009 Tim Hunt
1436  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1437  * @since Moodle 2.0
1438  * @package core
1439  * @category output
1440  */
1441 class xhtml_container_stack {
1443     /**
1444      * @var array Stores the list of open containers.
1445      */
1446     protected $opencontainers = array();
1448     /**
1449      * @var array In developer debug mode, stores a stack trace of all opens and
1450      * closes, so we can output helpful error messages when there is a mismatch.
1451      */
1452     protected $log = array();
1454     /**
1455      * @var boolean Store whether we are developer debug mode. We need this in
1456      * several places including in the destructor where we may not have access to $CFG.
1457      */
1458     protected $isdebugging;
1460     /**
1461      * Constructor
1462      */
1463     public function __construct() {
1464         $this->isdebugging = debugging('', DEBUG_DEVELOPER);
1465     }
1467     /**
1468      * Push the close HTML for a recently opened container onto the stack.
1469      *
1470      * @param string $type The type of container. This is checked when {@link pop()}
1471      *      is called and must match, otherwise a developer debug warning is output.
1472      * @param string $closehtml The HTML required to close the container.
1473      */
1474     public function push($type, $closehtml) {
1475         $container = new stdClass;
1476         $container->type = $type;
1477         $container->closehtml = $closehtml;
1478         if ($this->isdebugging) {
1479             $this->log('Open', $type);
1480         }
1481         array_push($this->opencontainers, $container);
1482     }
1484     /**
1485      * Pop the HTML for the next closing container from the stack. The $type
1486      * must match the type passed when the container was opened, otherwise a
1487      * warning will be output.
1488      *
1489      * @param string $type The type of container.
1490      * @return string the HTML required to close the container.
1491      */
1492     public function pop($type) {
1493         if (empty($this->opencontainers)) {
1494             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1495                     $this->output_log(), DEBUG_DEVELOPER);
1496             return;
1497         }
1499         $container = array_pop($this->opencontainers);
1500         if ($container->type != $type) {
1501             debugging('<p>The type of container to be closed (' . $container->type .
1502                     ') does not match the type of the next open container (' . $type .
1503                     '). This suggests there is a nesting problem.</p>' .
1504                     $this->output_log(), DEBUG_DEVELOPER);
1505         }
1506         if ($this->isdebugging) {
1507             $this->log('Close', $type);
1508         }
1509         return $container->closehtml;
1510     }
1512     /**
1513      * Close all but the last open container. This is useful in places like error
1514      * handling, where you want to close all the open containers (apart from <body>)
1515      * before outputting the error message.
1516      *
1517      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1518      *      developer debug warning if it isn't.
1519      * @return string the HTML required to close any open containers inside <body>.
1520      */
1521     public function pop_all_but_last($shouldbenone = false) {
1522         if ($shouldbenone && count($this->opencontainers) != 1) {
1523             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1524                     $this->output_log(), DEBUG_DEVELOPER);
1525         }
1526         $output = '';
1527         while (count($this->opencontainers) > 1) {
1528             $container = array_pop($this->opencontainers);
1529             $output .= $container->closehtml;
1530         }
1531         return $output;
1532     }
1534     /**
1535      * You can call this function if you want to throw away an instance of this
1536      * class without properly emptying the stack (for example, in a unit test).
1537      * Calling this method stops the destruct method from outputting a developer
1538      * debug warning. After calling this method, the instance can no longer be used.
1539      */
1540     public function discard() {
1541         $this->opencontainers = null;
1542     }
1544     /**
1545      * Adds an entry to the log.
1546      *
1547      * @param string $action The name of the action
1548      * @param string $type The type of action
1549      */
1550     protected function log($action, $type) {
1551         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1552                 format_backtrace(debug_backtrace()) . '</li>';
1553     }
1555     /**
1556      * Outputs the log's contents as a HTML list.
1557      *
1558      * @return string HTML list of the log
1559      */
1560     protected function output_log() {
1561         return '<ul>' . implode("\n", $this->log) . '</ul>';
1562     }