MediaWiki  master
UsersPager.php
Go to the documentation of this file.
1 <?php
27 
35 class UsersPager extends AlphabeticPager {
36 
40  protected $userGroupCache;
41 
44 
46  protected $editsOnly;
47 
50 
52  protected $creationSort;
53 
55  protected $including;
56 
58  protected $requestedUser;
59 
66  public function __construct( IContextSource $context = null, $par = null, $including = null ) {
67  if ( $context ) {
68  $this->setContext( $context );
69  }
70 
71  $request = $this->getRequest();
72  $par = $par ?? '';
73  $parms = explode( '/', $par );
74  $symsForAll = [ '*', 'user' ];
75 
76  if ( $parms[0] != '' &&
77  ( in_array( $par, User::getAllGroups() ) || in_array( $par, $symsForAll ) )
78  ) {
79  $this->requestedGroup = $par;
80  $un = $request->getText( 'username' );
81  } elseif ( count( $parms ) == 2 ) {
82  $this->requestedGroup = $parms[0];
83  $un = $parms[1];
84  } else {
85  $this->requestedGroup = $request->getVal( 'group' );
86  $un = ( $par != '' ) ? $par : $request->getText( 'username' );
87  }
88 
89  if ( in_array( $this->requestedGroup, $symsForAll ) ) {
90  $this->requestedGroup = '';
91  }
92  $this->editsOnly = $request->getBool( 'editsOnly' );
93  $this->temporaryGroupsOnly = $request->getBool( 'temporaryGroupsOnly' );
94  $this->creationSort = $request->getBool( 'creationSort' );
95  $this->including = $including;
96  $this->mDefaultDirection = $request->getBool( 'desc' )
99 
100  $this->requestedUser = '';
101 
102  if ( $un != '' ) {
103  $username = Title::makeTitleSafe( NS_USER, $un );
104 
105  if ( $username !== null ) {
106  $this->requestedUser = $username->getText();
107  }
108  }
109 
110  parent::__construct();
111  }
112 
116  public function getIndexField() {
117  return $this->creationSort ? 'user_id' : 'user_name';
118  }
119 
123  public function getQueryInfo() {
124  $dbr = wfGetDB( DB_REPLICA );
125  $conds = [];
126 
127  // Don't show hidden names
128  if ( !MediaWikiServices::getInstance()
130  ->userHasRight( $this->getUser(), 'hideuser' )
131  ) {
132  $conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
133  }
134 
135  $options = [];
136 
137  if ( $this->requestedGroup != '' || $this->temporaryGroupsOnly ) {
138  $conds[] = 'ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ) .
139  ( !$this->temporaryGroupsOnly ? ' OR ug_expiry IS NULL' : '' );
140  }
141 
142  if ( $this->requestedGroup != '' ) {
143  $conds['ug_group'] = $this->requestedGroup;
144  }
145 
146  if ( $this->requestedUser != '' ) {
147  # Sorted either by account creation or name
148  if ( $this->creationSort ) {
149  $conds[] = 'user_id >= ' . intval( User::idFromName( $this->requestedUser ) );
150  } else {
151  $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser );
152  }
153  }
154 
155  if ( $this->editsOnly ) {
156  $conds[] = 'user_editcount > 0';
157  }
158 
159  $options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';
160 
161  $query = [
162  'tables' => [ 'user', 'user_groups', 'ipblocks' ],
163  'fields' => [
164  'user_name' => $this->creationSort ? 'MAX(user_name)' : 'user_name',
165  'user_id' => $this->creationSort ? 'user_id' : 'MAX(user_id)',
166  'edits' => 'MAX(user_editcount)',
167  'creation' => 'MIN(user_registration)',
168  'ipb_deleted' => 'MAX(ipb_deleted)', // block/hide status
169  'ipb_sitewide' => 'MAX(ipb_sitewide)'
170  ],
171  'options' => $options,
172  'join_conds' => [
173  'user_groups' => [ 'LEFT JOIN', 'user_id=ug_user' ],
174  'ipblocks' => [
175  'LEFT JOIN', [
176  'user_id=ipb_user',
177  'ipb_auto' => 0
178  ]
179  ],
180  ],
181  'conds' => $conds
182  ];
183 
184  $this->getHookRunner()->onSpecialListusersQueryInfo( $this, $query );
185 
186  return $query;
187  }
188 
193  public function formatRow( $row ) {
194  if ( $row->user_id == 0 ) { # T18487
195  return '';
196  }
197 
198  $userName = $row->user_name;
199 
200  $ulinks = Linker::userLink( $row->user_id, $userName );
202  $row->user_id,
203  $userName,
204  (int)$row->edits,
205  // don't render parentheses in HTML markup (CSS will provide)
206  false
207  );
208 
209  $lang = $this->getLanguage();
210 
211  $groups = '';
212  $ugms = self::getGroupMemberships( intval( $row->user_id ), $this->userGroupCache );
213 
214  if ( !$this->including && count( $ugms ) > 0 ) {
215  $list = [];
216  foreach ( $ugms as $ugm ) {
217  $list[] = $this->buildGroupLink( $ugm, $userName );
218  }
219  $groups = $lang->commaList( $list );
220  }
221 
222  $item = $lang->specialList( $ulinks, $groups );
223 
224  if ( $row->ipb_deleted ) {
225  $item = "<span class=\"deleted\">$item</span>";
226  }
227 
228  $edits = '';
229  if ( !$this->including && $this->getConfig()->get( 'Edititis' ) ) {
230  $count = $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped();
231  $edits = $this->msg( 'word-separator' )->escaped() . $this->msg( 'brackets', $count )->escaped();
232  }
233 
234  $created = '';
235  # Some rows may be null
236  if ( !$this->including && $row->creation ) {
237  $user = $this->getUser();
238  $d = $lang->userDate( $row->creation, $user );
239  $t = $lang->userTime( $row->creation, $user );
240  $created = $this->msg( 'usercreated', $d, $t, $row->user_name )->escaped();
241  $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
242  }
243 
244  $blocked = $row->ipb_deleted !== null && $row->ipb_sitewide === '1' ?
245  ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() :
246  '';
247 
248  $this->getHookRunner()->onSpecialListusersFormatRow( $item, $row );
249 
250  return Html::rawElement( 'li', [], "{$item}{$edits}{$created}{$blocked}" );
251  }
252 
253  protected function doBatchLookups() {
254  $batch = new LinkBatch();
255  $userIds = [];
256  # Give some pointers to make user links
257  foreach ( $this->mResult as $row ) {
258  $batch->add( NS_USER, $row->user_name );
259  $batch->add( NS_USER_TALK, $row->user_name );
260  $userIds[] = $row->user_id;
261  }
262 
263  // Lookup groups for all the users
264  $dbr = wfGetDB( DB_REPLICA );
265  $groupManager = MediaWikiServices::getInstance()->getUserGroupManager();
266  $groupsQueryInfo = $groupManager->getQueryInfo();
267  $groupRes = $dbr->select(
268  $groupsQueryInfo['tables'],
269  $groupsQueryInfo['fields'],
270  [ 'ug_user' => $userIds ],
271  __METHOD__,
272  $groupsQueryInfo['joins']
273  );
274  $cache = [];
275  $groups = [];
276  foreach ( $groupRes as $row ) {
277  $ugm = $groupManager->newGroupMembershipFromRow( $row );
278  if ( !$ugm->isExpired() ) {
279  $cache[$row->ug_user][$row->ug_group] = $ugm;
280  $groups[$row->ug_group] = true;
281  }
282  }
283 
284  // Give extensions a chance to add things like global user group data
285  // into the cache array to ensure proper output later on
286  $this->getHookRunner()->onUsersPagerDoBatchLookups( $dbr, $userIds, $cache, $groups );
287 
288  $this->userGroupCache = $cache;
289 
290  // Add page of groups to link batch
291  foreach ( $groups as $group => $unused ) {
292  $groupPage = UserGroupMembership::getGroupPage( $group );
293  if ( $groupPage ) {
294  $batch->addObj( $groupPage );
295  }
296  }
297 
298  $batch->execute();
299  $this->mResult->rewind();
300  }
301 
305  public function getPageHeader() {
306  $self = explode( '/', $this->getTitle()->getPrefixedDBkey(), 2 )[0];
307 
308  $groupOptions = [ $this->msg( 'group-all' )->text() => '' ];
309  foreach ( $this->getAllGroups() as $group => $groupText ) {
310  $groupOptions[ $groupText ] = $group;
311  }
312 
313  $formDescriptor = [
314  'user' => [
315  'class' => HTMLUserTextField::class,
316  'label' => $this->msg( 'listusersfrom' )->text(),
317  'name' => 'username',
318  'default' => $this->requestedUser,
319  ],
320  'dropdown' => [
321  'label' => $this->msg( 'group' )->text(),
322  'name' => 'group',
323  'default' => $this->requestedGroup,
324  'class' => HTMLSelectField::class,
325  'options' => $groupOptions,
326  ],
327  'editsOnly' => [
328  'type' => 'check',
329  'label' => $this->msg( 'listusers-editsonly' )->text(),
330  'name' => 'editsOnly',
331  'id' => 'editsOnly',
332  'default' => $this->editsOnly
333  ],
334  'temporaryGroupsOnly' => [
335  'type' => 'check',
336  'label' => $this->msg( 'listusers-temporarygroupsonly' )->text(),
337  'name' => 'temporaryGroupsOnly',
338  'id' => 'temporaryGroupsOnly',
339  'default' => $this->temporaryGroupsOnly
340  ],
341  'creationSort' => [
342  'type' => 'check',
343  'label' => $this->msg( 'listusers-creationsort' )->text(),
344  'name' => 'creationSort',
345  'id' => 'creationSort',
346  'default' => $this->creationSort
347  ],
348  'desc' => [
349  'type' => 'check',
350  'label' => $this->msg( 'listusers-desc' )->text(),
351  'name' => 'desc',
352  'id' => 'desc',
353  'default' => $this->mDefaultDirection
354  ],
355  'limithiddenfield' => [
356  'class' => HTMLHiddenField::class,
357  'name' => 'limit',
358  'default' => $this->mLimit
359  ]
360  ];
361 
362  $beforeSubmitButtonHookOut = '';
363  $this->getHookRunner()->onSpecialListusersHeaderForm( $this, $beforeSubmitButtonHookOut );
364 
365  if ( $beforeSubmitButtonHookOut !== '' ) {
366  $formDescriptor[ 'beforeSubmitButtonHookOut' ] = [
367  'class' => HTMLInfoField::class,
368  'raw' => true,
369  'default' => $beforeSubmitButtonHookOut
370  ];
371  }
372 
373  $formDescriptor[ 'submit' ] = [
374  'class' => HTMLSubmitField::class,
375  'buttonlabel-message' => 'listusers-submit',
376  ];
377 
378  $beforeClosingFieldsetHookOut = '';
379  $this->getHookRunner()->onSpecialListusersHeader( $this, $beforeClosingFieldsetHookOut );
380 
381  if ( $beforeClosingFieldsetHookOut !== '' ) {
382  $formDescriptor[ 'beforeClosingFieldsetHookOut' ] = [
383  'class' => HTMLInfoField::class,
384  'raw' => true,
385  'default' => $beforeClosingFieldsetHookOut
386  ];
387  }
388 
389  $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
390  $htmlForm
391  ->setMethod( 'get' )
392  ->setAction( Title::newFromText( $self )->getLocalURL() )
393  ->setId( 'mw-listusers-form' )
394  ->setFormIdentifier( 'mw-listusers-form' )
395  ->suppressDefaultSubmit()
396  ->setWrapperLegendMsg( 'listusers' );
397  return $htmlForm->prepareForm()->getHTML( true );
398  }
399 
404  private function getAllGroups() {
405  $result = [];
406  foreach ( User::getAllGroups() as $group ) {
407  $result[$group] = UserGroupMembership::getGroupName( $group );
408  }
409  asort( $result );
410 
411  return $result;
412  }
413 
418  public function getDefaultQuery() {
419  $query = parent::getDefaultQuery();
420  if ( $this->requestedGroup != '' ) {
421  $query['group'] = $this->requestedGroup;
422  }
423  if ( $this->requestedUser != '' ) {
424  $query['username'] = $this->requestedUser;
425  }
426  $this->getHookRunner()->onSpecialListusersDefaultQuery( $this, $query );
427 
428  return $query;
429  }
430 
439  protected static function getGroupMemberships( $uid, $cache = null ) {
440  if ( $cache === null ) {
441  $user = User::newFromId( $uid );
442  return $user->getGroupMemberships();
443  } else {
444  return $cache[$uid] ?? [];
445  }
446  }
447 
455  protected function buildGroupLink( $group, $username ) {
456  return UserGroupMembership::getLink( $group, $this->getContext(), 'html', $username );
457  }
458 }
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
IndexPager\$mLimit
int $mLimit
The maximum number of entries to show.
Definition: IndexPager.php:95
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:557
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:329
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
IndexPager\$mDefaultDirection
bool $mDefaultDirection
$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.
Definition: IndexPager.php:132
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:35
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:896
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:152
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:37
UsersPager\$creationSort
bool $creationSort
Definition: UsersPager.php:52
UsersPager\getIndexField
getIndexField()
Definition: UsersPager.php:116
UsersPager\buildGroupLink
buildGroupLink( $group, $username)
Format a link to a group description page.
Definition: UsersPager.php:455
UserGroupMembership\getGroupName
static getGroupName( $group)
Gets the localized friendly name for a group, if it exists.
Definition: UserGroupMembership.php:344
UsersPager\$editsOnly
bool $editsOnly
Definition: UsersPager.php:46
UsersPager\$requestedGroup
string $requestedGroup
Definition: UsersPager.php:43
AlphabeticPager
IndexPager with an alphabetic list and a formatted navigation bar.
Definition: AlphabeticPager.php:28
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
UsersPager\__construct
__construct(IContextSource $context=null, $par=null, $including=null)
Definition: UsersPager.php:66
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ContextSource\getTitle
getTitle()
Definition: ContextSource.php:79
UserGroupMembership\getGroupPage
static getGroupPage( $group)
Gets the title of a page describing a particular user group.
Definition: UserGroupMembership.php:369
IndexPager\DIR_ASCENDING
const DIR_ASCENDING
Backwards-compatible constant for $mDefaultDirection field (do not change)
Definition: IndexPager.php:77
UsersPager\getPageHeader
getPageHeader()
Definition: UsersPager.php:305
UsersPager\$requestedUser
string $requestedUser
Definition: UsersPager.php:58
$dbr
$dbr
Definition: testCompression.php:54
ContextSource\getLanguage
getLanguage()
Definition: ContextSource.php:128
UsersPager\getDefaultQuery
getDefaultQuery()
Preserve group and username offset parameters when paging.
Definition: UsersPager.php:418
UserGroupMembership\getLink
static getLink( $ugm, IContextSource $context, $format, $userName=null)
Gets a link for a user group, possibly including the expiry date if relevant.
Definition: UserGroupMembership.php:279
UsersPager\doBatchLookups
doBatchLookups()
Called from getBody(), before getStartBody() is called and after doQuery() was called.
Definition: UsersPager.php:253
getPermissionManager
getPermissionManager()
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2464
UsersPager\$including
bool null $including
Definition: UsersPager.php:55
UsersPager
This class is used to get a list of user.
Definition: UsersPager.php:35
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
UsersPager\$temporaryGroupsOnly
bool $temporaryGroupsOnly
Definition: UsersPager.php:49
ContextSource\setContext
setContext(IContextSource $context)
Definition: ContextSource.php:55
UsersPager\getAllGroups
getAllGroups()
Get a list of all explicit groups.
Definition: UsersPager.php:404
ContextSource\msg
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:618
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:72
UsersPager\formatRow
formatRow( $row)
Definition: UsersPager.php:193
Linker\userToolLinksRedContribs
static userToolLinksRedContribs( $userId, $userText, $edits=null, $useParentheses=true)
Alias for userToolLinks( $userId, $userText, true );.
Definition: Linker.php:1023
User\getAllGroups
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4271
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
UsersPager\getGroupMemberships
static getGroupMemberships( $uid, $cache=null)
Get an associative array containing groups the specified user belongs to, and the relevant UserGroupM...
Definition: UsersPager.php:439
IndexPager\DIR_DESCENDING
const DIR_DESCENDING
Backwards-compatible constant for $mDefaultDirection field (do not change)
Definition: IndexPager.php:79
UsersPager\$userGroupCache
array[] $userGroupCache
A array with user ids as key and a array of groups as value.
Definition: UsersPager.php:40
$self
$self
Definition: doMaintenance.php:63
UsersPager\getQueryInfo
getQueryInfo()
Definition: UsersPager.php:123
$cache
$cache
Definition: mcc.php:33
User\idFromName
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:879
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
NS_USER
const NS_USER
Definition: Defines.php:71
$t
$t
Definition: testCompression.php:74
HTMLForm\factory
static factory( $displayFormat,... $arguments)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:311