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