xref: /dokuwiki/inc/init.php (revision 276820f70d7e96ee375735c1a15bdc0a8331a5a7) 
1<?php
2/**
3 * Initialize some defaults needed for DokuWiki
4 */
5
6/**
7 * timing Dokuwiki execution
8 */
9function delta_time($start=0) {
10    return microtime(true)-((float)$start);
11}
12define('DOKU_START_TIME', delta_time());
13
14global $config_cascade;
15$config_cascade = array();
16
17// if available load a preload config file
18$preload = fullpath(dirname(__FILE__)).'/preload.php';
19if (file_exists($preload)) include($preload);
20
21// define the include path
22if(!defined('DOKU_INC')) define('DOKU_INC',fullpath(dirname(__FILE__).'/../').'/');
23
24// define Plugin dir
25if(!defined('DOKU_PLUGIN'))  define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
26
27// define config path (packagers may want to change this to /etc/dokuwiki/)
28if(!defined('DOKU_CONF')) define('DOKU_CONF',DOKU_INC.'conf/');
29
30// check for error reporting override or set error reporting to sane values
31if (!defined('DOKU_E_LEVEL') && file_exists(DOKU_CONF.'report_e_all')) {
32    define('DOKU_E_LEVEL', E_ALL);
33}
34if (!defined('DOKU_E_LEVEL')) {
35    if(defined('E_DEPRECATED')){ // since php 5.3, since php 5.4 E_STRICT is part of E_ALL
36        error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_STRICT);
37    }else{
38        error_reporting(E_ALL ^ E_NOTICE);
39    }
40} else {
41    error_reporting(DOKU_E_LEVEL);
42}
43
44// init memory caches
45global $cache_revinfo;
46       $cache_revinfo = array();
47global $cache_wikifn;
48       $cache_wikifn = array();
49global $cache_cleanid;
50       $cache_cleanid = array();
51global $cache_authname;
52       $cache_authname = array();
53global $cache_metadata;
54       $cache_metadata = array();
55
56// always include 'inc/config_cascade.php'
57// previously in preload.php set fields of $config_cascade will be merged with the defaults
58include(DOKU_INC.'inc/config_cascade.php');
59
60//prepare config array()
61global $conf;
62$conf = array();
63
64// load the global config file(s)
65foreach (array('default','local','protected') as $config_group) {
66    if (empty($config_cascade['main'][$config_group])) continue;
67    foreach ($config_cascade['main'][$config_group] as $config_file) {
68        if (file_exists($config_file)) {
69            include($config_file);
70        }
71    }
72}
73
74//prepare license array()
75global $license;
76$license = array();
77
78// load the license file(s)
79foreach (array('default','local') as $config_group) {
80    if (empty($config_cascade['license'][$config_group])) continue;
81    foreach ($config_cascade['license'][$config_group] as $config_file) {
82        if(file_exists($config_file)){
83            include($config_file);
84        }
85    }
86}
87
88// set timezone (as in pre 5.3.0 days)
89date_default_timezone_set(@date_default_timezone_get());
90
91// define baseURL
92if(!defined('DOKU_REL')) define('DOKU_REL',getBaseURL(false));
93if(!defined('DOKU_URL')) define('DOKU_URL',getBaseURL(true));
94if(!defined('DOKU_BASE')){
95    if($conf['canonical']){
96        define('DOKU_BASE',DOKU_URL);
97    }else{
98        define('DOKU_BASE',DOKU_REL);
99    }
100}
101
102// define whitespace
103if(!defined('DOKU_LF')) define ('DOKU_LF',"\n");
104if(!defined('DOKU_TAB')) define ('DOKU_TAB',"\t");
105
106// define cookie and session id, append server port when securecookie is configured FS#1664
107if (!defined('DOKU_COOKIE')) define('DOKU_COOKIE', 'DW'.md5(DOKU_REL.(($conf['securecookie'])?$_SERVER['SERVER_PORT']:'')));
108
109
110// define main script
111if(!defined('DOKU_SCRIPT')) define('DOKU_SCRIPT','doku.php');
112
113// DEPRECATED, use tpl_basedir() instead
114if(!defined('DOKU_TPL')) define('DOKU_TPL',
115        DOKU_BASE.'lib/tpl/'.$conf['template'].'/');
116
117// DEPRECATED, use tpl_incdir() instead
118if(!defined('DOKU_TPLINC')) define('DOKU_TPLINC',
119        DOKU_INC.'lib/tpl/'.$conf['template'].'/');
120
121// make session rewrites XHTML compliant
122@ini_set('arg_separator.output', '&amp;');
123
124// make sure global zlib does not interfere FS#1132
125@ini_set('zlib.output_compression', 'off');
126
127// increase PCRE backtrack limit
128@ini_set('pcre.backtrack_limit', '20971520');
129
130// enable gzip compression if supported
131$conf['gzip_output'] &= (strpos($_SERVER['HTTP_ACCEPT_ENCODING'],'gzip') !== false);
132global $ACT;
133if ($conf['gzip_output'] &&
134        !defined('DOKU_DISABLE_GZIP_OUTPUT') &&
135        function_exists('ob_gzhandler') &&
136        // Disable compression when a (compressed) sitemap might be delivered
137        // See https://bugs.dokuwiki.org/index.php?do=details&task_id=2576
138        $ACT != 'sitemap') {
139    ob_start('ob_gzhandler');
140}
141
142// init session
143if(!headers_sent() && !defined('NOSESSION')) {
144    if(!defined('DOKU_SESSION_NAME'))     define ('DOKU_SESSION_NAME', "DokuWiki");
145    if(!defined('DOKU_SESSION_LIFETIME')) define ('DOKU_SESSION_LIFETIME', 0);
146    if(!defined('DOKU_SESSION_PATH')) {
147        $cookieDir = empty($conf['cookiedir']) ? DOKU_REL : $conf['cookiedir'];
148        define ('DOKU_SESSION_PATH', $cookieDir);
149    }
150    if(!defined('DOKU_SESSION_DOMAIN'))   define ('DOKU_SESSION_DOMAIN', '');
151
152    session_name(DOKU_SESSION_NAME);
153    session_set_cookie_params(DOKU_SESSION_LIFETIME, DOKU_SESSION_PATH, DOKU_SESSION_DOMAIN, ($conf['securecookie'] && is_ssl()), true);
154    session_start();
155
156    // load left over messages
157    if(isset($_SESSION[DOKU_COOKIE]['msg'])) {
158        $MSG = $_SESSION[DOKU_COOKIE]['msg'];
159        unset($_SESSION[DOKU_COOKIE]['msg']);
160    }
161}
162
163// kill magic quotes
164if (get_magic_quotes_gpc() && !defined('MAGIC_QUOTES_STRIPPED')) {
165    if (!empty($_GET))    remove_magic_quotes($_GET);
166    if (!empty($_POST))   remove_magic_quotes($_POST);
167    if (!empty($_COOKIE)) remove_magic_quotes($_COOKIE);
168    if (!empty($_REQUEST)) remove_magic_quotes($_REQUEST);
169    @ini_set('magic_quotes_gpc', 0);
170    define('MAGIC_QUOTES_STRIPPED',1);
171}
172if(function_exists('set_magic_quotes_runtime')) @set_magic_quotes_runtime(0);
173@ini_set('magic_quotes_sybase',0);
174
175// don't let cookies ever interfere with request vars
176$_REQUEST = array_merge($_GET,$_POST);
177
178// we don't want a purge URL to be digged
179if(isset($_REQUEST['purge']) && !empty($_SERVER['HTTP_REFERER'])) unset($_REQUEST['purge']);
180
181// precalculate file creation modes
182init_creationmodes();
183
184// make real paths and check them
185init_paths();
186init_files();
187
188// setup plugin controller class (can be overwritten in preload.php)
189$plugin_types = array('auth', 'admin','syntax','action','renderer', 'helper','remote');
190global $plugin_controller_class, $plugin_controller;
191if (empty($plugin_controller_class)) $plugin_controller_class = 'Doku_Plugin_Controller';
192
193// load libraries
194require_once(DOKU_INC.'inc/load.php');
195
196// disable gzip if not available
197if($conf['compression'] == 'bz2' && !function_exists('bzopen')){
198    $conf['compression'] = 'gz';
199}
200if($conf['compression'] == 'gz' && !function_exists('gzopen')){
201    $conf['compression'] = 0;
202}
203
204// input handle class
205global $INPUT;
206$INPUT = new Input();
207
208// initialize plugin controller
209$plugin_controller = new $plugin_controller_class();
210
211// initialize the event handler
212global $EVENT_HANDLER;
213$EVENT_HANDLER = new Doku_Event_Handler();
214
215$local = $conf['lang'];
216trigger_event('INIT_LANG_LOAD', $local, 'init_lang', true);
217
218
219// setup authentication system
220if (!defined('NOSESSION')) {
221    auth_setup();
222}
223
224// setup mail system
225mail_setup();
226
227/**
228 * Checks paths from config file
229 */
230function init_paths(){
231    global $conf;
232
233    $paths = array('datadir'   => 'pages',
234            'olddir'    => 'attic',
235            'mediadir'  => 'media',
236            'mediaolddir' => 'media_attic',
237            'metadir'   => 'meta',
238            'mediametadir' => 'media_meta',
239            'cachedir'  => 'cache',
240            'indexdir'  => 'index',
241            'lockdir'   => 'locks',
242            'tmpdir'    => 'tmp');
243
244    foreach($paths as $c => $p) {
245        $path = empty($conf[$c]) ? $conf['savedir'].'/'.$p : $conf[$c];
246        $conf[$c] = init_path($path);
247        if(empty($conf[$c]))
248            nice_die("The $c ('$p') at $path is not found, isn't accessible or writable.
249                You should check your config and permission settings.
250                Or maybe you want to <a href=\"install.php\">run the
251                installer</a>?");
252    }
253
254    // path to old changelog only needed for upgrading
255    $conf['changelog_old'] = init_path((isset($conf['changelog']))?($conf['changelog']):($conf['savedir'].'/changes.log'));
256    if ($conf['changelog_old']=='') { unset($conf['changelog_old']); }
257    // hardcoded changelog because it is now a cache that lives in meta
258    $conf['changelog'] = $conf['metadir'].'/_dokuwiki.changes';
259    $conf['media_changelog'] = $conf['metadir'].'/_media.changes';
260}
261
262/**
263 * Load the language strings
264 *
265 * @param string $langCode language code, as passed by event handler
266 */
267function init_lang($langCode) {
268    //prepare language array
269    global $lang, $config_cascade;
270    $lang = array();
271
272    //load the language files
273    require(DOKU_INC.'inc/lang/en/lang.php');
274    foreach ($config_cascade['lang']['core'] as $config_file) {
275        if (file_exists($config_file . 'en/lang.php')) {
276            include($config_file . 'en/lang.php');
277        }
278    }
279
280    if ($langCode && $langCode != 'en') {
281        if (file_exists(DOKU_INC."inc/lang/$langCode/lang.php")) {
282            require(DOKU_INC."inc/lang/$langCode/lang.php");
283        }
284        foreach ($config_cascade['lang']['core'] as $config_file) {
285            if (file_exists($config_file . "$langCode/lang.php")) {
286                include($config_file . "$langCode/lang.php");
287            }
288        }
289    }
290}
291
292/**
293 * Checks the existence of certain files and creates them if missing.
294 */
295function init_files(){
296    global $conf;
297
298    $files = array($conf['indexdir'].'/page.idx');
299
300    foreach($files as $file){
301        if(!file_exists($file)){
302            $fh = @fopen($file,'a');
303            if($fh){
304                fclose($fh);
305                if(!empty($conf['fperm'])) chmod($file, $conf['fperm']);
306            }else{
307                nice_die("$file is not writable. Check your permissions settings!");
308            }
309        }
310    }
311
312    # create title index (needs to have same length as page.idx)
313    /*
314    $file = $conf['indexdir'].'/title.idx';
315    if(!file_exists($file)){
316        $pages = file($conf['indexdir'].'/page.idx');
317        $pages = count($pages);
318        $fh = @fopen($file,'a');
319        if($fh){
320            for($i=0; $i<$pages; $i++){
321                fwrite($fh,"\n");
322            }
323            fclose($fh);
324        }else{
325            nice_die("$file is not writable. Check your permissions settings!");
326        }
327    }
328    */
329}
330
331/**
332 * Returns absolute path
333 *
334 * This tries the given path first, then checks in DOKU_INC.
335 * Check for accessibility on directories as well.
336 *
337 * @author Andreas Gohr <andi@splitbrain.org>
338 */
339function init_path($path){
340    // check existence
341    $p = fullpath($path);
342    if(!file_exists($p)){
343        $p = fullpath(DOKU_INC.$path);
344        if(!file_exists($p)){
345            return '';
346        }
347    }
348
349    // check writability
350    if(!@is_writable($p)){
351        return '';
352    }
353
354    // check accessability (execute bit) for directories
355    if(@is_dir($p) && !file_exists("$p/.")){
356        return '';
357    }
358
359    return $p;
360}
361
362/**
363 * Sets the internal config values fperm and dperm which, when set,
364 * will be used to change the permission of a newly created dir or
365 * file with chmod. Considers the influence of the system's umask
366 * setting the values only if needed.
367 */
368function init_creationmodes(){
369    global $conf;
370
371    // Legacy support for old umask/dmask scheme
372    unset($conf['dmask']);
373    unset($conf['fmask']);
374    unset($conf['umask']);
375    unset($conf['fperm']);
376    unset($conf['dperm']);
377
378    // get system umask, fallback to 0 if none available
379    $umask = @umask();
380    if(!$umask) $umask = 0000;
381
382    // check what is set automatically by the system on file creation
383    // and set the fperm param if it's not what we want
384    $auto_fmode = 0666 & ~$umask;
385    if($auto_fmode != $conf['fmode']) $conf['fperm'] = $conf['fmode'];
386
387    // check what is set automatically by the system on file creation
388    // and set the dperm param if it's not what we want
389    $auto_dmode = $conf['dmode'] & ~$umask;
390    if($auto_dmode != $conf['dmode']) $conf['dperm'] = $conf['dmode'];
391}
392
393/**
394 * remove magic quotes recursivly
395 *
396 * @author Andreas Gohr <andi@splitbrain.org>
397 */
398function remove_magic_quotes(&$array) {
399    foreach (array_keys($array) as $key) {
400        // handle magic quotes in keynames (breaks order)
401        $sk = stripslashes($key);
402        if($sk != $key){
403            $array[$sk] = $array[$key];
404            unset($array[$key]);
405            $key = $sk;
406        }
407
408        // do recursion if needed
409        if (is_array($array[$key])) {
410            remove_magic_quotes($array[$key]);
411        }else {
412            $array[$key] = stripslashes($array[$key]);
413        }
414    }
415}
416
417/**
418 * Returns the full absolute URL to the directory where
419 * DokuWiki is installed in (includes a trailing slash)
420 *
421 * !! Can not access $_SERVER values through $INPUT
422 * !! here as this function is called before $INPUT is
423 * !! initialized.
424 *
425 * @author Andreas Gohr <andi@splitbrain.org>
426 */
427function getBaseURL($abs=null){
428    global $conf;
429    //if canonical url enabled always return absolute
430    if(is_null($abs)) $abs = $conf['canonical'];
431
432    if(!empty($conf['basedir'])){
433        $dir = $conf['basedir'];
434    }elseif(substr($_SERVER['SCRIPT_NAME'],-4) == '.php'){
435        $dir = dirname($_SERVER['SCRIPT_NAME']);
436    }elseif(substr($_SERVER['PHP_SELF'],-4) == '.php'){
437        $dir = dirname($_SERVER['PHP_SELF']);
438    }elseif($_SERVER['DOCUMENT_ROOT'] && $_SERVER['SCRIPT_FILENAME']){
439        $dir = preg_replace ('/^'.preg_quote($_SERVER['DOCUMENT_ROOT'],'/').'/','',
440                $_SERVER['SCRIPT_FILENAME']);
441        $dir = dirname('/'.$dir);
442    }else{
443        $dir = '.'; //probably wrong
444    }
445
446    $dir = str_replace('\\','/',$dir);             // bugfix for weird WIN behaviour
447    $dir = preg_replace('#//+#','/',"/$dir/");     // ensure leading and trailing slashes
448
449    //handle script in lib/exe dir
450    $dir = preg_replace('!lib/exe/$!','',$dir);
451
452    //handle script in lib/plugins dir
453    $dir = preg_replace('!lib/plugins/.*$!','',$dir);
454
455    //finish here for relative URLs
456    if(!$abs) return $dir;
457
458    //use config option if available, trim any slash from end of baseurl to avoid multiple consecutive slashes in the path
459    if(!empty($conf['baseurl'])) return rtrim($conf['baseurl'],'/').$dir;
460
461    //split hostheader into host and port
462    if(isset($_SERVER['HTTP_HOST'])){
463        $parsed_host = parse_url('http://'.$_SERVER['HTTP_HOST']);
464        $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
465        $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
466    }elseif(isset($_SERVER['SERVER_NAME'])){
467        $parsed_host = parse_url('http://'.$_SERVER['SERVER_NAME']);
468        $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
469        $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
470    }else{
471        $host = php_uname('n');
472        $port = '';
473    }
474
475    if(is_null($port)){
476        $port = '';
477    }
478
479    if(!is_ssl()){
480        $proto = 'http://';
481        if ($port == '80') {
482            $port = '';
483        }
484    }else{
485        $proto = 'https://';
486        if ($port == '443') {
487            $port = '';
488        }
489    }
490
491    if($port !== '') $port = ':'.$port;
492
493    return $proto.$host.$port.$dir;
494}
495
496/**
497 * Check if accessed via HTTPS
498 *
499 * Apache leaves ,$_SERVER['HTTPS'] empty when not available, IIS sets it to 'off'.
500 * 'false' and 'disabled' are just guessing
501 *
502 * @returns bool true when SSL is active
503 */
504function is_ssl(){
505    // check if we are behind a reverse proxy
506    if (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
507        if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') {
508	    return true;
509	} else {
510	    return false;
511	}
512    }
513    if (!isset($_SERVER['HTTPS']) ||
514        preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){
515        return false;
516    }else{
517        return true;
518    }
519}
520
521/**
522 * print a nice message even if no styles are loaded yet.
523 */
524function nice_die($msg){
525    echo<<<EOT
526<!DOCTYPE html>
527<html>
528<head><title>DokuWiki Setup Error</title></head>
529<body style="font-family: Arial, sans-serif">
530    <div style="width:60%; margin: auto; background-color: #fcc;
531                border: 1px solid #faa; padding: 0.5em 1em;">
532        <h1 style="font-size: 120%">DokuWiki Setup Error</h1>
533        <p>$msg</p>
534    </div>
535</body>
536</html>
537EOT;
538    exit;
539}
540
541/**
542 * A realpath() replacement
543 *
544 * This function behaves similar to PHP's realpath() but does not resolve
545 * symlinks or accesses upper directories
546 *
547 * @author Andreas Gohr <andi@splitbrain.org>
548 * @author <richpageau at yahoo dot co dot uk>
549 * @link   http://de3.php.net/manual/en/function.realpath.php#75992
550 */
551function fullpath($path,$exists=false){
552    static $run = 0;
553    $root  = '';
554    $iswin = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' || @$GLOBALS['DOKU_UNITTEST_ASSUME_WINDOWS']);
555
556    // find the (indestructable) root of the path - keeps windows stuff intact
557    if($path{0} == '/'){
558        $root = '/';
559    }elseif($iswin){
560        // match drive letter and UNC paths
561        if(preg_match('!^([a-zA-z]:)(.*)!',$path,$match)){
562            $root = $match[1].'/';
563            $path = $match[2];
564        }else if(preg_match('!^(\\\\\\\\[^\\\\/]+\\\\[^\\\\/]+[\\\\/])(.*)!',$path,$match)){
565            $root = $match[1];
566            $path = $match[2];
567        }
568    }
569    $path = str_replace('\\','/',$path);
570
571    // if the given path wasn't absolute already, prepend the script path and retry
572    if(!$root){
573        $base = dirname($_SERVER['SCRIPT_FILENAME']);
574        $path = $base.'/'.$path;
575        if($run == 0){ // avoid endless recursion when base isn't absolute for some reason
576            $run++;
577            return fullpath($path,$exists);
578        }
579    }
580    $run = 0;
581
582    // canonicalize
583    $path=explode('/', $path);
584    $newpath=array();
585    foreach($path as $p) {
586        if ($p === '' || $p === '.') continue;
587        if ($p==='..') {
588            array_pop($newpath);
589            continue;
590        }
591        array_push($newpath, $p);
592    }
593    $finalpath = $root.implode('/', $newpath);
594
595    // check for existence when needed (except when unit testing)
596    if($exists && !defined('DOKU_UNITTEST') && !file_exists($finalpath)) {
597        return false;
598    }
599    return $finalpath;
600}
601
602