MediaWiki  master
MWLBFactory.php
Go to the documentation of this file.
1 <?php
28 
33 abstract class MWLBFactory {
34 
36  private static $loggedDeprecations = [];
37 
44  public static $applyDefaultConfigOptions = [
45  'DBcompress',
46  'DBDefaultGroup',
47  'DBmwschema',
48  'DBname',
49  'DBpassword',
50  'DBport',
51  'DBprefix',
52  'DBserver',
53  'DBservers',
54  'DBssl',
55  'DBtype',
56  'DBuser',
57  'DBWindowsAuthentication',
58  'DebugDumpSql',
59  'DebugLogFile',
60  'ExternalServers',
61  'SQLiteDataDir',
62  'SQLMode',
63  ];
64 
75  public static function applyDefaultConfig(
76  array $lbConf,
78  ConfiguredReadOnlyMode $readOnlyMode,
79  BagOStuff $srvCace,
80  BagOStuff $mainStash,
81  WANObjectCache $wanCache
82  ) {
83  $options->assertRequiredOptions( self::$applyDefaultConfigOptions );
84 
85  global $wgCommandLineMode;
86 
87  $typesWithSchema = self::getDbTypesWithSchemas();
88 
89  $lbConf += [
90  'localDomain' => new DatabaseDomain(
91  $options->get( 'DBname' ),
92  $options->get( 'DBmwschema' ),
93  $options->get( 'DBprefix' )
94  ),
95  'profiler' => function ( $section ) {
96  return Profiler::instance()->scopedProfileIn( $section );
97  },
98  'trxProfiler' => Profiler::instance()->getTransactionProfiler(),
99  'replLogger' => LoggerFactory::getInstance( 'DBReplication' ),
100  'queryLogger' => LoggerFactory::getInstance( 'DBQuery' ),
101  'connLogger' => LoggerFactory::getInstance( 'DBConnection' ),
102  'perfLogger' => LoggerFactory::getInstance( 'DBPerformance' ),
103  'errorLogger' => [ MWExceptionHandler::class, 'logException' ],
104  'deprecationLogger' => [ static::class, 'logDeprecation' ],
105  'cliMode' => $wgCommandLineMode,
106  'hostname' => wfHostname(),
107  'readOnlyReason' => $readOnlyMode->getReason(),
108  'defaultGroup' => $options->get( 'DBDefaultGroup' ),
109  ];
110 
111  $serversCheck = [];
112  // When making changes here, remember to also specify MediaWiki-specific options
113  // for Database classes in the relevant Installer subclass.
114  // Such as MysqlInstaller::openConnection and PostgresInstaller::openConnectionWithParams.
115  if ( $lbConf['class'] === Wikimedia\Rdbms\LBFactorySimple::class ) {
116  if ( isset( $lbConf['servers'] ) ) {
117  // Server array is already explicitly configured
118  } elseif ( is_array( $options->get( 'DBservers' ) ) ) {
119  $lbConf['servers'] = [];
120  foreach ( $options->get( 'DBservers' ) as $i => $server ) {
121  $lbConf['servers'][$i] = self::initServerInfo( $server, $options );
122  }
123  } else {
124  $server = self::initServerInfo(
125  [
126  'host' => $options->get( 'DBserver' ),
127  'user' => $options->get( 'DBuser' ),
128  'password' => $options->get( 'DBpassword' ),
129  'dbname' => $options->get( 'DBname' ),
130  'type' => $options->get( 'DBtype' ),
131  'load' => 1
132  ],
133  $options
134  );
135 
136  $server['flags'] |= $options->get( 'DBssl' ) ? DBO_SSL : 0;
137  $server['flags'] |= $options->get( 'DBcompress' ) ? DBO_COMPRESS : 0;
138 
139  $lbConf['servers'] = [ $server ];
140  }
141  if ( !isset( $lbConf['externalClusters'] ) ) {
142  $lbConf['externalClusters'] = $options->get( 'ExternalServers' );
143  }
144 
145  $serversCheck = $lbConf['servers'];
146  } elseif ( $lbConf['class'] === Wikimedia\Rdbms\LBFactoryMulti::class ) {
147  if ( isset( $lbConf['serverTemplate'] ) ) {
148  if ( in_array( $lbConf['serverTemplate']['type'], $typesWithSchema, true ) ) {
149  $lbConf['serverTemplate']['schema'] = $options->get( 'DBmwschema' );
150  }
151  $lbConf['serverTemplate']['sqlMode'] = $options->get( 'SQLMode' );
152  }
153  $serversCheck = [ $lbConf['serverTemplate'] ] ?? [];
154  }
155 
156  self::assertValidServerConfigs(
157  $serversCheck,
158  $options->get( 'DBname' ),
159  $options->get( 'DBprefix' )
160  );
161 
162  $lbConf = self::injectObjectCaches( $lbConf, $srvCace, $mainStash, $wanCache );
163 
164  return $lbConf;
165  }
166 
170  private static function getDbTypesWithSchemas() {
171  return [ 'postgres', 'mssql' ];
172  }
173 
179  private static function initServerInfo( array $server, ServiceOptions $options ) {
180  if ( $server['type'] === 'sqlite' ) {
181  $httpMethod = $_SERVER['REQUEST_METHOD'] ?? null;
182  // T93097: hint for how file-based databases (e.g. sqlite) should go about locking.
183  // See https://www.sqlite.org/lang_transaction.html
184  // See https://www.sqlite.org/lockingv3.html#shared_lock
185  $isHttpRead = in_array( $httpMethod, [ 'GET', 'HEAD', 'OPTIONS', 'TRACE' ] );
186  $server += [
187  'dbDirectory' => $options->get( 'SQLiteDataDir' ),
188  'trxMode' => $isHttpRead ? 'DEFERRED' : 'IMMEDIATE'
189  ];
190  } elseif ( $server['type'] === 'postgres' ) {
191  $server += [
192  'port' => $options->get( 'DBport' ),
193  // Work around the reserved word usage in MediaWiki schema
194  'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ]
195  ];
196  } elseif ( $server['type'] === 'oracle' ) {
197  $server += [
198  // Work around the reserved word usage in MediaWiki schema
199  'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ]
200  ];
201  } elseif ( $server['type'] === 'mssql' ) {
202  $server += [
203  'port' => $options->get( 'DBport' ),
204  'useWindowsAuth' => $options->get( 'DBWindowsAuthentication' )
205  ];
206  }
207 
208  if ( in_array( $server['type'], self::getDbTypesWithSchemas(), true ) ) {
209  $server += [ 'schema' => $options->get( 'DBmwschema' ) ];
210  }
211 
212  $flags = DBO_DEFAULT;
213  $flags |= $options->get( 'DebugDumpSql' ) ? DBO_DEBUG : 0;
214  $flags |= $options->get( 'DebugLogFile' ) ? DBO_DEBUG : 0;
215 
216  $server += [
217  'tablePrefix' => $options->get( 'DBprefix' ),
218  'flags' => $flags,
219  'sqlMode' => $options->get( 'SQLMode' ),
220  ];
221 
222  return $server;
223  }
224 
232  private static function injectObjectCaches(
233  array $lbConf, BagOStuff $sCache, BagOStuff $mStash, WANObjectCache $wCache
234  ) {
235  // Use APC/memcached style caching, but avoids loops with CACHE_DB (T141804)
236  if ( $sCache->getQoS( $sCache::ATTR_EMULATION ) > $sCache::QOS_EMULATION_SQL ) {
237  $lbConf['srvCache'] = $sCache;
238  }
239  if ( $mStash->getQoS( $mStash::ATTR_EMULATION ) > $mStash::QOS_EMULATION_SQL ) {
240  $lbConf['memStash'] = $mStash;
241  }
242  if ( $wCache->getQoS( $wCache::ATTR_EMULATION ) > $wCache::QOS_EMULATION_SQL ) {
243  $lbConf['wanCache'] = $wCache;
244  }
245 
246  return $lbConf;
247  }
248 
254  private static function assertValidServerConfigs( array $servers, $ldDB, $ldTP ) {
255  foreach ( $servers as $server ) {
256  $type = $server['type'] ?? null;
257  $srvDB = $server['dbname'] ?? null; // server DB
258  $srvTP = $server['tablePrefix'] ?? ''; // server table prefix
259 
260  if ( $type === 'mysql' ) {
261  // A DB name is not needed to connect to mysql; 'dbname' is useless.
262  // This field only defines the DB to use for unspecified DB domains.
263  if ( $srvDB !== null && $srvDB !== $ldDB ) {
264  self::reportMismatchedDBs( $srvDB, $ldDB );
265  }
266  } elseif ( $type === 'postgres' ) {
267  if ( $srvTP !== '' ) {
268  self::reportIfPrefixSet( $srvTP, $type );
269  }
270  }
271 
272  if ( $srvTP !== '' && $srvTP !== $ldTP ) {
273  self::reportMismatchedPrefixes( $srvTP, $ldTP );
274  }
275  }
276  }
277 
282  private static function reportIfPrefixSet( $prefix, $dbType ) {
284  "\$wgDBprefix is set to '$prefix' but the database type is '$dbType'. " .
285  "MediaWiki does not support using a table prefix with this RDBMS type."
286  );
288  exit;
289  }
290 
295  private static function reportMismatchedDBs( $srvDB, $ldDB ) {
297  "\$wgDBservers has dbname='$srvDB' but \$wgDBname='$ldDB'. " .
298  "Set \$wgDBname to the database used by this wiki project. " .
299  "There is rarely a need to set 'dbname' in \$wgDBservers. " .
300  "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " .
301  "use of Database::getDomainId(), and other features are not reliable when " .
302  "\$wgDBservers does not match the local wiki database/prefix."
303  );
305  exit;
306  }
307 
312  private static function reportMismatchedPrefixes( $srvTP, $ldTP ) {
314  "\$wgDBservers has tablePrefix='$srvTP' but \$wgDBprefix='$ldTP'. " .
315  "Set \$wgDBprefix to the table prefix used by this wiki project. " .
316  "There is rarely a need to set 'tablePrefix' in \$wgDBservers. " .
317  "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " .
318  "use of Database::getDomainId(), and other features are not reliable when " .
319  "\$wgDBservers does not match the local wiki database/prefix."
320  );
322  exit;
323  }
324 
334  public static function getLBFactoryClass( array $config ) {
335  // For configuration backward compatibility after removing
336  // underscores from class names in MediaWiki 1.23.
337  $bcClasses = [
338  'LBFactory_Simple' => 'LBFactorySimple',
339  'LBFactory_Single' => 'LBFactorySingle',
340  'LBFactory_Multi' => 'LBFactoryMulti'
341  ];
342 
343  $class = $config['class'];
344 
345  if ( isset( $bcClasses[$class] ) ) {
346  $class = $bcClasses[$class];
347  wfDeprecated(
348  '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details',
349  '1.23'
350  );
351  }
352 
353  // For configuration backward compatibility after moving classes to namespaces (1.29)
354  $compat = [
355  'LBFactorySingle' => Wikimedia\Rdbms\LBFactorySingle::class,
356  'LBFactorySimple' => Wikimedia\Rdbms\LBFactorySimple::class,
357  'LBFactoryMulti' => Wikimedia\Rdbms\LBFactoryMulti::class
358  ];
359 
360  if ( isset( $compat[$class] ) ) {
361  $class = $compat[$class];
362  }
363 
364  return $class;
365  }
366 
372  public static function setSchemaAliases( LBFactory $lbFactory, $dbType ) {
373  if ( $dbType === 'mysql' ) {
388  $lbFactory->setIndexAliases( [
389  'ar_usertext_timestamp' => 'usertext_timestamp',
390  'un_user_id' => 'user_id',
391  'un_user_ip' => 'user_ip',
392  ] );
393  }
394  }
395 
401  public static function logDeprecation( $msg ) {
402  global $wgDevelopmentWarnings;
403 
404  if ( isset( self::$loggedDeprecations[$msg] ) ) {
405  return;
406  }
407  self::$loggedDeprecations[$msg] = true;
408 
409  if ( $wgDevelopmentWarnings ) {
410  trigger_error( $msg, E_USER_DEPRECATED );
411  }
412  wfDebugLog( 'deprecated', $msg, 'private' );
413  }
414 }
An interface for generating database load balancers.
Definition: LBFactory.php:40
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2153
static instance()
Singleton.
Definition: Profiler.php:62
wfHostname()
Fetch server name for use in error reporting etc.
static getDbTypesWithSchemas()
static setSchemaAliases(LBFactory $lbFactory, $dbType)
A read-only mode service which does not depend on LoadBalancer.
A class for passing options to services.
static initServerInfo(array $server, ServiceOptions $options)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
static assertValidServerConfigs(array $servers, $ldDB, $ldTP)
const DBO_DEBUG
Definition: defines.php:9
static logDeprecation( $msg)
Log a database deprecation warning.
static reportMismatchedPrefixes( $srvTP, $ldTP)
static array $loggedDeprecations
Cache of already-logged deprecation messages.
Definition: MWLBFactory.php:36
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1978
static injectObjectCaches(array $lbConf, BagOStuff $sCache, BagOStuff $mStash, WANObjectCache $wCache)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
static applyDefaultConfig(array $lbConf, ServiceOptions $options, ConfiguredReadOnlyMode $readOnlyMode, BagOStuff $srvCace, BagOStuff $mainStash, WANObjectCache $wanCache)
Definition: MWLBFactory.php:75
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3045
getQoS( $flag)
Definition: BagOStuff.php:461
static output( $e, $mode, $eNew=null)
setIndexAliases(array $aliases)
Convert certain index names to alternative names before querying the DB.
Definition: LBFactory.php:650
getReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
assertRequiredOptions(array $expectedKeys)
Assert that the list of options provided in this instance exactly match $expectedKeys, without regard for order.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const DBO_DEFAULT
Definition: defines.php:13
Class to handle database/prefix specification for IDatabase domains.
static reportIfPrefixSet( $prefix, $dbType)
static array $applyDefaultConfigOptions
TODO Make this a const when HHVM support is dropped (T192166)
Definition: MWLBFactory.php:44
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static getLBFactoryClass(array $config)
Returns the LBFactory class to use and the load balancer configuration.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
global $wgCommandLineMode
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
MediaWiki-specific class for generating database load balancers.
Definition: MWLBFactory.php:33
const DBO_SSL
Definition: defines.php:17
static reportMismatchedDBs( $srvDB, $ldDB)
$wgDevelopmentWarnings
If set to true MediaWiki will throw notices for some possible error conditions and for deprecated fun...
const DBO_COMPRESS
Definition: defines.php:18