3 * Generator of database load balancing objects.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\Logger\LoggerFactory
;
27 * MediaWiki-specific class for generating database load balancers
30 abstract class MWLBFactory
{
32 * @param array $lbConf Config for LBFactory::__construct()
33 * @param Config $mainConfig Main config object from MediaWikiServices
36 public static function applyDefaultConfig( array $lbConf, Config
$mainConfig ) {
37 global $wgCommandLineMode;
40 'localDomain' => new DatabaseDomain(
41 $mainConfig->get( 'DBname' ),
43 $mainConfig->get( 'DBprefix' )
45 'profiler' => Profiler
::instance(),
46 'trxProfiler' => Profiler
::instance()->getTransactionProfiler(),
47 'replLogger' => LoggerFactory
::getInstance( 'DBReplication' ),
48 'queryLogger' => LoggerFactory
::getInstance( 'DBQuery' ),
49 'connLogger' => LoggerFactory
::getInstance( 'DBConnection' ),
50 'perfLogger' => LoggerFactory
::getInstance( 'DBPerformance' ),
51 'errorLogger' => [ MWExceptionHandler
::class, 'logException' ],
52 'cliMode' => $wgCommandLineMode,
53 'hostname' => wfHostname(),
54 // TODO: replace the global wfConfiguredReadOnlyReason() with a service.
55 'readOnlyReason' => wfConfiguredReadOnlyReason(),
58 if ( $lbConf['class'] === 'LBFactorySimple' ) {
59 if ( isset( $lbConf['servers'] ) ) {
60 // Server array is already explicitly configured; leave alone
61 } elseif ( is_array( $mainConfig->get( 'DBservers' ) ) ) {
62 foreach ( $mainConfig->get( 'DBservers' ) as $i => $server ) {
63 if ( $server['type'] === 'sqlite' ) {
64 $server +
= [ 'dbDirectory' => $mainConfig->get( 'SQLiteDataDir' ) ];
65 } elseif ( $server['type'] === 'postgres' ) {
66 $server +
= [ 'port' => $mainConfig->get( 'DBport' ) ];
68 $lbConf['servers'][$i] = $server +
[
69 'schema' => $mainConfig->get( 'DBmwschema' ),
70 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
71 'flags' => DBO_DEFAULT
,
72 'sqlMode' => $mainConfig->get( 'SQLMode' ),
73 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
78 $flags |
= $mainConfig->get( 'DebugDumpSql' ) ? DBO_DEBUG
: 0;
79 $flags |
= $mainConfig->get( 'DBssl' ) ? DBO_SSL
: 0;
80 $flags |
= $mainConfig->get( 'DBcompress' ) ? DBO_COMPRESS
: 0;
82 'host' => $mainConfig->get( 'DBserver' ),
83 'user' => $mainConfig->get( 'DBuser' ),
84 'password' => $mainConfig->get( 'DBpassword' ),
85 'dbname' => $mainConfig->get( 'DBname' ),
86 'schema' => $mainConfig->get( 'DBmwschema' ),
87 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
88 'type' => $mainConfig->get( 'DBtype' ),
91 'sqlMode' => $mainConfig->get( 'SQLMode' ),
92 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
94 if ( $server['type'] === 'sqlite' ) {
95 $server[ 'dbDirectory'] = $mainConfig->get( 'SQLiteDataDir' );
96 } elseif ( $server['type'] === 'postgres' ) {
97 $server['port'] = $mainConfig->get( 'DBport' );
99 $lbConf['servers'] = [ $server ];
101 if ( !isset( $lbConf['externalClusters'] ) ) {
102 $lbConf['externalClusters'] = $mainConfig->get( 'ExternalServers' );
104 } elseif ( $lbConf['class'] === 'LBFactoryMulti' ) {
105 if ( isset( $lbConf['serverTemplate'] ) ) {
106 $lbConf['serverTemplate']['schema'] = $mainConfig->get( 'DBmwschema' );
107 $lbConf['serverTemplate']['sqlMode'] = $mainConfig->get( 'SQLMode' );
108 $lbConf['serverTemplate']['utf8Mode'] = $mainConfig->get( 'DBmysql5' );
112 // Use APC/memcached style caching, but avoids loops with CACHE_DB (T141804)
113 $sCache = ObjectCache
::getLocalServerInstance();
114 if ( $sCache->getQoS( $sCache::ATTR_EMULATION
) > $sCache::QOS_EMULATION_SQL
) {
115 $lbConf['srvCache'] = $sCache;
117 $cCache = ObjectCache
::getLocalClusterInstance();
118 if ( $cCache->getQoS( $cCache::ATTR_EMULATION
) > $cCache::QOS_EMULATION_SQL
) {
119 $lbConf['memCache'] = $cCache;
121 $wCache = ObjectCache
::getMainWANInstance();
122 if ( $wCache->getQoS( $wCache::ATTR_EMULATION
) > $wCache::QOS_EMULATION_SQL
) {
123 $lbConf['wanCache'] = $wCache;
130 * Returns the LBFactory class to use and the load balancer configuration.
132 * @todo instead of this, use a ServiceContainer for managing the different implementations.
134 * @param array $config (e.g. $wgLBFactoryConf)
135 * @return string Class name
137 public static function getLBFactoryClass( array $config ) {
138 // For configuration backward compatibility after removing
139 // underscores from class names in MediaWiki 1.23.
141 'LBFactory_Simple' => 'LBFactorySimple',
142 'LBFactory_Single' => 'LBFactorySingle',
143 'LBFactory_Multi' => 'LBFactoryMulti'
146 $class = $config['class'];
148 if ( isset( $bcClasses[$class] ) ) {
149 $class = $bcClasses[$class];
151 '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details',