xref: /dokuwiki/lib/exe/js.php (revision 253d4b48ec708eb42033862dc15c8576f44a48ed) 
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 *
158 * @param string $file filename path to file
159 */
160function js_load($file){
161    if(!@file_exists($file)) return;
162    static $loaded = array();
163
164    $data = io_readFile($file);
165    while(preg_match('#/\*\s*DOKUWIKI:include(_once)?\s+([\w\.\-_/]+)\s*\*/#',$data,$match)){
166        $ifile = $match[2];
167
168        // is it a include_once?
169        if($match[1]){
170            $base = utf8_basename($ifile);
171            if($loaded[$base]){
172                $data  = str_replace($match[0], '' ,$data);
173                continue;
174            }
175            $loaded[$base] = true;
176        }
177
178        if($ifile{0} != '/') $ifile = dirname($file).'/'.$ifile;
179
180        if(@file_exists($ifile)){
181            $idata = io_readFile($ifile);
182        }else{
183            $idata = '';
184        }
185        $data  = str_replace($match[0],$idata,$data);
186    }
187    echo "$data\n";
188}
189
190/**
191 * Returns a list of possible Plugin Scripts (no existance check here)
192 *
193 * @author Andreas Gohr <andi@splitbrain.org>
194 *
195 * @return array
196 */
197function js_pluginscripts(){
198    $list = array();
199    $plugins = plugin_list();
200    foreach ($plugins as $p){
201        $list[] = DOKU_PLUGIN."$p/script.js";
202    }
203    return $list;
204}
205
206/**
207 * Return an two-dimensional array with strings from the language file of each plugin.
208 *
209 * - $lang['js'] must be an array.
210 * - Nothing is returned for plugins without an entry for $lang['js']
211 *
212 * @author Gabriel Birke <birke@d-scribe.de>
213 *
214 * @return array
215 */
216function js_pluginstrings() {
217    global $conf;
218    $pluginstrings = array();
219    $plugins = plugin_list();
220    foreach ($plugins as $p){
221        if (isset($lang)) unset($lang);
222        if (@file_exists(DOKU_PLUGIN."$p/lang/en/lang.php")) {
223            include DOKU_PLUGIN."$p/lang/en/lang.php";
224        }
225        if (isset($conf['lang']) && $conf['lang']!='en' && @file_exists(DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php")) {
226            include DOKU_PLUGIN."$p/lang/".$conf['lang']."/lang.php";
227        }
228        if (isset($lang['js'])) {
229            $pluginstrings[$p] = $lang['js'];
230        }
231    }
232    return $pluginstrings;
233}
234
235/**
236 * Return an two-dimensional array with strings from the language file of current active template.
237 *
238 * - $lang['js'] must be an array.
239 * - Nothing is returned for template without an entry for $lang['js']
240 *
241 * @return array
242 */
243function js_templatestrings() {
244    global $conf;
245    $templatestrings = array();
246    if (@file_exists(tpl_incdir()."lang/en/lang.php")) {
247        include tpl_incdir()."lang/en/lang.php";
248    }
249    if (isset($conf['lang']) && $conf['lang']!='en' && @file_exists(tpl_incdir()."lang/".$conf['lang']."/lang.php")) {
250        include tpl_incdir()."lang/".$conf['lang']."/lang.php";
251    }
252    if (isset($lang['js'])) {
253        $templatestrings[$conf['template']] = $lang['js'];
254    }
255    return $templatestrings;
256}
257
258/**
259 * Escapes a String to be embedded in a JavaScript call, keeps \n
260 * as newline
261 *
262 * @author Andreas Gohr <andi@splitbrain.org>
263 *
264 * @param string $string
265 * @return string
266 */
267function js_escape($string){
268    return str_replace('\\\\n','\\n',addslashes($string));
269}
270
271/**
272 * Adds the given JavaScript code to the window.onload() event
273 *
274 * @author Andreas Gohr <andi@splitbrain.org>
275 *
276 * @param string $func
277 */
278function js_runonstart($func){
279    echo "jQuery(function(){ $func; });".NL;
280}
281
282/**
283 * Strip comments and whitespaces from given JavaScript Code
284 *
285 * This is a port of Nick Galbreath's python tool jsstrip.py which is
286 * released under BSD license. See link for original code.
287 *
288 * @author Nick Galbreath <nickg@modp.com>
289 * @author Andreas Gohr <andi@splitbrain.org>
290 * @link   http://code.google.com/p/jsstrip/
291 *
292 * @param string $s
293 * @return string
294 */
295function js_compress($s){
296    $s = ltrim($s);     // strip all initial whitespace
297    $s .= "\n";
298    $i = 0;             // char index for input string
299    $j = 0;             // char forward index for input string
300    $line = 0;          // line number of file (close to it anyways)
301    $slen = strlen($s); // size of input string
302    $lch  = '';         // last char added
303    $result = '';       // we store the final result here
304
305    // items that don't need spaces next to them
306    $chars = "^&|!+\-*\/%=\?:;,{}()<>% \t\n\r'\"[]";
307
308    $regex_starters = array("(", "=", "[", "," , ":", "!");
309
310    $whitespaces_chars = array(" ", "\t", "\n", "\r", "\0", "\x0B");
311
312    while($i < $slen){
313        // skip all "boring" characters.  This is either
314        // reserved word (e.g. "for", "else", "if") or a
315        // variable/object/method (e.g. "foo.color")
316        while ($i < $slen && (strpos($chars,$s[$i]) === false) ){
317            $result .= $s{$i};
318            $i = $i + 1;
319        }
320
321        $ch = $s{$i};
322        // multiline comments (keeping IE conditionals)
323        if($ch == '/' && $s{$i+1} == '*' && $s{$i+2} != '@'){
324            $endC = strpos($s,'*/',$i+2);
325            if($endC === false) trigger_error('Found invalid /*..*/ comment', E_USER_ERROR);
326
327            // check if this is a NOCOMPRESS comment
328            if(substr($s, $i, $endC+2-$i) == '/* BEGIN NOCOMPRESS */'){
329                $endNC = strpos($s, '/* END NOCOMPRESS */', $endC+2);
330                if($endNC === false) trigger_error('Found invalid NOCOMPRESS comment', E_USER_ERROR);
331
332                // verbatim copy contents, trimming but putting it on its own line
333                $result .= "\n".trim(substr($s, $i + 22, $endNC - ($i + 22)))."\n"; // BEGIN comment = 22 chars
334                $i = $endNC + 20; // END comment = 20 chars
335            }else{
336                $i = $endC + 2;
337            }
338            continue;
339        }
340
341        // singleline
342        if($ch == '/' && $s{$i+1} == '/'){
343            $endC = strpos($s,"\n",$i+2);
344            if($endC === false) trigger_error('Invalid comment', E_USER_ERROR);
345            $i = $endC;
346            continue;
347        }
348
349        // tricky.  might be an RE
350        if($ch == '/'){
351            // rewind, skip white space
352            $j = 1;
353            while(in_array($s{$i-$j}, $whitespaces_chars)){
354                $j = $j + 1;
355            }
356            if( in_array($s{$i-$j}, $regex_starters) ){
357                // yes, this is an re
358                // now move forward and find the end of it
359                $j = 1;
360                while($s{$i+$j} != '/'){
361                    if($s{$i+$j} == '\\') $j = $j + 2;
362                    else $j++;
363                }
364                $result .= substr($s,$i,$j+1);
365                $i = $i + $j + 1;
366                continue;
367            }
368        }
369
370        // double quote strings
371        if($ch == '"'){
372            $j = 1;
373            while( $s{$i+$j} != '"' && ($i+$j < $slen)){
374                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == '"' || $s{$i+$j+1} == '\\') ){
375                    $j += 2;
376                }else{
377                    $j += 1;
378                }
379            }
380            $string  = substr($s,$i,$j+1);
381            // remove multiline markers:
382            $string  = str_replace("\\\n",'',$string);
383            $result .= $string;
384            $i = $i + $j + 1;
385            continue;
386        }
387
388        // single quote strings
389        if($ch == "'"){
390            $j = 1;
391            while( $s{$i+$j} != "'" && ($i+$j < $slen)){
392                if( $s{$i+$j} == '\\' && ($s{$i+$j+1} == "'" || $s{$i+$j+1} == '\\') ){
393                    $j += 2;
394                }else{
395                    $j += 1;
396                }
397            }
398            $string = substr($s,$i,$j+1);
399            // remove multiline markers:
400            $string  = str_replace("\\\n",'',$string);
401            $result .= $string;
402            $i = $i + $j + 1;
403            continue;
404        }
405
406        // whitespaces
407        if( $ch == ' ' || $ch == "\r" || $ch == "\n" || $ch == "\t" ){
408            // leading spaces
409            if($i+1 < $slen && (strpos($chars,$s[$i+1]) !== false)){
410                $i = $i + 1;
411                continue;
412            }
413            // trailing spaces
414            //  if this ch is space AND the last char processed
415            //  is special, then skip the space
416            $lch = substr($result,-1);
417            if($lch && (strpos($chars,$lch) !== false)){
418                $i = $i + 1;
419                continue;
420            }
421            // else after all of this convert the "whitespace" to
422            // a single space.  It will get appended below
423            $ch = ' ';
424        }
425
426        // other chars
427        $result .= $ch;
428        $i = $i + 1;
429    }
430
431    return trim($result);
432}
433
434//Setup VIM: ex: et ts=4 :
435