MediaWiki  REL1_31
LockManagerGroup.php
Go to the documentation of this file.
1 <?php
25 
34  protected static $instances = [];
35 
36  protected $domain; // string; domain (usually wiki ID)
37 
39  protected $managers = [];
40 
44  protected function __construct( $domain ) {
45  $this->domain = $domain;
46  }
47 
52  public static function singleton( $domain = false ) {
53  $domain = ( $domain === false ) ? wfWikiID() : $domain;
54  if ( !isset( self::$instances[$domain] ) ) {
55  self::$instances[$domain] = new self( $domain );
56  self::$instances[$domain]->initFromGlobals();
57  }
58 
59  return self::$instances[$domain];
60  }
61 
65  public static function destroySingletons() {
66  self::$instances = [];
67  }
68 
72  protected function initFromGlobals() {
74 
75  $this->register( $wgLockManagers );
76  }
77 
84  protected function register( array $configs ) {
85  foreach ( $configs as $config ) {
86  $config['domain'] = $this->domain;
87  if ( !isset( $config['name'] ) ) {
88  throw new Exception( "Cannot register a lock manager with no name." );
89  }
90  $name = $config['name'];
91  if ( !isset( $config['class'] ) ) {
92  throw new Exception( "Cannot register lock manager `{$name}` with no class." );
93  }
94  $class = $config['class'];
95  unset( $config['class'] ); // lock manager won't need this
96  $this->managers[$name] = [
97  'class' => $class,
98  'config' => $config,
99  'instance' => null
100  ];
101  }
102  }
103 
111  public function get( $name ) {
112  if ( !isset( $this->managers[$name] ) ) {
113  throw new Exception( "No lock manager defined with the name `$name`." );
114  }
115  // Lazy-load the actual lock manager instance
116  if ( !isset( $this->managers[$name]['instance'] ) ) {
117  $class = $this->managers[$name]['class'];
118  $config = $this->managers[$name]['config'];
119  if ( $class === DBLockManager::class ) {
120  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
121  $lb = $lbFactory->newMainLB( $config['domain'] );
122  $dbw = $lb->getLazyConnectionRef( DB_MASTER, [], $config['domain'] );
123 
124  $config['dbServers']['localDBMaster'] = $dbw;
125  $config['srvCache'] = ObjectCache::getLocalServerInstance( 'hash' );
126  }
127  $config['logger'] = LoggerFactory::getInstance( 'LockManager' );
128 
129  $this->managers[$name]['instance'] = new $class( $config );
130  }
131 
132  return $this->managers[$name]['instance'];
133  }
134 
142  public function config( $name ) {
143  if ( !isset( $this->managers[$name] ) ) {
144  throw new Exception( "No lock manager defined with the name `$name`." );
145  }
146  $class = $this->managers[$name]['class'];
147 
148  return [ 'class' => $class ] + $this->managers[$name]['config'];
149  }
150 
157  public function getDefault() {
158  return isset( $this->managers['default'] )
159  ? $this->get( 'default' )
160  : new NullLockManager( [] );
161  }
162 
171  public function getAny() {
172  return isset( $this->managers['default'] )
173  ? $this->get( 'default' )
174  : $this->get( 'fsLockManager' );
175  }
176 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
LockManagerGroup\destroySingletons
static destroySingletons()
Destroy the singleton instances.
Definition: LockManagerGroup.php:65
array
the array() calling protocol came about after MediaWiki 1.4rc1.
LockManagerGroup\singleton
static singleton( $domain=false)
Definition: LockManagerGroup.php:52
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
LockManagerGroup\$instances
static LockManagerGroup[] $instances
(domain => LockManagerGroup)
Definition: LockManagerGroup.php:34
LockManagerGroup\getAny
getAny()
Get the default lock manager configured for the site or at least some other effective configured lock...
Definition: LockManagerGroup.php:171
NullLockManager
Simple version of LockManager that does nothing.
Definition: NullLockManager.php:28
$wgLockManagers
$wgLockManagers
Array of configuration arrays for each lock manager.
Definition: DefaultSettings.php:678
LockManagerGroup
Class to handle file lock manager registration.
Definition: LockManagerGroup.php:32
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
LockManagerGroup\$domain
$domain
Definition: LockManagerGroup.php:36
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2763
LockManagerGroup\initFromGlobals
initFromGlobals()
Register lock managers from the global variables.
Definition: LockManagerGroup.php:72
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
LockManagerGroup\config
config( $name)
Get the config array for a lock manager object with a given name.
Definition: LockManagerGroup.php:142
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
LockManagerGroup\getDefault
getDefault()
Get the default lock manager configured for the site.
Definition: LockManagerGroup.php:157
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
LockManagerGroup\__construct
__construct( $domain)
Definition: LockManagerGroup.php:44
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
ObjectCache\getLocalServerInstance
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
Definition: ObjectCache.php:288
LockManagerGroup\$managers
array $managers
Array of (name => ('class' => ..., 'config' => ..., 'instance' => ...))
Definition: LockManagerGroup.php:39