xref: /dokuwiki/inc/init.php (revision 59bc3b48fdffb76ee65a4b630be3ffa1f6c20c80) 
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// disable gzip if not available
182if($conf['compression'] == 'bz2' && !function_exists('bzopen')){
183    $conf['compression'] = 'gz';
184}
185if($conf['compression'] == 'gz' && !function_exists('gzopen')){
186    $conf['compression'] = 0;
187}
188
189// precalculate file creation modes
190init_creationmodes();
191
192// make real paths and check them
193init_paths();
194init_files();
195
196// setup plugin controller class (can be overwritten in preload.php)
197$plugin_types = array('auth', 'admin','syntax','action','renderer', 'helper','remote');
198global $plugin_controller_class, $plugin_controller;
199if (empty($plugin_controller_class)) $plugin_controller_class = 'Doku_Plugin_Controller';
200
201// load libraries
202require_once(DOKU_INC.'inc/load.php');
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
262function init_lang($langCode) {
263    //prepare language array
264    global $lang;
265    $lang = array();
266
267    //load the language files
268    require(DOKU_INC.'inc/lang/en/lang.php');
269    if ($langCode && $langCode != 'en') {
270        if (file_exists(DOKU_INC."inc/lang/$langCode/lang.php")) {
271            require(DOKU_INC."inc/lang/$langCode/lang.php");
272        }
273    }
274}
275
276/**
277 * Checks the existence of certain files and creates them if missing.
278 */
279function init_files(){
280    global $conf;
281
282    $files = array($conf['indexdir'].'/page.idx');
283
284    foreach($files as $file){
285        if(!@file_exists($file)){
286            $fh = @fopen($file,'a');
287            if($fh){
288                fclose($fh);
289                if(!empty($conf['fperm'])) chmod($file, $conf['fperm']);
290            }else{
291                nice_die("$file is not writable. Check your permissions settings!");
292            }
293        }
294    }
295
296    # create title index (needs to have same length as page.idx)
297    /*
298    $file = $conf['indexdir'].'/title.idx';
299    if(!@file_exists($file)){
300        $pages = file($conf['indexdir'].'/page.idx');
301        $pages = count($pages);
302        $fh = @fopen($file,'a');
303        if($fh){
304            for($i=0; $i<$pages; $i++){
305                fwrite($fh,"\n");
306            }
307            fclose($fh);
308        }else{
309            nice_die("$file is not writable. Check your permissions settings!");
310        }
311    }
312    */
313}
314
315/**
316 * Returns absolute path
317 *
318 * This tries the given path first, then checks in DOKU_INC.
319 * Check for accessibility on directories as well.
320 *
321 * @author Andreas Gohr <andi@splitbrain.org>
322 */
323function init_path($path){
324    // check existence
325    $p = fullpath($path);
326    if(!@file_exists($p)){
327        $p = fullpath(DOKU_INC.$path);
328        if(!@file_exists($p)){
329            return '';
330        }
331    }
332
333    // check writability
334    if(!@is_writable($p)){
335        return '';
336    }
337
338    // check accessability (execute bit) for directories
339    if(@is_dir($p) && !@file_exists("$p/.")){
340        return '';
341    }
342
343    return $p;
344}
345
346/**
347 * Sets the internal config values fperm and dperm which, when set,
348 * will be used to change the permission of a newly created dir or
349 * file with chmod. Considers the influence of the system's umask
350 * setting the values only if needed.
351 */
352function init_creationmodes(){
353    global $conf;
354
355    // Legacy support for old umask/dmask scheme
356    unset($conf['dmask']);
357    unset($conf['fmask']);
358    unset($conf['umask']);
359    unset($conf['fperm']);
360    unset($conf['dperm']);
361
362    // get system umask, fallback to 0 if none available
363    $umask = @umask();
364    if(!$umask) $umask = 0000;
365
366    // check what is set automatically by the system on file creation
367    // and set the fperm param if it's not what we want
368    $auto_fmode = 0666 & ~$umask;
369    if($auto_fmode != $conf['fmode']) $conf['fperm'] = $conf['fmode'];
370
371    // check what is set automatically by the system on file creation
372    // and set the dperm param if it's not what we want
373    $auto_dmode = $conf['dmode'] & ~$umask;
374    if($auto_dmode != $conf['dmode']) $conf['dperm'] = $conf['dmode'];
375}
376
377/**
378 * remove magic quotes recursivly
379 *
380 * @author Andreas Gohr <andi@splitbrain.org>
381 */
382function remove_magic_quotes(&$array) {
383    foreach (array_keys($array) as $key) {
384        // handle magic quotes in keynames (breaks order)
385        $sk = stripslashes($key);
386        if($sk != $key){
387            $array[$sk] = $array[$key];
388            unset($array[$key]);
389            $key = $sk;
390        }
391
392        // do recursion if needed
393        if (is_array($array[$key])) {
394            remove_magic_quotes($array[$key]);
395        }else {
396            $array[$key] = stripslashes($array[$key]);
397        }
398    }
399}
400
401/**
402 * Returns the full absolute URL to the directory where
403 * DokuWiki is installed in (includes a trailing slash)
404 *
405 * !! Can not access $_SERVER values through $INPUT
406 * !! here as this function is called before $INPUT is
407 * !! initialized.
408 *
409 * @author Andreas Gohr <andi@splitbrain.org>
410 */
411function getBaseURL($abs=null){
412    global $conf;
413    //if canonical url enabled always return absolute
414    if(is_null($abs)) $abs = $conf['canonical'];
415
416    if($conf['basedir']){
417        $dir = $conf['basedir'];
418    }elseif(substr($_SERVER['SCRIPT_NAME'],-4) == '.php'){
419        $dir = dirname($_SERVER['SCRIPT_NAME']);
420    }elseif(substr($_SERVER['PHP_SELF'],-4) == '.php'){
421        $dir = dirname($_SERVER['PHP_SELF']);
422    }elseif($_SERVER['DOCUMENT_ROOT'] && $_SERVER['SCRIPT_FILENAME']){
423        $dir = preg_replace ('/^'.preg_quote($_SERVER['DOCUMENT_ROOT'],'/').'/','',
424                $_SERVER['SCRIPT_FILENAME']);
425        $dir = dirname('/'.$dir);
426    }else{
427        $dir = '.'; //probably wrong
428    }
429
430    $dir = str_replace('\\','/',$dir);             // bugfix for weird WIN behaviour
431    $dir = preg_replace('#//+#','/',"/$dir/");     // ensure leading and trailing slashes
432
433    //handle script in lib/exe dir
434    $dir = preg_replace('!lib/exe/$!','',$dir);
435
436    //handle script in lib/plugins dir
437    $dir = preg_replace('!lib/plugins/.*$!','',$dir);
438
439    //finish here for relative URLs
440    if(!$abs) return $dir;
441
442    //use config option if available, trim any slash from end of baseurl to avoid multiple consecutive slashes in the path
443    if($conf['baseurl']) return rtrim($conf['baseurl'],'/').$dir;
444
445    //split hostheader into host and port
446    if(isset($_SERVER['HTTP_HOST'])){
447        $parsed_host = parse_url('http://'.$_SERVER['HTTP_HOST']);
448        $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
449        $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
450    }elseif(isset($_SERVER['SERVER_NAME'])){
451        $parsed_host = parse_url('http://'.$_SERVER['SERVER_NAME']);
452        $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
453        $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
454    }else{
455        $host = php_uname('n');
456        $port = '';
457    }
458
459    if(is_null($port)){
460        $port = '';
461    }
462
463    if(!is_ssl()){
464        $proto = 'http://';
465        if ($port == '80') {
466            $port = '';
467        }
468    }else{
469        $proto = 'https://';
470        if ($port == '443') {
471            $port = '';
472        }
473    }
474
475    if($port !== '') $port = ':'.$port;
476
477    return $proto.$host.$port.$dir;
478}
479
480/**
481 * Check if accessed via HTTPS
482 *
483 * Apache leaves ,$_SERVER['HTTPS'] empty when not available, IIS sets it to 'off'.
484 * 'false' and 'disabled' are just guessing
485 *
486 * @returns bool true when SSL is active
487 */
488function is_ssl(){
489    // check if we are behind a reverse proxy
490    if (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
491        if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') {
492	    return true;
493	} else {
494	    return false;
495	}
496    }
497    if (!isset($_SERVER['HTTPS']) ||
498        preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){
499        return false;
500    }else{
501        return true;
502    }
503}
504
505/**
506 * print a nice message even if no styles are loaded yet.
507 */
508function nice_die($msg){
509    echo<<<EOT
510<!DOCTYPE html>
511<html>
512<head><title>DokuWiki Setup Error</title></head>
513<body style="font-family: Arial, sans-serif">
514    <div style="width:60%; margin: auto; background-color: #fcc;
515                border: 1px solid #faa; padding: 0.5em 1em;">
516        <h1 style="font-size: 120%">DokuWiki Setup Error</h1>
517        <p>$msg</p>
518    </div>
519</body>
520</html>
521EOT;
522    exit;
523}
524
525/**
526 * A realpath() replacement
527 *
528 * This function behaves similar to PHP's realpath() but does not resolve
529 * symlinks or accesses upper directories
530 *
531 * @author Andreas Gohr <andi@splitbrain.org>
532 * @author <richpageau at yahoo dot co dot uk>
533 * @link   http://de3.php.net/manual/en/function.realpath.php#75992
534 */
535function fullpath($path,$exists=false){
536    static $run = 0;
537    $root  = '';
538    $iswin = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' || @$GLOBALS['DOKU_UNITTEST_ASSUME_WINDOWS']);
539
540    // find the (indestructable) root of the path - keeps windows stuff intact
541    if($path{0} == '/'){
542        $root = '/';
543    }elseif($iswin){
544        // match drive letter and UNC paths
545        if(preg_match('!^([a-zA-z]:)(.*)!',$path,$match)){
546            $root = $match[1].'/';
547            $path = $match[2];
548        }else if(preg_match('!^(\\\\\\\\[^\\\\/]+\\\\[^\\\\/]+[\\\\/])(.*)!',$path,$match)){
549            $root = $match[1];
550            $path = $match[2];
551        }
552    }
553    $path = str_replace('\\','/',$path);
554
555    // if the given path wasn't absolute already, prepend the script path and retry
556    if(!$root){
557        $base = dirname($_SERVER['SCRIPT_FILENAME']);
558        $path = $base.'/'.$path;
559        if($run == 0){ // avoid endless recursion when base isn't absolute for some reason
560            $run++;
561            return fullpath($path,$exists);
562        }
563    }
564    $run = 0;
565
566    // canonicalize
567    $path=explode('/', $path);
568    $newpath=array();
569    foreach($path as $p) {
570        if ($p === '' || $p === '.') continue;
571        if ($p==='..') {
572            array_pop($newpath);
573            continue;
574        }
575        array_push($newpath, $p);
576    }
577    $finalpath = $root.implode('/', $newpath);
578
579    // check for existence when needed (except when unit testing)
580    if($exists && !defined('DOKU_UNITTEST') && !@file_exists($finalpath)) {
581        return false;
582    }
583    return $finalpath;
584}
585
586