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