1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?php
/**
* Lock manager registration handling.
*
* 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 LockManager
*/
/**
* Class to handle file lock manager registration
*
* @ingroup LockManager
* @author Aaron Schulz
* @since 1.19
*/
class LockManagerGroup {
/** @var array (domain => LockManager) */
protected static $instances = array();
protected $domain; // string; domain (usually wiki ID)
/** @var array Array of (name => ('class' => ..., 'config' => ..., 'instance' => ...)) */
protected $managers = array();
/**
* @param string $domain Domain (usually wiki ID)
*/
protected function __construct( $domain ) {
$this->domain = $domain;
}
/**
* @param bool|string $domain Domain (usually wiki ID). Default: false.
* @return LockManagerGroup
*/
public static function singleton( $domain = false ) {
$domain = ( $domain === false ) ? wfWikiID() : $domain;
if ( !isset( self::$instances[$domain] ) ) {
self::$instances[$domain] = new self( $domain );
self::$instances[$domain]->initFromGlobals();
}
return self::$instances[$domain];
}
/**
* Destroy the singleton instances
*/
public static function destroySingletons() {
self::$instances = array();
}
/**
* Register lock managers from the global variables
*/
protected function initFromGlobals() {
global $wgLockManagers;
$this->register( $wgLockManagers );
}
/**
* Register an array of file lock manager configurations
*
* @param array $configs
* @throws Exception
*/
protected function register( array $configs ) {
foreach ( $configs as $config ) {
$config['domain'] = $this->domain;
if ( !isset( $config['name'] ) ) {
throw new Exception( "Cannot register a lock manager with no name." );
}
$name = $config['name'];
if ( !isset( $config['class'] ) ) {
throw new Exception( "Cannot register lock manager `{$name}` with no class." );
}
$class = $config['class'];
unset( $config['class'] ); // lock manager won't need this
$this->managers[$name] = array(
'class' => $class,
'config' => $config,
'instance' => null
);
}
}
/**
* Get the lock manager object with a given name
*
* @param string $name
* @return LockManager
* @throws Exception
*/
public function get( $name ) {
if ( !isset( $this->managers[$name] ) ) {
throw new Exception( "No lock manager defined with the name `$name`." );
}
// Lazy-load the actual lock manager instance
if ( !isset( $this->managers[$name]['instance'] ) ) {
$class = $this->managers[$name]['class'];
$config = $this->managers[$name]['config'];
$this->managers[$name]['instance'] = new $class( $config );
}
return $this->managers[$name]['instance'];
}
/**
* Get the config array for a lock manager object with a given name
*
* @param string $name
* @return array
* @throws Exception
*/
public function config( $name ) {
if ( !isset( $this->managers[$name] ) ) {
throw new Exception( "No lock manager defined with the name `$name`." );
}
$class = $this->managers[$name]['class'];
return array( 'class' => $class ) + $this->managers[$name]['config'];
}
/**
* Get the default lock manager configured for the site.
* Returns NullLockManager if no lock manager could be found.
*
* @return LockManager
*/
public function getDefault() {
return isset( $this->managers['default'] )
? $this->get( 'default' )
: new NullLockManager( array() );
}
/**
* Get the default lock manager configured for the site
* or at least some other effective configured lock manager.
* Throws an exception if no lock manager could be found.
*
* @return LockManager
* @throws Exception
*/
public function getAny() {
return isset( $this->managers['default'] )
? $this->get( 'default' )
: $this->get( 'fsLockManager' );
}
}
|
