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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
<?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 Iterator;
use Wikimedia\Assert\Assert;
use Wikimedia\Assert\PreconditionException;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\SelectQueryBuilder;
class UserSelectQueryBuilder extends SelectQueryBuilder {
/** @var ActorStore */
private $actorStore;
/**
* @internal
* @param IDatabase $db
* @param ActorStore $actorStore
*/
public function __construct( IDatabase $db, ActorStore $actorStore ) {
parent::__construct( $db );
$this->actorStore = $actorStore;
$this->table( 'actor' );
}
/**
* Find by provided user ids.
*
* @param int|int[] $userIds
* @return UserSelectQueryBuilder
*/
public function whereUserIds( $userIds ): self {
Assert::parameterType( [ 'integer', 'array' ], $userIds, '$userIds' );
$this->conds( [ 'actor_user' => $userIds ] );
return $this;
}
/**
* Find by provided user ids.
* @deprecated since 1.37, use whereUserIds instead
* @param int|int[] $userIds
* @return UserSelectQueryBuilder
*/
public function userIds( $userIds ): self {
return $this->whereUserIds( $userIds );
}
/**
* Find by provided user names.
*
* @param string|string[] $userNames
* @return UserSelectQueryBuilder
*/
public function whereUserNames( $userNames ): self {
Assert::parameterType( [ 'string', 'array' ], $userNames, '$userIds' );
$userNames = array_map( function ( $name ) {
return $this->actorStore->normalizeUserName( (string)$name );
}, (array)$userNames );
$this->conds( [ 'actor_name' => $userNames ] );
return $this;
}
/**
* Find by provided user names.
* @deprecated since 1.37, use whereUserNames instead
* @param string|string[] $userNames
* @return UserSelectQueryBuilder
*/
public function userNames( $userNames ): self {
return $this->whereUserNames( $userNames );
}
/**
* Find users with names starting from the provided prefix.
*
* @note this could produce a huge number of results, like User00000 ... User99999,
* so you must set a limit when using this condition.
*
* @param string $prefix
* @return UserSelectQueryBuilder
*/
public function whereUserNamePrefix( string $prefix ): self {
if ( !isset( $this->options['LIMIT'] ) ) {
throw new PreconditionException( 'Must set a limit when using a user name prefix' );
}
$like = $this->db->buildLike( $prefix, $this->db->anyString() );
$this->conds( "actor_name{$like}" );
return $this;
}
/**
* Find users with names starting from the provided prefix.
*
* @note this could produce a huge number of results, like User00000 ... User99999,
* so you must set a limit when using this condition.
* @deprecated since 1.37 use whereUserNamePrefix instead
* @param string $prefix
* @return UserSelectQueryBuilder
*/
public function userNamePrefix( string $prefix ): self {
return $this->whereUserNamePrefix( $prefix );
}
/**
* Order results by name in $direction
*
* @param string $dir one of self::SORT_ACS or self::SORT_DESC
* @return UserSelectQueryBuilder
*/
public function orderByName( string $dir = self::SORT_ASC ): self {
$this->orderBy( 'actor_name', $dir );
return $this;
}
/**
* Order results by user id.
*
* @param string $dir one of self::SORT_ACS or self::SORT_DESC
* @return UserSelectQueryBuilder
*/
public function orderByUserId( string $dir = self::SORT_ASC ): self {
$this->orderBy( 'actor_user', $dir );
return $this;
}
/**
* Only return registered users.
*
* @return UserSelectQueryBuilder
*/
public function registered(): self {
$this->conds( [ 'actor_user != 0' ] );
return $this;
}
/**
* Only return anonymous users.
*
* @return UserSelectQueryBuilder
*/
public function anon(): self {
$this->conds( [ 'actor_user' => null ] );
return $this;
}
/**
* Filter based on user hidden status
*
* @since 1.38
* @param bool $hidden True - only hidden users, false - no hidden users
* @return $this
*/
public function hidden( bool $hidden ): self {
$this->leftJoin( 'ipblocks', null, [ "actor_user=ipb_user" ] );
if ( $hidden ) {
// only hidden users
$this->conds( [ 'ipb_deleted = 1' ] );
} else {
// filter out hidden users
$this->conds( [ 'ipb_deleted = 0 OR ipb_deleted IS NULL' ] );
}
return $this;
}
/**
* Fetch a single UserIdentity that matches specified criteria.
*
* @return UserIdentity|null
*/
public function fetchUserIdentity(): ?UserIdentity {
$this->fields( [ 'actor_id', 'actor_name', 'actor_user' ] );
$row = $this->fetchRow();
if ( !$row ) {
return null;
}
return $this->actorStore->newActorFromRow( $row );
}
/**
* Fetch UserIdentities for the specified query.
*
* @return Iterator<UserIdentity>
*/
public function fetchUserIdentities(): Iterator {
$this->fields( [ 'actor_id', 'actor_name', 'actor_user' ] );
return call_user_func( function () {
$result = $this->fetchResultSet();
foreach ( $result as $row ) {
yield $this->actorStore->newActorFromRow( $row );
}
$result->free();
} );
}
/**
* Returns an array of user names matching the query.
*
* @return string[]
*/
public function fetchUserNames(): array {
$this->field( 'actor_name' );
return $this->fetchFieldValues();
}
}
|
