theme/styles_debug.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/>.
  16
  17 /**
  18  * This file is responsible for serving of individual style sheets in designer mode.
  19  *
  20  * @package   core
  21  * @copyright 2009 Petr Skoda (skodak)  {@link http://skodak.org}
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 // Disable moodle specific debug messages and any errors in output,
  26 // comment out when debugging or better look into error log!
  27 define('NO_DEBUG_DISPLAY', true);
  28 define('NO_UPGRADE_CHECK', true);
  29 define('NO_MOODLE_COOKIES', true);
  30
  31 require('../config.php');
  32 require_once($CFG->dirroot.'/lib/csslib.php');
  33
  34 $themename = optional_param('theme', 'standard', PARAM_SAFEDIR);
  35 $type      = optional_param('type', '', PARAM_SAFEDIR);
  36 $subtype   = optional_param('subtype', '', PARAM_SAFEDIR);
  37 $sheet     = optional_param('sheet', '', PARAM_SAFEDIR);
  38 $usesvg    = optional_param('svg', 1, PARAM_BOOL);
  39 $chunk     = optional_param('chunk', null, PARAM_INT);
  40 $rtl       = optional_param('rtl', false, PARAM_BOOL);
  41
  42 if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
  43     // The theme exists in standard location - ok.
  44 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
  45     // Alternative theme location contains this theme - ok.
  46 } else {
  47     css_send_css_not_found();
  48 }
  49
  50 $theme = theme_config::load($themename);
  51 $theme->force_svg_use($usesvg);
  52 $theme->set_rtl_mode($rtl);
  53
  54 if ($type === 'editor') {
  55     $csscontent = $theme->get_css_content_editor();
  56     css_send_uncached_css($csscontent);
  57 }
  58
  59 $chunkurl = new moodle_url($CFG->httpswwwroot . '/theme/styles_debug.php', array('theme' => $themename,
  60     'type' => $type, 'subtype' => $subtype, 'sheet' => $sheet, 'usesvg' => $usesvg, 'rtl' => $rtl));
  61
  62 // We need some kind of caching here because otherwise the page navigation becomes
  63 // way too slow in theme designer mode. Feel free to create full cache definition later...
  64 $key = "$type $subtype $sheet $usesvg $rtl";
  65 $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner', array('theme' => $themename));
  66 if ($content = $cache->get($key)) {
  67     if ($content['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME) {
  68         $csscontent = $content['data'];
  69
  70         // We need to chunk the content.
  71         if ($chunk !== null) {
  72             $chunks = css_chunk_by_selector_count($csscontent, $chunkurl->out(false));
  73             $csscontent = ($chunk === 0) ? end($chunks) : $chunks[$chunk - 1];
  74         }
  75
  76         css_send_uncached_css($csscontent);
  77     }
  78 }
  79
  80 $csscontent = $theme->get_css_content_debug($type, $subtype, $sheet);
  81 $cache->set($key, array('data' => $csscontent, 'created' => time()));
  82
  83 // We need to chunk the content.
  84 if ($chunk !== null) {
  85     // The chunks are ordered so that the last chunk is the one containing the @import, and so
  86     // the first one to be included. All the other chunks are set in the array before that one.
  87     // See {@link css_chunk_by_selector_count()} for more details.
  88     $chunks = css_chunk_by_selector_count($csscontent, $chunkurl->out(false));
  89     $csscontent = ($chunk === 0) ? end($chunks) : $chunks[$chunk - 1];
  90 }
  91
  92 css_send_uncached_css($csscontent);