* @ingroup Database
*/
-use MediaWiki\MediaWikiServices;
-use MediaWiki\Services\DestructibleService;
use MediaWiki\Logger\LoggerFactory;
/**
* Legacy MediaWiki-specific class for generating database load balancers
* @ingroup Database
*/
-abstract class LBFactoryMW extends LBFactory implements DestructibleService {
- /** @noinspection PhpMissingParentConstructorInspection */
+abstract class LBFactoryMW {
/**
- * Construct a factory based on a configuration array (typically from $wgLBFactoryConf)
- * @param array $conf
- * @TODO: inject objects via dependency framework
+ * @param array $lbConf Config for LBFactory::__construct()
+ * @param Config $mainConfig Main config object from MediaWikiServices
+ * @return array
*/
- public function __construct( array $conf ) {
- $defaults = [
- 'domain' => wfWikiID(),
- 'hostname' => wfHostname(),
+ public static function applyDefaultConfig( array $lbConf, Config $mainConfig ) {
+ global $wgCommandLineMode;
+
+ $lbConf += [
+ 'localDomain' => new DatabaseDomain(
+ $mainConfig->get( 'DBname' ),
+ null,
+ $mainConfig->get( 'DBprefix' )
+ ),
+ 'profiler' => Profiler::instance(),
'trxProfiler' => Profiler::instance()->getTransactionProfiler(),
'replLogger' => LoggerFactory::getInstance( 'DBReplication' ),
- 'queryLogger' => LoggerFactory::getInstance( 'wfLogDBError' ),
- 'connLogger' => LoggerFactory::getInstance( 'wfLogDBError' ),
+ 'queryLogger' => LoggerFactory::getInstance( 'DBQuery' ),
+ 'connLogger' => LoggerFactory::getInstance( 'DBConnection' ),
'perfLogger' => LoggerFactory::getInstance( 'DBPerformance' ),
- 'errorLogger' => [ MWExceptionHandler::class, 'logException' ]
+ 'errorLogger' => [ MWExceptionHandler::class, 'logException' ],
+ 'cliMode' => $wgCommandLineMode,
+ 'hostname' => wfHostname(),
+ // TODO: replace the global wfConfiguredReadOnlyReason() with a service.
+ 'readOnlyReason' => wfConfiguredReadOnlyReason(),
];
+
+ if ( $lbConf['class'] === 'LBFactorySimple' ) {
+ if ( isset( $lbConf['servers'] ) ) {
+ // Server array is already explicitly configured; leave alone
+ } elseif ( is_array( $mainConfig->get( 'DBservers' ) ) ) {
+ foreach ( $mainConfig->get( 'DBservers' ) as $i => $server ) {
+ if ( $server['type'] === 'sqlite' ) {
+ $server += [ 'dbDirectory' => $mainConfig->get( 'SQLiteDataDir' ) ];
+ } elseif ( $server['type'] === 'postgres' ) {
+ $server += [ 'port' => $mainConfig->get( 'DBport' ) ];
+ }
+ $lbConf['servers'][$i] = $server + [
+ 'schema' => $mainConfig->get( 'DBmwschema' ),
+ 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
+ 'flags' => DBO_DEFAULT,
+ 'sqlMode' => $mainConfig->get( 'SQLMode' ),
+ 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
+ ];
+ }
+ } else {
+ $flags = DBO_DEFAULT;
+ $flags |= $mainConfig->get( 'DebugDumpSql' ) ? DBO_DEBUG : 0;
+ $flags |= $mainConfig->get( 'DBssl' ) ? DBO_SSL : 0;
+ $flags |= $mainConfig->get( 'DBcompress' ) ? DBO_COMPRESS : 0;
+ $server = [
+ 'host' => $mainConfig->get( 'DBserver' ),
+ 'user' => $mainConfig->get( 'DBuser' ),
+ 'password' => $mainConfig->get( 'DBpassword' ),
+ 'dbname' => $mainConfig->get( 'DBname' ),
+ 'schema' => $mainConfig->get( 'DBmwschema' ),
+ 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
+ 'type' => $mainConfig->get( 'DBtype' ),
+ 'load' => 1,
+ 'flags' => $flags,
+ 'sqlMode' => $mainConfig->get( 'SQLMode' ),
+ 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
+ ];
+ if ( $server['type'] === 'sqlite' ) {
+ $server[ 'dbDirectory'] = $mainConfig->get( 'SQLiteDataDir' );
+ } elseif ( $server['type'] === 'postgres' ) {
+ $server['port'] = $mainConfig->get( 'DBport' );
+ }
+ $lbConf['servers'] = [ $server ];
+ }
+ if ( !isset( $lbConf['externalClusters'] ) ) {
+ $lbConf['externalClusters'] = $mainConfig->get( 'ExternalServers' );
+ }
+ } elseif ( $lbConf['class'] === 'LBFactoryMulti' ) {
+ if ( isset( $lbConf['serverTemplate'] ) ) {
+ $lbConf['serverTemplate']['schema'] = $mainConfig->get( 'DBmwschema' );
+ $lbConf['serverTemplate']['sqlMode'] = $mainConfig->get( 'SQLMode' );
+ $lbConf['serverTemplate']['utf8Mode'] = $mainConfig->get( 'DBmysql5' );
+ }
+ }
+
// Use APC/memcached style caching, but avoids loops with CACHE_DB (T141804)
$sCache = ObjectCache::getLocalServerInstance();
if ( $sCache->getQoS( $sCache::ATTR_EMULATION ) > $sCache::QOS_EMULATION_SQL ) {
- $defaults['srvCache'] = $sCache;
+ $lbConf['srvCache'] = $sCache;
}
$cCache = ObjectCache::getLocalClusterInstance();
if ( $cCache->getQoS( $cCache::ATTR_EMULATION ) > $cCache::QOS_EMULATION_SQL ) {
- $defaults['memCache'] = $cCache;
+ $lbConf['memCache'] = $cCache;
}
$wCache = ObjectCache::getMainWANInstance();
if ( $wCache->getQoS( $wCache::ATTR_EMULATION ) > $wCache::QOS_EMULATION_SQL ) {
- $defaults['wanCache'] = $wCache;
+ $lbConf['wanCache'] = $wCache;
}
- parent::__construct( $conf + $defaults );
+ return $lbConf;
}
/**
return $class;
}
-
- /**
- * @return bool
- * @since 1.27
- * @deprecated Since 1.28; use laggedReplicaUsed()
- */
- public function laggedSlaveUsed() {
- return $this->laggedReplicaUsed();
- }
-
- protected function newChronologyProtector() {
- $request = RequestContext::getMain()->getRequest();
- $chronProt = new ChronologyProtector(
- ObjectCache::getMainStashInstance(),
- [
- 'ip' => $request->getIP(),
- 'agent' => $request->getHeader( 'User-Agent' ),
- ],
- $request->getFloat( 'cpPosTime', $request->getCookie( 'cpPosTime', '' ) )
- );
- if ( PHP_SAPI === 'cli' ) {
- $chronProt->setEnabled( false );
- } elseif ( $request->getHeader( 'ChronologyProtection' ) === 'false' ) {
- // Request opted out of using position wait logic. This is useful for requests
- // done by the job queue or background ETL that do not have a meaningful session.
- $chronProt->setWaitEnabled( false );
- }
-
- return $chronProt;
- }
-
- /**
- * Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed
- *
- * Note that unlike cookies, this works accross domains
- *
- * @param string $url
- * @param float $time UNIX timestamp just before shutdown() was called
- * @return string
- * @since 1.28
- */
- public function appendPreShutdownTimeAsQuery( $url, $time ) {
- $usedCluster = 0;
- $this->forEachLB( function ( LoadBalancer $lb ) use ( &$usedCluster ) {
- $usedCluster |= ( $lb->getServerCount() > 1 );
- } );
-
- if ( !$usedCluster ) {
- return $url; // no master/replica clusters touched
- }
-
- return wfAppendQuery( $url, [ 'cpPosTime' => $time ] );
- }
}