xref: /dokuwiki/lib/exe/css.php (revision fbaa87779929e23ede8a79fd3890ef493fdb1d81) 
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    // parse LESS
158    $less = new lessc();
159    $css = $less->compile($css);
160
161    // place all remaining @import statements at the top of the file
162    $css = css_moveimports($css);
163
164    // compress whitespace and comments
165    if($conf['compress']){
166        $css = css_compress($css);
167    }
168
169    // embed small images right into the stylesheet
170    if($conf['cssdatauri']){
171        $base = preg_quote(DOKU_BASE,'#');
172        $css = preg_replace_callback('#(url\([ \'"]*)('.$base.')(.*?(?:\.(png|gif)))#i','css_datauri',$css);
173    }
174
175    http_cached_finish($cache->cache, $css);
176}
177
178/**
179 * Does placeholder replacements in the style according to
180 * the ones defined in a templates style.ini file
181 *
182 * This also adds the ini defined placeholders as less variables
183 * (sans the surrounding __ and with a ini_ prefix)
184 *
185 * @author Andreas Gohr <andi@splitbrain.org>
186 */
187function css_applystyle($css,$tplinc){
188    $styleini = css_styleini($tplinc);
189
190    if($styleini){
191        // we convert ini replacements to LESS variable names
192        // and build a list of variable: value; pairs
193        $less = '';
194        foreach($styleini['replacements'] as $key => $value){
195            $lkey = trim($key, '_');
196            $lkey = '@ini_'.$lkey;
197            $less .= "$lkey: $value;\n";
198
199            $styleini['replacements'][$key] = $lkey;
200        }
201
202        // we now replace all old ini replacements with LESS variables
203        $css = strtr($css, $styleini['replacements']);
204
205        // now prepend the list of LESS variables as the very first thing
206        $css = $less.$css;
207    }
208    return $css;
209}
210
211/**
212 * Get contents of merged style.ini and style.local.ini as an array.
213 *
214 * @author Anika Henke <anika@selfthinker.org>
215 */
216function css_styleini($tplinc) {
217    $styleini = array();
218
219    foreach (array($tplinc.'style.ini', $tplinc.'style.local.ini') as $ini) {
220        $tmp = (@file_exists($ini)) ? parse_ini_file($ini, true) : array();
221
222        foreach($tmp as $key => $value) {
223            if(array_key_exists($key, $styleini) && is_array($value)) {
224                $styleini[$key] = array_merge($styleini[$key], $tmp[$key]);
225            } else {
226                $styleini[$key] = $value;
227            }
228        }
229    }
230    return $styleini;
231}
232
233/**
234 * Prints classes for interwikilinks
235 *
236 * Interwiki links have two classes: 'interwiki' and 'iw_$name>' where
237 * $name is the identifier given in the config. All Interwiki links get
238 * an default style with a default icon. If a special icon is available
239 * for an interwiki URL it is set in it's own class. Both classes can be
240 * overwritten in the template or userstyles.
241 *
242 * @author Andreas Gohr <andi@splitbrain.org>
243 */
244function css_interwiki(){
245
246    // default style
247    echo 'a.interwiki {';
248    echo ' background: transparent url('.DOKU_BASE.'lib/images/interwiki.png) 0px 1px no-repeat;';
249    echo ' padding: 1px 0px 1px 16px;';
250    echo '}';
251
252    // additional styles when icon available
253    $iwlinks = getInterwiki();
254    foreach(array_keys($iwlinks) as $iw){
255        $class = preg_replace('/[^_\-a-z0-9]+/i','_',$iw);
256        if(@file_exists(DOKU_INC.'lib/images/interwiki/'.$iw.'.png')){
257            echo "a.iw_$class {";
258            echo '  background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$iw.'.png)';
259            echo '}';
260        }elseif(@file_exists(DOKU_INC.'lib/images/interwiki/'.$iw.'.gif')){
261            echo "a.iw_$class {";
262            echo '  background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$iw.'.gif)';
263            echo '}';
264        }
265    }
266}
267
268/**
269 * Prints classes for file download links
270 *
271 * @author Andreas Gohr <andi@splitbrain.org>
272 */
273function css_filetypes(){
274
275    // default style
276    echo '.mediafile {';
277    echo ' background: transparent url('.DOKU_BASE.'lib/images/fileicons/file.png) 0px 1px no-repeat;';
278    echo ' padding-left: 18px;';
279    echo ' padding-bottom: 1px;';
280    echo '}';
281
282    // additional styles when icon available
283    // scan directory for all icons
284    $exts = array();
285    if($dh = opendir(DOKU_INC.'lib/images/fileicons')){
286        while(false !== ($file = readdir($dh))){
287            if(preg_match('/([_\-a-z0-9]+(?:\.[_\-a-z0-9]+)*?)\.(png|gif)/i',$file,$match)){
288                $ext = strtolower($match[1]);
289                $type = '.'.strtolower($match[2]);
290                if($ext!='file' && (!isset($exts[$ext]) || $type=='.png')){
291                    $exts[$ext] = $type;
292                }
293            }
294        }
295        closedir($dh);
296    }
297    foreach($exts as $ext=>$type){
298        $class = preg_replace('/[^_\-a-z0-9]+/','_',$ext);
299        echo ".mf_$class {";
300        echo '  background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.$type.')';
301        echo '}';
302    }
303}
304
305/**
306 * Loads a given file and fixes relative URLs with the
307 * given location prefix
308 */
309function css_loadfile($file,$location=''){
310    if(!@file_exists($file)) return '';
311    $css = io_readFile($file);
312    if(!$location) return $css;
313
314    $css = preg_replace('#(url\([ \'"]*)(?!/|data:|http://|https://| |\'|")#','\\1'.$location,$css);
315    $css = preg_replace('#(@import\s+[\'"])(?!/|data:|http://|https://)#', '\\1'.$location, $css);
316
317    return $css;
318}
319
320/**
321 * Converte local image URLs to data URLs if the filesize is small
322 *
323 * Callback for preg_replace_callback
324 */
325function css_datauri($match){
326    global $conf;
327
328    $pre   = unslash($match[1]);
329    $base  = unslash($match[2]);
330    $url   = unslash($match[3]);
331    $ext   = unslash($match[4]);
332
333    $local = DOKU_INC.$url;
334    $size  = @filesize($local);
335    if($size && $size < $conf['cssdatauri']){
336        $data = base64_encode(file_get_contents($local));
337    }
338    if($data){
339        $url = 'data:image/'.$ext.';base64,'.$data;
340    }else{
341        $url = $base.$url;
342    }
343    return $pre.$url;
344}
345
346
347/**
348 * Returns a list of possible Plugin Styles (no existance check here)
349 *
350 * @author Andreas Gohr <andi@splitbrain.org>
351 */
352function css_pluginstyles($mediatype='screen'){
353    global $lang;
354    $list = array();
355    $plugins = plugin_list();
356    foreach ($plugins as $p){
357        $list[DOKU_PLUGIN."$p/$mediatype.css"]  = DOKU_BASE."lib/plugins/$p/";
358        $list[DOKU_PLUGIN."$p/$mediatype.less"]  = DOKU_BASE."lib/plugins/$p/";
359        // alternative for screen.css
360        if ($mediatype=='screen') {
361            $list[DOKU_PLUGIN."$p/style.css"]  = DOKU_BASE."lib/plugins/$p/";
362            $list[DOKU_PLUGIN."$p/style.less"]  = DOKU_BASE."lib/plugins/$p/";
363        }
364        // @deprecated 2012-04-09: rtl will cease to be a mode of its own,
365        //     please use "[dir=rtl]" in any css file in all, screen or print mode instead
366        if($lang['direction'] == 'rtl'){
367            $list[DOKU_PLUGIN."$p/rtl.css"] = DOKU_BASE."lib/plugins/$p/";
368            $list[DOKU_PLUGIN."$p/rtl.less"] = DOKU_BASE."lib/plugins/$p/";
369        }
370    }
371    return $list;
372}
373
374/**
375 * Move all @import statements in a combined stylesheet to the top so they
376 * aren't ignored by the browser.
377 *
378 * @author Gabriel Birke <birke@d-scribe.de>
379 */
380function css_moveimports($css)
381{
382    if(!preg_match_all('/@import\s+(?:url\([^)]+\)|"[^"]+")\s*[^;]*;\s*/', $css, $matches, PREG_OFFSET_CAPTURE)) {
383        return $css;
384    }
385    $newCss  = "";
386    $imports = "";
387    $offset  = 0;
388    foreach($matches[0] as $match) {
389        $newCss  .= substr($css, $offset, $match[1] - $offset);
390        $imports .= $match[0];
391        $offset   = $match[1] + strlen($match[0]);
392    }
393    $newCss .= substr($css, $offset);
394    return $imports.$newCss;
395}
396
397/**
398 * Very simple CSS optimizer
399 *
400 * @author Andreas Gohr <andi@splitbrain.org>
401 */
402function css_compress($css){
403    //strip comments through a callback
404    $css = preg_replace_callback('#(/\*)(.*?)(\*/)#s','css_comment_cb',$css);
405
406    //strip (incorrect but common) one line comments
407    $css = preg_replace('/(?<!:)\/\/.*$/m','',$css);
408
409    // strip whitespaces
410    $css = preg_replace('![\r\n\t ]+!',' ',$css);
411    $css = preg_replace('/ ?([;,{}\/]) ?/','\\1',$css);
412    $css = preg_replace('/ ?: /',':',$css);
413
414    // shorten colors
415    $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);
416
417    return $css;
418}
419
420/**
421 * Callback for css_compress()
422 *
423 * Keeps short comments (< 5 chars) to maintain typical browser hacks
424 *
425 * @author Andreas Gohr <andi@splitbrain.org>
426 */
427function css_comment_cb($matches){
428    if(strlen($matches[2]) > 4) return '';
429    return $matches[0];
430}
431
432//Setup VIM: ex: et ts=4 :
433