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
25 * An interface for generating database load balancers
28 abstract class LBFactory
{
30 private static $instance;
33 * Disables all access to the load balancer, will cause all database access
34 * to throw a DBAccessError
36 public static function disableBackend() {
37 global $wgLBFactoryConf;
38 self
::$instance = new LBFactoryFake( $wgLBFactoryConf );
42 * Get an LBFactory instance
46 public static function singleton() {
47 global $wgLBFactoryConf;
49 if ( is_null( self
::$instance ) ) {
50 $class = self
::getLBFactoryClass( $wgLBFactoryConf );
52 self
::$instance = new $class( $wgLBFactoryConf );
55 return self
::$instance;
59 * Returns the LBFactory class to use and the load balancer configuration.
61 * @param array $config (e.g. $wgLBFactoryConf)
62 * @return string Class name
64 public static function getLBFactoryClass( array $config ) {
65 // For configuration backward compatibility after removing
66 // underscores from class names in MediaWiki 1.23.
68 'LBFactory_Simple' => 'LBFactorySimple',
69 'LBFactory_Single' => 'LBFactorySingle',
70 'LBFactory_Multi' => 'LBFactoryMulti',
71 'LBFactory_Fake' => 'LBFactoryFake',
74 $class = $config['class'];
76 if ( isset( $bcClasses[$class] ) ) {
77 $class = $bcClasses[$class];
79 '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details',
88 * Shut down, close connections and destroy the cached instance.
90 public static function destroyInstance() {
91 if ( self
::$instance ) {
92 self
::$instance->shutdown();
93 self
::$instance->forEachLBCallMethod( 'closeAll' );
94 self
::$instance = null;
99 * Set the instance to be the given object
101 * @param LBFactory $instance
103 public static function setInstance( $instance ) {
104 self
::destroyInstance();
105 self
::$instance = $instance;
109 * Construct a factory based on a configuration array (typically from $wgLBFactoryConf)
112 abstract public function __construct( array $conf );
115 * Create a new load balancer object. The resulting object will be untracked,
116 * not chronology-protected, and the caller is responsible for cleaning it up.
118 * @param bool|string $wiki Wiki ID, or false for the current wiki
119 * @return LoadBalancer
121 abstract public function newMainLB( $wiki = false );
124 * Get a cached (tracked) load balancer object.
126 * @param bool|string $wiki Wiki ID, or false for the current wiki
127 * @return LoadBalancer
129 abstract public function getMainLB( $wiki = false );
132 * Create a new load balancer for external storage. The resulting object will be
133 * untracked, not chronology-protected, and the caller is responsible for
136 * @param string $cluster External storage cluster, or false for core
137 * @param bool|string $wiki Wiki ID, or false for the current wiki
138 * @return LoadBalancer
140 abstract protected function newExternalLB( $cluster, $wiki = false );
143 * Get a cached (tracked) load balancer for external storage
145 * @param string $cluster External storage cluster, or false for core
146 * @param bool|string $wiki Wiki ID, or false for the current wiki
147 * @return LoadBalancer
149 abstract public function &getExternalLB( $cluster, $wiki = false );
152 * Execute a function for each tracked load balancer
153 * The callback is called with the load balancer as the first parameter,
154 * and $params passed as the subsequent parameters.
156 * @param callable $callback
157 * @param array $params
159 abstract public function forEachLB( $callback, array $params = array() );
162 * Prepare all tracked load balancers for shutdown
165 public function shutdown() {
169 * Call a method of each tracked load balancer
171 * @param string $methodName
174 private function forEachLBCallMethod( $methodName, array $args = array() ) {
175 $this->forEachLB( function ( LoadBalancer
$loadBalancer, $methodName, array $args ) {
176 call_user_func_array( array( $loadBalancer, $methodName ), $args );
177 }, array( $methodName, $args ) );
181 * Commit on all connections. Done for two reasons:
182 * 1. To commit changes to the masters.
183 * 2. To release the snapshot on all connections, master and slave.
185 public function commitAll() {
186 $this->forEachLBCallMethod( 'commitAll' );
190 * Commit changes on all master connections
192 public function commitMasterChanges() {
193 $this->forEachLBCallMethod( 'commitMasterChanges' );
197 * Rollback changes on all master connections
200 public function rollbackMasterChanges() {
201 $this->forEachLBCallMethod( 'rollbackMasterChanges' );
205 * Detemine if any master connection has pending changes.
209 public function hasMasterChanges() {
211 $this->forEachLB( function ( LoadBalancer
$lb ) use ( &$ret ) {
212 $ret = $ret ||
$lb->hasMasterChanges();
219 * Exception class for attempted DB access
221 class DBAccessError
extends MWException
{
222 public function __construct() {
223 parent
::__construct( "Mediawiki tried to access the database via wfGetDB(). " .
224 "This is not allowed." );