includes/SiteConfiguration.php

   1 <?php
   2
   3 /**
   4  * The include paths change after this file is included from commandLine.inc,
   5  * meaning that require_once() fails to detect that it is including the same
   6  * file again. We use DIY C-style protection as a workaround.
   7  */
   8 if (!defined('SITE_CONFIGURATION')) {
   9 define('SITE_CONFIGURATION', 1);
  10
  11 /**
  12  * This is a class used to hold configuration settings, particularly for multi-wiki sites.
  13  *
  14  */
  15 class SiteConfiguration {
  16         var $suffixes = array();
  17         var $wikis = array();
  18         var $settings = array();
  19         var $localVHosts = array();
  20
  21         /** */
  22         function get( $setting, $wiki, $suffix, $params = array() ) {
  23                 if ( array_key_exists( $setting, $this->settings ) ) {
  24                         if ( array_key_exists( $wiki, $this->settings[$setting] ) ) {
  25                                 $retval = $this->settings[$setting][$wiki];
  26                         } elseif ( array_key_exists( $suffix, $this->settings[$setting] ) ) {
  27                                 $retval = $this->settings[$setting][$suffix];
  28                         } elseif ( array_key_exists( 'default', $this->settings[$setting] ) ) {
  29                                 $retval = $this->settings[$setting]['default'];
  30                         } else {
  31                                 $retval = NULL;
  32                         }
  33                 } else {
  34                         $retval = NULL;
  35                 }
  36
  37                 if ( !is_null( $retval ) && count( $params ) ) {
  38                         foreach ( $params as $key => $value ) {
  39                                 $retval = $this->doReplace( '$' . $key, $value, $retval );
  40                         }
  41                 }
  42                 return $retval;
  43         }
  44
  45         /** Type-safe string replace; won't do replacements on non-strings */
  46         function doReplace( $from, $to, $in ) {
  47                 if( is_string( $in ) ) {
  48                         return str_replace( $from, $to, $in );
  49                 } elseif( is_array( $in ) ) {
  50                         foreach( $in as $key => $val ) {
  51                                 $in[$key] = $this->doReplace( $from, $to, $in );
  52                         }
  53                         return $in;
  54                 } else {
  55                         return $in;
  56                 }
  57         }
  58
  59         /** */
  60         function getAll( $wiki, $suffix, $params ) {
  61                 $localSettings = array();
  62                 foreach ( $this->settings as $varname => $stuff ) {
  63                         $value = $this->get( $varname, $wiki, $suffix, $params );
  64                         if ( !is_null( $value ) ) {
  65                                 $localSettings[$varname] = $value;
  66                         }
  67                 }
  68                 return $localSettings;
  69         }
  70
  71         /** */
  72         function getBool( $setting, $wiki, $suffix ) {
  73                 return (bool)($this->get( $setting, $wiki, $suffix ));
  74         }
  75
  76         /** */
  77         function &getLocalDatabases() {
  78                 return $this->wikis;
  79         }
  80
  81         /** */
  82         function initialise() {
  83         }
  84
  85         /** */
  86         function extractVar( $setting, $wiki, $suffix, &$var, $params ) {
  87                 $value = $this->get( $setting, $wiki, $suffix, $params );
  88                 if ( !is_null( $value ) ) {
  89                         $var = $value;
  90                 }
  91         }
  92
  93         /** */
  94         function extractGlobal( $setting, $wiki, $suffix, $params ) {
  95                 $value = $this->get( $setting, $wiki, $suffix, $params );
  96                 if ( !is_null( $value ) ) {
  97                         $GLOBALS[$setting] = $value;
  98                 }
  99         }
 100
 101         /** */
 102         function extractAllGlobals( $wiki, $suffix, $params ) {
 103                 foreach ( $this->settings as $varName => $setting ) {
 104                         $this->extractGlobal( $varName, $wiki, $suffix, $params );
 105                 }
 106         }
 107
 108         /**
 109          * Work out the site and language name from a database name
 110          * @param $db
 111          */
 112         function siteFromDB( $db ) {
 113                 $site = NULL;
 114                 $lang = NULL;
 115                 foreach ( $this->suffixes as $suffix ) {
 116                         if ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
 117                                 $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
 118                                 $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
 119                                 break;
 120                         }
 121                 }
 122                 $lang = str_replace( '_', '-', $lang );
 123                 return array( $site, $lang );
 124         }
 125
 126         /** */
 127         function isLocalVHost( $vhost ) {
 128                 return in_array( $vhost, $this->localVHosts );
 129         }
 130 }
 131 }
 132
 133