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
|
<?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\CentralId;
use InvalidArgumentException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentityLookup;
use Wikimedia\ObjectFactory\ObjectFactory;
/**
* @since 1.37
* @ingroup User
*/
class CentralIdLookupFactory {
/**
* @internal
*/
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::CentralIdLookupProviders,
MainConfigNames::CentralIdLookupProvider,
];
/** @var array ObjectFactory specs indexed by provider name */
private $providers;
/** @var string */
private $defaultProvider;
private ObjectFactory $objectFactory;
private UserIdentityLookup $userIdentityLookup;
private UserFactory $userFactory;
/** @var CentralIdLookup[] */
private $instanceCache = [];
public function __construct(
ServiceOptions $options,
ObjectFactory $objectFactory,
UserIdentityLookup $userIdentityLookup,
UserFactory $userFactory
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->providers = $options->get( MainConfigNames::CentralIdLookupProviders );
$this->defaultProvider = $options->get( MainConfigNames::CentralIdLookupProvider );
$this->objectFactory = $objectFactory;
$this->userIdentityLookup = $userIdentityLookup;
$this->userFactory = $userFactory;
}
/**
* Get the IDs of the registered central ID lookup providers.
*
* @return string[]
*/
public function getProviderIds(): array {
return array_keys( $this->providers );
}
/**
* Get the ID of the default central ID provider.
*/
public function getDefaultProviderId(): string {
return $this->defaultProvider;
}
/**
* Get an instance of a CentralIdLookup.
*
* @param string|null $providerId Provider ID from $wgCentralIdLookupProviders or null
* to use the provider configured in $wgCentralIdLookupProvider
* @return CentralIdLookup
* @throws InvalidArgumentException if $providerId is not properly configured
*/
public function getLookup( ?string $providerId = null ): CentralIdLookup {
$providerId ??= $this->defaultProvider;
if ( !array_key_exists( $providerId, $this->instanceCache ) ) {
$providerSpec = $this->providers[$providerId] ?? null;
if ( !$providerSpec ) {
throw new InvalidArgumentException( "Invalid central ID provider $providerId" );
}
$provider = $this->objectFactory->createObject(
$providerSpec,
[ 'assertClass' => CentralIdLookup::class ]
);
$provider->init( $providerId, $this->userIdentityLookup, $this->userFactory );
$this->instanceCache[$providerId] = $provider;
}
return $this->instanceCache[$providerId];
}
/**
* Returns a CentralIdLookup that is guaranteed to be non-local.
* If no such guarantee can be made, returns null.
*
* If this function returns a non-null CentralIdLookup, that lookup is expected to provide IDs
* that are shared with some set of other wikis. However, you should still be cautious
* when using those IDs, as they will not necessarily work with *all* other wikis, and it can be
* hard to tell if another wiki is in the same set as this one or not.
*
* @param string|null $providerID Provider ID from $wgCentralIdLookupProviders or null
* to use the provider configured in $wgCentralIdLookupProvider
* @return ?CentralIdLookup
* @throws InvalidArgumentException if $providerId is not properly configured
*/
public function getNonLocalLookup( ?string $providerID = null ): ?CentralIdLookup {
$centralIdLookup = $this->getLookup( $providerID );
if ( $centralIdLookup instanceof LocalIdLookup ) {
/*
* A LocalIdLookup (which is the default) may actually be non-local,
* if shared user tables are used.
* However, we cannot know that here, so play it safe and refuse to return it.
* See also T163277 and T170996.
*/
return null;
}
return $centralIdLookup;
}
}
|
