MediaWiki  master
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  if ( $domain === false ) {
55  }
56 
57  if ( !isset( self::$instances[$domain] ) ) {
58  self::$instances[$domain] = new self( $domain );
59  self::$instances[$domain]->initFromGlobals();
60  }
61 
62  return self::$instances[$domain];
63  }
64 
68  public static function destroySingletons() {
69  self::$instances = [];
70  }
71 
75  protected function initFromGlobals() {
76  global $wgLockManagers;
77 
78  $this->register( $wgLockManagers );
79  }
80 
87  protected function register( array $configs ) {
88  foreach ( $configs as $config ) {
89  $config['domain'] = $this->domain;
90  if ( !isset( $config['name'] ) ) {
91  throw new Exception( "Cannot register a lock manager with no name." );
92  }
93  $name = $config['name'];
94  if ( !isset( $config['class'] ) ) {
95  throw new Exception( "Cannot register lock manager `{$name}` with no class." );
96  }
97  $class = $config['class'];
98  unset( $config['class'] ); // lock manager won't need this
99  $this->managers[$name] = [
100  'class' => $class,
101  'config' => $config,
102  'instance' => null
103  ];
104  }
105  }
106 
114  public function get( $name ) {
115  if ( !isset( $this->managers[$name] ) ) {
116  throw new Exception( "No lock manager defined with the name `$name`." );
117  }
118  // Lazy-load the actual lock manager instance
119  if ( !isset( $this->managers[$name]['instance'] ) ) {
120  $class = $this->managers[$name]['class'];
121  $config = $this->managers[$name]['config'];
122  if ( $class === DBLockManager::class ) {
123  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
124  $lb = $lbFactory->newMainLB( $config['domain'] );
125  $dbw = $lb->getLazyConnectionRef( DB_MASTER, [], $config['domain'] );
126 
127  $config['dbServers']['localDBMaster'] = $dbw;
128  $config['srvCache'] = ObjectCache::getLocalServerInstance( 'hash' );
129  }
130  $config['logger'] = LoggerFactory::getInstance( 'LockManager' );
131 
132  // @phan-suppress-next-line PhanTypeInstantiateAbstract
133  $this->managers[$name]['instance'] = new $class( $config );
134  }
135 
136  return $this->managers[$name]['instance'];
137  }
138 
146  public function config( $name ) {
147  if ( !isset( $this->managers[$name] ) ) {
148  throw new Exception( "No lock manager defined with the name `$name`." );
149  }
150  $class = $this->managers[$name]['class'];
151 
152  return [ 'class' => $class ] + $this->managers[$name]['config'];
153  }
154 
161  public function getDefault() {
162  return isset( $this->managers['default'] )
163  ? $this->get( 'default' )
164  : new NullLockManager( [] );
165  }
166 
175  public function getAny() {
176  return isset( $this->managers['default'] )
177  ? $this->get( 'default' )
178  : $this->get( 'fsLockManager' );
179  }
180 }
static LockManagerGroup [] $instances
(domain => LockManagerGroup)
config( $name)
Get the config array for a lock manager object with a given name.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Simple version of LockManager that does nothing.
initFromGlobals()
Register lock managers from the global variables.
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:23
const DB_MASTER
Definition: defines.php:26
getDefault()
Get the default lock manager configured for the site.
Class to handle file lock manager registration.
static destroySingletons()
Destroy the singleton instances.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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:9
static getCurrentWikiDbDomain()
Definition: WikiMap.php:302
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:35
static singleton( $domain=false)
array $managers
Array of (name => (&#39;class&#39; => ..., &#39;config&#39; => ..., &#39;instance&#39; => ...))
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:52
getAny()
Get the default lock manager configured for the site or at least some other effective configured lock...
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
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
$wgLockManagers
Array of configuration arrays for each lock manager.