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 $localDatabases = array();
  22         var $localVHosts = array();
  23
  24         /** */
  25         function get( $setting, $wiki, $suffix, $params = array() ) {
  26                 if ( array_key_exists( $setting, $this->settings ) ) {
  27                         if ( array_key_exists( $wiki, $this->settings[$setting] ) ) {
  28                                 $retval = $this->settings[$setting][$wiki];
  29                         } elseif ( array_key_exists( $suffix, $this->settings[$setting] ) ) {
  30                                 $retval = $this->settings[$setting][$suffix];
  31                         } elseif ( array_key_exists( 'default', $this->settings[$setting] ) ) {
  32                                 $retval = $this->settings[$setting]['default'];
  33                         } else {
  34                                 $retval = NULL;
  35                         }
  36                 } else {
  37                         $retval = NULL;
  38                 }
  39
  40                 if ( !is_null( $retval ) && count( $params ) ) {
  41                         foreach ( $params as $key => $value ) {
  42                                 $retval = str_replace( '$' . $key, $value, $retval );
  43                         }
  44                 }
  45                 return $retval;
  46         }
  47
  48         /** */
  49         function getBool( $setting, $wiki, $suffix ) {
  50                 return (bool)($this->get( $setting, $wiki, $suffix ));
  51         }
  52
  53         /** */
  54         function &getLocalDatabases() {
  55                 return $this->localDatabases;
  56         }
  57
  58         /** */
  59         function initialise() {
  60                 foreach ( $this->wikis as $db ) {
  61                         $this->localDatabases[$db] = $db;
  62                 }
  63         }
  64
  65         /** */
  66         function extractVar( $setting, $wiki, $suffix, &$var, $params ) {
  67                 $value = $this->get( $setting, $wiki, $suffix, $params );
  68                 if ( !is_null( $value ) ) {
  69                         $var = $value;
  70                 }
  71         }
  72
  73         /** */
  74         function extractGlobal( $setting, $wiki, $suffix, $params ) {
  75                 $value = $this->get( $setting, $wiki, $suffix, $params );
  76                 if ( !is_null( $value ) ) {
  77                         $GLOBALS[$setting] = $value;
  78                 }
  79         }
  80
  81         /** */
  82         function extractAllGlobals( $wiki, $suffix, $params ) {
  83                 foreach ( $this->settings as $varName => $setting ) {
  84                         $this->extractGlobal( $varName, $wiki, $suffix, $params );
  85                 }
  86         }
  87
  88         /**
  89          * Work out the site and language name from a database name
  90          * @param $db
  91          */
  92         function siteFromDB( $db ) {
  93                 $site = NULL;
  94                 $lang = NULL;
  95                 foreach ( $this->suffixes as $suffix ) {
  96                         if ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
  97                                 $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
  98                                 $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
  99                                 break;
 100                         }
 101                 }
 102                 $lang = str_replace( '_', '-', $lang );
 103                 return array( $site, $lang );
 104         }
 105
 106         /** */
 107         function isLocalVHost( $vhost ) {
 108                 return in_array( $vhost, $this->localVHosts );
 109         }
 110 }
 111 }
 112
 113 ?>