xref: /dokuwiki/inc/init.php (revision 0e65a4846cba3dee39cbd53b702a833788e6fec0) 
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    session_name("DokuWiki");
145    $cookieDir = empty($conf['cookiedir']) ? DOKU_REL : $conf['cookiedir'];
146    if (version_compare(PHP_VERSION, '5.2.0', '>')) {
147        session_set_cookie_params(0,$cookieDir,'',($conf['securecookie'] && is_ssl()),true);
148    }else{
149        session_set_cookie_params(0,$cookieDir,'',($conf['securecookie'] && is_ssl()));
150    }
151    session_start();
152
153    // load left over messages
154    if(isset($_SESSION[DOKU_COOKIE]['msg'])){
155        $MSG = $_SESSION[DOKU_COOKIE]['msg'];
156        unset($_SESSION[DOKU_COOKIE]['msg']);
157    }
158}
159
160// kill magic quotes
161if (get_magic_quotes_gpc() && !defined('MAGIC_QUOTES_STRIPPED')) {
162    if (!empty($_GET))    remove_magic_quotes($_GET);
163    if (!empty($_POST))   remove_magic_quotes($_POST);
164    if (!empty($_COOKIE)) remove_magic_quotes($_COOKIE);
165    if (!empty($_REQUEST)) remove_magic_quotes($_REQUEST);
166    @ini_set('magic_quotes_gpc', 0);
167    define('MAGIC_QUOTES_STRIPPED',1);
168}
169if(function_exists('set_magic_quotes_runtime')) @set_magic_quotes_runtime(0);
170@ini_set('magic_quotes_sybase',0);
171
172// don't let cookies ever interfere with request vars
173$_REQUEST = array_merge($_GET,$_POST);
174
175// we don't want a purge URL to be digged
176if(isset($_REQUEST['purge']) && $_SERVER['HTTP_REFERER']) unset($_REQUEST['purge']);
177
178// disable gzip if not available
179if($conf['compression'] == 'bz2' && !function_exists('bzopen')){
180    $conf['compression'] = 'gz';
181}
182if($conf['compression'] == 'gz' && !function_exists('gzopen')){
183    $conf['compression'] = 0;
184}
185
186// fix dateformat for upgraders
187if(strpos($conf['dformat'],'%') === false){
188    $conf['dformat'] = '%Y/%m/%d %H:%M';
189}
190
191// precalculate file creation modes
192init_creationmodes();
193
194// make real paths and check them
195init_paths();
196init_files();
197
198// setup plugin controller class (can be overwritten in preload.php)
199$plugin_types = array('admin','syntax','action','renderer', 'helper','remote');
200global $plugin_controller_class, $plugin_controller;
201if (empty($plugin_controller_class)) $plugin_controller_class = 'Doku_Plugin_Controller';
202
203// load libraries
204require_once(DOKU_INC.'inc/load.php');
205
206// input handle class
207global $INPUT;
208$INPUT = new Input();
209
210// initialize plugin controller
211$plugin_controller = new $plugin_controller_class();
212
213// initialize the event handler
214global $EVENT_HANDLER;
215$EVENT_HANDLER = new Doku_Event_Handler();
216
217$local = $conf['lang'];
218trigger_event('INIT_LANG_LOAD', $local, 'init_lang', true);
219
220
221// setup authentication system
222if (!defined('NOSESSION')) {
223    auth_setup();
224}
225
226// setup mail system
227mail_setup();
228
229/**
230 * Checks paths from config file
231 */
232function init_paths(){
233    global $conf;
234
235    $paths = array('datadir'   => 'pages',
236            'olddir'    => 'attic',
237            'mediadir'  => 'media',
238            'mediaolddir' => 'media_attic',
239            'metadir'   => 'meta',
240            'mediametadir' => 'media_meta',
241            'cachedir'  => 'cache',
242            'indexdir'  => 'index',
243            'lockdir'   => 'locks',
244            'tmpdir'    => 'tmp');
245
246    foreach($paths as $c => $p) {
247        $path = empty($conf[$c]) ? $conf['savedir'].'/'.$p : $conf[$c];
248        $conf[$c] = init_path($path);
249        if(empty($conf[$c]))
250            nice_die("The $c ('$p') at $path is not found, isn't accessible or writable.
251                You should check your config and permission settings.
252                Or maybe you want to <a href=\"install.php\">run the
253                installer</a>?");
254    }
255
256    // path to old changelog only needed for upgrading
257    $conf['changelog_old'] = init_path((isset($conf['changelog']))?($conf['changelog']):($conf['savedir'].'/changes.log'));
258    if ($conf['changelog_old']=='') { unset($conf['changelog_old']); }
259    // hardcoded changelog because it is now a cache that lives in meta
260    $conf['changelog'] = $conf['metadir'].'/_dokuwiki.changes';
261    $conf['media_changelog'] = $conf['metadir'].'/_media.changes';
262}
263
264function init_lang($langCode) {
265    //prepare language array
266    global $lang;
267    $lang = array();
268
269    //load the language files
270    require_once(DOKU_INC.'inc/lang/en/lang.php');
271    if ($langCode && $langCode != 'en') {
272        if (file_exists(DOKU_INC."inc/lang/$langCode/lang.php")) {
273            require_once(DOKU_INC."inc/lang/$langCode/lang.php");
274        }
275    }
276}
277
278/**
279 * Checks the existence of certain files and creates them if missing.
280 */
281function init_files(){
282    global $conf;
283
284    $files = array($conf['indexdir'].'/page.idx');
285
286    foreach($files as $file){
287        if(!@file_exists($file)){
288            $fh = @fopen($file,'a');
289            if($fh){
290                fclose($fh);
291                if($conf['fperm']) chmod($file, $conf['fperm']);
292            }else{
293                nice_die("$file is not writable. Check your permissions settings!");
294            }
295        }
296    }
297
298    # create title index (needs to have same length as page.idx)
299    /*
300    $file = $conf['indexdir'].'/title.idx';
301    if(!@file_exists($file)){
302        $pages = file($conf['indexdir'].'/page.idx');
303        $pages = count($pages);
304        $fh = @fopen($file,'a');
305        if($fh){
306            for($i=0; $i<$pages; $i++){
307                fwrite($fh,"\n");
308            }
309            fclose($fh);
310        }else{
311            nice_die("$file is not writable. Check your permissions settings!");
312        }
313    }
314    */
315}
316
317/**
318 * Returns absolute path
319 *
320 * This tries the given path first, then checks in DOKU_INC.
321 * Check for accessibility on directories as well.
322 *
323 * @author Andreas Gohr <andi@splitbrain.org>
324 */
325function init_path($path){
326    // check existence
327    $p = fullpath($path);
328    if(!@file_exists($p)){
329        $p = fullpath(DOKU_INC.$path);
330        if(!@file_exists($p)){
331            return '';
332        }
333    }
334
335    // check writability
336    if(!@is_writable($p)){
337        return '';
338    }
339
340    // check accessability (execute bit) for directories
341    if(@is_dir($p) && !@file_exists("$p/.")){
342        return '';
343    }
344
345    return $p;
346}
347
348/**
349 * Sets the internal config values fperm and dperm which, when set,
350 * will be used to change the permission of a newly created dir or
351 * file with chmod. Considers the influence of the system's umask
352 * setting the values only if needed.
353 */
354function init_creationmodes(){
355    global $conf;
356
357    // Legacy support for old umask/dmask scheme
358    unset($conf['dmask']);
359    unset($conf['fmask']);
360    unset($conf['umask']);
361    unset($conf['fperm']);
362    unset($conf['dperm']);
363
364    // get system umask, fallback to 0 if none available
365    $umask = @umask();
366    if(!$umask) $umask = 0000;
367
368    // check what is set automatically by the system on file creation
369    // and set the fperm param if it's not what we want
370    $auto_fmode = 0666 & ~$umask;
371    if($auto_fmode != $conf['fmode']) $conf['fperm'] = $conf['fmode'];
372
373    // check what is set automatically by the system on file creation
374    // and set the dperm param if it's not what we want
375    $auto_dmode = $conf['dmode'] & ~$umask;
376    if($auto_dmode != $conf['dmode']) $conf['dperm'] = $conf['dmode'];
377}
378
379/**
380 * remove magic quotes recursivly
381 *
382 * @author Andreas Gohr <andi@splitbrain.org>
383 */
384function remove_magic_quotes(&$array) {
385    foreach (array_keys($array) as $key) {
386        // handle magic quotes in keynames (breaks order)
387        $sk = stripslashes($key);
388        if($sk != $key){
389            $array[$sk] = $array[$key];
390            unset($array[$key]);
391            $key = $sk;
392        }
393
394        // do recursion if needed
395        if (is_array($array[$key])) {
396            remove_magic_quotes($array[$key]);
397        }else {
398            $array[$key] = stripslashes($array[$key]);
399        }
400    }
401}
402
403/**
404 * Returns the full absolute URL to the directory where
405 * DokuWiki is installed in (includes a trailing slash)
406 *
407 * @author Andreas Gohr <andi@splitbrain.org>
408 */
409function getBaseURL($abs=null){
410    global $conf;
411    //if canonical url enabled always return absolute
412    if(is_null($abs)) $abs = $conf['canonical'];
413
414    if($conf['basedir']){
415        $dir = $conf['basedir'];
416    }elseif(substr($_SERVER['SCRIPT_NAME'],-4) == '.php'){
417        $dir = dirname($_SERVER['SCRIPT_NAME']);
418    }elseif(substr($_SERVER['PHP_SELF'],-4) == '.php'){
419        $dir = dirname($_SERVER['PHP_SELF']);
420    }elseif($_SERVER['DOCUMENT_ROOT'] && $_SERVER['SCRIPT_FILENAME']){
421        $dir = preg_replace ('/^'.preg_quote($_SERVER['DOCUMENT_ROOT'],'/').'/','',
422                $_SERVER['SCRIPT_FILENAME']);
423        $dir = dirname('/'.$dir);
424    }else{
425        $dir = '.'; //probably wrong
426    }
427
428    $dir = str_replace('\\','/',$dir);             // bugfix for weird WIN behaviour
429    $dir = preg_replace('#//+#','/',"/$dir/");     // ensure leading and trailing slashes
430
431    //handle script in lib/exe dir
432    $dir = preg_replace('!lib/exe/$!','',$dir);
433
434    //handle script in lib/plugins dir
435    $dir = preg_replace('!lib/plugins/.*$!','',$dir);
436
437    //finish here for relative URLs
438    if(!$abs) return $dir;
439
440    //use config option if available, trim any slash from end of baseurl to avoid multiple consecutive slashes in the path
441    if($conf['baseurl']) return rtrim($conf['baseurl'],'/').$dir;
442
443    //split hostheader into host and port
444    if(isset($_SERVER['HTTP_HOST'])){
445        $parsed_host = parse_url('http://'.$_SERVER['HTTP_HOST']);
446        $host = $parsed_host['host'];
447        $port = $parsed_host['port'];
448    }elseif(isset($_SERVER['SERVER_NAME'])){
449        $parsed_host = parse_url('http://'.$_SERVER['SERVER_NAME']);
450        $host = $parsed_host['host'];
451        $port = $parsed_host['port'];
452    }else{
453        $host = php_uname('n');
454        $port = '';
455    }
456
457    if(!$port && isset($_SERVER['SERVER_PORT'])) {
458        $port = $_SERVER['SERVER_PORT'];
459    }
460
461    if(is_null($port)){
462        $port = '';
463    }
464
465    if(!is_ssl()){
466        $proto = 'http://';
467        if ($port == '80') {
468            $port = '';
469        }
470    }else{
471        $proto = 'https://';
472        if ($port == '443') {
473            $port = '';
474        }
475    }
476
477    if($port !== '') $port = ':'.$port;
478
479    return $proto.$host.$port.$dir;
480}
481
482/**
483 * Check if accessed via HTTPS
484 *
485 * Apache leaves ,$_SERVER['HTTPS'] empty when not available, IIS sets it to 'off'.
486 * 'false' and 'disabled' are just guessing
487 *
488 * @returns bool true when SSL is active
489 */
490function is_ssl(){
491    if (!isset($_SERVER['HTTPS']) ||
492        preg_match('/^(|off|false|disabled)$/i',$_SERVER['HTTPS'])){
493        return false;
494    }else{
495        return true;
496    }
497}
498
499/**
500 * print a nice message even if no styles are loaded yet.
501 */
502function nice_die($msg){
503    echo<<<EOT
504<!DOCTYPE html>
505<html>
506<head><title>DokuWiki Setup Error</title></head>
507<body style="font-family: Arial, sans-serif">
508    <div style="width:60%; margin: auto; background-color: #fcc;
509                border: 1px solid #faa; padding: 0.5em 1em;">
510        <h1 style="font-size: 120%">DokuWiki Setup Error</h1>
511        <p>$msg</p>
512    </div>
513</body>
514</html>
515EOT;
516    exit;
517}
518
519/**
520 * A realpath() replacement
521 *
522 * This function behaves similar to PHP's realpath() but does not resolve
523 * symlinks or accesses upper directories
524 *
525 * @author Andreas Gohr <andi@splitbrain.org>
526 * @author <richpageau at yahoo dot co dot uk>
527 * @link   http://de3.php.net/manual/en/function.realpath.php#75992
528 */
529function fullpath($path,$exists=false){
530    static $run = 0;
531    $root  = '';
532    $iswin = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' || @$GLOBALS['DOKU_UNITTEST_ASSUME_WINDOWS']);
533
534    // find the (indestructable) root of the path - keeps windows stuff intact
535    if($path{0} == '/'){
536        $root = '/';
537    }elseif($iswin){
538        // match drive letter and UNC paths
539        if(preg_match('!^([a-zA-z]:)(.*)!',$path,$match)){
540            $root = $match[1].'/';
541            $path = $match[2];
542        }else if(preg_match('!^(\\\\\\\\[^\\\\/]+\\\\[^\\\\/]+[\\\\/])(.*)!',$path,$match)){
543            $root = $match[1];
544            $path = $match[2];
545        }
546    }
547    $path = str_replace('\\','/',$path);
548
549    // if the given path wasn't absolute already, prepend the script path and retry
550    if(!$root){
551        $base = dirname($_SERVER['SCRIPT_FILENAME']);
552        $path = $base.'/'.$path;
553        if($run == 0){ // avoid endless recursion when base isn't absolute for some reason
554            $run++;
555            return fullpath($path,$exists);
556        }
557    }
558    $run = 0;
559
560    // canonicalize
561    $path=explode('/', $path);
562    $newpath=array();
563    foreach($path as $p) {
564        if ($p === '' || $p === '.') continue;
565        if ($p==='..') {
566            array_pop($newpath);
567            continue;
568        }
569        array_push($newpath, $p);
570    }
571    $finalpath = $root.implode('/', $newpath);
572
573    // check for existence when needed (except when unit testing)
574    if($exists && !defined('DOKU_UNITTEST') && !@file_exists($finalpath)) {
575        return false;
576    }
577    return $finalpath;
578}
579
580