includes/db/loadbalancer/LBFactorySimple.php

   1 <?php
   2 /**
   3  * Generator of database load balancing objects.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Database
  22  */
  23
  24 /**
  25  * A simple single-master LBFactory that gets its configuration from the b/c globals
  26  */
  27 class LBFactorySimple extends LBFactory {
  28         /** @var LoadBalancer */
  29         private $mainLB;
  30         /** @var LoadBalancer[] */
  31         private $extLBs = [];
  32
  33         /** @var string */
  34         private $loadMonitorClass;
  35
  36         public function __construct( array $conf ) {
  37                 parent::__construct( $conf );
  38
  39                 $this->loadMonitorClass = isset( $conf['loadMonitorClass'] )
  40                         ? $conf['loadMonitorClass']
  41                         : null;
  42         }
  43
  44         /**
  45          * @param bool|string $wiki
  46          * @return LoadBalancer
  47          */
  48         public function newMainLB( $wiki = false ) {
  49                 global $wgDBservers;
  50
  51                 if ( is_array( $wgDBservers ) ) {
  52                         $servers = $wgDBservers;
  53                         foreach ( $servers as $i => &$server ) {
  54                                 if ( $i == 0 ) {
  55                                         $server['master'] = true;
  56                                 } else {
  57                                         $server['slave'] = true;
  58                                 }
  59                         }
  60                 } else {
  61                         global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBtype, $wgDebugDumpSql;
  62                         global $wgDBssl, $wgDBcompress;
  63
  64                         $flags = DBO_DEFAULT;
  65                         if ( $wgDebugDumpSql ) {
  66                                 $flags |= DBO_DEBUG;
  67                         }
  68                         if ( $wgDBssl ) {
  69                                 $flags |= DBO_SSL;
  70                         }
  71                         if ( $wgDBcompress ) {
  72                                 $flags |= DBO_COMPRESS;
  73                         }
  74
  75                         $servers = [ [
  76                                 'host' => $wgDBserver,
  77                                 'user' => $wgDBuser,
  78                                 'password' => $wgDBpassword,
  79                                 'dbname' => $wgDBname,
  80                                 'type' => $wgDBtype,
  81                                 'load' => 1,
  82                                 'flags' => $flags,
  83                                 'master' => true
  84                         ] ];
  85                 }
  86
  87                 return $this->newLoadBalancer( $servers );
  88         }
  89
  90         /**
  91          * @param bool|string $wiki
  92          * @return LoadBalancer
  93          */
  94         public function getMainLB( $wiki = false ) {
  95                 if ( !isset( $this->mainLB ) ) {
  96                         $this->mainLB = $this->newMainLB( $wiki );
  97                         $this->mainLB->parentInfo( [ 'id' => 'main' ] );
  98                         $this->chronProt->initLB( $this->mainLB );
  99                 }
 100
 101                 return $this->mainLB;
 102         }
 103
 104         /**
 105          * @throws MWException
 106          * @param string $cluster
 107          * @param bool|string $wiki
 108          * @return LoadBalancer
 109          */
 110         protected function newExternalLB( $cluster, $wiki = false ) {
 111                 global $wgExternalServers;
 112                 if ( !isset( $wgExternalServers[$cluster] ) ) {
 113                         throw new MWException( __METHOD__ . ": Unknown cluster \"$cluster\"" );
 114                 }
 115
 116                 return $this->newLoadBalancer( $wgExternalServers[$cluster] );
 117         }
 118
 119         /**
 120          * @param string $cluster
 121          * @param bool|string $wiki
 122          * @return array
 123          */
 124         public function &getExternalLB( $cluster, $wiki = false ) {
 125                 if ( !isset( $this->extLBs[$cluster] ) ) {
 126                         $this->extLBs[$cluster] = $this->newExternalLB( $cluster, $wiki );
 127                         $this->extLBs[$cluster]->parentInfo( [ 'id' => "ext-$cluster" ] );
 128                         $this->chronProt->initLB( $this->extLBs[$cluster] );
 129                 }
 130
 131                 return $this->extLBs[$cluster];
 132         }
 133
 134         private function newLoadBalancer( array $servers ) {
 135                 return new LoadBalancer( [
 136                         'servers' => $servers,
 137                         'loadMonitor' => $this->loadMonitorClass,
 138                         'readOnlyReason' => $this->readOnlyReason,
 139                         'trxProfiler' => $this->trxProfiler,
 140                         'srvCache' => $this->srvCache,
 141                         'wanCache' => $this->wanCache
 142                 ] );
 143         }
 144
 145         /**
 146          * Execute a function for each tracked load balancer
 147          * The callback is called with the load balancer as the first parameter,
 148          * and $params passed as the subsequent parameters.
 149          *
 150          * @param callable $callback
 151          * @param array $params
 152          */
 153         public function forEachLB( $callback, array $params = [] ) {
 154                 if ( isset( $this->mainLB ) ) {
 155                         call_user_func_array( $callback, array_merge( [ $this->mainLB ], $params ) );
 156                 }
 157                 foreach ( $this->extLBs as $lb ) {
 158                         call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
 159                 }
 160         }
 161
 162         public function shutdown( $flags = 0 ) {
 163                 if ( !( $flags & self::SHUTDOWN_NO_CHRONPROT ) ) {
 164                         $this->shutdownChronologyProtector( $this->chronProt );
 165                 }
 166                 $this->commitMasterChanges( __METHOD__ ); // sanity
 167         }
 168 }