LBFactorySimple

Complexity

Total Complexity

20

Size/Duplication

Total Lines	127
Duplicated Lines	6.3 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	19	6
A	newMainLB()	0	3	1
A	getMainLB()	0	8	2
A	newExternalLB()	0	7	2
A	getExternalLB()	8	8	2
A	getAllMainLBs()	0	3	1
A	getAllExternalLBs()	0	8	2
A	newLoadBalancer()	0	12	1
A	forEachLB()	0	8	3

<?php
/**
 * Generator of database load balancing objects.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Database
 */

/**
 * A simple single-master LBFactory that gets its configuration from the b/c globals
 */
class LBFactorySimple extends LBFactory {
	/** @var LoadBalancer */
	private $mainLB;
	/** @var LoadBalancer[] */
	private $extLBs = [];

	/** @var array[] Map of (server index => server config) */
	private $servers = [];
	/** @var array[] Map of (cluster => (server index => server config)) */
	private $externalClusters = [];

	/** @var string */
	private $loadMonitorClass;

	/**
	 * @see LBFactory::__construct()
	 * @param array $conf Parameters of LBFactory::__construct() as well as:
	 *   - servers : list of server configuration maps to Database::factory().
	 *      Additionally, the server maps should have a 'load' key, which is used to decide
	 *      how often clients connect to one server verses the others. A 'max lag' key should
	 *      also be set on server maps, indicating how stale the data can be before the load
	 *      balancer tries to avoid using it. The map can have 'is static' set to disable blocking
	 *      replication sync checks (intended for archive servers with unchanging data).
	 *   - externalClusters : map of cluster names to server arrays. The servers arrays have the
	 *      same format as "servers" above.
	 */
	public function __construct( array $conf ) {
		parent::__construct( $conf );

		$this->servers = isset( $conf['servers'] ) ? $conf['servers'] : [];
		foreach ( $this->servers as $i => $server ) {
			if ( $i == 0 ) {
				$this->servers[$i]['master'] = true;
			} else {
				$this->servers[$i]['replica'] = true;
			}
		}

		$this->externalClusters = isset( $conf['externalClusters'] )
			? $conf['externalClusters']
			: [];
		$this->loadMonitorClass = isset( $conf['loadMonitorClass'] )
			? $conf['loadMonitorClass']
			: 'LoadMonitor';
	}

	/**
	 * @param bool|string $domain
	 * @return LoadBalancer
	 */
	public function newMainLB( $domain = false ) {
		return $this->newLoadBalancer( $this->servers );
	}

	/**
	 * @param bool|string $domain
	 * @return LoadBalancer
	 */
	public function getMainLB( $domain = false ) {
		if ( !isset( $this->mainLB ) ) {
			$this->mainLB = $this->newMainLB( $domain );
			$this->getChronologyProtector()->initLB( $this->mainLB );
		}

		return $this->mainLB;
	}

	public function newExternalLB( $cluster ) {
		if ( !isset( $this->externalClusters[$cluster] ) ) {
			throw new InvalidArgumentException( __METHOD__ . ": Unknown cluster \"$cluster\"." );
		}

		return $this->newLoadBalancer( $this->externalClusters[$cluster] );
	}

	public function getExternalLB( $cluster ) {
		if ( !isset( $this->extLBs[$cluster] ) ) {
			$this->extLBs[$cluster] = $this->newExternalLB( $cluster );
			$this->getChronologyProtector()->initLB( $this->extLBs[$cluster] );
		}

		return $this->extLBs[$cluster];
	}

	public function getAllMainLBs() {
		return [ 'DEFAULT' => $this->getMainLB() ];
	}

	public function getAllExternalLBs() {
		$lbs = [];
		foreach ( $this->externalClusters as $cluster => $unused ) {
			$lbs[$cluster] = $this->getExternalLB( $cluster );
		}

		return $lbs;
	}

	private function newLoadBalancer( array $servers ) {
		$lb = new LoadBalancer( array_merge(
			$this->baseLoadBalancerParams(),
			[
				'servers' => $servers,
				'loadMonitor' => [ 'class' => $this->loadMonitorClass ],
			]
		) );
		$this->initLoadBalancer( $lb );

		return $lb;
	}

	/**
	 * Execute a function for each tracked load balancer
	 * The callback is called with the load balancer as the first parameter,
	 * and $params passed as the subsequent parameters.
	 *
	 * @param callable $callback
	 * @param array $params
	 */
	public function forEachLB( $callback, array $params = [] ) {
		if ( isset( $this->mainLB ) ) {
			call_user_func_array( $callback, array_merge( [ $this->mainLB ], $params ) );
		}
		foreach ( $this->extLBs as $lb ) {
			call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
		}
	}
}