xref: /dokuwiki/lib/exe/js.php (revision d85fc3586a46a48ee5896c125d867fb1aaa33b25) 
1<?php
2/**
3 * DokuWiki JavaScript 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('NL')) define('NL',"\n");
12if(!defined('DOKU_DISABLE_GZIP_OUTPUT')) define('DOKU_DISABLE_GZIP_OUTPUT',1); // we gzip ourself here
13require_once(DOKU_INC.'inc/init.php');
14require_once(DOKU_INC.'inc/pageutils.php');
15require_once(DOKU_INC.'inc/httputils.php');
16require_once(DOKU_INC.'inc/io.php');
17require_once(DOKU_INC.'inc/JSON.php');
18
19// Main (don't run when UNIT test)
20if(!defined('SIMPLE_TEST')){
21    header('Content-Type: text/javascript; charset=utf-8');
22    js_out();
23}
24
25
26// ---------------------- functions ------------------------------
27
28/**
29 * Output all needed JavaScript
30 *
31 * @author Andreas Gohr <andi@splitbrain.org>
32 */
33function js_out(){
34    global $conf;
35    global $lang;
36
37    // The generated script depends on some dynamic options
38    $cache = getCacheName('scripts'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],'.js');
39
40    // array of core files
41    $files = array(
42                DOKU_INC.'lib/scripts/helpers.js',
43                DOKU_INC.'lib/scripts/events.js',
44                DOKU_INC.'lib/scripts/cookie.js',
45                DOKU_INC.'lib/scripts/script.js',
46                DOKU_INC.'lib/scripts/tw-sack.js',
47                DOKU_INC.'lib/scripts/ajax.js',
48                DOKU_INC.'lib/scripts/index.js',
49                DOKU_INC.'lib/scripts/drag.js',
50                DOKU_INC.'lib/scripts/textselection.js',
51                DOKU_INC.'lib/scripts/toolbar.js',
52                DOKU_INC.'lib/scripts/edit.js',
53                DOKU_INC.'lib/scripts/linkwiz.js',
54                DOKU_INC.'lib/scripts/media.js',
55                DOKU_TPLINC.'script.js',
56            );
57
58    // add possible plugin scripts and userscript
59    $files   = array_merge($files,js_pluginscripts());
60    $files[] = DOKU_CONF.'userscript.js';
61
62    // check cache age & handle conditional request
63    header('Cache-Control: public, max-age=3600');
64    header('Pragma: public');
65    if(js_cacheok($cache,$files)){
66        http_conditionalRequest(filemtime($cache));
67        if($conf['allowdebug']) header("X-CacheUsed: $cache");
68
69        // finally send output
70        if ($conf['gzip_output'] && http_gzip_valid($cache)) {
71            header('Vary: Accept-Encoding');
72            header('Content-Encoding: gzip');
73            readfile($cache.".gz");
74        } else {
75            if (!http_sendfile($cache)) readfile($cache);
76        }
77        return;
78    } else {
79        http_conditionalRequest(time());
80    }
81
82    // start output buffering and build the script
83    ob_start();
84
85    // add some global variables
86    print "var DOKU_BASE   = '".DOKU_BASE."';";
87    print "var DOKU_TPL    = '".DOKU_TPL."';";
88
89    // load JS specific translations
90    $json = new JSON();
91    $lang['js']['plugins'] = js_pluginstrings();
92    echo 'LANG = '.$json->encode($lang['js']).";\n";
93
94    // load toolbar
95    require_once(DOKU_INC.'inc/toolbar.php');
96    toolbar_JSdefines('toolbar');
97
98    // load files
99    foreach($files as $file){
100        echo "\n\n/* XXXXXXXXXX begin of ".str_replace(DOKU_INC, '', $file) ." XXXXXXXXXX */\n\n";
101        js_load($file);
102        echo "\n\n/* XXXXXXXXXX end of " . str_replace(DOKU_INC, '', $file) . " XXXXXXXXXX */\n\n";
103    }
104
105
106    // init stuff
107    js_runonstart("ajax_qsearch.init('qsearch__in','qsearch__out')");
108    js_runonstart("addEvent(document,'click',closePopups)");
109    js_runonstart('addTocToggle()');
110    js_runonstart("initSizeCtl('size__ctl','wiki__text')");
111    js_runonstart("initToolbar('tool__bar','wiki__text',toolbar)");
112    js_runonstart("initChangeCheck('".js_escape($lang['notsavedyet'])."')");
113    js_runonstart("locktimer.init(".($conf['locktime'] - 60).",'".js_escape($lang['willexpire'])."',".$conf['usedraft'].")");
114    js_runonstart('scrollToMarker()');
115    js_runonstart('focusMarker()');
116
117    // end output buffering and get contents
118    $js = ob_get_contents();
119    ob_end_clean();
120
121    // compress whitespace and comments
122    if($conf['compress']){
123        $js = js_compress($js);
124    }
125
126    $js .= "\n"; // https://bugzilla.mozilla.org/show_bug.cgi?id=316033
127
128    // save cache file
129    io_saveFile($cache,$js);
130    if(function_exists('gzopen')) io_saveFile("$cache.gz",$js);
131
132    // finally send output
133    if ($conf['gzip_output']) {
134        header('Vary: Accept-Encoding');
135        header('Content-Encoding: gzip');
136        print gzencode($js,9,FORCE_GZIP);
137    } else {
138        print $js;
139    }
140}
141
142/**
143 * Load the given file, handle include calls and print it
144 *
145 * @author Andreas Gohr <andi@splitbrain.org>
146 */
147function js_load($file){
148    if(!@file_exists($file)) return;
149    static $loaded = array();
150
151    $data = io_readFile($file);
152    while(preg_match('#/\*\s*DOKUWIKI:include(_once)?\s+([\w\./]+)\s*\*/#',$data,$match)){
153        $ifile = $match[2];
154
155        // is it a include_once?
156        if($match[1]){
157            $base = basename($ifile);
158            if($loaded[$base]) continue;
159            $loaded[$base] = true;
160        }
161
162        if($ifile{0} != '/') $ifile = dirname($file).'/'.$ifile;
163
164        if(@file_exists($ifile)){
165            $idata = io_readFile($ifile);
166        }else{
167            $idata = '';
168        }
169        $data  = str_replace($match[0],$idata,$data);
170    }
171    echo $data;
172}
173
174/**
175 * Checks if a JavaScript Cache file still is valid
176 *
177 * @author Andreas Gohr <andi@splitbrain.org>
178 */
179function js_cacheok($cache,$files){
180    if($_REQUEST['purge']) return false; //support purge request
181
182    $ctime = @filemtime($cache);
183    if(!$ctime) return false; //There is no cache
184
185    // some additional files to check
186    $files = array_merge($files, getConfigFiles('main'));
187    $files[] = DOKU_CONF.'userscript.js';
188    $files[] = __FILE__;
189
190    // now walk the files
191    foreach($files as $file){
192        if(@filemtime($file) > $ctime){
193            return false;
194        }
195    }
196    return true;
197}
198
199/**
200 * Returns a list of possible Plugin Scripts (no existance check here)
201 *
202 * @author Andreas Gohr <andi@splitbrain.org>
203 */
204function js_pluginscripts(){
205    $list = array();
206    $plugins = plugin_list();
207    foreach ($plugins as $p){
208        $list[] = DOKU_PLUGIN."$p/script.js";
209    }
210    return $list;
211}
212
213/**
214 * Return an two-dimensional array with strings from the language file of each plugin.
215 *
216 * - $lang['js'] must be an array.
217 * - Nothing is returned for plugins without an entry for $lang['js']
218 *
219 * @author Gabriel Birke <birke@d-scribe.de>
220 */
221function js_pluginstrings()
222{
223    global $conf;
224    $pluginstrings = array();
225    $plugins = plugin_list();
226    foreach ($plugins as $p){
227        if (isset($lang)) unset($lang);
228        if (@file_exists(DOKU_PLUGIN."$p/lang/en/lang.php")) {
229            include DOKU_PLUGIN."$p/lang/en/lang.php";
230        }
231        if (isset($conf['lang']) && $conf['lang']!='en' && @file_exists(DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php")) {
232            include DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php";
233        }
234        if (isset($lang['js'])) {
235            $pluginstrings[$p] = $lang['js'];
236        }
237    }
238    return $pluginstrings;
239}
240
241/**
242 * Escapes a String to be embedded in a JavaScript call, keeps \n
243 * as newline
244 *
245 * @author Andreas Gohr <andi@splitbrain.org>
246 */
247function js_escape($string){
248    return str_replace('\\\\n','\\n',addslashes($string));
249}
250
251/**
252 * Adds the given JavaScript code to the window.onload() event
253 *
254 * @author Andreas Gohr <andi@splitbrain.org>
255 */
256function js_runonstart($func){
257    echo "addInitEvent(function(){ $func; });".NL;
258}
259
260/**
261 * Strip comments and whitespaces from given JavaScript Code
262 *
263 * This is a port of Nick Galbreath's python tool jsstrip.py which is
264 * released under BSD license. See link for original code.
265 *
266 * @author Nick Galbreath <nickg@modp.com>
267 * @author Andreas Gohr <andi@splitbrain.org>
268 * @link   http://code.google.com/p/jsstrip/
269 */
270function js_compress($s){
271    $s = ltrim($s);     // strip all initial whitespace
272    $s .= "\n";
273    $i = 0;             // char index for input string
274    $j = 0;             // char forward index for input string
275    $line = 0;          // line number of file (close to it anyways)
276    $slen = strlen($s); // size of input string
277    $lch  = '';         // last char added
278    $result = '';       // we store the final result here
279
280    // items that don't need spaces next to them
281    $chars = "^&|!+\-*\/%=\?:;,{}()<>% \t\n\r'\"[]";
282
283    while($i < $slen){
284        // skip all "boring" characters.  This is either
285        // reserved word (e.g. "for", "else", "if") or a
286        // variable/object/method (e.g. "foo.color")
287        while ($i < $slen && (strpos($chars,$s[$i]) === false) ){
288            $result .= $s{$i};
289            $i = $i + 1;
290        }
291
292        $ch = $s{$i};
293        // multiline comments (keeping IE conditionals)
294        if($ch == '/' && $s{$i+1} == '*' && $s{$i+2} != '@'){
295            $endC = strpos($s,'*/',$i+2);
296            if($endC === false) trigger_error('Found invalid /*..*/ comment', E_USER_ERROR);
297            $i = $endC + 2;
298            continue;
299        }
300
301        // singleline
302        if($ch == '/' && $s{$i+1} == '/'){
303            $endC = strpos($s,"\n",$i+2);
304            if($endC === false) trigger_error('Invalid comment', E_USER_ERROR);
305            $i = $endC;
306            continue;
307        }
308
309        // tricky.  might be an RE
310        if($ch == '/'){
311            // rewind, skip white space
312            $j = 1;
313            while($s{$i-$j} == ' '){
314                $j = $j + 1;
315            }
316            if( ($s{$i-$j} == '=') || ($s{$i-$j} == '(') ){
317                // yes, this is an re
318                // now move forward and find the end of it
319                $j = 1;
320                while($s{$i+$j} != '/'){
321                    while( ($s{$i+$j} != '\\') && ($s{$i+$j} != '/')){
322                        $j = $j + 1;
323                    }
324                    if($s{$i+$j} == '\\') $j = $j + 2;
325                }
326                $result .= substr($s,$i,$j+1);
327                $i = $i + $j + 1;
328                continue;
329            }
330        }
331
332        // double quote strings
333        if($ch == '"'){
334            $j = 1;
335            while( $s{$i+$j} != '"' && ($i+$j < $slen)){
336                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == '"' || $s{$i+$j+1} == '\\') ){
337                    $j += 2;
338                }else{
339                    $j += 1;
340                }
341            }
342            $result .= substr($s,$i,$j+1);
343            $i = $i + $j + 1;
344            continue;
345        }
346
347        // single quote strings
348        if($ch == "'"){
349            $j = 1;
350            while( $s{$i+$j} != "'" && ($i+$j < $slen)){
351                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == "'" || $s{$i+$j+1} == '\\') ){
352                    $j += 2;
353                }else{
354                    $j += 1;
355                }
356            }
357            $result .= substr($s,$i,$j+1);
358            $i = $i + $j + 1;
359            continue;
360        }
361
362        // whitespaces
363        if( $ch == ' ' || $ch == "\r" || $ch == "\n" || $ch == "\t" ){
364            // leading spaces
365            if($i+1 < $slen && (strpos($chars,$s[$i+1]) !== false)){
366                $i = $i + 1;
367                continue;
368            }
369            // trailing spaces
370            //  if this ch is space AND the last char processed
371            //  is special, then skip the space
372            $lch = substr($result,-1);
373            if($lch && (strpos($chars,$lch) !== false)){
374                $i = $i + 1;
375                continue;
376            }
377            // else after all of this convert the "whitespace" to
378            // a single space.  It will get appended below
379            $ch = ' ';
380        }
381
382        // other chars
383        $result .= $ch;
384        $i = $i + 1;
385    }
386
387    return trim($result);
388}
389
390//Setup VIM: ex: et ts=4 enc=utf-8 :
391