MediaWiki  master
SiteConfiguration.php
Go to the documentation of this file.
1 <?php
24 
125 
129  public $suffixes = [];
130 
134  public $wikis = [];
135 
139  public $settings = [];
140 
146  public $localVHosts = [];
147 
152  public $fullLoadCallback = null;
153 
155  public $fullLoadDone = false;
156 
171  public $siteParamsCallback = null;
172 
177  protected $cfgCache = [];
178 
188  public function get( $settingName, $wiki, $suffix = null, $params = [],
189  $wikiTags = []
190  ) {
191  $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
192  return $this->getSetting( $settingName, $wiki, $params );
193  }
194 
203  protected function getSetting( $settingName, $wiki, array $params ) {
204  $retval = null;
205  if ( array_key_exists( $settingName, $this->settings ) ) {
206  $thisSetting =& $this->settings[$settingName];
207  do {
208  // Do individual wiki settings
209  if ( array_key_exists( $wiki, $thisSetting ) ) {
210  $retval = $thisSetting[$wiki];
211  break;
212  } elseif ( array_key_exists( "+$wiki", $thisSetting ) && is_array( $thisSetting["+$wiki"] ) ) {
213  $retval = $thisSetting["+$wiki"];
214  }
215 
216  // Do tag settings
217  foreach ( $params['tags'] as $tag ) {
218  if ( array_key_exists( $tag, $thisSetting ) ) {
219  if ( is_array( $retval ) && is_array( $thisSetting[$tag] ) ) {
220  $retval = self::arrayMerge( $retval, $thisSetting[$tag] );
221  } else {
222  $retval = $thisSetting[$tag];
223  }
224  break 2;
225  } elseif ( array_key_exists( "+$tag", $thisSetting ) && is_array( $thisSetting["+$tag"] ) ) {
226  if ( $retval === null ) {
227  $retval = [];
228  }
229  $retval = self::arrayMerge( $retval, $thisSetting["+$tag"] );
230  }
231  }
232  // Do suffix settings
233  $suffix = $params['suffix'];
234  if ( !is_null( $suffix ) ) {
235  if ( array_key_exists( $suffix, $thisSetting ) ) {
236  if ( is_array( $retval ) && is_array( $thisSetting[$suffix] ) ) {
237  $retval = self::arrayMerge( $retval, $thisSetting[$suffix] );
238  } else {
239  $retval = $thisSetting[$suffix];
240  }
241  break;
242  } elseif ( array_key_exists( "+$suffix", $thisSetting )
243  && is_array( $thisSetting["+$suffix"] )
244  ) {
245  if ( $retval === null ) {
246  $retval = [];
247  }
248  $retval = self::arrayMerge( $retval, $thisSetting["+$suffix"] );
249  }
250  }
251 
252  // Fall back to default.
253  if ( array_key_exists( 'default', $thisSetting ) ) {
254  if ( is_array( $retval ) && is_array( $thisSetting['default'] ) ) {
255  $retval = self::arrayMerge( $retval, $thisSetting['default'] );
256  } else {
257  $retval = $thisSetting['default'];
258  }
259  break;
260  }
261  } while ( false );
262  }
263 
264  if ( !is_null( $retval ) && count( $params['params'] ) ) {
265  foreach ( $params['params'] as $key => $value ) {
266  $retval = $this->doReplace( '$' . $key, $value, $retval );
267  }
268  }
269  return $retval;
270  }
271 
281  function doReplace( $from, $to, $in ) {
282  if ( is_string( $in ) ) {
283  return str_replace( $from, $to, $in );
284  } elseif ( is_array( $in ) ) {
285  foreach ( $in as $key => $val ) {
286  $in[$key] = $this->doReplace( $from, $to, $val );
287  }
288  return $in;
289  } else {
290  return $in;
291  }
292  }
293 
302  public function getAll( $wiki, $suffix = null, $params = [], $wikiTags = [] ) {
303  $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
304  $localSettings = [];
305  foreach ( $this->settings as $varname => $stuff ) {
306  $append = false;
307  $var = $varname;
308  if ( substr( $varname, 0, 1 ) == '+' ) {
309  $append = true;
310  $var = substr( $varname, 1 );
311  }
312 
313  $value = $this->getSetting( $varname, $wiki, $params );
314  if ( $append && is_array( $value ) && is_array( $GLOBALS[$var] ) ) {
315  $value = self::arrayMerge( $value, $GLOBALS[$var] );
316  }
317  if ( !is_null( $value ) ) {
318  $localSettings[$var] = $value;
319  }
320  }
321  return $localSettings;
322  }
323 
332  public function getBool( $setting, $wiki, $suffix = null, $wikiTags = [] ) {
333  return (bool)$this->get( $setting, $wiki, $suffix, [], $wikiTags );
334  }
335 
341  function &getLocalDatabases() {
342  return $this->wikis;
343  }
344 
354  public function extractVar( $setting, $wiki, $suffix, &$var,
355  $params = [], $wikiTags = []
356  ) {
357  $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags );
358  if ( !is_null( $value ) ) {
359  $var = $value;
360  }
361  }
362 
371  public function extractGlobal( $setting, $wiki, $suffix = null,
372  $params = [], $wikiTags = []
373  ) {
374  $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
375  $this->extractGlobalSetting( $setting, $wiki, $params );
376  }
377 
383  public function extractGlobalSetting( $setting, $wiki, $params ) {
384  $value = $this->getSetting( $setting, $wiki, $params );
385  if ( !is_null( $value ) ) {
386  if ( substr( $setting, 0, 1 ) == '+' && is_array( $value ) ) {
387  $setting = substr( $setting, 1 );
388  if ( is_array( $GLOBALS[$setting] ) ) {
389  $GLOBALS[$setting] = self::arrayMerge( $GLOBALS[$setting], $value );
390  } else {
391  $GLOBALS[$setting] = $value;
392  }
393  } else {
394  $GLOBALS[$setting] = $value;
395  }
396  }
397  }
398 
406  public function extractAllGlobals( $wiki, $suffix = null, $params = [],
407  $wikiTags = []
408  ) {
409  $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
410  foreach ( $this->settings as $varName => $setting ) {
411  $this->extractGlobalSetting( $varName, $wiki, $params );
412  }
413  }
414 
423  protected function getWikiParams( $wiki ) {
424  static $default = [
425  'suffix' => null,
426  'lang' => null,
427  'tags' => [],
428  'params' => [],
429  ];
430 
431  if ( !is_callable( $this->siteParamsCallback ) ) {
432  return $default;
433  }
434 
435  $ret = ( $this->siteParamsCallback )( $this, $wiki );
436  # Validate the returned value
437  if ( !is_array( $ret ) ) {
438  return $default;
439  }
440 
441  foreach ( $default as $name => $def ) {
442  if ( !isset( $ret[$name] ) || ( is_array( $default[$name] ) && !is_array( $ret[$name] ) ) ) {
443  $ret[$name] = $default[$name];
444  }
445  }
446 
447  return $ret;
448  }
449 
462  protected function mergeParams( $wiki, $suffix, array $params, array $wikiTags ) {
463  $ret = $this->getWikiParams( $wiki );
464 
465  if ( is_null( $ret['suffix'] ) ) {
466  $ret['suffix'] = $suffix;
467  }
468 
469  $ret['tags'] = array_unique( array_merge( $ret['tags'], $wikiTags ) );
470 
471  $ret['params'] += $params;
472 
473  // Automatically fill that ones if needed
474  if ( !isset( $ret['params']['lang'] ) && !is_null( $ret['lang'] ) ) {
475  $ret['params']['lang'] = $ret['lang'];
476  }
477  if ( !isset( $ret['params']['site'] ) && !is_null( $ret['suffix'] ) ) {
478  $ret['params']['site'] = $ret['suffix'];
479  }
480 
481  return $ret;
482  }
483 
490  public function siteFromDB( $wiki ) {
491  // Allow override
492  $def = $this->getWikiParams( $wiki );
493  if ( !is_null( $def['suffix'] ) && !is_null( $def['lang'] ) ) {
494  return [ $def['suffix'], $def['lang'] ];
495  }
496 
497  $site = null;
498  $lang = null;
499  foreach ( $this->suffixes as $altSite => $suffix ) {
500  if ( $suffix === '' ) {
501  $site = '';
502  $lang = $wiki;
503  break;
504  } elseif ( substr( $wiki, -strlen( $suffix ) ) == $suffix ) {
505  $site = is_numeric( $altSite ) ? $suffix : $altSite;
506  $lang = substr( $wiki, 0, strlen( $wiki ) - strlen( $suffix ) );
507  break;
508  }
509  }
510  $lang = str_replace( '_', '-', $lang );
511 
512  return [ $site, $lang ];
513  }
514 
526  public function getConfig( $wiki, $settings ) {
527  global $IP;
528 
529  $multi = is_array( $settings );
530  $settings = (array)$settings;
531  if ( WikiMap::isCurrentWikiId( $wiki ) ) { // $wiki is this wiki
532  $res = [];
533  foreach ( $settings as $name ) {
534  if ( !preg_match( '/^wg[A-Z]/', $name ) ) {
535  throw new MWException( "Variable '$name' does start with 'wg'." );
536  } elseif ( !isset( $GLOBALS[$name] ) ) {
537  throw new MWException( "Variable '$name' is not set." );
538  }
539  $res[$name] = $GLOBALS[$name];
540  }
541  } else { // $wiki is a foreign wiki
542  if ( isset( $this->cfgCache[$wiki] ) ) {
543  $res = array_intersect_key( $this->cfgCache[$wiki], array_flip( $settings ) );
544  if ( count( $res ) == count( $settings ) ) {
545  return $multi ? $res : current( $res ); // cache hit
546  }
547  } elseif ( !in_array( $wiki, $this->wikis ) ) {
548  throw new MWException( "No such wiki '$wiki'." );
549  } else {
550  $this->cfgCache[$wiki] = [];
551  }
552  $result = Shell::makeScriptCommand(
553  "$IP/maintenance/getConfiguration.php",
554  [
555  '--wiki', $wiki,
556  '--settings', implode( ' ', $settings ),
557  '--format', 'PHP',
558  ]
559  )
560  // limit.sh breaks this call
561  ->limits( [ 'memory' => 0, 'filesize' => 0 ] )
562  ->execute();
563 
564  $data = trim( $result->getStdout() );
565  if ( $result->getExitCode() || $data === '' ) {
566  throw new MWException( "Failed to run getConfiguration.php: {$result->getStdout()}" );
567  }
568  $res = unserialize( $data );
569  if ( !is_array( $res ) ) {
570  throw new MWException( "Failed to unserialize configuration array." );
571  }
572  $this->cfgCache[$wiki] = $this->cfgCache[$wiki] + $res;
573  }
574 
575  return $multi ? $res : current( $res );
576  }
577 
589  static function arrayMerge( array $array1, ...$arrays ) {
590  $out = $array1;
591  foreach ( $arrays as $array ) {
592  foreach ( $array as $key => $value ) {
593  if ( isset( $out[$key] ) && is_array( $out[$key] ) && is_array( $value ) ) {
594  $out[$key] = self::arrayMerge( $out[$key], $value );
595  } elseif ( !isset( $out[$key] ) || !$out[$key] && !is_numeric( $key ) ) {
596  // Values that evaluate to true given precedence, for the
597  // primary purpose of merging permissions arrays.
598  $out[$key] = $value;
599  } elseif ( is_numeric( $key ) ) {
600  $out[] = $value;
601  }
602  }
603  }
604 
605  return $out;
606  }
607 
608  public function loadFullData() {
609  if ( $this->fullLoadCallback && !$this->fullLoadDone ) {
610  ( $this->fullLoadCallback )( $this );
611  $this->fullLoadDone = true;
612  }
613  }
614 }
getWikiParams( $wiki)
Return specific settings for $wiki See the documentation of self::$siteParamsCallback for more in-dep...
extractVar( $setting, $wiki, $suffix, &$var, $params=[], $wikiTags=[])
Retrieves the value of a given setting, and places it in a variable passed by reference.
$fullLoadDone
Whether or not all data has been loaded.
getConfig( $wiki, $settings)
Get the resolved (post-setup) configuration of a potentially foreign wiki.
$IP
Definition: WebStart.php:41
if(!isset( $args[0])) $lang
extractAllGlobals( $wiki, $suffix=null, $params=[], $wikiTags=[])
Retrieves the values of all settings, and places them in their corresponding global variables...
getBool( $setting, $wiki, $suffix=null, $wikiTags=[])
Retrieves a configuration setting for a given wiki, forced to a boolean.
siteFromDB( $wiki)
Work out the site and language name from a database name.
doReplace( $from, $to, $in)
Type-safe string replace; won&#39;t do replacements on non-strings private?
array $cfgCache
Configuration cache for getConfig()
static arrayMerge(array $array1,... $arrays)
Merge multiple arrays together.
unserialize( $serialized)
string array $siteParamsCallback
A callback function that returns an array with the following keys (all optional): ...
$localVHosts
Array of domains that are local and can be handled by the same server.
$GLOBALS['IP']
getAll( $wiki, $suffix=null, $params=[], $wikiTags=[])
Gets all settings for a wiki.
static isCurrentWikiId( $wikiId)
Definition: WikiMap.php:313
string array $fullLoadCallback
Optional callback to load full configuration data.
& getLocalDatabases()
Retrieves an array of local databases.
$settings
The whole array of settings.
$wikis
Array of wikis, should be the same as $wgLocalDatabases.
extractGlobal( $setting, $wiki, $suffix=null, $params=[], $wikiTags=[])
Retrieves the value of a given setting, and places it in its corresponding global variable...
This is a class for holding configuration settings, particularly for multi-wiki sites.
getSetting( $settingName, $wiki, array $params)
Really retrieves a configuration setting for a given wiki.
mergeParams( $wiki, $suffix, array $params, array $wikiTags)
Merge params between the ones passed to the function and the ones given by self::$siteParamsCallback ...
$suffixes
Array of suffixes, for self::siteFromDB()
extractGlobalSetting( $setting, $wiki, $params)