Merge branch 'MDL-38048-master' of git://github.com/FMCorz/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             foreach ($file as $key=>$f) {
827                 $file[$key] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
828             }
829             return $file;
830         } else {
831             $contents = file_get_contents($file);
832             $contents = $this->post_process($contents);
833             $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
834             $stats = '';
835             if (!is_null($optimiser)) {
836                 $contents = $optimiser->process($contents);
837                 if (!empty($CFG->cssoptimiserstats)) {
838                     $stats = $optimiser->output_stats_css();
839                 }
840             }
841             return $comment.$stats.$contents;
842         }
843     }
846     /**
847      * Generate a URL to the file that serves theme JavaScript files.
848      *
849      * If we determine that the theme has no relevant files, then we return
850      * early with a null value.
851      *
852      * @param bool $inhead true means head url, false means footer
853      * @return moodle_url|null
854      */
855     public function javascript_url($inhead) {
856         global $CFG;
858         $rev = theme_get_revision();
859         $params = array('theme'=>$this->name,'rev'=>$rev);
860         $params['type'] = $inhead ? 'head' : 'footer';
862         // Return early if there are no files to serve
863         if (count($this->javascript_files($params['type'])) === 0) {
864             return null;
865         }
867         if (!empty($CFG->slasharguments) and $rev > 0) {
868             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
869             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
870             return $url;
871         } else {
872             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
873         }
874     }
876     /**
877      * Get the URL's for the JavaScript files used by this theme.
878      * They won't be served directly, instead they'll be mediated through
879      * theme/javascript.php.
880      *
881      * @param string $type Either javascripts_footer, or javascripts
882      * @return array
883      */
884     public function javascript_files($type) {
885         if ($type === 'footer') {
886             $type = 'javascripts_footer';
887         } else {
888             $type = 'javascripts';
889         }
891         $js = array();
892         // find out wanted parent javascripts
893         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
894         if ($excludes !== true) {
895             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
896                 $parent = $parent_config->name;
897                 if (empty($parent_config->$type)) {
898                     continue;
899                 }
900                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
901                     continue;
902                 }
903                 foreach ($parent_config->$type as $javascript) {
904                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
905                         and in_array($javascript, $excludes[$parent])) {
906                         continue;
907                     }
908                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
909                     if (is_readable($javascriptfile)) {
910                         $js[] = $javascriptfile;
911                     }
912                 }
913             }
914         }
916         // current theme javascripts
917         if (is_array($this->$type)) {
918             foreach ($this->$type as $javascript) {
919                 $javascriptfile = "$this->dir/javascript/$javascript.js";
920                 if (is_readable($javascriptfile)) {
921                     $js[] = $javascriptfile;
922                 }
923             }
924         }
926         return $js;
927     }
929     /**
930      * Resolves an exclude setting to the themes setting is applicable or the
931      * setting of its closest parent.
932      *
933      * @param string $variable The name of the setting the exclude setting to resolve
934      * @param string $default
935      * @return mixed
936      */
937     protected function resolve_excludes($variable, $default = null) {
938         $setting = $default;
939         if (is_array($this->{$variable}) or $this->{$variable} === true) {
940             $setting = $this->{$variable};
941         } else {
942             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
943                 if (!isset($parent_config->{$variable})) {
944                     continue;
945                 }
946                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
947                     $setting = $parent_config->{$variable};
948                     break;
949                 }
950             }
951         }
952         return $setting;
953     }
955     /**
956      * Returns the content of the one huge javascript file merged from all theme javascript files.
957      *
958      * @param bool $type
959      * @return string
960      */
961     public function javascript_content($type) {
962         $jsfiles = $this->javascript_files($type);
963         $js = '';
964         foreach ($jsfiles as $jsfile) {
965             $js .= file_get_contents($jsfile)."\n";
966         }
967         return $js;
968     }
970     /**
971      * Post processes CSS.
972      *
973      * This method post processes all of the CSS before it is served for this theme.
974      * This is done so that things such as image URL's can be swapped in and to
975      * run any specific CSS post process method the theme has requested.
976      * This allows themes to use CSS settings.
977      *
978      * @param string $css The CSS to process.
979      * @return string The processed CSS.
980      */
981     public function post_process($css) {
982         // now resolve all image locations
983         if (preg_match_all('/\[\[pix:([a-z_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
984             $replaced = array();
985             foreach ($matches as $match) {
986                 if (isset($replaced[$match[0]])) {
987                     continue;
988                 }
989                 $replaced[$match[0]] = true;
990                 $imagename = $match[2];
991                 $component = rtrim($match[1], '|');
992                 $imageurl = $this->pix_url($imagename, $component)->out(false);
993                  // we do not need full url because the image.php is always in the same dir
994                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
995                 $css = str_replace($match[0], $imageurl, $css);
996             }
997         }
999         // now resolve all theme settings or do any other postprocessing
1000         $csspostprocess = $this->csspostprocess;
1001         if (function_exists($csspostprocess)) {
1002             $css = $csspostprocess($css, $this);
1003         }
1005         return $css;
1006     }
1008     /**
1009      * Return the URL for an image
1010      *
1011      * @param string $imagename the name of the icon.
1012      * @param string $component specification of one plugin like in get_string()
1013      * @return moodle_url
1014      */
1015     public function pix_url($imagename, $component) {
1016         global $CFG;
1018         $params = array('theme'=>$this->name);
1019         $svg = $this->use_svg_icons();
1021         if (empty($component) or $component === 'moodle' or $component === 'core') {
1022             $params['component'] = 'core';
1023         } else {
1024             $params['component'] = $component;
1025         }
1027         $rev = theme_get_revision();
1028         if ($rev != -1) {
1029             $params['rev'] = $rev;
1030         }
1032         $params['image'] = $imagename;
1034         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1035         if (!empty($CFG->slasharguments) and $rev > 0) {
1036             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1037             if (!$svg) {
1038                 // We add a simple /_s to the start of the path.
1039                 // The underscore is used to ensure that it isn't a valid theme name.
1040                 $path = '/_s'.$path;
1041             }
1042             $url->set_slashargument($path, 'noparam', true);
1043         } else {
1044             if (!$svg) {
1045                 // We add an SVG param so that we know not to serve SVG images.
1046                 // We do this because all modern browsers support SVG and this param will one day be removed.
1047                 $params['svg'] = '0';
1048             }
1049             $url->params($params);
1050         }
1052         return $url;
1053     }
1055     /**
1056      * Resolves the real image location.
1057      *
1058      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1059      * and we need a way in which to turn it off.
1060      * By default SVG won't be used unless asked for. This is done for two reasons:
1061      *   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
1062      *      browser supports SVG.
1063      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1064      *      by the user due to security concerns.
1065      *
1066      * @param string $image name of image, may contain relative path
1067      * @param string $component
1068      * @param bool $svg If set to true SVG images will also be looked for.
1069      * @return string full file path
1070      */
1071     public function resolve_image_location($image, $component, $svg = false) {
1072         global $CFG;
1074         if (!is_bool($svg)) {
1075             // If $svg isn't a bool then we need to decide for ourselves.
1076             $svg = $this->use_svg_icons();
1077         }
1079         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1080             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1081                 return $imagefile;
1082             }
1083             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1084                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1085                     return $imagefile;
1086                 }
1087             }
1088             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1089                 return $imagefile;
1090             }
1091             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1092                 return $imagefile;
1093             }
1094             return null;
1096         } else if ($component === 'theme') { //exception
1097             if ($image === 'favicon') {
1098                 return "$this->dir/pix/favicon.ico";
1099             }
1100             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1101                 return $imagefile;
1102             }
1103             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1104                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1105                     return $imagefile;
1106                 }
1107             }
1108             return null;
1110         } else {
1111             if (strpos($component, '_') === false) {
1112                 $component = 'mod_'.$component;
1113             }
1114             list($type, $plugin) = explode('_', $component, 2);
1116             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1117                 return $imagefile;
1118             }
1119             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1120                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1121                     return $imagefile;
1122                 }
1123             }
1124             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1125                 return $imagefile;
1126             }
1127             $dir = get_plugin_directory($type, $plugin);
1128             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1129                 return $imagefile;
1130             }
1131             return null;
1132         }
1133     }
1135     /**
1136      * Return true if we should look for SVG images as well.
1137      *
1138      * @staticvar bool $svg
1139      * @return bool
1140      */
1141     public function use_svg_icons() {
1142         global $CFG;
1143         if ($this->usesvg === null) {
1144             if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1145                 // IE 5 - 8 don't support SVG at all.
1146                 if (empty($_SERVER['HTTP_USER_AGENT'])) {
1147                     // Can't be sure, just say no.
1148                     $this->usesvg = false;
1149                 } else if (check_browser_version('MSIE', 0) and !check_browser_version('MSIE', 9)) {
1150                     // IE < 9 doesn't support SVG. Say no.
1151                     $this->usesvg = false;
1152                 } else if (preg_match('#Android +[0-2]\.#', $_SERVER['HTTP_USER_AGENT'])) {
1153                     // Android < 3 doesn't support SVG. Say no.
1154                     $this->usesvg = false;
1155                 } else if (check_browser_version('Opera', 0)) {
1156                     // Opera 12 still does not support SVG well enough. Say no.
1157                     $this->usesvg = false;
1158                 } else {
1159                     // Presumed fine.
1160                     $this->usesvg = true;
1161                 }
1162             } else {
1163                 // Force them on/off depending upon the setting.
1164                 $this->usesvg = $CFG->svgicons;
1165             }
1166         }
1167         return $this->usesvg;
1168     }
1170     /**
1171      * Forces the usesvg setting to either true or false, avoiding any decision making.
1172      *
1173      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1174      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1175      *
1176      * @param bool $setting True to force the use of svg when available, null otherwise.
1177      */
1178     public function force_svg_use($setting) {
1179         $this->usesvg = (bool)$setting;
1180     }
1182     /**
1183      * Checks if file with any image extension exists.
1184      *
1185      * The order to these images was adjusted prior to the release of 2.4
1186      * At that point the were the following image counts in Moodle core:
1187      *
1188      *     - png = 667 in pix dirs (1499 total)
1189      *     - gif = 385 in pix dirs (606 total)
1190      *     - jpg = 62  in pix dirs (74 total)
1191      *     - jpeg = 0  in pix dirs (1 total)
1192      *
1193      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1194      *
1195      * @param string $filepath
1196      * @param bool $svg If set to true SVG images will also be looked for.
1197      * @return string image name with extension
1198      */
1199     private static function image_exists($filepath, $svg = false) {
1200         if ($svg && file_exists("$filepath.svg")) {
1201             return "$filepath.svg";
1202         } else  if (file_exists("$filepath.png")) {
1203             return "$filepath.png";
1204         } else if (file_exists("$filepath.gif")) {
1205             return "$filepath.gif";
1206         } else  if (file_exists("$filepath.jpg")) {
1207             return "$filepath.jpg";
1208         } else  if (file_exists("$filepath.jpeg")) {
1209             return "$filepath.jpeg";
1210         } else {
1211             return false;
1212         }
1213     }
1215     /**
1216      * Loads the theme config from config.php file.
1217      *
1218      * @param string $themename
1219      * @param stdClass $settings from config_plugins table
1220      * @return stdClass The theme configuration
1221      */
1222     private static function find_theme_config($themename, $settings) {
1223         // We have to use the variable name $THEME (upper case) because that
1224         // is what is used in theme config.php files.
1226         if (!$dir = theme_config::find_theme_location($themename)) {
1227             return null;
1228         }
1230         $THEME = new stdClass();
1231         $THEME->name     = $themename;
1232         $THEME->dir      = $dir;
1233         $THEME->settings = $settings;
1235         global $CFG; // just in case somebody tries to use $CFG in theme config
1236         include("$THEME->dir/config.php");
1238         // verify the theme configuration is OK
1239         if (!is_array($THEME->parents)) {
1240             // parents option is mandatory now
1241             return null;
1242         }
1244         return $THEME;
1245     }
1247     /**
1248      * Finds the theme location and verifies the theme has all needed files
1249      * and is not obsoleted.
1250      *
1251      * @param string $themename
1252      * @return string full dir path or null if not found
1253      */
1254     private static function find_theme_location($themename) {
1255         global $CFG;
1257         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1258             $dir = "$CFG->dirroot/theme/$themename";
1260         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1261             $dir = "$CFG->themedir/$themename";
1263         } else {
1264             return null;
1265         }
1267         if (file_exists("$dir/styles.php")) {
1268             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1269             return null;
1270         }
1272         return $dir;
1273     }
1275     /**
1276      * Get the renderer for a part of Moodle for this theme.
1277      *
1278      * @param moodle_page $page the page we are rendering
1279      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
1280      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
1281      * @param string $target one of rendering target constants
1282      * @return renderer_base the requested renderer.
1283      */
1284     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
1285         if (is_null($this->rf)) {
1286             $classname = $this->rendererfactory;
1287             $this->rf = new $classname($this);
1288         }
1290         return $this->rf->get_renderer($page, $component, $subtype, $target);
1291     }
1293     /**
1294      * Get the information from {@link $layouts} for this type of page.
1295      *
1296      * @param string $pagelayout the the page layout name.
1297      * @return array the appropriate part of {@link $layouts}.
1298      */
1299     protected function layout_info_for_page($pagelayout) {
1300         if (array_key_exists($pagelayout, $this->layouts)) {
1301             return $this->layouts[$pagelayout];
1302         } else {
1303             debugging('Invalid page layout specified: ' . $pagelayout);
1304             return $this->layouts['standard'];
1305         }
1306     }
1308     /**
1309      * Given the settings of this theme, and the page pagelayout, return the
1310      * full path of the page layout file to use.
1311      *
1312      * Used by {@link core_renderer::header()}.
1313      *
1314      * @param string $pagelayout the the page layout name.
1315      * @return string Full path to the lyout file to use
1316      */
1317     public function layout_file($pagelayout) {
1318         global $CFG;
1320         $layoutinfo = $this->layout_info_for_page($pagelayout);
1321         $layoutfile = $layoutinfo['file'];
1323         if (array_key_exists('theme', $layoutinfo)) {
1324             $themes = array($layoutinfo['theme']);
1325         } else {
1326             $themes = array_merge(array($this->name),$this->parents);
1327         }
1329         foreach ($themes as $theme) {
1330             if ($dir = $this->find_theme_location($theme)) {
1331                 $path = "$dir/layout/$layoutfile";
1333                 // Check the template exists, return general base theme template if not.
1334                 if (is_readable($path)) {
1335                     return $path;
1336                 }
1337             }
1338         }
1340         debugging('Can not find layout file for: ' . $pagelayout);
1341         // fallback to standard normal layout
1342         return "$CFG->dirroot/theme/base/layout/general.php";
1343     }
1345     /**
1346      * Returns auxiliary page layout options specified in layout configuration array.
1347      *
1348      * @param string $pagelayout
1349      * @return array
1350      */
1351     public function pagelayout_options($pagelayout) {
1352         $info = $this->layout_info_for_page($pagelayout);
1353         if (!empty($info['options'])) {
1354             return $info['options'];
1355         }
1356         return array();
1357     }
1359     /**
1360      * Inform a block_manager about the block regions this theme wants on this
1361      * page layout.
1362      *
1363      * @param string $pagelayout the general type of the page.
1364      * @param block_manager $blockmanager the block_manger to set up.
1365      */
1366     public function setup_blocks($pagelayout, $blockmanager) {
1367         $layoutinfo = $this->layout_info_for_page($pagelayout);
1368         if (!empty($layoutinfo['regions'])) {
1369             $blockmanager->add_regions($layoutinfo['regions']);
1370             $blockmanager->set_default_region($layoutinfo['defaultregion']);
1371         }
1372     }
1374     /**
1375      * Gets the visible name for the requested block region.
1376      *
1377      * @param string $region The region name to get
1378      * @param string $theme The theme the region belongs to (may come from the parent theme)
1379      * @return string
1380      */
1381     protected function get_region_name($region, $theme) {
1382         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1383         // A name exists in this theme, so use it
1384         if (substr($regionstring, 0, 1) != '[') {
1385             return $regionstring;
1386         }
1388         // Otherwise, try to find one elsewhere
1389         // Check parents, if any
1390         foreach ($this->parents as $parentthemename) {
1391             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1392             if (substr($regionstring, 0, 1) != '[') {
1393                 return $regionstring;
1394             }
1395         }
1397         // Last resort, try the base theme for names
1398         return get_string('region-' . $region, 'theme_base');
1399     }
1401     /**
1402      * Get the list of all block regions known to this theme in all templates.
1403      *
1404      * @return array internal region name => human readable name.
1405      */
1406     public function get_all_block_regions() {
1407         $regions = array();
1408         foreach ($this->layouts as $layoutinfo) {
1409             foreach ($layoutinfo['regions'] as $region) {
1410                 $regions[$region] = $this->get_region_name($region, $this->name);
1411             }
1412         }
1413         return $regions;
1414     }
1416     /**
1417      * Returns the human readable name of the theme
1418      *
1419      * @return string
1420      */
1421     public function get_theme_name() {
1422         return get_string('pluginname', 'theme_'.$this->name);
1423     }
1426 /**
1427  * This class keeps track of which HTML tags are currently open.
1428  *
1429  * This makes it much easier to always generate well formed XHTML output, even
1430  * if execution terminates abruptly. Any time you output some opening HTML
1431  * without the matching closing HTML, you should push the necessary close tags
1432  * onto the stack.
1433  *
1434  * @copyright 2009 Tim Hunt
1435  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1436  * @since Moodle 2.0
1437  * @package core
1438  * @category output
1439  */
1440 class xhtml_container_stack {
1442     /**
1443      * @var array Stores the list of open containers.
1444      */
1445     protected $opencontainers = array();
1447     /**
1448      * @var array In developer debug mode, stores a stack trace of all opens and
1449      * closes, so we can output helpful error messages when there is a mismatch.
1450      */
1451     protected $log = array();
1453     /**
1454      * @var boolean Store whether we are developer debug mode. We need this in
1455      * several places including in the destructor where we may not have access to $CFG.
1456      */
1457     protected $isdebugging;
1459     /**
1460      * Constructor
1461      */
1462     public function __construct() {
1463         $this->isdebugging = debugging('', DEBUG_DEVELOPER);
1464     }
1466     /**
1467      * Push the close HTML for a recently opened container onto the stack.
1468      *
1469      * @param string $type The type of container. This is checked when {@link pop()}
1470      *      is called and must match, otherwise a developer debug warning is output.
1471      * @param string $closehtml The HTML required to close the container.
1472      */
1473     public function push($type, $closehtml) {
1474         $container = new stdClass;
1475         $container->type = $type;
1476         $container->closehtml = $closehtml;
1477         if ($this->isdebugging) {
1478             $this->log('Open', $type);
1479         }
1480         array_push($this->opencontainers, $container);
1481     }
1483     /**
1484      * Pop the HTML for the next closing container from the stack. The $type
1485      * must match the type passed when the container was opened, otherwise a
1486      * warning will be output.
1487      *
1488      * @param string $type The type of container.
1489      * @return string the HTML required to close the container.
1490      */
1491     public function pop($type) {
1492         if (empty($this->opencontainers)) {
1493             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1494                     $this->output_log(), DEBUG_DEVELOPER);
1495             return;
1496         }
1498         $container = array_pop($this->opencontainers);
1499         if ($container->type != $type) {
1500             debugging('<p>The type of container to be closed (' . $container->type .
1501                     ') does not match the type of the next open container (' . $type .
1502                     '). This suggests there is a nesting problem.</p>' .
1503                     $this->output_log(), DEBUG_DEVELOPER);
1504         }
1505         if ($this->isdebugging) {
1506             $this->log('Close', $type);
1507         }
1508         return $container->closehtml;
1509     }
1511     /**
1512      * Close all but the last open container. This is useful in places like error
1513      * handling, where you want to close all the open containers (apart from <body>)
1514      * before outputting the error message.
1515      *
1516      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1517      *      developer debug warning if it isn't.
1518      * @return string the HTML required to close any open containers inside <body>.
1519      */
1520     public function pop_all_but_last($shouldbenone = false) {
1521         if ($shouldbenone && count($this->opencontainers) != 1) {
1522             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1523                     $this->output_log(), DEBUG_DEVELOPER);
1524         }
1525         $output = '';
1526         while (count($this->opencontainers) > 1) {
1527             $container = array_pop($this->opencontainers);
1528             $output .= $container->closehtml;
1529         }
1530         return $output;
1531     }
1533     /**
1534      * You can call this function if you want to throw away an instance of this
1535      * class without properly emptying the stack (for example, in a unit test).
1536      * Calling this method stops the destruct method from outputting a developer
1537      * debug warning. After calling this method, the instance can no longer be used.
1538      */
1539     public function discard() {
1540         $this->opencontainers = null;
1541     }
1543     /**
1544      * Adds an entry to the log.
1545      *
1546      * @param string $action The name of the action
1547      * @param string $type The type of action
1548      */
1549     protected function log($action, $type) {
1550         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1551                 format_backtrace(debug_backtrace()) . '</li>';
1552     }
1554     /**
1555      * Outputs the log's contents as a HTML list.
1556      *
1557      * @return string HTML list of the log
1558      */
1559     protected function output_log() {
1560         return '<ul>' . implode("\n", $this->log) . '</ul>';
1561     }