3 * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
4 * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
5 * 2006 Rob Church <robchur@gmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
27 * This class is used to get a list of user. The ones with specials
28 * rights (sysop, bureaucrat, developer) will have them displayed
29 * next to their names.
33 class UsersPager
extends AlphabeticPager
{
36 * @var array[] A array with user ids as key and a array of groups as value
38 protected $userGroupCache;
41 * @param IContextSource $context
42 * @param array $par (Default null)
43 * @param bool $including Whether this page is being transcluded in
46 function __construct( IContextSource
$context = null, $par = null, $including = null ) {
48 $this->setContext( $context );
51 $request = $this->getRequest();
52 $par = ( $par !== null ) ?
$par : '';
53 $parms = explode( '/', $par );
54 $symsForAll = [ '*', 'user' ];
56 if ( $parms[0] != '' &&
57 ( in_array( $par, User
::getAllGroups() ) ||
in_array( $par, $symsForAll ) )
59 $this->requestedGroup
= $par;
60 $un = $request->getText( 'username' );
61 } elseif ( count( $parms ) == 2 ) {
62 $this->requestedGroup
= $parms[0];
65 $this->requestedGroup
= $request->getVal( 'group' );
66 $un = ( $par != '' ) ?
$par : $request->getText( 'username' );
69 if ( in_array( $this->requestedGroup
, $symsForAll ) ) {
70 $this->requestedGroup
= '';
72 $this->editsOnly
= $request->getBool( 'editsOnly' );
73 $this->temporaryGroupsOnly
= $request->getBool( 'temporaryGroupsOnly' );
74 $this->creationSort
= $request->getBool( 'creationSort' );
75 $this->including
= $including;
76 $this->mDefaultDirection
= $request->getBool( 'desc' )
77 ? IndexPager
::DIR_DESCENDING
78 : IndexPager
::DIR_ASCENDING
;
80 $this->requestedUser
= '';
83 $username = Title
::makeTitleSafe( NS_USER
, $un );
85 if ( !is_null( $username ) ) {
86 $this->requestedUser
= $username->getText();
90 parent
::__construct();
96 function getIndexField() {
97 return $this->creationSort ?
'user_id' : 'user_name';
103 function getQueryInfo() {
104 $dbr = wfGetDB( DB_REPLICA
);
107 // Don't show hidden names
108 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
109 $conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
114 if ( $this->requestedGroup
!= '' ||
$this->temporaryGroupsOnly
) {
115 $conds[] = 'ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ) .
116 ( !$this->temporaryGroupsOnly ?
' OR ug_expiry IS NULL' : '' );
119 if ( $this->requestedGroup
!= '' ) {
120 $conds['ug_group'] = $this->requestedGroup
;
123 if ( $this->requestedUser
!= '' ) {
124 # Sorted either by account creation or name
125 if ( $this->creationSort
) {
126 $conds[] = 'user_id >= ' . intval( User
::idFromName( $this->requestedUser
) );
128 $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser
);
132 if ( $this->editsOnly
) {
133 $conds[] = 'user_editcount > 0';
136 $options['GROUP BY'] = $this->creationSort ?
'user_id' : 'user_name';
139 'tables' => [ 'user', 'user_groups', 'ipblocks' ],
141 'user_name' => $this->creationSort ?
'MAX(user_name)' : 'user_name',
142 'user_id' => $this->creationSort ?
'user_id' : 'MAX(user_id)',
143 'edits' => 'MAX(user_editcount)',
144 'creation' => 'MIN(user_registration)',
145 'ipb_deleted' => 'MAX(ipb_deleted)' // block/hide status
147 'options' => $options,
149 'user_groups' => [ 'LEFT JOIN', 'user_id=ug_user' ],
160 Hooks
::run( 'SpecialListusersQueryInfo', [ $this, &$query ] );
166 * @param stdClass $row
169 function formatRow( $row ) {
170 if ( $row->user_id
== 0 ) { # T18487
174 $userName = $row->user_name
;
176 $ulinks = Linker
::userLink( $row->user_id
, $userName );
177 $ulinks .= Linker
::userToolLinksRedContribs(
183 $lang = $this->getLanguage();
186 $ugms = self
::getGroupMemberships( intval( $row->user_id
), $this->userGroupCache
);
188 if ( !$this->including
&& count( $ugms ) > 0 ) {
190 foreach ( $ugms as $ugm ) {
191 $list[] = $this->buildGroupLink( $ugm, $userName );
193 $groups = $lang->commaList( $list );
196 $item = $lang->specialList( $ulinks, $groups );
198 if ( $row->ipb_deleted
) {
199 $item = "<span class=\"deleted\">$item</span>";
203 if ( !$this->including
&& $this->getConfig()->get( 'Edititis' ) ) {
204 $count = $this->msg( 'usereditcount' )->numParams( $row->edits
)->escaped();
205 $edits = $this->msg( 'word-separator' )->escaped() . $this->msg( 'brackets', $count )->escaped();
209 # Some rows may be null
210 if ( !$this->including
&& $row->creation
) {
211 $user = $this->getUser();
212 $d = $lang->userDate( $row->creation
, $user );
213 $t = $lang->userTime( $row->creation
, $user );
214 $created = $this->msg( 'usercreated', $d, $t, $row->user_name
)->escaped();
215 $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
217 $blocked = !is_null( $row->ipb_deleted
) ?
218 ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() :
221 Hooks
::run( 'SpecialListusersFormatRow', [ &$item, $row ] );
223 return Html
::rawElement( 'li', [], "{$item}{$edits}{$created}{$blocked}" );
226 function doBatchLookups() {
227 $batch = new LinkBatch();
229 # Give some pointers to make user links
230 foreach ( $this->mResult
as $row ) {
231 $batch->add( NS_USER
, $row->user_name
);
232 $batch->add( NS_USER_TALK
, $row->user_name
);
233 $userIds[] = $row->user_id
;
236 // Lookup groups for all the users
237 $dbr = wfGetDB( DB_REPLICA
);
238 $groupRes = $dbr->select(
240 UserGroupMembership
::selectFields(),
241 [ 'ug_user' => $userIds ],
246 foreach ( $groupRes as $row ) {
247 $ugm = UserGroupMembership
::newFromRow( $row );
248 if ( !$ugm->isExpired() ) {
249 $cache[$row->ug_user
][$row->ug_group
] = $ugm;
250 $groups[$row->ug_group
] = true;
254 // Give extensions a chance to add things like global user group data
255 // into the cache array to ensure proper output later on
256 Hooks
::run( 'UsersPagerDoBatchLookups', [ $dbr, $userIds, &$cache, &$groups ] );
258 $this->userGroupCache
= $cache;
260 // Add page of groups to link batch
261 foreach ( $groups as $group => $unused ) {
262 $groupPage = UserGroupMembership
::getGroupPage( $group );
264 $batch->addObj( $groupPage );
269 $this->mResult
->rewind();
275 function getPageHeader() {
276 list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
278 $groupOptions = [ $this->msg( 'group-all' )->text() => '' ];
279 foreach ( $this->getAllGroups() as $group => $groupText ) {
280 $groupOptions[ $groupText ] = $group;
285 'class' => HTMLUserTextField
::class,
286 'label' => $this->msg( 'listusersfrom' )->text(),
287 'name' => 'username',
288 'default' => $this->requestedUser
,
291 'label' => $this->msg( 'group' )->text(),
293 'default' => $this->requestedGroup
,
294 'class' => HTMLSelectField
::class,
295 'options' => $groupOptions,
299 'label' => $this->msg( 'listusers-editsonly' )->text(),
300 'name' => 'editsOnly',
302 'default' => $this->editsOnly
304 'temporaryGroupsOnly' => [
306 'label' => $this->msg( 'listusers-temporarygroupsonly' )->text(),
307 'name' => 'temporaryGroupsOnly',
308 'id' => 'temporaryGroupsOnly',
309 'default' => $this->temporaryGroupsOnly
313 'label' => $this->msg( 'listusers-creationsort' )->text(),
314 'name' => 'creationSort',
315 'id' => 'creationSort',
316 'default' => $this->creationSort
320 'label' => $this->msg( 'listusers-desc' )->text(),
323 'default' => $this->mDefaultDirection
325 'limithiddenfield' => [
326 'class' => HTMLHiddenField
::class,
328 'default' => $this->mLimit
332 $beforeSubmitButtonHookOut = '';
333 Hooks
::run( 'SpecialListusersHeaderForm', [ $this, &$beforeSubmitButtonHookOut ] );
335 if ( $beforeSubmitButtonHookOut !== '' ) {
336 $formDescriptior[ 'beforeSubmitButtonHookOut' ] = [
337 'class' => HTMLInfoField
::class,
339 'default' => $beforeSubmitButtonHookOut
343 $formDescriptor[ 'submit' ] = [
344 'class' => HTMLSubmitField
::class,
345 'buttonlabel-message' => 'listusers-submit',
348 $beforeClosingFieldsetHookOut = '';
349 Hooks
::run( 'SpecialListusersHeader', [ $this, &$beforeClosingFieldsetHookOut ] );
351 if ( $beforeClosingFieldsetHookOut !== '' ) {
352 $formDescriptior[ 'beforeClosingFieldsetHookOut' ] = [
353 'class' => HTMLInfoField
::class,
355 'default' => $beforeClosingFieldsetHookOut
359 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
362 ->setAction( Title
::newFromText( $self )->getLocalURL() )
363 ->setId( 'mw-listusers-form' )
364 ->setFormIdentifier( 'mw-listusers-form' )
365 ->suppressDefaultSubmit()
366 ->setWrapperLegendMsg( 'listusers' );
367 return $htmlForm->prepareForm()->getHTML( true );
371 * Get a list of all explicit groups
374 function getAllGroups() {
376 foreach ( User
::getAllGroups() as $group ) {
377 $result[$group] = UserGroupMembership
::getGroupName( $group );
385 * Preserve group and username offset parameters when paging
388 function getDefaultQuery() {
389 $query = parent
::getDefaultQuery();
390 if ( $this->requestedGroup
!= '' ) {
391 $query['group'] = $this->requestedGroup
;
393 if ( $this->requestedUser
!= '' ) {
394 $query['username'] = $this->requestedUser
;
396 Hooks
::run( 'SpecialListusersDefaultQuery', [ $this, &$query ] );
402 * Get an associative array containing groups the specified user belongs to,
403 * and the relevant UserGroupMembership objects
405 * @param int $uid User id
406 * @param array[]|null $cache
407 * @return UserGroupMembership[] (group name => UserGroupMembership object)
409 protected static function getGroupMemberships( $uid, $cache = null ) {
410 if ( $cache === null ) {
411 $user = User
::newFromId( $uid );
412 return $user->getGroupMemberships();
414 return isset( $cache[$uid] ) ?
$cache[$uid] : [];
419 * Format a link to a group description page
421 * @param string|UserGroupMembership $group Group name or UserGroupMembership object
422 * @param string $username
425 protected function buildGroupLink( $group, $username ) {
426 return UserGroupMembership
::getLink( $group, $this->getContext(), 'html', $username );