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