inc/farm.php

   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($_GET['animal']) || ('cli' == php_sapi_name() && isset($_SERVER['animal']))) {
  51         $mode = isset($_GET['animal']) ? 'htaccess' : 'cli';
  52         $animal = $mode == 'htaccess' ? $_GET['animal'] : $_SERVER['animal'];
  53         if(isset($_GET['animal'])) {
  54             // now unset the parameter to not leak into new queries
  55             // code by @splitbrain from farmer plugin
  56             unset($_GET['animal']);
  57             $params = [];
  58             parse_str($_SERVER['QUERY_STRING'], $params);
  59             if (isset($params['animal'])) unset($params['animal']);
  60             $_SERVER['QUERY_STRING'] = http_build_query($params);
  61         }
  62         // check that $animal is a string and just a directory name and not a path
  63         if (!is_string($animal) || strpbrk($animal, '\\/') !== false)
  64             nice_die('Sorry! Invalid animal name!');
  65         if(!is_dir($farm.'/'.$animal))
  66             nice_die("Sorry! This Wiki doesn't exist!");
  67         if(!defined('DOKU_FARM')) define('DOKU_FARM', $mode);
  68         return $farm.'/'.$animal.'/conf/';
  69     }
  70
  71     // virtual host based
  72     $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
  73     $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
  74     for ($i = count($uri) - 1; $i > 0; $i--) {
  75         for ($j = count($server); $j > 0; $j--) {
  76             $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
  77             if(is_dir("$farm/$dir/conf/")) {
  78                 if(!defined('DOKU_FARM')) define('DOKU_FARM', 'virtual');
  79                 return "$farm/$dir/conf/";
  80             }
  81         }
  82     }
  83
  84     // default conf directory in farm
  85     if(is_dir("$farm/default/conf/")) {
  86         if(!defined('DOKU_FARM')) define('DOKU_FARM', 'default');
  87         return "$farm/default/conf/";
  88     }
  89     // farmer
  90     return DOKU_INC.'conf/';
  91 }
  92
  93 /* Use default config files and local animal config files */
  94 $config_cascade = array(
  95     'main' => array(
  96         'default'   => array(DOKU_INC.'conf/dokuwiki.php'),
  97         'local'     => array(DOKU_CONF.'local.php'),
  98         'protected' => array(DOKU_CONF.'local.protected.php'),
  99     ),
 100     'acronyms'  => array(
 101         'default'   => array(DOKU_INC.'conf/acronyms.conf'),
 102         'local'     => array(DOKU_CONF.'acronyms.local.conf'),
 103     ),
 104     'entities'  => array(
 105         'default'   => array(DOKU_INC.'conf/entities.conf'),
 106         'local'     => array(DOKU_CONF.'entities.local.conf'),
 107     ),
 108     'interwiki' => array(
 109         'default'   => array(DOKU_INC.'conf/interwiki.conf'),
 110         'local'     => array(DOKU_CONF.'interwiki.local.conf'),
 111     ),
 112     'license' => array(
 113         'default'   => array(DOKU_INC.'conf/license.php'),
 114         'local'     => array(DOKU_CONF.'license.local.php'),
 115     ),
 116     'mediameta' => array(
 117         'default'   => array(DOKU_INC.'conf/mediameta.php'),
 118         'local'     => array(DOKU_CONF.'mediameta.local.php'),
 119     ),
 120     'mime'      => array(
 121         'default'   => array(DOKU_INC.'conf/mime.conf'),
 122         'local'     => array(DOKU_CONF.'mime.local.conf'),
 123     ),
 124     'scheme'    => array(
 125         'default'   => array(DOKU_INC.'conf/scheme.conf'),
 126         'local'     => array(DOKU_CONF.'scheme.local.conf'),
 127     ),
 128     'smileys'   => array(
 129         'default'   => array(DOKU_INC.'conf/smileys.conf'),
 130         'local'     => array(DOKU_CONF.'smileys.local.conf'),
 131     ),
 132     'wordblock' => array(
 133         'default'   => array(DOKU_INC.'conf/wordblock.conf'),
 134         'local'     => array(DOKU_CONF.'wordblock.local.conf'),
 135     ),
 136     'acl'       => array(
 137         'default'   => DOKU_CONF.'acl.auth.php',
 138     ),
 139     'plainauth.users' => array(
 140         'default'   => DOKU_CONF.'users.auth.php',
 141     ),
 142     'plugins' => array( // needed since Angua
 143         'default'   => array(DOKU_INC.'conf/plugins.php'),
 144         'local'     => array(DOKU_CONF.'plugins.local.php'),
 145         'protected' => array(
 146             DOKU_INC.'conf/plugins.required.php',
 147             DOKU_CONF.'plugins.protected.php',
 148         ),
 149     ),
 150     'userstyle' => array(
 151         'screen'    => array(DOKU_CONF . 'userstyle.css', DOKU_CONF . 'userstyle.less'),
 152         'print'     => array(DOKU_CONF . 'userprint.css', DOKU_CONF . 'userprint.less'),
 153         'feed'      => array(DOKU_CONF . 'userfeed.css', DOKU_CONF . 'userfeed.less'),
 154         'all'       => array(DOKU_CONF . 'userall.css', DOKU_CONF . 'userall.less')
 155     ),
 156     'userscript' => array(
 157         'default'   => array(DOKU_CONF . 'userscript.js')
 158     ),
 159 );