[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> init.php (source)

   1  <?php
   2  /**
   3   * Initialize some defaults needed for DokuWiki
   4   */
   5  
   6  use dokuwiki\Extension\Event;
   7  use dokuwiki\Extension\EventHandler;
   8  
   9  /**
  10   * timing Dokuwiki execution
  11   *
  12   * @param integer $start
  13   *
  14   * @return mixed
  15   */
  16  function delta_time($start=0) {
  17      return microtime(true)-((float)$start);
  18  }
  19  define('DOKU_START_TIME', delta_time());
  20  
  21  global $config_cascade;
  22  $config_cascade = array();
  23  
  24  // if available load a preload config file
  25  $preload = fullpath(dirname(__FILE__)).'/preload.php';
  26  if (file_exists($preload)) include($preload);
  27  
  28  // define the include path
  29  if(!defined('DOKU_INC')) define('DOKU_INC',fullpath(dirname(__FILE__).'/../').'/');
  30  
  31  // define Plugin dir
  32  if(!defined('DOKU_PLUGIN'))  define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
  33  
  34  // define config path (packagers may want to change this to /etc/dokuwiki/)
  35  if(!defined('DOKU_CONF')) define('DOKU_CONF',DOKU_INC.'conf/');
  36  
  37  // check for error reporting override or set error reporting to sane values
  38  if (!defined('DOKU_E_LEVEL') && file_exists(DOKU_CONF.'report_e_all')) {
  39      define('DOKU_E_LEVEL', E_ALL);
  40  }
  41  if (!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
  48  header('Vary: Cookie');
  49  
  50  // init memory caches
  51  global $cache_revinfo;
  52         $cache_revinfo = array();
  53  global $cache_wikifn;
  54         $cache_wikifn = array();
  55  global $cache_cleanid;
  56         $cache_cleanid = array();
  57  global $cache_authname;
  58         $cache_authname = array();
  59  global $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
  64  include (DOKU_INC.'inc/config_cascade.php');
  65  
  66  //prepare config array()
  67  global $conf;
  68  $conf = array();
  69  
  70  // load the global config file(s)
  71  foreach (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()
  81  global $license;
  82  $license = array();
  83  
  84  // load the license file(s)
  85  foreach (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)
  95  date_default_timezone_set(@date_default_timezone_get());
  96  
  97  // define baseURL
  98  if(!defined('DOKU_REL')) define('DOKU_REL',getBaseURL(false));
  99  if(!defined('DOKU_URL')) define('DOKU_URL',getBaseURL(true));
 100  if(!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
 109  if(!defined('NL')) define ('NL',"\n");
 110  if(!defined('DOKU_LF')) define ('DOKU_LF',"\n");
 111  if(!defined('DOKU_TAB')) define ('DOKU_TAB',"\t");
 112  
 113  // define cookie and session id, append server port when securecookie is configured FS#1664
 114  if (!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
 121  if(!defined('DOKU_SCRIPT')) define('DOKU_SCRIPT','doku.php');
 122  
 123  if(!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  
 131  if(!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);
 151  global $ACT;
 152  if ($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
 162  if(!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
 185  if(isset($_REQUEST['purge']) && !empty($_SERVER['HTTP_REFERER'])) unset($_REQUEST['purge']);
 186  
 187  // precalculate file creation modes
 188  init_creationmodes();
 189  
 190  // make real paths and check them
 191  init_paths();
 192  init_files();
 193  
 194  // setup plugin controller class (can be overwritten in preload.php)
 195  global $plugin_controller_class, $plugin_controller;
 196  if (empty($plugin_controller_class)) $plugin_controller_class = dokuwiki\Extension\PluginController::class;
 197  
 198  // load libraries
 199  require_once (DOKU_INC.'vendor/autoload.php');
 200  require_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
 206  define('DOKU_HAS_BZIP', function_exists('bzopen'));
 207  define('DOKU_HAS_GZIP', function_exists('gzopen'));
 208  if($conf['compression'] == 'bz2' && !DOKU_HAS_BZIP) {
 209      $conf['compression'] = 'gz';
 210  }
 211  if($conf['compression'] == 'gz' && !DOKU_HAS_GZIP) {
 212      $conf['compression'] = 0;
 213  }
 214  
 215  // input handle class
 216  global $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
 223  global $EVENT_HANDLER;
 224  $EVENT_HANDLER = new EventHandler();
 225  
 226  $local = $conf['lang'];
 227  Event::createAndTrigger('INIT_LANG_LOAD', $local, 'init_lang', true);
 228  
 229  
 230  // setup authentication system
 231  if (!defined('NOSESSION')) {
 232      auth_setup();
 233  }
 234  
 235  // setup mail system
 236  mail_setup();
 237  
 238  $nil = null;
 239  Event::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   */
 249  function 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   */
 272  function 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              nice_die("The $c ('$p') at $path is not found, isn't accessible or writable.
 294                  You should check your config and permission settings.
 295                  Or maybe you want to <a href=\"install.php\">run the
 296                  installer</a>?");
 297      }
 298  
 299      // path to old changelog only needed for upgrading
 300      $conf['changelog_old'] = init_path(
 301          (isset($conf['changelog'])) ? ($conf['changelog']) : ($conf['savedir'] . '/changes.log')
 302      );
 303      if ($conf['changelog_old']=='') { unset($conf['changelog_old']); }
 304      // hardcoded changelog because it is now a cache that lives in meta
 305      $conf['changelog'] = $conf['metadir'].'/_dokuwiki.changes';
 306      $conf['media_changelog'] = $conf['metadir'].'/_media.changes';
 307  }
 308  
 309  /**
 310   * Load the language strings
 311   *
 312   * @param string $langCode language code, as passed by event handler
 313   */
 314  function init_lang($langCode) {
 315      //prepare language array
 316      global $lang, $config_cascade;
 317      $lang = array();
 318  
 319      //load the language files
 320      require (DOKU_INC.'inc/lang/en/lang.php');
 321      foreach ($config_cascade['lang']['core'] as $config_file) {
 322          if (file_exists($config_file . 'en/lang.php')) {
 323              include($config_file . 'en/lang.php');
 324          }
 325      }
 326  
 327      if ($langCode && $langCode != 'en') {
 328          if (file_exists(DOKU_INC."inc/lang/$langCode/lang.php")) {
 329              require(DOKU_INC."inc/lang/$langCode/lang.php");
 330          }
 331          foreach ($config_cascade['lang']['core'] as $config_file) {
 332              if (file_exists($config_file . "$langCode/lang.php")) {
 333                  include($config_file . "$langCode/lang.php");
 334              }
 335          }
 336      }
 337  }
 338  
 339  /**
 340   * Checks the existence of certain files and creates them if missing.
 341   */
 342  function init_files(){
 343      global $conf;
 344  
 345      $files = array($conf['indexdir'].'/page.idx');
 346  
 347      foreach($files as $file){
 348          if(!file_exists($file)){
 349              $fh = @fopen($file,'a');
 350              if($fh){
 351                  fclose($fh);
 352                  if($conf['fperm']) chmod($file, $conf['fperm']);
 353              }else{
 354                  nice_die("$file is not writable. Check your permissions settings!");
 355              }
 356          }
 357      }
 358  }
 359  
 360  /**
 361   * Returns absolute path
 362   *
 363   * This tries the given path first, then checks in DOKU_INC.
 364   * Check for accessibility on directories as well.
 365   *
 366   * @author Andreas Gohr <andi@splitbrain.org>
 367   *
 368   * @param string $path
 369   *
 370   * @return bool|string
 371   */
 372  function init_path($path){
 373      // check existence
 374      $p = fullpath($path);
 375      if(!file_exists($p)){
 376          $p = fullpath(DOKU_INC.$path);
 377          if(!file_exists($p)){
 378              return '';
 379          }
 380      }
 381  
 382      // check writability
 383      if(!@is_writable($p)){
 384          return '';
 385      }
 386  
 387      // check accessability (execute bit) for directories
 388      if(@is_dir($p) && !file_exists("$p/.")){
 389          return '';
 390      }
 391  
 392      return $p;
 393  }
 394  
 395  /**
 396   * Sets the internal config values fperm and dperm which, when set,
 397   * will be used to change the permission of a newly created dir or
 398   * file with chmod. Considers the influence of the system's umask
 399   * setting the values only if needed.
 400   */
 401  function init_creationmodes(){
 402      global $conf;
 403  
 404      // Legacy support for old umask/dmask scheme
 405      unset($conf['dmask']);
 406      unset($conf['fmask']);
 407      unset($conf['umask']);
 408  
 409      $conf['fperm'] = false;
 410      $conf['dperm'] = false;
 411  
 412      // get system umask, fallback to 0 if none available
 413      $umask = @umask();
 414      if(!$umask) $umask = 0000;
 415  
 416      // check what is set automatically by the system on file creation
 417      // and set the fperm param if it's not what we want
 418      $auto_fmode = 0666 & ~$umask;
 419      if($auto_fmode != $conf['fmode']) $conf['fperm'] = $conf['fmode'];
 420  
 421      // check what is set automatically by the system on directory creation
 422      // and set the dperm param if it's not what we want.
 423      $auto_dmode = 0777 & ~$umask;
 424      if($auto_dmode != $conf['dmode']) $conf['dperm'] = $conf['dmode'];
 425  }
 426  
 427  /**
 428   * Returns the full absolute URL to the directory where
 429   * DokuWiki is installed in (includes a trailing slash)
 430   *
 431   * !! Can not access $_SERVER values through $INPUT
 432   * !! here as this function is called before $INPUT is
 433   * !! initialized.
 434   *
 435   * @author Andreas Gohr <andi@splitbrain.org>
 436   *
 437   * @param null|string $abs
 438   *
 439   * @return string
 440   */
 441  function getBaseURL($abs=null){
 442      global $conf;
 443      //if canonical url enabled always return absolute
 444      if(is_null($abs)) $abs = $conf['canonical'];
 445  
 446      if(!empty($conf['basedir'])){
 447          $dir = $conf['basedir'];
 448      }elseif(substr($_SERVER['SCRIPT_NAME'],-4) == '.php'){
 449          $dir = dirname($_SERVER['SCRIPT_NAME']);
 450      }elseif(substr($_SERVER['PHP_SELF'],-4) == '.php'){
 451          $dir = dirname($_SERVER['PHP_SELF']);
 452      }elseif($_SERVER['DOCUMENT_ROOT'] && $_SERVER['SCRIPT_FILENAME']){
 453          $dir = preg_replace ('/^'.preg_quote($_SERVER['DOCUMENT_ROOT'],'/').'/','',
 454                  $_SERVER['SCRIPT_FILENAME']);
 455          $dir = dirname('/'.$dir);
 456      }else{
 457          $dir = '.'; //probably wrong
 458      }
 459  
 460      $dir = str_replace('\\','/',$dir);             // bugfix for weird WIN behaviour
 461      $dir = preg_replace('#//+#','/',"/$dir/");     // ensure leading and trailing slashes
 462  
 463      //handle script in lib/exe dir
 464      $dir = preg_replace('!lib/exe/$!','',$dir);
 465  
 466      //handle script in lib/plugins dir
 467      $dir = preg_replace('!lib/plugins/.*$!','',$dir);
 468  
 469      //finish here for relative URLs
 470      if(!$abs) return $dir;
 471  
 472      //use config if available, trim any slash from end of baseurl to avoid multiple consecutive slashes in the path
 473      if(!empty($conf['baseurl'])) return rtrim($conf['baseurl'],'/').$dir;
 474  
 475      //split hostheader into host and port
 476      if(isset($_SERVER['HTTP_HOST'])){
 477          $parsed_host = parse_url('http://'.$_SERVER['HTTP_HOST']);
 478          $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
 479          $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
 480      }elseif(isset($_SERVER['SERVER_NAME'])){
 481          $parsed_host = parse_url('http://'.$_SERVER['SERVER_NAME']);
 482          $host = isset($parsed_host['host']) ? $parsed_host['host'] : null;
 483          $port = isset($parsed_host['port']) ? $parsed_host['port'] : null;
 484      }else{
 485          $host = php_uname('n');
 486          $port = '';
 487      }
 488  
 489      if(is_null($port)){
 490          $port = '';
 491      }
 492  
 493      if(!is_ssl()){
 494          $proto = 'http://';
 495          if ($port == '80') {
 496              $port = '';
 497          }
 498      }else{
 499          $proto = 'https://';
 500          if ($port == '443') {
 501              $port = '';
 502          }
 503      }
 504  
 505      if($port !== '') $port = ':'.$port;
 506  
 507      return $proto.$host.$port.$dir;
 508  }
 509  
 510  /**
 511   * Check if accessed via HTTPS
 512   *
 513   * Apache leaves ,$_SERVER['HTTPS'] empty when not available, IIS sets it to 'off'.
 514   * 'false' and 'disabled' are just guessing
 515   *
 516   * @returns bool true when SSL is active
 517   */
 518  function is_ssl() {
 519      // check if we are behind a reverse proxy
 520      if(isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
 521          if($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') {
 522              return true;
 523          } else {
 524              return false;
 525          }
 526      }
 527      if(!isset($_SERVER['HTTPS']) ||
 528          preg_match('/^(|off|false|disabled)$/i', $_SERVER['HTTPS'])) {
 529          return false;
 530      } else {
 531          return true;
 532      }
 533  }
 534  
 535  /**
 536   * checks it is windows OS
 537   * @return bool
 538   */
 539  function isWindows() {
 540      return (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') ? true : false;
 541  }
 542  
 543  /**
 544   * print a nice message even if no styles are loaded yet.
 545   *
 546   * @param integer|string $msg
 547   */
 548  function nice_die($msg){
 549      echo<<<EOT
 550  <!DOCTYPE html>
 551  <html>
 552  <head><title>DokuWiki Setup Error</title></head>
 553  <body style="font-family: Arial, sans-serif">
 554      <div style="width:60%; margin: auto; background-color: #fcc;
 555                  border: 1px solid #faa; padding: 0.5em 1em;">
 556          <h1 style="font-size: 120%">DokuWiki Setup Error</h1>
 557          <p>$msg</p>
 558      </div>
 559  </body>
 560  </html>
 561  EOT;
 562      if(defined('DOKU_UNITTEST')) {
 563          throw new RuntimeException('nice_die: '.$msg);
 564      }
 565      exit(1);
 566  }
 567  
 568  /**
 569   * A realpath() replacement
 570   *
 571   * This function behaves similar to PHP's realpath() but does not resolve
 572   * symlinks or accesses upper directories
 573   *
 574   * @author Andreas Gohr <andi@splitbrain.org>
 575   * @author <richpageau at yahoo dot co dot uk>
 576   * @link   http://php.net/manual/en/function.realpath.php#75992
 577   *
 578   * @param string $path
 579   * @param bool $exists
 580   *
 581   * @return bool|string
 582   */
 583  function fullpath($path,$exists=false){
 584      static $run = 0;
 585      $root  = '';
 586      $iswin = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' || !empty($GLOBALS['DOKU_UNITTEST_ASSUME_WINDOWS']));
 587  
 588      // find the (indestructable) root of the path - keeps windows stuff intact
 589      if($path[0] == '/'){
 590          $root = '/';
 591      }elseif($iswin){
 592          // match drive letter and UNC paths
 593          if(preg_match('!^([a-zA-z]:)(.*)!',$path,$match)){
 594              $root = $match[1].'/';
 595              $path = $match[2];
 596          }else if(preg_match('!^(\\\\\\\\[^\\\\/]+\\\\[^\\\\/]+[\\\\/])(.*)!',$path,$match)){
 597              $root = $match[1];
 598              $path = $match[2];
 599          }
 600      }
 601      $path = str_replace('\\','/',$path);
 602  
 603      // if the given path wasn't absolute already, prepend the script path and retry
 604      if(!$root){
 605          $base = dirname($_SERVER['SCRIPT_FILENAME']);
 606          $path = $base.'/'.$path;
 607          if($run == 0){ // avoid endless recursion when base isn't absolute for some reason
 608              $run++;
 609              return fullpath($path,$exists);
 610          }
 611      }
 612      $run = 0;
 613  
 614      // canonicalize
 615      $path=explode('/', $path);
 616      $newpath=array();
 617      foreach($path as $p) {
 618          if ($p === '' || $p === '.') continue;
 619          if ($p==='..') {
 620              array_pop($newpath);
 621              continue;
 622          }
 623          array_push($newpath, $p);
 624      }
 625      $finalpath = $root.implode('/', $newpath);
 626  
 627      // check for existence when needed (except when unit testing)
 628      if($exists && !defined('DOKU_UNITTEST') && !file_exists($finalpath)) {
 629          return false;
 630      }
 631      return $finalpath;
 632  }
 633