| Index: trunk/phase3/includes/SiteConfiguration.php |
| — | — | @@ -8,21 +8,50 @@ |
| 9 | 9 | |
| 10 | 10 | // Hide this pattern from Doxygen, which spazzes out at it |
| 11 | 11 | /// @cond |
| 12 | | -if (!defined('SITE_CONFIGURATION')) { |
| 13 | | -define('SITE_CONFIGURATION', 1); |
| | 12 | +if( !defined( 'SITE_CONFIGURATION' ) ){ |
| | 13 | +define( 'SITE_CONFIGURATION', 1 ); |
| 14 | 14 | /// @endcond |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | 17 | * This is a class used to hold configuration settings, particularly for multi-wiki sites. |
| 18 | | - * |
| 19 | 18 | */ |
| 20 | 19 | class SiteConfiguration { |
| 21 | | - var $suffixes = array(); |
| 22 | | - var $wikis = array(); |
| 23 | | - var $settings = array(); |
| 24 | | - var $localVHosts = array(); |
| 25 | 20 | |
| 26 | 21 | /** |
| | 22 | + * Array of suffixes, for self::siteFromDB() |
| | 23 | + */ |
| | 24 | + public $suffixes = array(); |
| | 25 | + |
| | 26 | + /** |
| | 27 | + * Array of wikis, should be the same as $wgLocalDatabases |
| | 28 | + */ |
| | 29 | + public $wikis = array(); |
| | 30 | + |
| | 31 | + /** |
| | 32 | + * The whole array of settings |
| | 33 | + */ |
| | 34 | + public $settings = array(); |
| | 35 | + |
| | 36 | + /** |
| | 37 | + * Array of domains that are local and can be handled by the same server |
| | 38 | + */ |
| | 39 | + public $localVHosts = array(); |
| | 40 | + |
| | 41 | + /** |
| | 42 | + * A callback function that returns an array with the following keys (all |
| | 43 | + * optional): |
| | 44 | + * - suffix: site's suffix |
| | 45 | + * - lang: site's lang |
| | 46 | + * - tags: array of wiki tags |
| | 47 | + * - params: array of parameters to be replaced |
| | 48 | + * The function will receive the SiteConfiguration instance in the first |
| | 49 | + * argument and the wiki in the second one. |
| | 50 | + * if suffix and lang are passed they will be used for the return value of |
| | 51 | + * self::siteFromDB() and self::$suffixes will be ignored |
| | 52 | + */ |
| | 53 | + public $siteParamsCallback = null; |
| | 54 | + |
| | 55 | + /** |
| 27 | 56 | * Retrieves a configuration setting for a given wiki. |
| 28 | 57 | * @param $settingName String ID of the setting name to retrieve |
| 29 | 58 | * @param $wiki String Wiki ID of the wiki in question. |
| — | — | @@ -31,72 +60,88 @@ |
| 32 | 61 | * @param $wikiTags Array The tags assigned to the wiki. |
| 33 | 62 | * @return Mixed the value of the setting requested. |
| 34 | 63 | */ |
| 35 | | - function get( $settingName, $wiki, $suffix, $params = array(), $wikiTags = array() ) { |
| 36 | | - if ( array_key_exists( $settingName, $this->settings ) ) { |
| | 64 | + public function get( $settingName, $wiki, $suffix = null, $params = array(), $wikiTags = array() ) { |
| | 65 | + $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags ); |
| | 66 | + return $this->getSetting( $settingName, $wiki, $params ); |
| | 67 | + } |
| | 68 | + |
| | 69 | + /** |
| | 70 | + * Really retrieves a configuration setting for a given wiki. |
| | 71 | + * |
| | 72 | + * @param $settingName String ID of the setting name to retrieve. |
| | 73 | + * @param $wiki String Wiki ID of the wiki in question. |
| | 74 | + * @param $params Array: array of parameters. |
| | 75 | + * @return Mixed the value of the setting requested. |
| | 76 | + */ |
| | 77 | + protected function getSetting( $settingName, $wiki, /*array*/ $params ){ |
| | 78 | + $retval = null; |
| | 79 | + if( array_key_exists( $settingName, $this->settings ) ) { |
| 37 | 80 | $thisSetting =& $this->settings[$settingName]; |
| 38 | 81 | do { |
| 39 | 82 | // Do individual wiki settings |
| 40 | | - if ( array_key_exists( $wiki, $thisSetting ) ) { |
| | 83 | + if( array_key_exists( $wiki, $thisSetting ) ) { |
| 41 | 84 | $retval = $thisSetting[$wiki]; |
| 42 | 85 | break; |
| 43 | | - } elseif ( array_key_exists( "+$wiki", $thisSetting ) && is_array($thisSetting["+$wiki"]) ) { |
| | 86 | + } elseif( array_key_exists( "+$wiki", $thisSetting ) && is_array( $thisSetting["+$wiki"] ) ) { |
| 44 | 87 | $retval = $thisSetting["+$wiki"]; |
| 45 | 88 | } |
| 46 | | - |
| | 89 | + |
| 47 | 90 | // Do tag settings |
| 48 | | - foreach ( $wikiTags as $tag ) { |
| 49 | | - if ( array_key_exists( $tag, $thisSetting ) ) { |
| 50 | | - if ( isset($retval) && is_array($retval) && is_array($thisSetting[$tag]) ) { |
| 51 | | - $retval = array_merge( $retval, $thisSetting[$tag] ); |
| | 91 | + foreach( $params['tags'] as $tag ) { |
| | 92 | + if( array_key_exists( $tag, $thisSetting ) ) { |
| | 93 | + if ( isset( $retval ) && is_array( $retval ) && is_array( $thisSetting[$tag] ) ) { |
| | 94 | + $retval = self::arrayMerge( $retval, $thisSetting[$tag] ); |
| 52 | 95 | } else { |
| 53 | 96 | $retval = $thisSetting[$tag]; |
| 54 | 97 | } |
| 55 | 98 | break 2; |
| 56 | | - } elseif ( array_key_exists( "+$tag", $thisSetting ) && is_array($thisSetting["+$tag"]) ) { |
| 57 | | - if (!isset($retval)) |
| | 99 | + } elseif( array_key_exists( "+$tag", $thisSetting ) && is_array($thisSetting["+$tag"]) ) { |
| | 100 | + if( !isset( $retval ) ) |
| 58 | 101 | $retval = array(); |
| 59 | | - $retval = array_merge( $retval, $thisSetting["+$tag"] ); |
| | 102 | + $retval = self::arrayMerge( $retval, $thisSetting["+$tag"] ); |
| 60 | 103 | } |
| 61 | 104 | } |
| 62 | | - |
| 63 | 105 | // Do suffix settings |
| 64 | | - if ( array_key_exists( $suffix, $thisSetting ) ) { |
| 65 | | - if ( isset($retval) && is_array($retval) && is_array($thisSetting[$suffix]) ) { |
| 66 | | - $retval = array_merge( $retval, $thisSetting[$suffix] ); |
| 67 | | - } else { |
| 68 | | - $retval = $thisSetting[$suffix]; |
| | 106 | + $suffix = $params['suffix']; |
| | 107 | + if( !is_null( $suffix ) ) { |
| | 108 | + if( array_key_exists( $suffix, $thisSetting ) ) { |
| | 109 | + if ( isset($retval) && is_array($retval) && is_array($thisSetting[$suffix]) ) { |
| | 110 | + $retval = self::arrayMerge( $retval, $thisSetting[$suffix] ); |
| | 111 | + } else { |
| | 112 | + $retval = $thisSetting[$suffix]; |
| | 113 | + } |
| | 114 | + break; |
| | 115 | + } elseif( array_key_exists( "+$suffix", $thisSetting ) && is_array($thisSetting["+$suffix"]) ) { |
| | 116 | + if (!isset($retval)) |
| | 117 | + $retval = array(); |
| | 118 | + $retval = self::arrayMerge( $retval, $thisSetting["+$suffix"] ); |
| 69 | 119 | } |
| 70 | | - break; |
| 71 | | - } elseif ( array_key_exists( "+$suffix", $thisSetting ) && is_array($thisSetting["+$suffix"]) ) { |
| 72 | | - if (!isset($retval)) |
| 73 | | - $retval = array(); |
| 74 | | - $retval = array_merge( $retval, $thisSetting["+$suffix"] ); |
| 75 | 120 | } |
| 76 | | - |
| | 121 | + |
| 77 | 122 | // Fall back to default. |
| 78 | | - if ( array_key_exists( 'default', $thisSetting ) ) { |
| 79 | | - if ( isset($retval) && is_array($retval) && is_array($thisSetting['default']) ) { |
| 80 | | - $retval = array_merge( $retval, $thisSetting['default'] ); |
| | 123 | + if( array_key_exists( 'default', $thisSetting ) ) { |
| | 124 | + if( is_array( $retval ) && is_array( $thisSetting['default'] ) ) { |
| | 125 | + $retval = self::arrayMerge( $retval, $thisSetting['default'] ); |
| 81 | 126 | } else { |
| 82 | 127 | $retval = $thisSetting['default']; |
| 83 | 128 | } |
| 84 | 129 | break; |
| 85 | 130 | } |
| 86 | | - $retval = null; |
| 87 | 131 | } while ( false ); |
| 88 | | - } else { |
| 89 | | - $retval = NULL; |
| 90 | 132 | } |
| 91 | 133 | |
| 92 | | - if ( !is_null( $retval ) && count( $params ) ) { |
| 93 | | - foreach ( $params as $key => $value ) { |
| | 134 | + if( !is_null( $retval ) && count( $params['params'] ) ) { |
| | 135 | + foreach ( $params['params'] as $key => $value ) { |
| 94 | 136 | $retval = $this->doReplace( '$' . $key, $value, $retval ); |
| 95 | 137 | } |
| 96 | 138 | } |
| 97 | 139 | return $retval; |
| 98 | 140 | } |
| 99 | 141 | |
| 100 | | - /** Type-safe string replace; won't do replacements on non-strings */ |
| | 142 | + /** |
| | 143 | + * Type-safe string replace; won't do replacements on non-strings |
| | 144 | + * private? |
| | 145 | + */ |
| 101 | 146 | function doReplace( $from, $to, $in ) { |
| 102 | 147 | if( is_string( $in ) ) { |
| 103 | 148 | return str_replace( $from, $to, $in ); |
| — | — | @@ -118,19 +163,20 @@ |
| 119 | 164 | * @param $wikiTags Array The tags assigned to the wiki. |
| 120 | 165 | * @return Array Array of settings requested. |
| 121 | 166 | */ |
| 122 | | - function getAll( $wiki, $suffix, $params, $wikiTags = array() ) { |
| | 167 | + public function getAll( $wiki, $suffix = null, $params = array(), $wikiTags = array() ) { |
| | 168 | + $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags ); |
| 123 | 169 | $localSettings = array(); |
| 124 | | - foreach ( $this->settings as $varname => $stuff ) { |
| | 170 | + foreach( $this->settings as $varname => $stuff ) { |
| 125 | 171 | $append = false; |
| 126 | 172 | $var = $varname; |
| 127 | 173 | if ( substr( $varname, 0, 1 ) == '+' ) { |
| 128 | 174 | $append = true; |
| 129 | 175 | $var = substr( $varname, 1 ); |
| 130 | 176 | } |
| 131 | | - |
| 132 | | - $value = $this->get( $varname, $wiki, $suffix, $params, $wikiTags ); |
| 133 | | - if ( $append && is_array($value) && is_array( $GLOBALS[$var] ) ) |
| 134 | | - $value = array_merge( $value, $GLOBALS[$var] ); |
| | 177 | + |
| | 178 | + $value = $this->getSetting( $varname, $wiki, $params ); |
| | 179 | + if ( $append && is_array( $value ) && is_array( $GLOBALS[$var] ) ) |
| | 180 | + $value = self::arrayMerge( $value, $GLOBALS[$var] ); |
| 135 | 181 | if ( !is_null( $value ) ) { |
| 136 | 182 | $localSettings[$var] = $value; |
| 137 | 183 | } |
| — | — | @@ -147,7 +193,7 @@ |
| 148 | 194 | * @param $wikiTags Array The tags assigned to the wiki. |
| 149 | 195 | * @return bool The value of the setting requested. |
| 150 | 196 | */ |
| 151 | | - function getBool( $setting, $wiki, $suffix, $wikiTags = array() ) { |
| | 197 | + public function getBool( $setting, $wiki, $suffix = null, $wikiTags = array() ) { |
| 152 | 198 | return (bool)($this->get( $setting, $wiki, $suffix, array(), $wikiTags ) ); |
| 153 | 199 | } |
| 154 | 200 | |
| — | — | @@ -169,7 +215,7 @@ |
| 170 | 216 | * @param $params Array List of parameters. $.'key' is replaced by $value in all returned data. |
| 171 | 217 | * @param $wikiTags Array The tags assigned to the wiki. |
| 172 | 218 | */ |
| 173 | | - function extractVar( $setting, $wiki, $suffix, &$var, $params, $wikiTags = array() ) { |
| | 219 | + public function extractVar( $setting, $wiki, $suffix, &$var, $params = array(), $wikiTags = array() ) { |
| 174 | 220 | $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags ); |
| 175 | 221 | if ( !is_null( $value ) ) { |
| 176 | 222 | $var = $value; |
| — | — | @@ -184,13 +230,18 @@ |
| 185 | 231 | * @param $params Array List of parameters. $.'key' is replaced by $value in all returned data. |
| 186 | 232 | * @param $wikiTags Array The tags assigned to the wiki. |
| 187 | 233 | */ |
| 188 | | - function extractGlobal( $setting, $wiki, $suffix, $params, $wikiTags = array() ) { |
| 189 | | - $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags ); |
| | 234 | + public function extractGlobal( $setting, $wiki, $suffix = null, $params = array(), $wikiTags = array() ) { |
| | 235 | + $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags ); |
| | 236 | + $this->extractGlobalSetting( $setting, $wiki, $params ); |
| | 237 | + } |
| | 238 | + |
| | 239 | + public function extractGlobalSetting( $setting, $wiki, $params ) { |
| | 240 | + $value = $this->getSetting( $setting, $wiki, $params ); |
| 190 | 241 | if ( !is_null( $value ) ) { |
| 191 | 242 | if (substr($setting,0,1) == '+' && is_array($value)) { |
| 192 | 243 | $setting = substr($setting,1); |
| 193 | 244 | if ( is_array($GLOBALS[$setting]) ) { |
| 194 | | - $GLOBALS[$setting] = array_merge( $GLOBALS[$setting], $value ); |
| | 245 | + $GLOBALS[$setting] = self::arrayMerge( $GLOBALS[$setting], $value ); |
| 195 | 246 | } else { |
| 196 | 247 | $GLOBALS[$setting] = $value; |
| 197 | 248 | } |
| — | — | @@ -207,23 +258,88 @@ |
| 208 | 259 | * @param $params Array List of parameters. $.'key' is replaced by $value in all returned data. |
| 209 | 260 | * @param $wikiTags Array The tags assigned to the wiki. |
| 210 | 261 | */ |
| 211 | | - function extractAllGlobals( $wiki, $suffix, $params, $wikiTags = array() ) { |
| | 262 | + public function extractAllGlobals( $wiki, $suffix = null, $params = array(), $wikiTags = array() ) { |
| | 263 | + $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags ); |
| 212 | 264 | foreach ( $this->settings as $varName => $setting ) { |
| 213 | | - $this->extractGlobal( $varName, $wiki, $suffix, $params, $wikiTags ); |
| | 265 | + $this->extractGlobalSetting( $varName, $wiki, $params ); |
| 214 | 266 | } |
| 215 | 267 | } |
| 216 | 268 | |
| 217 | 269 | /** |
| | 270 | + * Return specific settings for $wiki |
| | 271 | + * See the documentation of self::$siteParamsCallback for more in-depth |
| | 272 | + * documentation about this function |
| | 273 | + * |
| | 274 | + * @param $wiki String |
| | 275 | + * @return array |
| | 276 | + */ |
| | 277 | + protected function getWikiParams( $wiki ){ |
| | 278 | + static $default = array( |
| | 279 | + 'suffix' => null, |
| | 280 | + 'lang' => null, |
| | 281 | + 'tags' => array(), |
| | 282 | + 'params' => array(), |
| | 283 | + ); |
| | 284 | + |
| | 285 | + if( !is_callable( $this->siteParamsCallback ) ) |
| | 286 | + return $default; |
| | 287 | + |
| | 288 | + $ret = call_user_func_array( $this->siteParamsCallback, array( $this, $wiki ) ); |
| | 289 | + # Validate the returned value |
| | 290 | + if( !is_array( $ret ) ) |
| | 291 | + return $default; |
| | 292 | + |
| | 293 | + foreach( $default as $name => $def ){ |
| | 294 | + if( !isset( $ret[$name] ) || ( is_array( $default[$name] ) && !is_array( $ret[$name] ) ) ) |
| | 295 | + $ret[$name] = $default[$name]; |
| | 296 | + } |
| | 297 | + |
| | 298 | + return $ret; |
| | 299 | + } |
| | 300 | + |
| | 301 | + /** |
| | 302 | + * Merge params beetween the ones passed to the function and the ones given |
| | 303 | + * by self::$siteParamsCallback for backward compatibility |
| | 304 | + * Values returned by self::getWikiParams() have the priority. |
| | 305 | + * |
| | 306 | + * @param $wiki String Wiki ID of the wiki in question. |
| | 307 | + * @param $suffix String The suffix of the wiki in question. |
| | 308 | + * @param $params Array List of parameters. $.'key' is replaced by $value in |
| | 309 | + * all returned data. |
| | 310 | + * @param $wikiTags Array The tags assigned to the wiki. |
| | 311 | + * @return array |
| | 312 | + */ |
| | 313 | + protected function mergeParams( $wiki, $suffix, /*array*/ $params, /*array*/ $wikiTags ){ |
| | 314 | + $ret = $this->getWikiParams( $wiki ); |
| | 315 | + |
| | 316 | + if( is_null( $ret['suffix'] ) ) |
| | 317 | + $ret['suffix'] = $suffix; |
| | 318 | + |
| | 319 | + $ret['tags'] = array_unique( array_merge( $ret['tags'], $wikiTags ) ); |
| | 320 | + |
| | 321 | + $ret['params'] += $params; |
| | 322 | + |
| | 323 | + // Automatically fill that ones if needed |
| | 324 | + if( !isset( $ret['params']['lang'] ) && !is_null( $ret['lang'] ) ) |
| | 325 | + $ret['params']['lang'] = $ret['lang']; |
| | 326 | + if( !isset( $ret['params']['site'] ) && !is_null( $ret['suffix'] ) ) |
| | 327 | + $ret['params']['site'] = $ret['suffix']; |
| | 328 | + |
| | 329 | + return $ret; |
| | 330 | + } |
| | 331 | + |
| | 332 | + /** |
| 218 | 333 | * Work out the site and language name from a database name |
| 219 | 334 | * @param $db |
| 220 | 335 | */ |
| 221 | | - function siteFromDB( $db ) { |
| 222 | | - $site = NULL; |
| 223 | | - $lang = NULL; |
| 224 | | - |
| 225 | | - // Only run hooks if they *can* be run. |
| 226 | | - if (function_exists( 'wfRunHooks' ) && !wfRunHooks( 'SiteFromDB', array( $db, &$site, &$lang ) ) ) |
| 227 | | - return array( $site, $lang ); |
| | 336 | + public function siteFromDB( $db ) { |
| | 337 | + // Allow override |
| | 338 | + $def = $this->getWikiParams( $db ); |
| | 339 | + if( !is_null( $def['suffix'] ) && !is_null( $def['lang'] ) ) |
| | 340 | + return array( $def['suffix'], $def['lang'] ); |
| | 341 | + |
| | 342 | + $site = null; |
| | 343 | + $lang = null; |
| 228 | 344 | foreach ( $this->suffixes as $suffix ) { |
| 229 | 345 | if ( $suffix === '' ) { |
| 230 | 346 | $site = ''; |
| — | — | @@ -239,9 +355,37 @@ |
| 240 | 356 | return array( $site, $lang ); |
| 241 | 357 | } |
| 242 | 358 | |
| 243 | | - /** Returns true if the given vhost is handled locally. */ |
| 244 | | - function isLocalVHost( $vhost ) { |
| | 359 | + /** |
| | 360 | + * Returns true if the given vhost is handled locally. |
| | 361 | + * @param $vhost String |
| | 362 | + * @return bool |
| | 363 | + */ |
| | 364 | + public function isLocalVHost( $vhost ) { |
| 245 | 365 | return in_array( $vhost, $this->localVHosts ); |
| 246 | 366 | } |
| | 367 | + |
| | 368 | + /** |
| | 369 | + * Merge multiple arrays together. |
| | 370 | + * On encountering duplicate keys, merge the two, but ONLY if they're arrays. |
| | 371 | + * PHP's array_merge_recursive() merges ANY duplicate values into arrays, |
| | 372 | + * which is not fun |
| | 373 | + */ |
| | 374 | + static function arrayMerge( $array1/* ... */ ) { |
| | 375 | + $out = $array1; |
| | 376 | + for( $i=1; $i < func_num_args(); $i++ ) { |
| | 377 | + foreach( func_get_arg( $i ) as $key => $value ) { |
| | 378 | + if ( isset($out[$key]) && is_array($out[$key]) && is_array($value) ) { |
| | 379 | + $out[$key] = self::arrayMerge( $out[$key], $value ); |
| | 380 | + } elseif ( !isset($out[$key]) || !$out[$key] && !is_numeric($key) ) { |
| | 381 | + // Values that evaluate to true given precedence, for the primary purpose of merging permissions arrays. |
| | 382 | + $out[$key] = $value; |
| | 383 | + } elseif ( is_numeric( $key ) ) { |
| | 384 | + $out[] = $value; |
| | 385 | + } |
| | 386 | + } |
| | 387 | + } |
| | 388 | + |
| | 389 | + return $out; |
| | 390 | + } |
| 247 | 391 | } |
| 248 | 392 | } |