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( $settingName, $wiki, $suffix, $params = array(), $wikiTags = array() ) {
  23                 if ( array_key_exists( $settingName, $this->settings ) ) {
  24                         $thisSetting =& $this->settings[$settingName];
  25                         do {
  26                                 if ( array_key_exists( $wiki, $thisSetting ) ) {
  27                                         $retval = $thisSetting[$wiki];
  28                                         break;
  29                                 }
  30                                 foreach ( $wikiTags as $tag ) {
  31                                         if ( array_key_exists( $tag, $thisSetting ) ) {
  32                                                 $retval = $thisSetting[$tag];
  33                                                 break 2;
  34                                         }
  35                                 }
  36                                 if ( array_key_exists( $suffix, $thisSetting ) ) {
  37                                         $retval = $thisSetting[$suffix];
  38                                         break;
  39                                 }
  40                                 if ( array_key_exists( 'default', $thisSetting ) ) {
  41                                         $retval = $thisSetting['default'];
  42                                         break;
  43                                 }
  44                                 $retval = null;
  45                         } while ( false );
  46                 } else {
  47                         $retval = NULL;
  48                 }
  49
  50                 if ( !is_null( $retval ) && count( $params ) ) {
  51                         foreach ( $params as $key => $value ) {
  52                                 $retval = $this->doReplace( '$' . $key, $value, $retval );
  53                         }
  54                 }
  55                 return $retval;
  56         }
  57
  58         /** Type-safe string replace; won't do replacements on non-strings */
  59         function doReplace( $from, $to, $in ) {
  60                 if( is_string( $in ) ) {
  61                         return str_replace( $from, $to, $in );
  62                 } elseif( is_array( $in ) ) {
  63                         foreach( $in as $key => $val ) {
  64                                 $in[$key] = $this->doReplace( $from, $to, $val );
  65                         }
  66                         return $in;
  67                 } else {
  68                         return $in;
  69                 }
  70         }
  71
  72         /** */
  73         function getAll( $wiki, $suffix, $params, $wikiTags = array() ) {
  74                 $localSettings = array();
  75                 foreach ( $this->settings as $varname => $stuff ) {
  76                         $value = $this->get( $varname, $wiki, $suffix, $params, $wikiTags );
  77                         if ( !is_null( $value ) ) {
  78                                 $localSettings[$varname] = $value;
  79                         }
  80                 }
  81                 return $localSettings;
  82         }
  83
  84         /** */
  85         function getBool( $setting, $wiki, $suffix, $wikiTags = array() ) {
  86                 return (bool)($this->get( $setting, $wiki, $suffix, array(), $wikiTags ) );
  87         }
  88
  89         /** */
  90         function &getLocalDatabases() {
  91                 return $this->wikis;
  92         }
  93
  94         /** */
  95         function initialise() {
  96         }
  97
  98         /** */
  99         function extractVar( $setting, $wiki, $suffix, &$var, $params, $wikiTags = array() ) {
 100                 $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags );
 101                 if ( !is_null( $value ) ) {
 102                         $var = $value;
 103                 }
 104         }
 105
 106         /** */
 107         function extractGlobal( $setting, $wiki, $suffix, $params, $wikiTags = array() ) {
 108                 $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags );
 109                 if ( !is_null( $value ) ) {
 110                         $GLOBALS[$setting] = $value;
 111                 }
 112         }
 113
 114         /** */
 115         function extractAllGlobals( $wiki, $suffix, $params, $wikiTags = array() ) {
 116                 foreach ( $this->settings as $varName => $setting ) {
 117                         $this->extractGlobal( $varName, $wiki, $suffix, $params, $wikiTags );
 118                 }
 119         }
 120
 121         /**
 122          * Work out the site and language name from a database name
 123          * @param $db
 124          */
 125         function siteFromDB( $db ) {
 126                 $site = NULL;
 127                 $lang = NULL;
 128                 foreach ( $this->suffixes as $suffix ) {
 129                         if ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
 130                                 $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
 131                                 $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
 132                                 break;
 133                         }
 134                 }
 135                 $lang = str_replace( '_', '-', $lang );
 136                 return array( $site, $lang );
 137         }
 138
 139         /** */
 140         function isLocalVHost( $vhost ) {
 141                 return in_array( $vhost, $this->localVHosts );
 142         }
 143 }
 144 }
 145
 146