Merge branch 'MDL-36950-updates-proxy' of git://github.com/mudrd8mz/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 {
368             // bad luck, the requested theme has some problems - admin see details in theme config
369             return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
370         }
371     }
373     /**
374      * Theme diagnostic code. It is very problematic to send debug output
375      * to the actual CSS file, instead this functions is supposed to
376      * diagnose given theme and highlights all potential problems.
377      * This information should be available from the theme selection page
378      * or some other debug page for theme designers.
379      *
380      * @param string $themename
381      * @return array description of problems
382      */
383     public static function diagnose($themename) {
384         //TODO: MDL-21108
385         return array();
386     }
388     /**
389      * Private constructor, can be called only from the factory method.
390      * @param stdClass $config
391      */
392     private function __construct($config) {
393         global $CFG; //needed for included lib.php files
395         $this->settings = $config->settings;
396         $this->name     = $config->name;
397         $this->dir      = $config->dir;
399         if ($this->name != 'base') {
400             $baseconfig = theme_config::find_theme_config('base', $this->settings);
401         } else {
402             $baseconfig = $config;
403         }
405         $configurable = array('parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'javascripts', 'javascripts_footer',
406                               'parents_exclude_javascripts', 'layouts', 'enable_dock', 'enablecourseajax', 'supportscssoptimisation',
407                               'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'hidefromselector', 'doctype');
409         foreach ($config as $key=>$value) {
410             if (in_array($key, $configurable)) {
411                 $this->$key = $value;
412             }
413         }
415         // verify all parents and load configs and renderers
416         foreach ($this->parents as $parent) {
417             if ($parent == 'base') {
418                 $parent_config = $baseconfig;
419             } else if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
420                 // this is not good - better exclude faulty parents
421                 continue;
422             }
423             $libfile = $parent_config->dir.'/lib.php';
424             if (is_readable($libfile)) {
425                 // theme may store various function here
426                 include_once($libfile);
427             }
428             $renderersfile = $parent_config->dir.'/renderers.php';
429             if (is_readable($renderersfile)) {
430                 // may contain core and plugin renderers and renderer factory
431                 include_once($renderersfile);
432             }
433             $this->parent_configs[$parent] = $parent_config;
434             $rendererfile = $parent_config->dir.'/renderers.php';
435             if (is_readable($rendererfile)) {
436                  // may contain core and plugin renderers and renderer factory
437                 include_once($rendererfile);
438             }
439         }
440         $libfile = $this->dir.'/lib.php';
441         if (is_readable($libfile)) {
442             // theme may store various function here
443             include_once($libfile);
444         }
445         $rendererfile = $this->dir.'/renderers.php';
446         if (is_readable($rendererfile)) {
447             // may contain core and plugin renderers and renderer factory
448             include_once($rendererfile);
449         } else {
450             // check if renderers.php file is missnamed renderer.php
451             if (is_readable($this->dir.'/renderer.php')) {
452                 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
453                     See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
454             }
455         }
457         // cascade all layouts properly
458         foreach ($baseconfig->layouts as $layout=>$value) {
459             if (!isset($this->layouts[$layout])) {
460                 foreach ($this->parent_configs as $parent_config) {
461                     if (isset($parent_config->layouts[$layout])) {
462                         $this->layouts[$layout] = $parent_config->layouts[$layout];
463                         continue 2;
464                     }
465                 }
466                 $this->layouts[$layout] = $value;
467             }
468         }
470         //fix arrows if needed
471         $this->check_theme_arrows();
472     }
474     /**
475      * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
476      * If not it applies sensible defaults.
477      *
478      * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
479      * search forum block, etc. Important: these are 'silent' in a screen-reader
480      * (unlike &gt; &raquo;), and must be accompanied by text.
481      */
482     private function check_theme_arrows() {
483         if (!isset($this->rarrow) and !isset($this->larrow)) {
484             // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
485             // Also OK in Win 9x/2K/IE 5.x
486             $this->rarrow = '&#x25BA;';
487             $this->larrow = '&#x25C4;';
488             if (empty($_SERVER['HTTP_USER_AGENT'])) {
489                 $uagent = '';
490             } else {
491                 $uagent = $_SERVER['HTTP_USER_AGENT'];
492             }
493             if (false !== strpos($uagent, 'Opera')
494                 || false !== strpos($uagent, 'Mac')) {
495                 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
496                 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
497                 $this->rarrow = '&#x25B6;';
498                 $this->larrow = '&#x25C0;';
499             }
500             elseif (false !== strpos($uagent, 'Konqueror')) {
501                 $this->rarrow = '&rarr;';
502                 $this->larrow = '&larr;';
503             }
504             elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
505                 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
506                 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
507                 // To be safe, non-Unicode browsers!
508                 $this->rarrow = '&gt;';
509                 $this->larrow = '&lt;';
510             }
512             // RTL support - in RTL languages, swap r and l arrows
513             if (right_to_left()) {
514                 $t = $this->rarrow;
515                 $this->rarrow = $this->larrow;
516                 $this->larrow = $t;
517             }
518         }
519     }
521     /**
522      * Returns output renderer prefixes, these are used when looking
523      * for the overridden renderers in themes.
524      *
525      * @return array
526      */
527     public function renderer_prefixes() {
528         global $CFG; // just in case the included files need it
530         $prefixes = array('theme_'.$this->name);
532         foreach ($this->parent_configs as $parent) {
533             $prefixes[] = 'theme_'.$parent->name;
534         }
536         return $prefixes;
537     }
539     /**
540      * Returns the stylesheet URL of this editor content
541      *
542      * @param bool $encoded false means use & and true use &amp; in URLs
543      * @return string
544      */
545     public function editor_css_url($encoded=true) {
546         global $CFG;
548         $rev = theme_get_revision();
550         if ($rev > -1) {
551             if (!empty($CFG->slasharguments)) {
552                 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
553                 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
554                 return $url;
555             } else {
556                 $params = array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor');
557                 return new moodle_url($CFG->httpswwwroot.'/theme/styles.php', $params);
558             }
559         } else {
560             $params = array('theme'=>$this->name, 'type'=>'editor');
561             return new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
562         }
563     }
565     /**
566      * Returns the content of the CSS to be used in editor content
567      *
568      * @return string
569      */
570     public function editor_css_files() {
571         global $CFG;
573         $files = array();
575         // first editor plugins
576         $plugins = get_plugin_list('editor');
577         foreach ($plugins as $plugin=>$fulldir) {
578             $sheetfile = "$fulldir/editor_styles.css";
579             if (is_readable($sheetfile)) {
580                 $files['plugin_'.$plugin] = $sheetfile;
581             }
582         }
583         // then parent themes
584         foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
585             if (empty($parent_config->editor_sheets)) {
586                 continue;
587             }
588             foreach ($parent_config->editor_sheets as $sheet) {
589                 $sheetfile = "$parent_config->dir/style/$sheet.css";
590                 if (is_readable($sheetfile)) {
591                     $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
592                 }
593             }
594         }
595         // finally this theme
596         if (!empty($this->editor_sheets)) {
597             foreach ($this->editor_sheets as $sheet) {
598                 $sheetfile = "$this->dir/style/$sheet.css";
599                 if (is_readable($sheetfile)) {
600                     $files['theme_'.$sheet] = $sheetfile;
601                 }
602             }
603         }
605         return $files;
606     }
608     /**
609      * Get the stylesheet URL of this theme
610      *
611      * @param moodle_page $page Not used... deprecated?
612      * @return array of moodle_url
613      */
614     public function css_urls(moodle_page $page) {
615         global $CFG;
617         $rev = theme_get_revision();
619         $urls = array();
621         $svg = $this->use_svg_icons();
623         if ($rev > -1) {
624             $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
625             if (check_browser_version('MSIE', 5)) {
626                 // We need to split the CSS files for IE
627                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'plugins', 'svg' => '0'));
628                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'parents', 'svg' => '0'));
629                 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'theme', 'svg' => '0'));
630             } else {
631                 if (!empty($CFG->slasharguments)) {
632                     $slashargs = '/'.$this->name.'/'.$rev.'/all';
633                     if (!$svg) {
634                         // We add a simple /_s to the start of the path.
635                         // The underscore is used to ensure that it isn't a valid theme name.
636                         $slashargs = '/_s'.$slashargs;
637                     }
638                     $url->set_slashargument($slashargs, 'noparam', true);
639                 } else {
640                     $params = array('theme' => $this->name,'rev' => $rev, 'type' => 'all');
641                     if (!$svg) {
642                         // We add an SVG param so that we know not to serve SVG images.
643                         // We do this because all modern browsers support SVG and this param will one day be removed.
644                         $params['svg'] = '0';
645                     }
646                     $url->params($params);
647                 }
648                 $urls[] = $url;
649             }
650         } else {
651             // find out the current CSS and cache it now for 5 seconds
652             // the point is to construct the CSS only once and pass it through the
653             // dataroot to the script that actually serves the sheets
654             if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
655                 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
656             }
657             $candidatedir = "$CFG->cachedir/theme/$this->name";
658             if ($svg) {
659                 $candidatesheet = "$candidatedir/designer.ser";
660             } else {
661                 $candidatesheet = "$candidatedir/designer_nosvg.ser";
662             }
663             $rebuild = true;
664             if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
665                 if ($css = file_get_contents($candidatesheet)) {
666                     $css = unserialize($css);
667                     if (is_array($css)) {
668                         $rebuild = false;
669                     }
670                 }
671             }
672             if ($rebuild) {
673                 // Prepare the CSS optimiser if it is to be used,
674                 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
675                 $optimiser = null;
676                 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
677                     require_once($CFG->dirroot.'/lib/csslib.php');
678                     $optimiser = new css_optimiser;
679                 }
680                 $css = $this->css_content($optimiser);
682                 // We do not want any errors here because this may fail easily because of the concurrent access.
683                 $prevabort = ignore_user_abort(true);
684                 check_dir_exists($candidatedir);
685                 $tempfile = tempnam($candidatedir, 'tmpdesigner');
686                 file_put_contents($tempfile, serialize($css));
687                 $reporting = error_reporting(0);
688                 chmod($tempfile, $CFG->filepermissions);
689                 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
690                 rename($tempfile, $candidatesheet);
691                 error_reporting($reporting);
692                 ignore_user_abort($prevabort);
693             }
695             $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
696             if (!$svg) {
697                 // We add an SVG param so that we know not to serve SVG images.
698                 // We do this because all modern browsers support SVG and this param will one day be removed.
699                 $baseurl->param('svg', '0');
700             }
701             if (check_browser_version('MSIE', 5)) {
702                 // lalala, IE does not allow more than 31 linked CSS files from main document
703                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
704                 foreach ($css['parents'] as $parent=>$sheets) {
705                     // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
706                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
707                 }
708                 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
710             } else {
711                 foreach ($css['plugins'] as $plugin=>$unused) {
712                     $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
713                 }
714                 foreach ($css['parents'] as $parent=>$sheets) {
715                     foreach ($sheets as $sheet=>$unused2) {
716                         $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
717                     }
718                 }
719                 foreach ($css['theme'] as $sheet=>$unused) {
720                     $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme')); // sheet first in order to make long urls easier to read
721                 }
722             }
723         }
725         return $urls;
726     }
728     /**
729      * Returns an array of organised CSS files required for this output
730      *
731      * @return array
732      */
733     public function css_files() {
734         $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
736         // get all plugin sheets
737         $excludes = $this->resolve_excludes('plugins_exclude_sheets');
738         if ($excludes !== true) {
739             foreach (get_plugin_types() as $type=>$unused) {
740                 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
741                     continue;
742                 }
743                 $plugins = get_plugin_list($type);
744                 foreach ($plugins as $plugin=>$fulldir) {
745                     if (!empty($excludes[$type]) and is_array($excludes[$type])
746                         and in_array($plugin, $excludes[$type])) {
747                         continue;
748                     }
750                     $plugincontent = '';
751                     $sheetfile = "$fulldir/styles.css";
752                     if (is_readable($sheetfile)) {
753                         $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
754                     }
755                     $sheetthemefile = "$fulldir/styles_{$this->name}.css";
756                     if (is_readable($sheetthemefile)) {
757                         $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
758                     }
759                     }
760                 }
761             }
763         // find out wanted parent sheets
764         $excludes = $this->resolve_excludes('parents_exclude_sheets');
765         if ($excludes !== true) {
766             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
767                 $parent = $parent_config->name;
768                 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
769                     continue;
770                 }
771                 foreach ($parent_config->sheets as $sheet) {
772                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
773                         and in_array($sheet, $excludes[$parent])) {
774                         continue;
775                     }
776                     $sheetfile = "$parent_config->dir/style/$sheet.css";
777                     if (is_readable($sheetfile)) {
778                         $cssfiles['parents'][$parent][$sheet] = $sheetfile;
779                     }
780                 }
781             }
782         }
784         // current theme sheets
785         if (is_array($this->sheets)) {
786             foreach ($this->sheets as $sheet) {
787                 $sheetfile = "$this->dir/style/$sheet.css";
788                 if (is_readable($sheetfile)) {
789                     $cssfiles['theme'][$sheet] = $sheetfile;
790                 }
791             }
792         }
794         return $cssfiles;
795     }
797     /**
798      * Returns the content of the one huge CSS merged from all style sheets.
799      *
800      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
801      * @return string
802      */
803     public function css_content(css_optimiser $optimiser = null) {
804         $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
805         $css = $this->css_files_get_contents($files, array(), $optimiser);
806         return $css;
807     }
809     /**
810      * Given an array of file paths or a single file path loads the contents of
811      * the CSS file, processes it then returns it in the same structure it was given.
812      *
813      * Can be used recursively on the results of {@link css_files}
814      *
815      * @param array|string $file An array of file paths or a single file path
816      * @param array $keys An array of previous array keys [recursive addition]
817      * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
818      * @return The converted array or the contents of the single file ($file type)
819      */
820     protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
821         global $CFG;
822         if (is_array($file)) {
823             foreach ($file as $key=>$f) {
824                 $file[$key] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
825             }
826             return $file;
827         } else {
828             $contents = file_get_contents($file);
829             $contents = $this->post_process($contents);
830             $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
831             $stats = '';
832             if (!is_null($optimiser)) {
833                 $contents = $optimiser->process($contents);
834                 if (!empty($CFG->cssoptimiserstats)) {
835                     $stats = $optimiser->output_stats_css();
836                 }
837             }
838             return $comment.$stats.$contents;
839         }
840     }
843     /**
844      * Generate a URL to the file that serves theme JavaScript files.
845      *
846      * @param bool $inhead true means head url, false means footer
847      * @return moodle_url
848      */
849     public function javascript_url($inhead) {
850         global $CFG;
852         $rev = theme_get_revision();
853         $params = array('theme'=>$this->name,'rev'=>$rev);
854         $params['type'] = $inhead ? 'head' : 'footer';
856         if (!empty($CFG->slasharguments) and $rev > 0) {
857             $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
858             $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
859             return $url;
860         } else {
861             return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
862         }
863     }
865     /**
866      * Get the URL's for the JavaScript files used by this theme.
867      * They won't be served directly, instead they'll be mediated through
868      * theme/javascript.php.
869      *
870      * @param string $type Either javascripts_footer, or javascripts
871      * @return array
872      */
873     public function javascript_files($type) {
874         if ($type === 'footer') {
875             $type = 'javascripts_footer';
876         } else {
877             $type = 'javascripts';
878         }
880         $js = array();
881         // find out wanted parent javascripts
882         $excludes = $this->resolve_excludes('parents_exclude_javascripts');
883         if ($excludes !== true) {
884             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
885                 $parent = $parent_config->name;
886                 if (empty($parent_config->$type)) {
887                     continue;
888                 }
889                 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
890                     continue;
891                 }
892                 foreach ($parent_config->$type as $javascript) {
893                     if (!empty($excludes[$parent]) and is_array($excludes[$parent])
894                         and in_array($javascript, $excludes[$parent])) {
895                         continue;
896                     }
897                     $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
898                     if (is_readable($javascriptfile)) {
899                         $js[] = $javascriptfile;
900                     }
901                 }
902             }
903         }
905         // current theme javascripts
906         if (is_array($this->$type)) {
907             foreach ($this->$type as $javascript) {
908                 $javascriptfile = "$this->dir/javascript/$javascript.js";
909                 if (is_readable($javascriptfile)) {
910                     $js[] = $javascriptfile;
911                 }
912             }
913         }
915         return $js;
916     }
918     /**
919      * Resolves an exclude setting to the themes setting is applicable or the
920      * setting of its closest parent.
921      *
922      * @param string $variable The name of the setting the exclude setting to resolve
923      * @param string $default
924      * @return mixed
925      */
926     protected function resolve_excludes($variable, $default = null) {
927         $setting = $default;
928         if (is_array($this->{$variable}) or $this->{$variable} === true) {
929             $setting = $this->{$variable};
930         } else {
931             foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
932                 if (!isset($parent_config->{$variable})) {
933                     continue;
934                 }
935                 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
936                     $setting = $parent_config->{$variable};
937                     break;
938                 }
939             }
940         }
941         return $setting;
942     }
944     /**
945      * Returns the content of the one huge javascript file merged from all theme javascript files.
946      *
947      * @param bool $type
948      * @return string
949      */
950     public function javascript_content($type) {
951         $jsfiles = $this->javascript_files($type);
952         $js = '';
953         foreach ($jsfiles as $jsfile) {
954             $js .= file_get_contents($jsfile)."\n";
955         }
956         return $js;
957     }
959     /**
960      * Post processes CSS.
961      *
962      * This method post processes all of the CSS before it is served for this theme.
963      * This is done so that things such as image URL's can be swapped in and to
964      * run any specific CSS post process method the theme has requested.
965      * This allows themes to use CSS settings.
966      *
967      * @param string $css The CSS to process.
968      * @return string The processed CSS.
969      */
970     public function post_process($css) {
971         // now resolve all image locations
972         if (preg_match_all('/\[\[pix:([a-z_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
973             $replaced = array();
974             foreach ($matches as $match) {
975                 if (isset($replaced[$match[0]])) {
976                     continue;
977                 }
978                 $replaced[$match[0]] = true;
979                 $imagename = $match[2];
980                 $component = rtrim($match[1], '|');
981                 $imageurl = $this->pix_url($imagename, $component)->out(false);
982                  // we do not need full url because the image.php is always in the same dir
983                 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
984                 $css = str_replace($match[0], $imageurl, $css);
985             }
986         }
988         // now resolve all theme settings or do any other postprocessing
989         $csspostprocess = $this->csspostprocess;
990         if (function_exists($csspostprocess)) {
991             $css = $csspostprocess($css, $this);
992         }
994         return $css;
995     }
997     /**
998      * Return the URL for an image
999      *
1000      * @param string $imagename the name of the icon.
1001      * @param string $component specification of one plugin like in get_string()
1002      * @return moodle_url
1003      */
1004     public function pix_url($imagename, $component) {
1005         global $CFG;
1007         $params = array('theme'=>$this->name);
1008         $svg = $this->use_svg_icons();
1010         if (empty($component) or $component === 'moodle' or $component === 'core') {
1011             $params['component'] = 'core';
1012         } else {
1013             $params['component'] = $component;
1014         }
1016         $rev = theme_get_revision();
1017         if ($rev != -1) {
1018             $params['rev'] = $rev;
1019         }
1021         $params['image'] = $imagename;
1023         $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
1024         if (!empty($CFG->slasharguments) and $rev > 0) {
1025             $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1026             if (!$svg) {
1027                 // We add a simple /_s to the start of the path.
1028                 // The underscore is used to ensure that it isn't a valid theme name.
1029                 $path = '/_s'.$path;
1030             }
1031             $url->set_slashargument($path, 'noparam', true);
1032         } else {
1033             if (!$svg) {
1034                 // We add an SVG param so that we know not to serve SVG images.
1035                 // We do this because all modern browsers support SVG and this param will one day be removed.
1036                 $params['svg'] = '0';
1037             }
1038             $url->params($params);
1039         }
1041         return $url;
1042     }
1044     /**
1045      * Resolves the real image location.
1046      *
1047      * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1048      * and we need a way in which to turn it off.
1049      * By default SVG won't be used unless asked for. This is done for two reasons:
1050      *   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
1051      *      browser supports SVG.
1052      *   2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1053      *      by the user due to security concerns.
1054      *
1055      * @param string $image name of image, may contain relative path
1056      * @param string $component
1057      * @param bool $svg If set to true SVG images will also be looked for.
1058      * @return string full file path
1059      */
1060     public function resolve_image_location($image, $component, $svg = false) {
1061         global $CFG;
1063         if (!is_bool($svg)) {
1064             // If $svg isn't a bool then we need to decide for ourselves.
1065             $svg = $this->use_svg_icons();
1066         }
1068         if ($component === 'moodle' or $component === 'core' or empty($component)) {
1069             if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
1070                 return $imagefile;
1071             }
1072             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1073                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
1074                     return $imagefile;
1075                 }
1076             }
1077             if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
1078                 return $imagefile;
1079             }
1080             if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
1081                 return $imagefile;
1082             }
1083             return null;
1085         } else if ($component === 'theme') { //exception
1086             if ($image === 'favicon') {
1087                 return "$this->dir/pix/favicon.ico";
1088             }
1089             if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
1090                 return $imagefile;
1091             }
1092             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1093                 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
1094                     return $imagefile;
1095                 }
1096             }
1097             return null;
1099         } else {
1100             if (strpos($component, '_') === false) {
1101                 $component = 'mod_'.$component;
1102             }
1103             list($type, $plugin) = explode('_', $component, 2);
1105             if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1106                 return $imagefile;
1107             }
1108             foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1109                 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
1110                     return $imagefile;
1111                 }
1112             }
1113             if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
1114                 return $imagefile;
1115             }
1116             $dir = get_plugin_directory($type, $plugin);
1117             if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
1118                 return $imagefile;
1119             }
1120             return null;
1121         }
1122     }
1124     /**
1125      * Return true if we should look for SVG images as well.
1126      *
1127      * @staticvar bool $svg
1128      * @return bool
1129      */
1130     public function use_svg_icons() {
1131         global $CFG;
1132         if ($this->usesvg === null) {
1133             if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1134                 // IE 5 - 8 don't support SVG at all.
1135                 if (empty($_SERVER['HTTP_USER_AGENT'])) {
1136                     // Can't be sure, just say no.
1137                     $this->usesvg = false;
1138                 } else if (check_browser_version('MSIE', 0) and !check_browser_version('MSIE', 9)) {
1139                     // IE < 9 doesn't support SVG. Say no.
1140                     $this->usesvg = false;
1141                 } else if (preg_match('#Android +[0-2]\.#', $_SERVER['HTTP_USER_AGENT'])) {
1142                     // Android < 3 doesn't support SVG. Say no.
1143                     $this->usesvg = false;
1144                 } else if (check_browser_version('Opera', 0)) {
1145                     // Opera 12 still does not support SVG well enough. Say no.
1146                     $this->usesvg = false;
1147                 } else {
1148                     // Presumed fine.
1149                     $this->usesvg = true;
1150                 }
1151             } else {
1152                 // Force them on/off depending upon the setting.
1153                 $this->usesvg = $CFG->svgicons;
1154             }
1155         }
1156         return $this->usesvg;
1157     }
1159     /**
1160      * Forces the usesvg setting to either true or false, avoiding any decision making.
1161      *
1162      * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
1163      * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
1164      *
1165      * @param bool $setting True to force the use of svg when available, null otherwise.
1166      */
1167     public function force_svg_use($setting) {
1168         $this->usesvg = (bool)$setting;
1169     }
1171     /**
1172      * Checks if file with any image extension exists.
1173      *
1174      * The order to these images was adjusted prior to the release of 2.4
1175      * At that point the were the following image counts in Moodle core:
1176      *
1177      *     - png = 667 in pix dirs (1499 total)
1178      *     - gif = 385 in pix dirs (606 total)
1179      *     - jpg = 62  in pix dirs (74 total)
1180      *     - jpeg = 0  in pix dirs (1 total)
1181      *
1182      * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1183      *
1184      * @param string $filepath
1185      * @param bool $svg If set to true SVG images will also be looked for.
1186      * @return string image name with extension
1187      */
1188     private static function image_exists($filepath, $svg = false) {
1189         if ($svg && file_exists("$filepath.svg")) {
1190             return "$filepath.svg";
1191         } else  if (file_exists("$filepath.png")) {
1192             return "$filepath.png";
1193         } else if (file_exists("$filepath.gif")) {
1194             return "$filepath.gif";
1195         } else  if (file_exists("$filepath.jpg")) {
1196             return "$filepath.jpg";
1197         } else  if (file_exists("$filepath.jpeg")) {
1198             return "$filepath.jpeg";
1199         } else {
1200             return false;
1201         }
1202     }
1204     /**
1205      * Loads the theme config from config.php file.
1206      *
1207      * @param string $themename
1208      * @param stdClass $settings from config_plugins table
1209      * @return stdClass The theme configuration
1210      */
1211     private static function find_theme_config($themename, $settings) {
1212         // We have to use the variable name $THEME (upper case) because that
1213         // is what is used in theme config.php files.
1215         if (!$dir = theme_config::find_theme_location($themename)) {
1216             return null;
1217         }
1219         $THEME = new stdClass();
1220         $THEME->name     = $themename;
1221         $THEME->dir      = $dir;
1222         $THEME->settings = $settings;
1224         global $CFG; // just in case somebody tries to use $CFG in theme config
1225         include("$THEME->dir/config.php");
1227         // verify the theme configuration is OK
1228         if (!is_array($THEME->parents)) {
1229             // parents option is mandatory now
1230             return null;
1231         }
1233         return $THEME;
1234     }
1236     /**
1237      * Finds the theme location and verifies the theme has all needed files
1238      * and is not obsoleted.
1239      *
1240      * @param string $themename
1241      * @return string full dir path or null if not found
1242      */
1243     private static function find_theme_location($themename) {
1244         global $CFG;
1246         if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1247             $dir = "$CFG->dirroot/theme/$themename";
1249         } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1250             $dir = "$CFG->themedir/$themename";
1252         } else {
1253             return null;
1254         }
1256         if (file_exists("$dir/styles.php")) {
1257             //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1258             return null;
1259         }
1261         return $dir;
1262     }
1264     /**
1265      * Get the renderer for a part of Moodle for this theme.
1266      *
1267      * @param moodle_page $page the page we are rendering
1268      * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
1269      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
1270      * @param string $target one of rendering target constants
1271      * @return renderer_base the requested renderer.
1272      */
1273     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
1274         if (is_null($this->rf)) {
1275             $classname = $this->rendererfactory;
1276             $this->rf = new $classname($this);
1277         }
1279         return $this->rf->get_renderer($page, $component, $subtype, $target);
1280     }
1282     /**
1283      * Get the information from {@link $layouts} for this type of page.
1284      *
1285      * @param string $pagelayout the the page layout name.
1286      * @return array the appropriate part of {@link $layouts}.
1287      */
1288     protected function layout_info_for_page($pagelayout) {
1289         if (array_key_exists($pagelayout, $this->layouts)) {
1290             return $this->layouts[$pagelayout];
1291         } else {
1292             debugging('Invalid page layout specified: ' . $pagelayout);
1293             return $this->layouts['standard'];
1294         }
1295     }
1297     /**
1298      * Given the settings of this theme, and the page pagelayout, return the
1299      * full path of the page layout file to use.
1300      *
1301      * Used by {@link core_renderer::header()}.
1302      *
1303      * @param string $pagelayout the the page layout name.
1304      * @return string Full path to the lyout file to use
1305      */
1306     public function layout_file($pagelayout) {
1307         global $CFG;
1309         $layoutinfo = $this->layout_info_for_page($pagelayout);
1310         $layoutfile = $layoutinfo['file'];
1312         if (array_key_exists('theme', $layoutinfo)) {
1313             $themes = array($layoutinfo['theme']);
1314         } else {
1315             $themes = array_merge(array($this->name),$this->parents);
1316         }
1318         foreach ($themes as $theme) {
1319             if ($dir = $this->find_theme_location($theme)) {
1320                 $path = "$dir/layout/$layoutfile";
1322                 // Check the template exists, return general base theme template if not.
1323                 if (is_readable($path)) {
1324                     return $path;
1325                 }
1326             }
1327         }
1329         debugging('Can not find layout file for: ' . $pagelayout);
1330         // fallback to standard normal layout
1331         return "$CFG->dirroot/theme/base/layout/general.php";
1332     }
1334     /**
1335      * Returns auxiliary page layout options specified in layout configuration array.
1336      *
1337      * @param string $pagelayout
1338      * @return array
1339      */
1340     public function pagelayout_options($pagelayout) {
1341         $info = $this->layout_info_for_page($pagelayout);
1342         if (!empty($info['options'])) {
1343             return $info['options'];
1344         }
1345         return array();
1346     }
1348     /**
1349      * Inform a block_manager about the block regions this theme wants on this
1350      * page layout.
1351      *
1352      * @param string $pagelayout the general type of the page.
1353      * @param block_manager $blockmanager the block_manger to set up.
1354      */
1355     public function setup_blocks($pagelayout, $blockmanager) {
1356         $layoutinfo = $this->layout_info_for_page($pagelayout);
1357         if (!empty($layoutinfo['regions'])) {
1358             $blockmanager->add_regions($layoutinfo['regions']);
1359             $blockmanager->set_default_region($layoutinfo['defaultregion']);
1360         }
1361     }
1363     /**
1364      * Gets the visible name for the requested block region.
1365      *
1366      * @param string $region The region name to get
1367      * @param string $theme The theme the region belongs to (may come from the parent theme)
1368      * @return string
1369      */
1370     protected function get_region_name($region, $theme) {
1371         $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1372         // A name exists in this theme, so use it
1373         if (substr($regionstring, 0, 1) != '[') {
1374             return $regionstring;
1375         }
1377         // Otherwise, try to find one elsewhere
1378         // Check parents, if any
1379         foreach ($this->parents as $parentthemename) {
1380             $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1381             if (substr($regionstring, 0, 1) != '[') {
1382                 return $regionstring;
1383             }
1384         }
1386         // Last resort, try the base theme for names
1387         return get_string('region-' . $region, 'theme_base');
1388     }
1390     /**
1391      * Get the list of all block regions known to this theme in all templates.
1392      *
1393      * @return array internal region name => human readable name.
1394      */
1395     public function get_all_block_regions() {
1396         $regions = array();
1397         foreach ($this->layouts as $layoutinfo) {
1398             foreach ($layoutinfo['regions'] as $region) {
1399                 $regions[$region] = $this->get_region_name($region, $this->name);
1400             }
1401         }
1402         return $regions;
1403     }
1405     /**
1406      * Returns the human readable name of the theme
1407      *
1408      * @return string
1409      */
1410     public function get_theme_name() {
1411         return get_string('pluginname', 'theme_'.$this->name);
1412     }
1415 /**
1416  * This class keeps track of which HTML tags are currently open.
1417  *
1418  * This makes it much easier to always generate well formed XHTML output, even
1419  * if execution terminates abruptly. Any time you output some opening HTML
1420  * without the matching closing HTML, you should push the necessary close tags
1421  * onto the stack.
1422  *
1423  * @copyright 2009 Tim Hunt
1424  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1425  * @since Moodle 2.0
1426  * @package core
1427  * @category output
1428  */
1429 class xhtml_container_stack {
1431     /**
1432      * @var array Stores the list of open containers.
1433      */
1434     protected $opencontainers = array();
1436     /**
1437      * @var array In developer debug mode, stores a stack trace of all opens and
1438      * closes, so we can output helpful error messages when there is a mismatch.
1439      */
1440     protected $log = array();
1442     /**
1443      * @var boolean Store whether we are developer debug mode. We need this in
1444      * several places including in the destructor where we may not have access to $CFG.
1445      */
1446     protected $isdebugging;
1448     /**
1449      * Constructor
1450      */
1451     public function __construct() {
1452         $this->isdebugging = debugging('', DEBUG_DEVELOPER);
1453     }
1455     /**
1456      * Push the close HTML for a recently opened container onto the stack.
1457      *
1458      * @param string $type The type of container. This is checked when {@link pop()}
1459      *      is called and must match, otherwise a developer debug warning is output.
1460      * @param string $closehtml The HTML required to close the container.
1461      */
1462     public function push($type, $closehtml) {
1463         $container = new stdClass;
1464         $container->type = $type;
1465         $container->closehtml = $closehtml;
1466         if ($this->isdebugging) {
1467             $this->log('Open', $type);
1468         }
1469         array_push($this->opencontainers, $container);
1470     }
1472     /**
1473      * Pop the HTML for the next closing container from the stack. The $type
1474      * must match the type passed when the container was opened, otherwise a
1475      * warning will be output.
1476      *
1477      * @param string $type The type of container.
1478      * @return string the HTML required to close the container.
1479      */
1480     public function pop($type) {
1481         if (empty($this->opencontainers)) {
1482             debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1483                     $this->output_log(), DEBUG_DEVELOPER);
1484             return;
1485         }
1487         $container = array_pop($this->opencontainers);
1488         if ($container->type != $type) {
1489             debugging('<p>The type of container to be closed (' . $container->type .
1490                     ') does not match the type of the next open container (' . $type .
1491                     '). This suggests there is a nesting problem.</p>' .
1492                     $this->output_log(), DEBUG_DEVELOPER);
1493         }
1494         if ($this->isdebugging) {
1495             $this->log('Close', $type);
1496         }
1497         return $container->closehtml;
1498     }
1500     /**
1501      * Close all but the last open container. This is useful in places like error
1502      * handling, where you want to close all the open containers (apart from <body>)
1503      * before outputting the error message.
1504      *
1505      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1506      *      developer debug warning if it isn't.
1507      * @return string the HTML required to close any open containers inside <body>.
1508      */
1509     public function pop_all_but_last($shouldbenone = false) {
1510         if ($shouldbenone && count($this->opencontainers) != 1) {
1511             debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1512                     $this->output_log(), DEBUG_DEVELOPER);
1513         }
1514         $output = '';
1515         while (count($this->opencontainers) > 1) {
1516             $container = array_pop($this->opencontainers);
1517             $output .= $container->closehtml;
1518         }
1519         return $output;
1520     }
1522     /**
1523      * You can call this function if you want to throw away an instance of this
1524      * class without properly emptying the stack (for example, in a unit test).
1525      * Calling this method stops the destruct method from outputting a developer
1526      * debug warning. After calling this method, the instance can no longer be used.
1527      */
1528     public function discard() {
1529         $this->opencontainers = null;
1530     }
1532     /**
1533      * Adds an entry to the log.
1534      *
1535      * @param string $action The name of the action
1536      * @param string $type The type of action
1537      */
1538     protected function log($action, $type) {
1539         $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1540                 format_backtrace(debug_backtrace()) . '</li>';
1541     }
1543     /**
1544      * Outputs the log's contents as a HTML list.
1545      *
1546      * @return string HTML list of the log
1547      */
1548     protected function output_log() {
1549         return '<ul>' . implode("\n", $this->log) . '</ul>';
1550     }