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
|
<?php
/**
* 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
*/
namespace MediaWiki\User;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\DAO\WikiAwareEntity;
use MediaWiki\MainConfigNames;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\ILBFactory;
use Wikimedia\Rdbms\ILoadBalancer;
/**
* ActorStore factory for various domains.
*
* @package MediaWiki\User
* @since 1.36
*/
class ActorStoreFactory {
/** @internal */
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::SharedDB,
MainConfigNames::SharedTables,
];
/** @var ILBFactory */
private $loadBalancerFactory;
/** @var UserNameUtils */
private $userNameUtils;
/** @var LoggerInterface */
private $logger;
/** @var string|false */
private $sharedDB;
/** @var string[] */
private $sharedTables;
/** @var ActorStore[] */
private $storeCache = [];
/**
* @param ServiceOptions $options
* @param ILBFactory $loadBalancerFactory
* @param UserNameUtils $userNameUtils
* @param LoggerInterface $logger
*/
public function __construct(
ServiceOptions $options,
ILBFactory $loadBalancerFactory,
UserNameUtils $userNameUtils,
LoggerInterface $logger
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->loadBalancerFactory = $loadBalancerFactory;
$this->sharedDB = $options->get( MainConfigNames::SharedDB );
$this->sharedTables = $options->get( MainConfigNames::SharedTables );
$this->userNameUtils = $userNameUtils;
$this->logger = $logger;
}
/**
* @param string|false $wikiId
* @return ActorNormalization
*/
public function getActorNormalization( $wikiId = WikiAwareEntity::LOCAL ): ActorNormalization {
return $this->getActorStore( $wikiId );
}
/**
* @param string|false $wikiId
* @return ActorStore
*/
public function getActorStore( $wikiId = WikiAwareEntity::LOCAL ): ActorStore {
// During the transition from User, we still have old User objects
// representing users from a different wiki, so we still have IDatabase::getDomainId
// passed as $wikiId, so we need to remap it back to LOCAL.
if ( is_string( $wikiId ) && $this->loadBalancerFactory->getLocalDomainID() === $wikiId ) {
$wikiId = WikiAwareEntity::LOCAL;
}
$storeCacheKey = $this->getStoreCacheKey( $wikiId );
if ( !isset( $this->storeCache[$storeCacheKey] ) ) {
$this->storeCache[$storeCacheKey] = new ActorStore(
$this->getLoadBalancerForTable( 'actor', $wikiId ),
$this->userNameUtils,
$this->logger,
$wikiId
);
}
return $this->storeCache[$storeCacheKey];
}
/**
* @param string|false $wikiId
* @return UserIdentityLookup
*/
public function getUserIdentityLookup(
$wikiId = WikiAwareEntity::LOCAL
): UserIdentityLookup {
return $this->getActorStore( $wikiId );
}
/**
* @param string|false $wikiId
* @return string
*/
private function getStoreCacheKey( $wikiId ): string {
return $wikiId === WikiAwareEntity::LOCAL ? 'LOCAL' : $wikiId;
}
/**
* Returns a load balancer for the database that has the $table
* for the given $wikiId.
*
* @param string $table
* @param string|false $wikiId
* @return ILoadBalancer
*/
private function getLoadBalancerForTable(
string $table,
$wikiId = WikiAwareEntity::LOCAL
): ILoadBalancer {
if ( $this->sharedDB && in_array( $table, $this->sharedTables ) ) {
// The main LB is already properly set up for shared databases early in Setup.php
return $this->loadBalancerFactory->getMainLB();
}
return $this->loadBalancerFactory->getMainLB( $wikiId );
}
}
|
