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