xref: /dokuwiki/lib/exe/js.php (revision 977fc56ff0b11268d93580422c0bb179c0e9dd91) 
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');
14
15// Main (don't run when UNIT test)
16if(!defined('SIMPLE_TEST')){
17    header('Content-Type: text/javascript; charset=utf-8');
18    js_out();
19}
20
21
22// ---------------------- functions ------------------------------
23
24/**
25 * Output all needed JavaScript
26 *
27 * @author Andreas Gohr <andi@splitbrain.org>
28 */
29function js_out(){
30    global $conf;
31    global $lang;
32    global $config_cascade;
33
34    // The generated script depends on some dynamic options
35    $cache = new cache('scripts'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],'.js');
36    $cache->_event = 'JS_CACHE_USE';
37
38    // load minified version for some files
39    $min = $conf['compress'] ? '.min' : '';
40
41    // array of core files
42    $files = array(
43                DOKU_INC."lib/scripts/jquery/jquery$min.js",
44                DOKU_INC.'lib/scripts/jquery/jquery.cookie.js',
45                DOKU_INC."lib/scripts/jquery/jquery-ui$min.js",
46                DOKU_INC."lib/scripts/jquery/jquery-migrate$min.js",
47                DOKU_INC.'inc/lang/'.$conf['lang'].'/jquery.ui.datepicker.js',
48                DOKU_INC."lib/scripts/fileuploader.js",
49                DOKU_INC."lib/scripts/fileuploaderextended.js",
50                DOKU_INC.'lib/scripts/helpers.js',
51                DOKU_INC.'lib/scripts/delay.js',
52                DOKU_INC.'lib/scripts/cookie.js',
53                DOKU_INC.'lib/scripts/script.js',
54                DOKU_INC.'lib/scripts/tw-sack.js',
55                DOKU_INC.'lib/scripts/qsearch.js',
56                DOKU_INC.'lib/scripts/tree.js',
57                DOKU_INC.'lib/scripts/index.js',
58                DOKU_INC.'lib/scripts/drag.js',
59                DOKU_INC.'lib/scripts/textselection.js',
60                DOKU_INC.'lib/scripts/toolbar.js',
61                DOKU_INC.'lib/scripts/edit.js',
62                DOKU_INC.'lib/scripts/editor.js',
63                DOKU_INC.'lib/scripts/locktimer.js',
64                DOKU_INC.'lib/scripts/linkwiz.js',
65                DOKU_INC.'lib/scripts/media.js',
66# deprecated                DOKU_INC.'lib/scripts/compatibility.js',
67# disabled for FS#1958                DOKU_INC.'lib/scripts/hotkeys.js',
68                DOKU_INC.'lib/scripts/behaviour.js',
69                DOKU_INC.'lib/scripts/page.js',
70                tpl_incdir().'script.js',
71            );
72
73    // add possible plugin scripts and userscript
74    $files   = array_merge($files,js_pluginscripts());
75    if(isset($config_cascade['userscript']['default'])){
76        $files[] = $config_cascade['userscript']['default'];
77    }
78
79    $cache_files = array_merge($files, getConfigFiles('main'));
80    $cache_files[] = __FILE__;
81
82    // check cache age & handle conditional request
83    // This may exit if a cache can be used
84    $cache_ok = $cache->useCache(array('files' => $cache_files));
85    http_cached($cache->cache, $cache_ok);
86
87    // start output buffering and build the script
88    ob_start();
89
90    $json = new JSON();
91    // add some global variables
92    print "var DOKU_BASE   = '".DOKU_BASE."';";
93    print "var DOKU_TPL    = '".tpl_basedir()."';";
94    print "var DOKU_COOKIE_PARAM = " . $json->encode(
95            array(
96                 'path' => empty($conf['cookiedir']) ? DOKU_REL : $conf['cookiedir'],
97                 'secure' => $conf['securecookie'] && is_ssl()
98            )).";";
99    // FIXME: Move those to JSINFO
100    print "var DOKU_UHN    = ".((int) useHeading('navigation')).";";
101    print "var DOKU_UHC    = ".((int) useHeading('content')).";";
102
103    // load JS specific translations
104    $lang['js']['plugins'] = js_pluginstrings();
105    $templatestrings = js_templatestrings();
106    if(!empty($templatestrings)) {
107        $lang['js']['template'] = $templatestrings;
108    }
109    echo 'LANG = '.$json->encode($lang['js']).";\n";
110
111    // load toolbar
112    toolbar_JSdefines('toolbar');
113
114    // load files
115    foreach($files as $file){
116        if(!file_exists($file)) continue;
117        $ismin = (substr($file,-7) == '.min.js');
118        $debugjs = ($conf['allowdebug'] && strpos($file, DOKU_INC.'lib/scripts/') !== 0);
119
120        echo "\n\n/* XXXXXXXXXX begin of ".str_replace(DOKU_INC, '', $file) ." XXXXXXXXXX */\n\n";
121        if($ismin) echo "\n/* BEGIN NOCOMPRESS */\n";
122        if ($debugjs) echo "\ntry {\n";
123        js_load($file);
124        if ($debugjs) echo "\n} catch (e) {\n   logError(e, '".str_replace(DOKU_INC, '', $file)."');\n}\n";
125        if($ismin) echo "\n/* END NOCOMPRESS */\n";
126        echo "\n\n/* XXXXXXXXXX end of " . str_replace(DOKU_INC, '', $file) . " XXXXXXXXXX */\n\n";
127    }
128
129    // init stuff
130    if($conf['locktime'] != 0){
131        js_runonstart("dw_locktimer.init(".($conf['locktime'] - 60).",".$conf['usedraft'].")");
132    }
133    // init hotkeys - must have been done after init of toolbar
134# disabled for FS#1958    js_runonstart('initializeHotkeys()');
135
136    // end output buffering and get contents
137    $js = ob_get_contents();
138    ob_end_clean();
139
140    // strip any source maps
141    stripsourcemaps($js);
142
143    // compress whitespace and comments
144    if($conf['compress']){
145        $js = js_compress($js);
146    }
147
148    $js .= "\n"; // https://bugzilla.mozilla.org/show_bug.cgi?id=316033
149
150    http_cached_finish($cache->cache, $js);
151}
152
153/**
154 * Load the given file, handle include calls and print it
155 *
156 * @author Andreas Gohr <andi@splitbrain.org>
157 */
158function js_load($file){
159    if(!@file_exists($file)) return;
160    static $loaded = array();
161
162    $data = io_readFile($file);
163    while(preg_match('#/\*\s*DOKUWIKI:include(_once)?\s+([\w\.\-_/]+)\s*\*/#',$data,$match)){
164        $ifile = $match[2];
165
166        // is it a include_once?
167        if($match[1]){
168            $base = utf8_basename($ifile);
169            if($loaded[$base]) continue;
170            $loaded[$base] = true;
171        }
172
173        if($ifile{0} != '/') $ifile = dirname($file).'/'.$ifile;
174
175        if(@file_exists($ifile)){
176            $idata = io_readFile($ifile);
177        }else{
178            $idata = '';
179        }
180        $data  = str_replace($match[0],$idata,$data);
181    }
182    echo "$data\n";
183}
184
185/**
186 * Returns a list of possible Plugin Scripts (no existance check here)
187 *
188 * @author Andreas Gohr <andi@splitbrain.org>
189 */
190function js_pluginscripts(){
191    $list = array();
192    $plugins = plugin_list();
193    foreach ($plugins as $p){
194        $list[] = DOKU_PLUGIN."$p/script.js";
195    }
196    return $list;
197}
198
199/**
200 * Return an two-dimensional array with strings from the language file of each plugin.
201 *
202 * - $lang['js'] must be an array.
203 * - Nothing is returned for plugins without an entry for $lang['js']
204 *
205 * @author Gabriel Birke <birke@d-scribe.de>
206 */
207function js_pluginstrings() {
208    global $conf;
209    $pluginstrings = array();
210    $plugins = plugin_list();
211    foreach ($plugins as $p){
212        if (isset($lang)) unset($lang);
213        if (@file_exists(DOKU_PLUGIN."$p/lang/en/lang.php")) {
214            include DOKU_PLUGIN."$p/lang/en/lang.php";
215        }
216        if (isset($conf['lang']) && $conf['lang']!='en' && @file_exists(DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php")) {
217            include DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php";
218        }
219        if (isset($lang['js'])) {
220            $pluginstrings[$p] = $lang['js'];
221        }
222    }
223    return $pluginstrings;
224}
225
226/**
227 * Return an two-dimensional array with strings from the language file of current active template.
228 *
229 * - $lang['js'] must be an array.
230 * - Nothing is returned for template without an entry for $lang['js']
231 */
232function js_templatestrings() {
233    global $conf;
234    $templatestrings = array();
235    if (@file_exists(tpl_incdir()."lang/en/lang.php")) {
236        include tpl_incdir()."lang/en/lang.php";
237    }
238    if (isset($conf['lang']) && $conf['lang']!='en' && @file_exists(tpl_incdir()."lang/".$conf['lang']."/lang.php")) {
239        include tpl_incdir()."lang/".$conf['lang']."/lang.php";
240    }
241    if (isset($lang['js'])) {
242        $templatestrings[$conf['template']] = $lang['js'];
243    }
244    return $templatestrings;
245}
246
247/**
248 * Escapes a String to be embedded in a JavaScript call, keeps \n
249 * as newline
250 *
251 * @author Andreas Gohr <andi@splitbrain.org>
252 */
253function js_escape($string){
254    return str_replace('\\\\n','\\n',addslashes($string));
255}
256
257/**
258 * Adds the given JavaScript code to the window.onload() event
259 *
260 * @author Andreas Gohr <andi@splitbrain.org>
261 */
262function js_runonstart($func){
263    echo "jQuery(function(){ $func; });".NL;
264}
265
266/**
267 * Strip comments and whitespaces from given JavaScript Code
268 *
269 * This is a port of Nick Galbreath's python tool jsstrip.py which is
270 * released under BSD license. See link for original code.
271 *
272 * @author Nick Galbreath <nickg@modp.com>
273 * @author Andreas Gohr <andi@splitbrain.org>
274 * @link   http://code.google.com/p/jsstrip/
275 */
276function js_compress($s){
277    $s = ltrim($s);     // strip all initial whitespace
278    $s .= "\n";
279    $i = 0;             // char index for input string
280    $j = 0;             // char forward index for input string
281    $line = 0;          // line number of file (close to it anyways)
282    $slen = strlen($s); // size of input string
283    $lch  = '';         // last char added
284    $result = '';       // we store the final result here
285
286    // items that don't need spaces next to them
287    $chars = "^&|!+\-*\/%=\?:;,{}()<>% \t\n\r'\"[]";
288
289    $regex_starters = array("(", "=", "[", "," , ":", "!");
290
291    $whitespaces_chars = array(" ", "\t", "\n", "\r", "\0", "\x0B");
292
293    while($i < $slen){
294        // skip all "boring" characters.  This is either
295        // reserved word (e.g. "for", "else", "if") or a
296        // variable/object/method (e.g. "foo.color")
297        while ($i < $slen && (strpos($chars,$s[$i]) === false) ){
298            $result .= $s{$i};
299            $i = $i + 1;
300        }
301
302        $ch = $s{$i};
303        // multiline comments (keeping IE conditionals)
304        if($ch == '/' && $s{$i+1} == '*' && $s{$i+2} != '@'){
305            $endC = strpos($s,'*/',$i+2);
306            if($endC === false) trigger_error('Found invalid /*..*/ comment', E_USER_ERROR);
307
308            // check if this is a NOCOMPRESS comment
309            if(substr($s, $i, $endC+2-$i) == '/* BEGIN NOCOMPRESS */'){
310                $endNC = strpos($s, '/* END NOCOMPRESS */', $endC+2);
311                if($endNC === false) trigger_error('Found invalid NOCOMPRESS comment', E_USER_ERROR);
312
313                // verbatim copy contents, trimming but putting it on its own line
314                $result .= "\n".trim(substr($s, $i + 22, $endNC - ($i + 22)))."\n"; // BEGIN comment = 22 chars
315                $i = $endNC + 20; // END comment = 20 chars
316            }else{
317                $i = $endC + 2;
318            }
319            continue;
320        }
321
322        // singleline
323        if($ch == '/' && $s{$i+1} == '/'){
324            $endC = strpos($s,"\n",$i+2);
325            if($endC === false) trigger_error('Invalid comment', E_USER_ERROR);
326            $i = $endC;
327            continue;
328        }
329
330        // tricky.  might be an RE
331        if($ch == '/'){
332            // rewind, skip white space
333            $j = 1;
334            while(in_array($s{$i-$j}, $whitespaces_chars)){
335                $j = $j + 1;
336            }
337            if( in_array($s{$i-$j}, $regex_starters) ){
338                // yes, this is an re
339                // now move forward and find the end of it
340                $j = 1;
341                while($s{$i+$j} != '/'){
342                    if($s{$i+$j} == '\\') $j = $j + 2;
343                    else $j++;
344                }
345                $result .= substr($s,$i,$j+1);
346                $i = $i + $j + 1;
347                continue;
348            }
349        }
350
351        // double quote strings
352        if($ch == '"'){
353            $j = 1;
354            while( $s{$i+$j} != '"' && ($i+$j < $slen)){
355                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == '"' || $s{$i+$j+1} == '\\') ){
356                    $j += 2;
357                }else{
358                    $j += 1;
359                }
360            }
361            $string  = substr($s,$i,$j+1);
362            // remove multiline markers:
363            $string  = str_replace("\\\n",'',$string);
364            $result .= $string;
365            $i = $i + $j + 1;
366            continue;
367        }
368
369        // single quote strings
370        if($ch == "'"){
371            $j = 1;
372            while( $s{$i+$j} != "'" && ($i+$j < $slen)){
373                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == "'" || $s{$i+$j+1} == '\\') ){
374                    $j += 2;
375                }else{
376                    $j += 1;
377                }
378            }
379            $string = substr($s,$i,$j+1);
380            // remove multiline markers:
381            $string  = str_replace("\\\n",'',$string);
382            $result .= $string;
383            $i = $i + $j + 1;
384            continue;
385        }
386
387        // whitespaces
388        if( $ch == ' ' || $ch == "\r" || $ch == "\n" || $ch == "\t" ){
389            // leading spaces
390            if($i+1 < $slen && (strpos($chars,$s[$i+1]) !== false)){
391                $i = $i + 1;
392                continue;
393            }
394            // trailing spaces
395            //  if this ch is space AND the last char processed
396            //  is special, then skip the space
397            $lch = substr($result,-1);
398            if($lch && (strpos($chars,$lch) !== false)){
399                $i = $i + 1;
400                continue;
401            }
402            // else after all of this convert the "whitespace" to
403            // a single space.  It will get appended below
404            $ch = ' ';
405        }
406
407        // other chars
408        $result .= $ch;
409        $i = $i + 1;
410    }
411
412    return trim($result);
413}
414
415//Setup VIM: ex: et ts=4 :
416