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  * The include paths change after this file is included from commandLine.inc,
  10  * meaning that require_once() fails to detect that it is including the same
  11  * file again. We use DIY C-style protection as a workaround.
  12  */
  13 if (!defined('SITE_CONFIGURATION')) {
  14 define('SITE_CONFIGURATION', 1);
  15
  16 /** @package MediaWiki */
  17 class SiteConfiguration {
  18         var $suffixes = array();
  19         var $wikis = array();
  20         var $settings = array();
  21         var $localVHosts = array();
  22
  23         /**
  24          * Get a setting
  25          */
  26         function get( $setting, $wiki, $suffix, $params = array() ) {
  27                 # Keys in order of increasing specificity
  28                 $keys = array( 'default', $suffix, $wiki );
  29
  30                 # Process ordinary settings
  31                 if ( isset( $this->settings[$setting] ) ) {
  32                         $retval = NULL;
  33                         foreach ( $keys as $key ) {
  34                                 if ( isset( $this->settings[$setting][$key] ) ) {
  35                                         $retval = $this->settings[$setting][$key];
  36                                 }
  37                         }
  38                 } else {
  39                         $retval = NULL;
  40                 }
  41
  42                 if ( is_array( $retval ) ) {
  43                         # Array overrides
  44                         $skey = "+$setting";
  45                         if ( isset( $this->settings[$skey] ) ) {
  46                                 foreach ( $keys as $key ) {
  47                                         if ( isset( $this->settings[$skey][$key] ) ) {
  48                                                 $retval = $this->settings[$skey][$key] + $retval;
  49                                         }
  50                                 }
  51                         }
  52
  53                         # Array appends
  54                         $skey = ".$setting";
  55                         if ( isset( $this->settings[$skey] ) ) {
  56                                 foreach ( $keys as $key ) {
  57                                         if ( isset( $this->settings[$skey][$key] ) ) {
  58                                                 $retval = array_merge( $retval, $this->settings[$skey][$key] );
  59                                         }
  60                                 }
  61                         }
  62                 }
  63
  64                 # Replace parameters
  65                 if ( !is_null( $retval ) && count( $params ) ) {
  66                         foreach ( $params as $key => $value ) {
  67                                 $retval = str_replace( '$' . $key, $value, $retval );
  68                         }
  69                 }
  70                 return $retval;
  71         }
  72
  73         /** */
  74         function getAll( $wiki, $suffix, $params ) {
  75                 $localSettings = array();
  76                 foreach ( $this->settings as $varname => $stuff ) {
  77                         $value = $this->get( $varname, $wiki, $suffix, $params );
  78                         if ( !is_null( $value ) ) {
  79                                 $localSettings[$varname] = $value;
  80                         }
  81                 }
  82                 return $localSettings;
  83         }
  84
  85         /** */
  86         function getBool( $setting, $wiki, $suffix ) {
  87                 return (bool)($this->get( $setting, $wiki, $suffix ));
  88         }
  89
  90         /** */
  91         function &getLocalDatabases() {
  92                 return $this->wikis;
  93         }
  94
  95         /** */
  96         function initialise() {
  97         }
  98
  99         /** */
 100         function extractVar( $setting, $wiki, $suffix, &$var, $params ) {
 101                 $value = $this->get( $setting, $wiki, $suffix, $params );
 102                 if ( !is_null( $value ) ) {
 103                         $var = $value;
 104                 }
 105         }
 106
 107         /** */
 108         function extractGlobal( $setting, $wiki, $suffix, $params ) {
 109                 $value = $this->get( $setting, $wiki, $suffix, $params );
 110                 if ( !is_null( $value ) ) {
 111                         $GLOBALS[$setting] = $value;
 112                 }
 113         }
 114
 115         /** */
 116         function extractAllGlobals( $wiki, $suffix, $params ) {
 117                 foreach ( $this->settings as $varName => $setting ) {
 118                         $this->extractGlobal( $varName, $wiki, $suffix, $params );
 119                 }
 120         }
 121
 122         /**
 123          * Work out the site and language name from a database name
 124          * @param $db
 125          */
 126         function siteFromDB( $db ) {
 127                 $site = NULL;
 128                 $lang = NULL;
 129                 foreach ( $this->suffixes as $suffix ) {
 130                         if ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
 131                                 $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
 132                                 $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
 133                                 break;
 134                         }
 135                 }
 136                 $lang = str_replace( '_', '-', $lang );
 137                 return array( $site, $lang );
 138         }
 139
 140         /** */
 141         function isLocalVHost( $vhost ) {
 142                 return in_array( $vhost, $this->localVHosts );
 143         }
 144 }
 145 }
 146
 147 ?>