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
166
|
<?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 MediaWiki\Block\HideUserUtils;
use MediaWiki\Config\Config;
use MediaWiki\MainConfigNames;
use MediaWiki\User\UserIdentity;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\Rdbms\DBAccessObjectUtils;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* A CentralIdLookup provider that just uses local IDs. Useful if the wiki
* isn't part of a cluster or you're using shared user tables.
*
* @note Shared user table support expects that all wikis involved have
* $wgSharedDB and $wgSharedTables set, and that all wikis involved in the
* sharing are listed in $wgLocalDatabases, and that no wikis not involved in
* the sharing are listed in $wgLocalDatabases.
* @since 1.27
*/
class LocalIdLookup extends CentralIdLookup {
private IConnectionProvider $dbProvider;
private HideUserUtils $hideUserUtils;
/** @var string|null */
private $sharedDB;
/** @var string[] */
private $sharedTables;
/** @var string[] */
private $localDatabases;
/**
* @param Config $config
* @param IConnectionProvider $dbProvider
* @param HideUserUtils $hideUserUtils
*/
public function __construct(
Config $config,
IConnectionProvider $dbProvider,
HideUserUtils $hideUserUtils
) {
$this->sharedDB = $config->get( MainConfigNames::SharedDB );
$this->sharedTables = $config->get( MainConfigNames::SharedTables );
$this->localDatabases = $config->get( MainConfigNames::LocalDatabases );
$this->dbProvider = $dbProvider;
$this->hideUserUtils = $hideUserUtils;
}
public function isAttached( UserIdentity $user, $wikiId = UserIdentity::LOCAL ): bool {
// If the user has no ID, it can't be attached
if ( !$user->isRegistered() ) {
return false;
}
return $this->isWikiSharingOurUsers( $wikiId );
}
/**
* Check if the specified wiki shares a user table with the current wiki
*
* @param string|false $wikiId
* @return bool
*/
private function isWikiSharingOurUsers( $wikiId ) {
// Easy case, the local wiki
if ( !$wikiId || WikiMap::isCurrentWikiId( $wikiId ) ) {
return true;
}
// Assume that shared user tables are set up as described above, if
// they're being used at all.
return $this->sharedDB !== null &&
in_array( 'user', $this->sharedTables, true ) &&
in_array( $wikiId, $this->localDatabases, true );
}
public function lookupCentralIds(
array $idToName, $audience = self::AUDIENCE_PUBLIC, $flags = IDBAccessObject::READ_NORMAL
): array {
if ( !$idToName ) {
return [];
}
$audience = $this->checkAudience( $audience );
$db = DBAccessObjectUtils::getDBFromRecency( $this->dbProvider, $flags );
$queryBuilder = $db->newSelectQueryBuilder();
$queryBuilder
->select( [ 'user_id', 'user_name' ] )
->from( 'user' )
->where( [ 'user_id' => array_map( 'intval', array_keys( $idToName ) ) ] )
->recency( $flags );
if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
$this->hideUserUtils->addFieldToBuilder( $queryBuilder );
}
$res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
foreach ( $res as $row ) {
$idToName[$row->user_id] = empty( $row->hu_deleted ) ? $row->user_name : '';
}
return $idToName;
}
public function lookupUserNamesWithFilter(
array $nameToId, $filter, $audience = self::AUDIENCE_PUBLIC,
$flags = IDBAccessObject::READ_NORMAL,
$wikiId = UserIdentity::LOCAL
): array {
if ( !$nameToId ) {
return [];
}
if ( ( $filter === self::FILTER_ATTACHED || $filter === self::FILTER_OWNED )
&& !$this->isWikiSharingOurUsers( $wikiId )
) {
// No users pass the filter
return $nameToId;
}
$audience = $this->checkAudience( $audience );
$db = DBAccessObjectUtils::getDBFromRecency( $this->dbProvider, $flags );
$queryBuilder = $db->newSelectQueryBuilder();
$queryBuilder
->select( [ 'user_id', 'user_name' ] )
->from( 'user' )
->where( [ 'user_name' => array_map( 'strval', array_keys( $nameToId ) ) ] )
->recency( $flags );
if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
$queryBuilder->andWhere( $this->hideUserUtils->getExpression( $db ) );
}
$res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
foreach ( $res as $row ) {
$nameToId[$row->user_name] = (int)$row->user_id;
}
return $nameToId;
}
}
/** @deprecated class alias since 1.41 */
class_alias( LocalIdLookup::class, 'LocalIdLookup' );
|
