Made a SiteConfiguration object generally available. Added functions for performing...
[lhc/web/wiklou.git] / includes / SiteConfiguration.php
1 <?php
2 /**
3 * This is a class used to hold configuration settings, particularly for multi-wiki sites.
4 *
5 * @package MediaWiki
6 */
7
8 /**
9 *
10 * @package MediaWiki
11 */
12
13 /**
14 * The include paths change after this file is included from commandLine.inc,
15 * meaning that require_once() fails to detect that it is including the same
16 * file again. We use DIY C-style protection as a workaround.
17 */
18 if (!defined('SITE_CONFIGURATION')) {
19 define('SITE_CONFIGURATION', 1);
20
21 class SiteConfiguration {
22 var $suffixes = array();
23 var $wikis = array();
24 var $settings = array();
25 var $localDatabases = array();
26 var $localVHosts = array();
27
28 function get( $setting, $wiki, $suffix, $params = array() ) {
29 if ( array_key_exists( $wiki, $this->settings[$setting] ) ) {
30 $retval = $this->settings[$setting][$wiki];
31 } elseif ( array_key_exists( $suffix, $this->settings[$setting] ) ) {
32 $retval = $this->settings[$setting][$suffix];
33 } elseif ( array_key_exists( 'default', $this->settings[$setting] ) ) {
34 $retval = $this->settings[$setting]['default'];
35 } else {
36 $retval = NULL;
37 }
38 if ( !is_null( $retval ) && count( $params ) ) {
39 foreach ( $params as $key => $value ) {
40 $retval = str_replace( '$' . $key, $value, $retval );
41 }
42 }
43 return $retval;
44 }
45
46 function getBool( $setting, $wiki, $suffix ) {
47 return (bool)($this->get( $setting, $wiki, $suffix ));
48 }
49
50 function &getLocalDatabases() {
51 return $this->localDatabases;
52 }
53
54 function initialise() {
55 foreach ( $this->wikis as $db ) {
56 $this->localDatabases[$db] = $db;
57 }
58 }
59
60 function extractVar( $setting, $wiki, $suffix, &$var, $params ) {
61 $value = $this->get( $setting, $wiki, $suffix, $params );
62 if ( !is_null( $value ) ) {
63 $var = $value;
64 }
65 }
66
67 function extractGlobal( $setting, $wiki, $suffix, $params ) {
68 $value = $this->get( $setting, $wiki, $suffix, $params );
69 if ( !is_null( $value ) ) {
70 $GLOBALS[$setting] = $value;
71 }
72 }
73
74 function extractAllGlobals( $wiki, $suffix, $params ) {
75 foreach ( $this->settings as $varName => $setting ) {
76 $this->extractGlobal( $varName, $wiki, $suffix, $params );
77 }
78 }
79
80 /**
81 * Work out the site and language name from a database name
82 * @param $db
83 */
84 function siteFromDB( $db ) {
85 $site = NULL;
86 $lang = NULL;
87 foreach ( $this->suffixes as $suffix ) {
88 if ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
89 $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
90 $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
91 break;
92 }
93 }
94 return array( $site, $lang );
95 }
96
97 function isLocalVHost( $vhost ) {
98 return in_array( $vhost, $this->localVHosts );
99 }
100 }
101 }
102
103 ?>