[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> farm.php (source)

   1  <?php
   2  /**
   3   * This overwrites DOKU_CONF. Each animal gets its own configuration and data directory.
   4   * This can be used together with preload.php. See preload.php.dist for an example setup.
   5   * For more information see http://www.dokuwiki.org/farms.
   6   *
   7   * The farm directory (constant DOKU_FARMDIR) can be any directory and needs to be set.
   8   * Animals are direct subdirectories of the farm directory.
   9   * There are two different approaches:
  10   *  * An .htaccess based setup can use any animal directory name:
  11   *    http://example.org/<path_to_farm>/subdir/ will need the subdirectory '$farm/subdir/'.
  12   *  * A virtual host based setup needs animal directory names which have to reflect
  13   *    the domain name: If an animal resides in http://www.example.org:8080/mysite/test/,
  14   *    directories that will match range from '$farm/8080.www.example.org.mysite.test/'
  15   *    to a simple '$farm/domain/'.
  16   *
  17   * @author Anika Henke <anika@selfthinker.org>
  18   * @author Michael Klier <chi@chimeric.de>
  19   * @author Christopher Smith <chris@jalakai.co.uk>
  20   * @author virtual host part of farm_confpath() based on conf_path() from Drupal.org's /includes/bootstrap.inc
  21   *   (see https://github.com/drupal/drupal/blob/7.x/includes/bootstrap.inc#L537)
  22   * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
  23   */
  24  
  25  // DOKU_FARMDIR needs to be set in preload.php, the fallback is the same as DOKU_INC would be (if it was set already)
  26  if(!defined('DOKU_FARMDIR')) define('DOKU_FARMDIR', fullpath(dirname(__FILE__).'/../').'/');
  27  if(!defined('DOKU_CONF')) define('DOKU_CONF', farm_confpath(DOKU_FARMDIR));
  28  if(!defined('DOKU_FARM')) define('DOKU_FARM', false);
  29  
  30  
  31  /**
  32   * Find the appropriate configuration directory.
  33   *
  34   * If the .htaccess based setup is used, the configuration directory can be
  35   * any subdirectory of the farm directory.
  36   *
  37   * Otherwise try finding a matching configuration directory by stripping the
  38   * website's hostname from left to right and pathname from right to left. The
  39   * first configuration file found will be used; the remaining will ignored.
  40   * If no configuration file is found, return the default confdir './conf'.
  41   *
  42   * @param string $farm
  43   *
  44   * @return string
  45   */
  46  function farm_confpath($farm) {
  47  
  48      // htaccess based or cli
  49      // cli usage example: animal=your_animal bin/indexer.php
  50      if(isset($_REQUEST['animal']) || ('cli' == php_sapi_name() && isset($_SERVER['animal']))) {
  51          $mode = isset($_REQUEST['animal']) ? 'htaccess' : 'cli';
  52          $animal = $mode == 'htaccess' ? $_REQUEST['animal'] : $_SERVER['animal'];
  53          // check that $animal is a string and just a directory name and not a path
  54          if (!is_string($animal) || strpbrk($animal, '\\/') !== false)
  55              nice_die('Sorry! Invalid animal name!');
  56          if(!is_dir($farm.'/'.$animal))
  57              nice_die("Sorry! This Wiki doesn't exist!");
  58          if(!defined('DOKU_FARM')) define('DOKU_FARM', $mode);
  59          return $farm.'/'.$animal.'/conf/';
  60      }
  61  
  62      // virtual host based
  63      $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
  64      $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
  65      for ($i = count($uri) - 1; $i > 0; $i--) {
  66          for ($j = count($server); $j > 0; $j--) {
  67              $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
  68              if(is_dir("$farm/$dir/conf/")) {
  69                  if(!defined('DOKU_FARM')) define('DOKU_FARM', 'virtual');
  70                  return "$farm/$dir/conf/";
  71              }
  72          }
  73      }
  74  
  75      // default conf directory in farm
  76      if(is_dir("$farm/default/conf/")) {
  77          if(!defined('DOKU_FARM')) define('DOKU_FARM', 'default');
  78          return "$farm/default/conf/";
  79      }
  80      // farmer
  81      return DOKU_INC.'conf/';
  82  }
  83  
  84  /* Use default config files and local animal config files */
  85  $config_cascade = array(
  86      'main' => array(
  87          'default'   => array(DOKU_INC.'conf/dokuwiki.php'),
  88          'local'     => array(DOKU_CONF.'local.php'),
  89          'protected' => array(DOKU_CONF.'local.protected.php'),
  90      ),
  91      'acronyms'  => array(
  92          'default'   => array(DOKU_INC.'conf/acronyms.conf'),
  93          'local'     => array(DOKU_CONF.'acronyms.local.conf'),
  94      ),
  95      'entities'  => array(
  96          'default'   => array(DOKU_INC.'conf/entities.conf'),
  97          'local'     => array(DOKU_CONF.'entities.local.conf'),
  98      ),
  99      'interwiki' => array(
 100          'default'   => array(DOKU_INC.'conf/interwiki.conf'),
 101          'local'     => array(DOKU_CONF.'interwiki.local.conf'),
 102      ),
 103      'license' => array(
 104          'default'   => array(DOKU_INC.'conf/license.php'),
 105          'local'     => array(DOKU_CONF.'license.local.php'),
 106      ),
 107      'mediameta' => array(
 108          'default'   => array(DOKU_INC.'conf/mediameta.php'),
 109          'local'     => array(DOKU_CONF.'mediameta.local.php'),
 110      ),
 111      'mime'      => array(
 112          'default'   => array(DOKU_INC.'conf/mime.conf'),
 113          'local'     => array(DOKU_CONF.'mime.local.conf'),
 114      ),
 115      'scheme'    => array(
 116          'default'   => array(DOKU_INC.'conf/scheme.conf'),
 117          'local'     => array(DOKU_CONF.'scheme.local.conf'),
 118      ),
 119      'smileys'   => array(
 120          'default'   => array(DOKU_INC.'conf/smileys.conf'),
 121          'local'     => array(DOKU_CONF.'smileys.local.conf'),
 122      ),
 123      'wordblock' => array(
 124          'default'   => array(DOKU_INC.'conf/wordblock.conf'),
 125          'local'     => array(DOKU_CONF.'wordblock.local.conf'),
 126      ),
 127      'acl'       => array(
 128          'default'   => DOKU_CONF.'acl.auth.php',
 129      ),
 130      'plainauth.users' => array(
 131          'default'   => DOKU_CONF.'users.auth.php',
 132      ),
 133      'plugins' => array( // needed since Angua
 134          'default'   => array(DOKU_INC.'conf/plugins.php'),
 135          'local'     => array(DOKU_CONF.'plugins.local.php'),
 136          'protected' => array(
 137              DOKU_INC.'conf/plugins.required.php',
 138              DOKU_CONF.'plugins.protected.php',
 139          ),
 140      ),
 141      'userstyle' => array(
 142          'screen'    => array(DOKU_CONF . 'userstyle.css', DOKU_CONF . 'userstyle.less'),
 143          'print'     => array(DOKU_CONF . 'userprint.css', DOKU_CONF . 'userprint.less'),
 144          'feed'      => array(DOKU_CONF . 'userfeed.css', DOKU_CONF . 'userfeed.less'),
 145          'all'       => array(DOKU_CONF . 'userall.css', DOKU_CONF . 'userall.less')
 146      ),
 147      'userscript' => array(
 148          'default'   => array(DOKU_CONF . 'userscript.js')
 149      ),
 150  );