xref: /dokuwiki/inc/farm.php (revision d22be2c028a00f1d2117588941c27cfe49dd9ee2)
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 conf_path() based on conf_path() from Drupal.org's /includes/bootstrap.inc
21 *   (see http://cvs.drupal.org/viewvc/drupal/drupal/includes/bootstrap.inc?view=markup)
22 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
23*/
24
25// DOKU_FARMDIR needs to be set in preload.php, here the fallback is the same as DOKU_INC would be (if it was set already)
26if(!defined('DOKU_FARMDIR')) define('DOKU_FARMDIR', fullpath(dirname(__FILE__).'/../').'/');
27if(!defined('DOKU_CONF')) define('DOKU_CONF', conf_path(DOKU_FARMDIR));
28if(!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 */
42function conf_path($farm) {
43
44    // htaccess based
45    if(isset($_REQUEST['animal'])) {
46        if(!is_dir($farm.'/'.$_REQUEST['animal']))
47            nice_die("Sorry! This Wiki doesn't exist!");
48        if(!defined('DOKU_FARM')) define('DOKU_FARM', 'htaccess');
49        return $farm.'/'.$_REQUEST['animal'].'/conf/';
50    }
51
52    // virtual host based
53    $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
54    $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
55    for ($i = count($uri) - 1; $i > 0; $i--) {
56        for ($j = count($server); $j > 0; $j--) {
57            $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
58            if(is_dir("$farm/$dir/conf/")) {
59                if(!defined('DOKU_FARM')) define('DOKU_FARM', 'virtual');
60                return "$farm/$dir/conf/";
61            }
62        }
63    }
64
65    // default conf directory in farm
66    if(is_dir("$farm/default/conf/")) {
67        if(!defined('DOKU_FARM')) define('DOKU_FARM', 'default');
68        return "$farm/default/conf/";
69    }
70    // farmer
71    return DOKU_INC.'conf/';
72}
73
74/* Use default config files and local animal config files */
75$config_cascade = array(
76    'main' => array(
77        'default'   => array(DOKU_INC.'conf/dokuwiki.php'),
78        'local'     => array(DOKU_CONF.'local.php'),
79        'protected' => array(DOKU_CONF.'local.protected.php'),
80    ),
81    'acronyms'  => array(
82        'default'   => array(DOKU_INC.'conf/acronyms.conf'),
83        'local'     => array(DOKU_CONF.'acronyms.local.conf'),
84    ),
85    'entities'  => array(
86        'default'   => array(DOKU_INC.'conf/entities.conf'),
87        'local'     => array(DOKU_CONF.'entities.local.conf'),
88    ),
89    'interwiki' => array(
90        'default'   => array(DOKU_INC.'conf/interwiki.conf'),
91        'local'     => array(DOKU_CONF.'interwiki.local.conf'),
92    ),
93    'license' => array(
94        'default'   => array(DOKU_INC.'conf/license.php'),
95        'local'     => array(DOKU_CONF.'license.local.php'),
96    ),
97    'mediameta' => array(
98        'default'   => array(DOKU_INC.'conf/mediameta.php'),
99        'local'     => array(DOKU_CONF.'mediameta.local.php'),
100    ),
101    'mime'      => array(
102        'default'   => array(DOKU_INC.'conf/mime.conf'),
103        'local'     => array(DOKU_CONF.'mime.local.conf'),
104    ),
105    'scheme'    => array(
106        'default'   => array(DOKU_INC.'conf/scheme.conf'),
107        'local'     => array(DOKU_CONF.'scheme.local.conf'),
108    ),
109    'smileys'   => array(
110        'default'   => array(DOKU_INC.'conf/smileys.conf'),
111        'local'     => array(DOKU_CONF.'smileys.local.conf'),
112    ),
113    'wordblock' => array(
114        'default'   => array(DOKU_INC.'conf/wordblock.conf'),
115        'local'     => array(DOKU_CONF.'wordblock.local.conf'),
116    ),
117    'acl'       => array(
118        'default'   => DOKU_CONF.'acl.auth.php',
119    ),
120    'plainauth.users' => array(
121        'default'   => DOKU_CONF.'users.auth.php',
122    ),
123    'plugins' => array( // needed since Angua
124        'default'   => array(DOKU_CONF.'plugins.php'),
125        'local'     => array(DOKU_CONF.'plugins.local.php'),
126        'protected' => array(
127            DOKU_INC.'conf/plugins.required.php',
128            DOKU_CONF.'plugins.protected.php',
129        ),
130    ),
131    'userstyle' => array(
132        'default' => DOKU_CONF.'userstyle.css', // 'default' was renamed to 'screen' on 2011-02-26, so will be deprecated in the next version
133        'screen'  => DOKU_CONF.'userstyle.css',
134        'rtl'     => DOKU_CONF.'userrtl.css', // deprecated since version after 2012-04-09
135        'print'   => DOKU_CONF.'userprint.css',
136        'feed'    => DOKU_CONF.'userfeed.css',
137        'all'     => DOKU_CONF.'userall.css',
138    ),
139    'userscript' => array(
140        'default' => DOKU_CONF.'userscript.js'
141    ),
142);
143