LBFactoryMulti::shutdown() - Code Metrics - Inspection of "Daily Inspection: Merge "mw.api.messages: Allow pa..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (a9d73a)

unknown

created 2016-08-30 17:34 UTC

LBFactoryMulti::shutdown() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Advanced generator of database load balancing objects for wiki farms.
 *
 * 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 multi-wiki, multi-master factory for Wikimedia and similar installations.
 * Ignores the old configuration globals.
 *
 * Template override precedence (highest => lowest):
 *   - templateOverridesByServer
 *   - masterTemplateOverrides
 *   - templateOverridesBySection/templateOverridesByCluster
 *   - externalTemplateOverrides
 *   - serverTemplate
 * Overrides only work on top level keys (so nested values will not be merged).
 *
 * Configuration:
 *     sectionsByDB                A map of database names to section names.
 *
 *     sectionLoads                A 2-d map. For each section, gives a map of server names to
 *                                 load ratios. For example:
 *                                 [
 *                                     'section1' => [
 *                                         'db1' => 100,
 *                                         'db2' => 100
 *                                     ]
 *                                 ]
 *
 *     serverTemplate              A server info associative array as documented for $wgDBservers.
 *                                 The host, hostName and load entries will be overridden.
 *
 *     groupLoadsBySection         A 3-d map giving server load ratios for each section and group.
 *                                 For example:
 *                                 [
 *                                     'section1' => [
 *                                         'group1' => [
 *                                             'db1' => 100,
 *                                             'db2' => 100
 *                                         ]
 *                                     ]
 *                                 ]
 *
 *     groupLoadsByDB              A 3-d map giving server load ratios by DB name.
 *
 *     hostsByName                 A map of hostname to IP address.
 *
 *     externalLoads               A map of external storage cluster name to server load map.
 *
 *     externalTemplateOverrides   A set of server info keys overriding serverTemplate for external
 *                                 storage.
 *
 *     templateOverridesByServer   A 2-d map overriding serverTemplate and
 *                                 externalTemplateOverrides on a server-by-server basis. Applies
 *                                 to both core and external storage.
 *     templateOverridesBySection  A 2-d map overriding the server info by section.
 *     templateOverridesByCluster  A 2-d map overriding the server info by external storage cluster.
 *
 *     masterTemplateOverrides     An override array for all master servers.
 *
 *     loadMonitorClass            Name of the LoadMonitor class to always use.
 *
 *     readOnlyBySection           A map of section name to read-only message.
 *                                 Missing or false for read/write.
 *
 * @ingroup Database
 */
class LBFactoryMulti extends LBFactory {
	/** @var array A map of database names to section names */
	private $sectionsByDB;

	/**
	 * @var array A 2-d map. For each section, gives a map of server names to
	 * load ratios
	 */
	private $sectionLoads;

	/**
	 * @var array A server info associative array as documented for
	 * $wgDBservers. The host, hostName and load entries will be
	 * overridden
	 */
	private $serverTemplate;

	// Optional settings

	/** @var array A 3-d map giving server load ratios for each section and group */
	private $groupLoadsBySection = [];

	/** @var array A 3-d map giving server load ratios by DB name */
	private $groupLoadsByDB = [];

	/** @var array A map of hostname to IP address */
	private $hostsByName = [];

	/** @var array A map of external storage cluster name to server load map */
	private $externalLoads = [];

	/**
	 * @var array A set of server info keys overriding serverTemplate for
	 * external storage
	 */
	private $externalTemplateOverrides;

	/**
	 * @var array A 2-d map overriding serverTemplate and
	 * externalTemplateOverrides on a server-by-server basis. Applies to both
	 * core and external storage
	 */
	private $templateOverridesByServer;

	/** @var array A 2-d map overriding the server info by section */
	private $templateOverridesBySection;

	/** @var array A 2-d map overriding the server info by external storage cluster */
	private $templateOverridesByCluster;

	/** @var array An override array for all master servers */
	private $masterTemplateOverrides;

	/**
	 * @var array|bool A map of section name to read-only message. Missing or
	 * false for read/write
	 */
	private $readOnlyBySection = [];

	// Other stuff

	/** @var array Load balancer factory configuration */
	private $conf;

	/** @var LoadBalancer[] */
	private $mainLBs = [];

	/** @var LoadBalancer[] */
	private $extLBs = [];

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

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

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

	/**
	 * @param array $conf
	 * @throws MWException
	 */
	public function __construct( array $conf ) {
		parent::__construct( $conf );

		$this->conf = $conf;
		$required = [ 'sectionsByDB', 'sectionLoads', 'serverTemplate' ];
		$optional = [ 'groupLoadsBySection', 'groupLoadsByDB', 'hostsByName',
			'externalLoads', 'externalTemplateOverrides', 'templateOverridesByServer',
			'templateOverridesByCluster', 'templateOverridesBySection', 'masterTemplateOverrides',
			'readOnlyBySection', 'loadMonitorClass' ];

		foreach ( $required as $key ) {
			if ( !isset( $conf[$key] ) ) {
				throw new MWException( __CLASS__ . ": $key is required in configuration" );
			}
			$this->$key = $conf[$key];
		}

		foreach ( $optional as $key ) {
			if ( isset( $conf[$key] ) ) {
				$this->$key = $conf[$key];
			}
		}
	}

	/**
	 * @param bool|string $wiki
	 * @return string
	 */
	private function getSectionForWiki( $wiki = false ) {
		if ( $this->lastWiki === $wiki ) {
			return $this->lastSection;
		}
		list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
		if ( isset( $this->sectionsByDB[$dbName] ) ) {
			$section = $this->sectionsByDB[$dbName];
		} else {
			$section = 'DEFAULT';
		}
		$this->lastSection = $section;
		$this->lastWiki = $wiki;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

		return $section;
	}

	/**
	 * @param bool|string $wiki
	 * @return LoadBalancer
	 */
	public function newMainLB( $wiki = false ) {
		list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
		$section = $this->getSectionForWiki( $wiki );
		if ( isset( $this->groupLoadsByDB[$dbName] ) ) {
			$groupLoads = $this->groupLoadsByDB[$dbName];
		} else {
			$groupLoads = [];
		}

		if ( isset( $this->groupLoadsBySection[$section] ) ) {
			$groupLoads = array_merge_recursive( $groupLoads, $this->groupLoadsBySection[$section] );
		}

		$readOnlyReason = $this->readOnlyReason;
		// Use the LB-specific read-only reason if everything isn't already read-only
		if ( $readOnlyReason === false && isset( $this->readOnlyBySection[$section] ) ) {
			$readOnlyReason = $this->readOnlyBySection[$section];
		}

		$template = $this->serverTemplate;
		if ( isset( $this->templateOverridesBySection[$section] ) ) {
			$template = $this->templateOverridesBySection[$section] + $template;
		}

		return $this->newLoadBalancer(
			$template,
			$this->sectionLoads[$section],
			$groupLoads,
			$readOnlyReason
		);
	}

	/**
	 * @param bool|string $wiki
	 * @return LoadBalancer
	 */
	public function getMainLB( $wiki = false ) {
		$section = $this->getSectionForWiki( $wiki );
		if ( !isset( $this->mainLBs[$section] ) ) {
			$lb = $this->newMainLB( $wiki );
			$lb->parentInfo( [ 'id' => "main-$section" ] );
			$this->chronProt->initLB( $lb );
			$this->mainLBs[$section] = $lb;
		}

		return $this->mainLBs[$section];
	}

	/**
	 * @param string $cluster
	 * @param bool|string $wiki
	 * @throws MWException
	 * @return LoadBalancer
	 */
	protected function newExternalLB( $cluster, $wiki = false ) {
		if ( !isset( $this->externalLoads[$cluster] ) ) {
			throw new MWException( __METHOD__ . ": Unknown cluster \"$cluster\"" );
		}
		$template = $this->serverTemplate;
		if ( isset( $this->externalTemplateOverrides ) ) {
			$template = $this->externalTemplateOverrides + $template;
		}
		if ( isset( $this->templateOverridesByCluster[$cluster] ) ) {
			$template = $this->templateOverridesByCluster[$cluster] + $template;
		}

		return $this->newLoadBalancer(
			$template,
			$this->externalLoads[$cluster],
			[],
			$this->readOnlyReason
		);
	}

	/**
	 * @param string $cluster External storage cluster, or false for core
	 * @param bool|string $wiki Wiki ID, or false for the current wiki
	 * @return LoadBalancer
	 */
	public function &getExternalLB( $cluster, $wiki = false ) {
		if ( !isset( $this->extLBs[$cluster] ) ) {
			$this->extLBs[$cluster] = $this->newExternalLB( $cluster, $wiki );
			$this->extLBs[$cluster]->parentInfo( [ 'id' => "ext-$cluster" ] );
			$this->chronProt->initLB( $this->extLBs[$cluster] );
		}

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

	/**
	 * Make a new load balancer object based on template and load array
	 *
	 * @param array $template
	 * @param array $loads
	 * @param array $groupLoads
	 * @param string|bool $readOnlyReason
	 * @return LoadBalancer
	 */
	private function newLoadBalancer( $template, $loads, $groupLoads, $readOnlyReason ) {
		return new LoadBalancer( [
			'servers' => $this->makeServerArray( $template, $loads, $groupLoads ),
			'loadMonitor' => $this->loadMonitorClass,
			'readOnlyReason' => $readOnlyReason,
			'trxProfiler' => $this->trxProfiler,
			'srvCache' => $this->srvCache,
			'wanCache' => $this->wanCache
		] );
	}

	/**
	 * Make a server array as expected by LoadBalancer::__construct, using a template and load array
	 *
	 * @param array $template
	 * @param array $loads
	 * @param array $groupLoads
	 * @return array
	 */
	private function makeServerArray( $template, $loads, $groupLoads ) {
		$servers = [];
		$master = true;
		$groupLoadsByServer = $this->reindexGroupLoads( $groupLoads );
		foreach ( $groupLoadsByServer as $server => $stuff ) {
			if ( !isset( $loads[$server] ) ) {
				$loads[$server] = 0;
			}
		}
		foreach ( $loads as $serverName => $load ) {
			$serverInfo = $template;
			if ( $master ) {
				$serverInfo['master'] = true;
				if ( isset( $this->masterTemplateOverrides ) ) {
					$serverInfo = $this->masterTemplateOverrides + $serverInfo;
				}
				$master = false;
			} else {
				$serverInfo['slave'] = true;
			}
			if ( isset( $this->templateOverridesByServer[$serverName] ) ) {
				$serverInfo = $this->templateOverridesByServer[$serverName] + $serverInfo;
			}
			if ( isset( $groupLoadsByServer[$serverName] ) ) {
				$serverInfo['groupLoads'] = $groupLoadsByServer[$serverName];
			}
			if ( isset( $this->hostsByName[$serverName] ) ) {
				$serverInfo['host'] = $this->hostsByName[$serverName];
			} else {
				$serverInfo['host'] = $serverName;
			}
			$serverInfo['hostName'] = $serverName;
			$serverInfo['load'] = $load;
			$serverInfo += [ 'flags' => DBO_DEFAULT ];

			$servers[] = $serverInfo;
		}

		return $servers;
	}

	/**
	 * Take a group load array indexed by group then server, and reindex it by server then group
	 * @param array $groupLoads
	 * @return array
	 */
	private function reindexGroupLoads( $groupLoads ) {
		$reindexed = [];
		foreach ( $groupLoads as $group => $loads ) {
			foreach ( $loads as $server => $load ) {
				$reindexed[$server][$group] = $load;
			}
		}

		return $reindexed;
	}

	/**
	 * Get the database name and prefix based on the wiki ID
	 * @param bool|string $wiki
	 * @return array
	 */
	private function getDBNameAndPrefix( $wiki = false ) {
		if ( $wiki === false ) {
			global $wgDBname, $wgDBprefix;

			return [ $wgDBname, $wgDBprefix ];
		} else {
			return wfSplitWikiID( $wiki );

		}
	}

	/**
	 * 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 = [] ) {
		foreach ( $this->mainLBs as $lb ) {
			call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
		}
		foreach ( $this->extLBs as $lb ) {
			call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
		}
	}
}


1		<?php
2		/**
3		* Advanced generator of database load balancing objects for wiki farms.
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 multi-wiki, multi-master factory for Wikimedia and similar installations.
26		* Ignores the old configuration globals.
27		*
28		* Template override precedence (highest => lowest):
29		* - templateOverridesByServer
30		* - masterTemplateOverrides
31		* - templateOverridesBySection/templateOverridesByCluster
32		* - externalTemplateOverrides
33		* - serverTemplate
34		* Overrides only work on top level keys (so nested values will not be merged).
35		*
36		* Configuration:
37		* sectionsByDB A map of database names to section names.
38		*
39		* sectionLoads A 2-d map. For each section, gives a map of server names to
40		* load ratios. For example:
41		* [
42		* 'section1' => [
43		* 'db1' => 100,
44		* 'db2' => 100
45		* ]
46		* ]
47		*
48		* serverTemplate A server info associative array as documented for $wgDBservers.
49		* The host, hostName and load entries will be overridden.
50		*
51		* groupLoadsBySection A 3-d map giving server load ratios for each section and group.
52		* For example:
53		* [
54		* 'section1' => [
55		* 'group1' => [
56		* 'db1' => 100,
57		* 'db2' => 100
58		* ]
59		* ]
60		* ]
61		*
62		* groupLoadsByDB A 3-d map giving server load ratios by DB name.
63		*
64		* hostsByName A map of hostname to IP address.
65		*
66		* externalLoads A map of external storage cluster name to server load map.
67		*
68		* externalTemplateOverrides A set of server info keys overriding serverTemplate for external
69		* storage.
70		*
71		* templateOverridesByServer A 2-d map overriding serverTemplate and
72		* externalTemplateOverrides on a server-by-server basis. Applies
73		* to both core and external storage.
74		* templateOverridesBySection A 2-d map overriding the server info by section.
75		* templateOverridesByCluster A 2-d map overriding the server info by external storage cluster.
76		*
77		* masterTemplateOverrides An override array for all master servers.
78		*
79		* loadMonitorClass Name of the LoadMonitor class to always use.
80		*
81		* readOnlyBySection A map of section name to read-only message.
82		* Missing or false for read/write.
83		*
84		* @ingroup Database
85		*/
86		class LBFactoryMulti extends LBFactory {
87		/** @var array A map of database names to section names */
88		private $sectionsByDB;
89
90		/**
91		* @var array A 2-d map. For each section, gives a map of server names to
92		* load ratios
93		*/
94		private $sectionLoads;
95
96		/**
97		* @var array A server info associative array as documented for
98		* $wgDBservers. The host, hostName and load entries will be
99		* overridden
100		*/
101		private $serverTemplate;
102
103		// Optional settings
104
105		/** @var array A 3-d map giving server load ratios for each section and group */
106		private $groupLoadsBySection = [];
107
108		/** @var array A 3-d map giving server load ratios by DB name */
109		private $groupLoadsByDB = [];
110
111		/** @var array A map of hostname to IP address */
112		private $hostsByName = [];
113
114		/** @var array A map of external storage cluster name to server load map */
115		private $externalLoads = [];
116
117		/**
118		* @var array A set of server info keys overriding serverTemplate for
119		* external storage
120		*/
121		private $externalTemplateOverrides;
122
123		/**
124		* @var array A 2-d map overriding serverTemplate and
125		* externalTemplateOverrides on a server-by-server basis. Applies to both
126		* core and external storage
127		*/
128		private $templateOverridesByServer;
129
130		/** @var array A 2-d map overriding the server info by section */
131		private $templateOverridesBySection;
132
133		/** @var array A 2-d map overriding the server info by external storage cluster */
134		private $templateOverridesByCluster;
135
136		/** @var array An override array for all master servers */
137		private $masterTemplateOverrides;
138
139		/**
140		* @var array\|bool A map of section name to read-only message. Missing or
141		* false for read/write
142		*/
143		private $readOnlyBySection = [];
144
145		// Other stuff
146
147		/** @var array Load balancer factory configuration */
148		private $conf;
149
150		/** @var LoadBalancer[] */
151		private $mainLBs = [];
152
153		/** @var LoadBalancer[] */
154		private $extLBs = [];
155
156		/** @var string */
157		private $loadMonitorClass;
158
159		/** @var string */
160		private $lastWiki;
161
162		/** @var string */
163		private $lastSection;
164
165		/**
166		* @param array $conf
167		* @throws MWException
168		*/
169		public function __construct( array $conf ) {
170		parent::__construct( $conf );
171
172		$this->conf = $conf;
173		$required = [ 'sectionsByDB', 'sectionLoads', 'serverTemplate' ];
174		$optional = [ 'groupLoadsBySection', 'groupLoadsByDB', 'hostsByName',
175		'externalLoads', 'externalTemplateOverrides', 'templateOverridesByServer',
176		'templateOverridesByCluster', 'templateOverridesBySection', 'masterTemplateOverrides',
177		'readOnlyBySection', 'loadMonitorClass' ];
178
179		foreach ( $required as $key ) {
180		if ( !isset( $conf[$key] ) ) {
181		throw new MWException( __CLASS__ . ": $key is required in configuration" );
182		}
183		$this->$key = $conf[$key];
184		}
185
186		foreach ( $optional as $key ) {
187		if ( isset( $conf[$key] ) ) {
188		$this->$key = $conf[$key];
189		}
190		}
191		}
192
193		/**
194		* @param bool\|string $wiki
195		* @return string
196		*/
197		private function getSectionForWiki( $wiki = false ) {
198		if ( $this->lastWiki === $wiki ) {
199		return $this->lastSection;
200		}
201		list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
202		if ( isset( $this->sectionsByDB[$dbName] ) ) {
203		$section = $this->sectionsByDB[$dbName];
204		} else {
205		$section = 'DEFAULT';
206		}
207		$this->lastSection = $section;
208		$this->lastWiki = $wiki;
		0 ignored issues – show Documentation Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$wiki` can also be of type `boolean`. However, the property `$lastWiki` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
209
210		return $section;
211		}
212
213		/**
214		* @param bool\|string $wiki
215		* @return LoadBalancer
216		*/
217		public function newMainLB( $wiki = false ) {
218		list( $dbName, ) = $this->getDBNameAndPrefix( $wiki );
219		$section = $this->getSectionForWiki( $wiki );
220		if ( isset( $this->groupLoadsByDB[$dbName] ) ) {
221		$groupLoads = $this->groupLoadsByDB[$dbName];
222		} else {
223		$groupLoads = [];
224		}
225
226		if ( isset( $this->groupLoadsBySection[$section] ) ) {
227		$groupLoads = array_merge_recursive( $groupLoads, $this->groupLoadsBySection[$section] );
228		}
229
230		$readOnlyReason = $this->readOnlyReason;
231		// Use the LB-specific read-only reason if everything isn't already read-only
232		if ( $readOnlyReason === false && isset( $this->readOnlyBySection[$section] ) ) {
233		$readOnlyReason = $this->readOnlyBySection[$section];
234		}
235
236		$template = $this->serverTemplate;
237		if ( isset( $this->templateOverridesBySection[$section] ) ) {
238		$template = $this->templateOverridesBySection[$section] + $template;
239		}
240
241		return $this->newLoadBalancer(
242		$template,
243		$this->sectionLoads[$section],
244		$groupLoads,
245		$readOnlyReason
246		);
247		}
248
249		/**
250		* @param bool\|string $wiki
251		* @return LoadBalancer
252		*/
253		public function getMainLB( $wiki = false ) {
254		$section = $this->getSectionForWiki( $wiki );
255		if ( !isset( $this->mainLBs[$section] ) ) {
256		$lb = $this->newMainLB( $wiki );
257		$lb->parentInfo( [ 'id' => "main-$section" ] );
258		$this->chronProt->initLB( $lb );
259		$this->mainLBs[$section] = $lb;
260		}
261
262		return $this->mainLBs[$section];
263		}
264
265		/**
266		* @param string $cluster
267		* @param bool\|string $wiki
268		* @throws MWException
269		* @return LoadBalancer
270		*/
271		protected function newExternalLB( $cluster, $wiki = false ) {
272		if ( !isset( $this->externalLoads[$cluster] ) ) {
273		throw new MWException( __METHOD__ . ": Unknown cluster \"$cluster\"" );
274		}
275		$template = $this->serverTemplate;
276		if ( isset( $this->externalTemplateOverrides ) ) {
277		$template = $this->externalTemplateOverrides + $template;
278		}
279		if ( isset( $this->templateOverridesByCluster[$cluster] ) ) {
280		$template = $this->templateOverridesByCluster[$cluster] + $template;
281		}
282
283		return $this->newLoadBalancer(
284		$template,
285		$this->externalLoads[$cluster],
286		[],
287		$this->readOnlyReason
288		);
289		}
290
291		/**
292		* @param string $cluster External storage cluster, or false for core
293		* @param bool\|string $wiki Wiki ID, or false for the current wiki
294		* @return LoadBalancer
295		*/
296	View Code Duplication	public function &getExternalLB( $cluster, $wiki = false ) {
297		if ( !isset( $this->extLBs[$cluster] ) ) {
298		$this->extLBs[$cluster] = $this->newExternalLB( $cluster, $wiki );
299		$this->extLBs[$cluster]->parentInfo( [ 'id' => "ext-$cluster" ] );
300		$this->chronProt->initLB( $this->extLBs[$cluster] );
301		}
302
303		return $this->extLBs[$cluster];
304		}
305
306		/**
307		* Make a new load balancer object based on template and load array
308		*
309		* @param array $template
310		* @param array $loads
311		* @param array $groupLoads
312		* @param string\|bool $readOnlyReason
313		* @return LoadBalancer
314		*/
315		private function newLoadBalancer( $template, $loads, $groupLoads, $readOnlyReason ) {
316		return new LoadBalancer( [
317		'servers' => $this->makeServerArray( $template, $loads, $groupLoads ),
318		'loadMonitor' => $this->loadMonitorClass,
319		'readOnlyReason' => $readOnlyReason,
320		'trxProfiler' => $this->trxProfiler,
321		'srvCache' => $this->srvCache,
322		'wanCache' => $this->wanCache
323		] );
324		}
325
326		/**
327		* Make a server array as expected by LoadBalancer::__construct, using a template and load array
328		*
329		* @param array $template
330		* @param array $loads
331		* @param array $groupLoads
332		* @return array
333		*/
334		private function makeServerArray( $template, $loads, $groupLoads ) {
335		$servers = [];
336		$master = true;
337		$groupLoadsByServer = $this->reindexGroupLoads( $groupLoads );
338		foreach ( $groupLoadsByServer as $server => $stuff ) {
339		if ( !isset( $loads[$server] ) ) {
340		$loads[$server] = 0;
341		}
342		}
343		foreach ( $loads as $serverName => $load ) {
344		$serverInfo = $template;
345		if ( $master ) {
346		$serverInfo['master'] = true;
347		if ( isset( $this->masterTemplateOverrides ) ) {
348		$serverInfo = $this->masterTemplateOverrides + $serverInfo;
349		}
350		$master = false;
351		} else {
352		$serverInfo['slave'] = true;
353		}
354		if ( isset( $this->templateOverridesByServer[$serverName] ) ) {
355		$serverInfo = $this->templateOverridesByServer[$serverName] + $serverInfo;
356		}
357		if ( isset( $groupLoadsByServer[$serverName] ) ) {
358		$serverInfo['groupLoads'] = $groupLoadsByServer[$serverName];
359		}
360		if ( isset( $this->hostsByName[$serverName] ) ) {
361		$serverInfo['host'] = $this->hostsByName[$serverName];
362		} else {
363		$serverInfo['host'] = $serverName;
364		}
365		$serverInfo['hostName'] = $serverName;
366		$serverInfo['load'] = $load;
367		$serverInfo += [ 'flags' => DBO_DEFAULT ];
368
369		$servers[] = $serverInfo;
370		}
371
372		return $servers;
373		}
374
375		/**
376		* Take a group load array indexed by group then server, and reindex it by server then group
377		* @param array $groupLoads
378		* @return array
379		*/
380		private function reindexGroupLoads( $groupLoads ) {
381		$reindexed = [];
382		foreach ( $groupLoads as $group => $loads ) {
383		foreach ( $loads as $server => $load ) {
384		$reindexed[$server][$group] = $load;
385		}
386		}
387
388		return $reindexed;
389		}
390
391		/**
392		* Get the database name and prefix based on the wiki ID
393		* @param bool\|string $wiki
394		* @return array
395		*/
396		private function getDBNameAndPrefix( $wiki = false ) {
397		if ( $wiki === false ) {
398		global $wgDBname, $wgDBprefix;
399
400		return [ $wgDBname, $wgDBprefix ];
401		} else {
402		return wfSplitWikiID( $wiki );
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$wiki` defined by parameter `$wiki` on line 396 can also be of type `boolean`; however, `wfSplitWikiID()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
403		}
404		}
405
406		/**
407		* Execute a function for each tracked load balancer
408		* The callback is called with the load balancer as the first parameter,
409		* and $params passed as the subsequent parameters.
410		* @param callable $callback
411		* @param array $params
412		*/
413		public function forEachLB( $callback, array $params = [] ) {
414		foreach ( $this->mainLBs as $lb ) {
415		call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
416		}
417		foreach ( $this->extLBs as $lb ) {
418		call_user_func_array( $callback, array_merge( [ $lb ], $params ) );
419		}
420		}
421		}
422

wikimedia / mediawiki

Branch — master (a9d73a)

LBFactoryMulti::shutdown() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like