assertRequiredOptions( self::APPLY_DEFAULT_CONFIG_OPTIONS ); global $wgCommandLineMode; $typesWithSchema = self::getDbTypesWithSchemas(); $lbConf += [ 'localDomain' => new DatabaseDomain( $options->get( 'DBname' ), $options->get( 'DBmwschema' ), $options->get( 'DBprefix' ) ), 'profiler' => function ( $section ) { return Profiler::instance()->scopedProfileIn( $section ); }, 'trxProfiler' => Profiler::instance()->getTransactionProfiler(), 'replLogger' => LoggerFactory::getInstance( 'DBReplication' ), 'queryLogger' => LoggerFactory::getInstance( 'DBQuery' ), 'connLogger' => LoggerFactory::getInstance( 'DBConnection' ), 'perfLogger' => LoggerFactory::getInstance( 'DBPerformance' ), 'errorLogger' => [ MWExceptionHandler::class, 'logException' ], 'deprecationLogger' => [ static::class, 'logDeprecation' ], 'cliMode' => $wgCommandLineMode, 'hostname' => wfHostname(), 'readOnlyReason' => $readOnlyMode->getReason(), 'defaultGroup' => $options->get( 'DBDefaultGroup' ), ]; $serversCheck = []; // When making changes here, remember to also specify MediaWiki-specific options // for Database classes in the relevant Installer subclass. // Such as MysqlInstaller::openConnection and PostgresInstaller::openConnectionWithParams. if ( $lbConf['class'] === Wikimedia\Rdbms\LBFactorySimple::class ) { if ( isset( $lbConf['servers'] ) ) { // Server array is already explicitly configured } elseif ( is_array( $options->get( 'DBservers' ) ) ) { $lbConf['servers'] = []; foreach ( $options->get( 'DBservers' ) as $i => $server ) { $lbConf['servers'][$i] = self::initServerInfo( $server, $options ); } } else { $server = self::initServerInfo( [ 'host' => $options->get( 'DBserver' ), 'user' => $options->get( 'DBuser' ), 'password' => $options->get( 'DBpassword' ), 'dbname' => $options->get( 'DBname' ), 'type' => $options->get( 'DBtype' ), 'load' => 1 ], $options ); $server['flags'] |= $options->get( 'DBssl' ) ? DBO_SSL : 0; $server['flags'] |= $options->get( 'DBcompress' ) ? DBO_COMPRESS : 0; $lbConf['servers'] = [ $server ]; } if ( !isset( $lbConf['externalClusters'] ) ) { $lbConf['externalClusters'] = $options->get( 'ExternalServers' ); } $serversCheck = $lbConf['servers']; } elseif ( $lbConf['class'] === Wikimedia\Rdbms\LBFactoryMulti::class ) { if ( isset( $lbConf['serverTemplate'] ) ) { if ( in_array( $lbConf['serverTemplate']['type'], $typesWithSchema, true ) ) { $lbConf['serverTemplate']['schema'] = $options->get( 'DBmwschema' ); } $lbConf['serverTemplate']['sqlMode'] = $options->get( 'SQLMode' ); $serversCheck = [ $lbConf['serverTemplate'] ]; } } self::assertValidServerConfigs( $serversCheck, $options->get( 'DBname' ), $options->get( 'DBprefix' ) ); $lbConf['srvCache'] = $srvCache; $lbConf['memStash'] = $mainStash; $lbConf['wanCache'] = $wanCache; return $lbConf; } /** * @return array */ private static function getDbTypesWithSchemas() { return [ 'postgres' ]; } /** * @param array $server * @param ServiceOptions $options * @return array */ private static function initServerInfo( array $server, ServiceOptions $options ) { if ( $server['type'] === 'sqlite' ) { $httpMethod = $_SERVER['REQUEST_METHOD'] ?? null; // T93097: hint for how file-based databases (e.g. sqlite) should go about locking. // See https://www.sqlite.org/lang_transaction.html // See https://www.sqlite.org/lockingv3.html#shared_lock $isHttpRead = in_array( $httpMethod, [ 'GET', 'HEAD', 'OPTIONS', 'TRACE' ] ); $server += [ 'dbDirectory' => $options->get( 'SQLiteDataDir' ), 'trxMode' => $isHttpRead ? 'DEFERRED' : 'IMMEDIATE' ]; } elseif ( $server['type'] === 'postgres' ) { $server += [ 'port' => $options->get( 'DBport' ), // Work around the reserved word usage in MediaWiki schema 'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ] ]; } if ( in_array( $server['type'], self::getDbTypesWithSchemas(), true ) ) { $server += [ 'schema' => $options->get( 'DBmwschema' ) ]; } $flags = $server['flags'] ?? DBO_DEFAULT; if ( $options->get( 'DebugDumpSql' ) || $options->get( 'DebugLogFile' ) || $options->get( 'DebugToolbar' ) ) { $flags |= DBO_DEBUG; } $server['flags'] = $flags; $server += [ 'tablePrefix' => $options->get( 'DBprefix' ), 'sqlMode' => $options->get( 'SQLMode' ), ]; return $server; } /** * @param array $servers * @param string $ldDB Local domain database name * @param string $ldTP Local domain prefix */ private static function assertValidServerConfigs( array $servers, $ldDB, $ldTP ) { foreach ( $servers as $server ) { $type = $server['type'] ?? null; $srvDB = $server['dbname'] ?? null; // server DB $srvTP = $server['tablePrefix'] ?? ''; // server table prefix if ( $type === 'mysql' ) { // A DB name is not needed to connect to mysql; 'dbname' is useless. // This field only defines the DB to use for unspecified DB domains. if ( $srvDB !== null && $srvDB !== $ldDB ) { self::reportMismatchedDBs( $srvDB, $ldDB ); } } elseif ( $type === 'postgres' ) { if ( $srvTP !== '' ) { self::reportIfPrefixSet( $srvTP, $type ); } } if ( $srvTP !== '' && $srvTP !== $ldTP ) { self::reportMismatchedPrefixes( $srvTP, $ldTP ); } } } /** * @param string $prefix Table prefix * @param string $dbType Database type */ private static function reportIfPrefixSet( $prefix, $dbType ) { $e = new UnexpectedValueException( "\$wgDBprefix is set to '$prefix' but the database type is '$dbType'. " . "MediaWiki does not support using a table prefix with this RDBMS type." ); MWExceptionRenderer::output( $e, MWExceptionRenderer::AS_PRETTY ); exit; } /** * @param string $srvDB Server config database * @param string $ldDB Local DB domain database */ private static function reportMismatchedDBs( $srvDB, $ldDB ) { $e = new UnexpectedValueException( "\$wgDBservers has dbname='$srvDB' but \$wgDBname='$ldDB'. " . "Set \$wgDBname to the database used by this wiki project. " . "There is rarely a need to set 'dbname' in \$wgDBservers. " . "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " . "use of Database::getDomainId(), and other features are not reliable when " . "\$wgDBservers does not match the local wiki database/prefix." ); MWExceptionRenderer::output( $e, MWExceptionRenderer::AS_PRETTY ); exit; } /** * @param string $srvTP Server config table prefix * @param string $ldTP Local DB domain database */ private static function reportMismatchedPrefixes( $srvTP, $ldTP ) { $e = new UnexpectedValueException( "\$wgDBservers has tablePrefix='$srvTP' but \$wgDBprefix='$ldTP'. " . "Set \$wgDBprefix to the table prefix used by this wiki project. " . "There is rarely a need to set 'tablePrefix' in \$wgDBservers. " . "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " . "use of Database::getDomainId(), and other features are not reliable when " . "\$wgDBservers does not match the local wiki database/prefix." ); MWExceptionRenderer::output( $e, MWExceptionRenderer::AS_PRETTY ); exit; } /** * Decide which LBFactory class to use. * * @internal For use by ServiceWiring * @param array $config (e.g. $wgLBFactoryConf) * @return string Class name */ public static function getLBFactoryClass( array $config ) { $compat = [ // For LocalSettings.php compat after removing underscores (since 1.23). 'LBFactory_Single' => Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactory_Simple' => Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactory_Multi' => Wikimedia\Rdbms\LBFactoryMulti::class, // For LocalSettings.php compat after moving classes to namespaces (since 1.29). 'LBFactorySingle' => Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactorySimple' => Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactoryMulti' => Wikimedia\Rdbms\LBFactoryMulti::class ]; $class = $config['class']; return $compat[$class] ?? $class; } /** * @param ILBFactory $lbFactory */ public static function setDomainAliases( ILBFactory $lbFactory ) { $domain = DatabaseDomain::newFromId( $lbFactory->getLocalDomainID() ); // For compatibility with hyphenated $wgDBname values on older wikis, handle callers // that assume corresponding database domain IDs and wiki IDs have identical values $rawLocalDomain = strlen( $domain->getTablePrefix() ) ? "{$domain->getDatabase()}-{$domain->getTablePrefix()}" : (string)$domain->getDatabase(); $lbFactory->setDomainAliases( [ $rawLocalDomain => $domain ] ); } /** * Log a database deprecation warning * @param string $msg Deprecation message * @internal For use with service wiring */ public static function logDeprecation( $msg ) { if ( isset( self::$loggedDeprecations[$msg] ) ) { return; } self::$loggedDeprecations[$msg] = true; MWDebug::sendRawDeprecated( $msg, true, wfGetCaller() ); } }