xref: /dokuwiki/lib/exe/css.php (revision 8036aaf2ed03c0233579841311fc9835e032e4dc) 
1<?php
2/**
3 * DokuWiki StyleSheet creator
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) define('DOKU_INC',dirname(__FILE__).'/../../');
10if(!defined('NOSESSION')) define('NOSESSION',true); // we do not use a session or authentication here (better caching)
11if(!defined('DOKU_DISABLE_GZIP_OUTPUT')) define('DOKU_DISABLE_GZIP_OUTPUT',1); // we gzip ourself here
12if(!defined('NL')) define('NL',"\n");
13require_once(DOKU_INC.'inc/init.php');
14
15// Main (don't run when UNIT test)
16if(!defined('SIMPLE_TEST')){
17    header('Content-Type: text/css; charset=utf-8');
18    css_out();
19}
20
21
22// ---------------------- functions ------------------------------
23
24/**
25 * Output all needed Styles
26 *
27 * @author Andreas Gohr <andi@splitbrain.org>
28 */
29function css_out(){
30    global $conf;
31    global $lang;
32    global $config_cascade;
33    global $INPUT;
34
35    if ($INPUT->str('s') == 'feed') {
36        $mediatypes = array('feed');
37        $type = 'feed';
38    } else {
39        $mediatypes = array('screen', 'all', 'print');
40        $type = '';
41    }
42
43    $tpl = trim(preg_replace('/[^\w-]+/','',$INPUT->str('t')));
44    if($tpl){
45        $tplinc = DOKU_INC.'lib/tpl/'.$tpl.'/';
46        $tpldir = DOKU_BASE.'lib/tpl/'.$tpl.'/';
47    }else{
48        $tplinc = tpl_incdir();
49        $tpldir = tpl_basedir();
50    }
51
52    // used style.ini file
53    $styleini = css_styleini($tplinc);
54
55    // The generated script depends on some dynamic options
56    $cache = new cache('styles'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'].DOKU_BASE.$tplinc.$type,'.css');
57
58    // load template styles
59    $tplstyles = array();
60    if ($styleini) {
61        foreach($styleini['stylesheets'] as $file => $mode) {
62            $tplstyles[$mode][$tplinc.$file] = $tpldir;
63        }
64    }
65
66    // if old 'default' userstyle setting exists, make it 'screen' userstyle for backwards compatibility
67    if (isset($config_cascade['userstyle']['default'])) {
68        $config_cascade['userstyle']['screen'] = $config_cascade['userstyle']['default'];
69    }
70
71    // Array of needed files and their web locations, the latter ones
72    // are needed to fix relative paths in the stylesheets
73    $files = array();
74
75    $cache_files = getConfigFiles('main');
76    $cache_files[] = $tplinc.'style.ini';
77    $cache_files[] = $tplinc.'style.local.ini';
78    $cache_files[] = __FILE__;
79
80    foreach($mediatypes as $mediatype) {
81        $files[$mediatype] = array();
82        // load core styles
83        $files[$mediatype][DOKU_INC.'lib/styles/'.$mediatype.'.css'] = DOKU_BASE.'lib/styles/';
84        // load jQuery-UI theme
85        if ($mediatype == 'screen') {
86            $files[$mediatype][DOKU_INC.'lib/scripts/jquery/jquery-ui-theme/smoothness.css'] = DOKU_BASE.'lib/scripts/jquery/jquery-ui-theme/';
87        }
88        // load plugin styles
89        $files[$mediatype] = array_merge($files[$mediatype], css_pluginstyles($mediatype));
90        // load template styles
91        if (isset($tplstyles[$mediatype])) {
92            $files[$mediatype] = array_merge($files[$mediatype], $tplstyles[$mediatype]);
93        }
94        // load user styles
95        if(isset($config_cascade['userstyle'][$mediatype])){
96            $files[$mediatype][$config_cascade['userstyle'][$mediatype]] = DOKU_BASE;
97        }
98        // load rtl styles
99        // note: this adds the rtl styles only to the 'screen' media type
100        // @deprecated 2012-04-09: rtl will cease to be a mode of its own,
101        //     please use "[dir=rtl]" in any css file in all, screen or print mode instead
102        if ($mediatype=='screen') {
103            if($lang['direction'] == 'rtl'){
104                if (isset($tplstyles['rtl'])) $files[$mediatype] = array_merge($files[$mediatype], $tplstyles['rtl']);
105                if (isset($config_cascade['userstyle']['rtl'])) $files[$mediatype][$config_cascade['userstyle']['rtl']] = DOKU_BASE;
106            }
107        }
108
109        $cache_files = array_merge($cache_files, array_keys($files[$mediatype]));
110    }
111
112    // check cache age & handle conditional request
113    // This may exit if a cache can be used
114    http_cached($cache->cache,
115                $cache->useCache(array('files' => $cache_files)));
116
117    // start output buffering
118    ob_start();
119
120    // build the stylesheet
121    foreach ($mediatypes as $mediatype) {
122
123        // print the default classes for interwiki links and file downloads
124        if ($mediatype == 'screen') {
125            print '@media screen {';
126            css_interwiki();
127            css_filetypes();
128            print '}';
129        }
130
131        // load files
132        $css_content = '';
133        foreach($files[$mediatype] as $file => $location){
134            $css_content .= css_loadfile($file, $location);
135        }
136        switch ($mediatype) {
137            case 'screen':
138                print NL.'@media screen { /* START screen styles */'.NL.$css_content.NL.'} /* /@media END screen styles */'.NL;
139                break;
140            case 'print':
141                print NL.'@media print { /* START print styles */'.NL.$css_content.NL.'} /* /@media END print styles */'.NL;
142                break;
143            case 'all':
144            case 'feed':
145            default:
146                print NL.'/* START rest styles */ '.NL.$css_content.NL.'/* END rest styles */'.NL;
147                break;
148        }
149    }
150    // end output buffering and get contents
151    $css = ob_get_contents();
152    ob_end_clean();
153
154    // apply style replacements
155    $css = css_applystyle($css,$tplinc);
156
157    // place all @import statements at the top of the file
158    $css = css_moveimports($css);
159
160    // compress whitespace and comments
161    if($conf['compress']){
162        $css = css_compress($css);
163    }
164
165    // embed small images right into the stylesheet
166    if($conf['cssdatauri']){
167        $base = preg_quote(DOKU_BASE,'#');
168        $css = preg_replace_callback('#(url\([ \'"]*)('.$base.')(.*?(?:\.(png|gif)))#i','css_datauri',$css);
169    }
170
171    http_cached_finish($cache->cache, $css);
172}
173
174/**
175 * Does placeholder replacements in the style according to
176 * the ones defined in a templates style.ini file
177 *
178 * @author Andreas Gohr <andi@splitbrain.org>
179 */
180function css_applystyle($css,$tplinc){
181    $styleini = css_styleini($tplinc);
182
183    if($styleini){
184        $css = strtr($css,$styleini['replacements']);
185    }
186    return $css;
187}
188
189/**
190 * Get contents of merged style.ini and style.local.ini as an array.
191 *
192 * @author Anika Henke <anika@selfthinker.org>
193 */
194function css_styleini($tplinc) {
195    $styleini = array();
196
197    foreach (array($tplinc.'style.ini', $tplinc.'style.local.ini') as $ini) {
198        $tmp = (@file_exists($ini)) ? parse_ini_file($ini, true) : array();
199
200        foreach($tmp as $key => $value) {
201            if(array_key_exists($key, $styleini) && is_array($value)) {
202                $styleini[$key] = array_merge($styleini[$key], $tmp[$key]);
203            } else {
204                $styleini[$key] = $value;
205            }
206        }
207    }
208    return $styleini;
209}
210
211/**
212 * Prints classes for interwikilinks
213 *
214 * Interwiki links have two classes: 'interwiki' and 'iw_$name>' where
215 * $name is the identifier given in the config. All Interwiki links get
216 * an default style with a default icon. If a special icon is available
217 * for an interwiki URL it is set in it's own class. Both classes can be
218 * overwritten in the template or userstyles.
219 *
220 * @author Andreas Gohr <andi@splitbrain.org>
221 */
222function css_interwiki(){
223
224    // default style
225    echo 'a.interwiki {';
226    echo ' background: transparent url('.DOKU_BASE.'lib/images/interwiki.png) 0px 1px no-repeat;';
227    echo ' padding: 1px 0px 1px 16px;';
228    echo '}';
229
230    // additional styles when icon available
231    $iwlinks = getInterwiki();
232    foreach(array_keys($iwlinks) as $iw){
233        $class = preg_replace('/[^_\-a-z0-9]+/i','_',$iw);
234        if(@file_exists(DOKU_INC.'lib/images/interwiki/'.$iw.'.png')){
235            echo "a.iw_$class {";
236            echo '  background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$iw.'.png)';
237            echo '}';
238        }elseif(@file_exists(DOKU_INC.'lib/images/interwiki/'.$iw.'.gif')){
239            echo "a.iw_$class {";
240            echo '  background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$iw.'.gif)';
241            echo '}';
242        }
243    }
244}
245
246/**
247 * Prints classes for file download links
248 *
249 * @author Andreas Gohr <andi@splitbrain.org>
250 */
251function css_filetypes(){
252
253    // default style
254    echo '.mediafile {';
255    echo ' background: transparent url('.DOKU_BASE.'lib/images/fileicons/file.png) 0px 1px no-repeat;';
256    echo ' padding-left: 18px;';
257    echo ' padding-bottom: 1px;';
258    echo '}';
259
260    // additional styles when icon available
261    // scan directory for all icons
262    $exts = array();
263    if($dh = opendir(DOKU_INC.'lib/images/fileicons')){
264        while(false !== ($file = readdir($dh))){
265            if(preg_match('/([_\-a-z0-9]+(?:\.[_\-a-z0-9]+)*?)\.(png|gif)/i',$file,$match)){
266                $ext = strtolower($match[1]);
267                $type = '.'.strtolower($match[2]);
268                if($ext!='file' && (!isset($exts[$ext]) || $type=='.png')){
269                    $exts[$ext] = $type;
270                }
271            }
272        }
273        closedir($dh);
274    }
275    foreach($exts as $ext=>$type){
276        $class = preg_replace('/[^_\-a-z0-9]+/','_',$ext);
277        echo ".mf_$class {";
278        echo '  background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.$type.')';
279        echo '}';
280    }
281}
282
283/**
284 * Loads a given file and fixes relative URLs with the
285 * given location prefix
286 */
287function css_loadfile($file,$location=''){
288    if(!@file_exists($file)) return '';
289    $css = io_readFile($file);
290    if(!$location) return $css;
291
292    $css = preg_replace('#(url\([ \'"]*)(?!/|data:|http://|https://| |\'|")#','\\1'.$location,$css);
293    $css = preg_replace('#(@import\s+[\'"])(?!/|data:|http://|https://)#', '\\1'.$location, $css);
294
295    return $css;
296}
297
298/**
299 * Converte local image URLs to data URLs if the filesize is small
300 *
301 * Callback for preg_replace_callback
302 */
303function css_datauri($match){
304    global $conf;
305
306    $pre   = unslash($match[1]);
307    $base  = unslash($match[2]);
308    $url   = unslash($match[3]);
309    $ext   = unslash($match[4]);
310
311    $local = DOKU_INC.$url;
312    $size  = @filesize($local);
313    if($size && $size < $conf['cssdatauri']){
314        $data = base64_encode(file_get_contents($local));
315    }
316    if($data){
317        $url = 'data:image/'.$ext.';base64,'.$data;
318    }else{
319        $url = $base.$url;
320    }
321    return $pre.$url;
322}
323
324
325/**
326 * Returns a list of possible Plugin Styles (no existance check here)
327 *
328 * @author Andreas Gohr <andi@splitbrain.org>
329 */
330function css_pluginstyles($mediatype='screen'){
331    global $lang;
332    $list = array();
333    $plugins = plugin_list();
334    foreach ($plugins as $p){
335        $list[DOKU_PLUGIN."$p/$mediatype.css"]  = DOKU_BASE."lib/plugins/$p/";
336        // alternative for screen.css
337        if ($mediatype=='screen') {
338            $list[DOKU_PLUGIN."$p/style.css"]  = DOKU_BASE."lib/plugins/$p/";
339        }
340        // @deprecated 2012-04-09: rtl will cease to be a mode of its own,
341        //     please use "[dir=rtl]" in any css file in all, screen or print mode instead
342        if($lang['direction'] == 'rtl'){
343            $list[DOKU_PLUGIN."$p/rtl.css"] = DOKU_BASE."lib/plugins/$p/";
344        }
345    }
346    return $list;
347}
348
349/**
350 * Move all @import statements in a combined stylesheet to the top so they
351 * aren't ignored by the browser.
352 *
353 * @author Gabriel Birke <birke@d-scribe.de>
354 */
355function css_moveimports($css)
356{
357    if(!preg_match_all('/@import\s+(?:url\([^)]+\)|"[^"]+")\s*[^;]*;\s*/', $css, $matches, PREG_OFFSET_CAPTURE)) {
358        return $css;
359    }
360    $newCss  = "";
361    $imports = "";
362    $offset  = 0;
363    foreach($matches[0] as $match) {
364        $newCss  .= substr($css, $offset, $match[1] - $offset);
365        $imports .= $match[0];
366        $offset   = $match[1] + strlen($match[0]);
367    }
368    $newCss .= substr($css, $offset);
369    return $imports.$newCss;
370}
371
372/**
373 * Very simple CSS optimizer
374 *
375 * @author Andreas Gohr <andi@splitbrain.org>
376 */
377function css_compress($css){
378    //strip comments through a callback
379    $css = preg_replace_callback('#(/\*)(.*?)(\*/)#s','css_comment_cb',$css);
380
381    //strip (incorrect but common) one line comments
382    $css = preg_replace('/(?<!:)\/\/.*$/m','',$css);
383
384    // strip whitespaces
385    $css = preg_replace('![\r\n\t ]+!',' ',$css);
386    $css = preg_replace('/ ?([;,{}\/]) ?/','\\1',$css);
387    $css = preg_replace('/ ?: /',':',$css);
388
389    // shorten colors
390    $css = preg_replace("/#([0-9a-fA-F]{1})\\1([0-9a-fA-F]{1})\\2([0-9a-fA-F]{1})\\3/", "#\\1\\2\\3",$css);
391
392    return $css;
393}
394
395/**
396 * Callback for css_compress()
397 *
398 * Keeps short comments (< 5 chars) to maintain typical browser hacks
399 *
400 * @author Andreas Gohr <andi@splitbrain.org>
401 */
402function css_comment_cb($matches){
403    if(strlen($matches[2]) > 4) return '';
404    return $matches[0];
405}
406
407//Setup VIM: ex: et ts=4 :
408