3 * Implements Special:Listusers
5 * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
6 * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
7 * 2006 Rob Church <robchur@gmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 * @ingroup SpecialPage
29 * This class is used to get a list of user. The ones with specials
30 * rights (sysop, bureaucrat, developer) will have them displayed
31 * next to their names.
33 * @ingroup SpecialPage
35 class UsersPager
extends AlphabeticPager
{
38 * @param $context IContextSource
39 * @param $par null|array
41 function __construct( IContextSource
$context = null, $par = null, $including = null ) {
43 $this->setContext( $context );
46 $request = $this->getRequest();
47 $par = ( $par !== null ) ?
$par : '';
48 $parms = explode( '/', $par );
49 $symsForAll = array( '*', 'user' );
50 if ( $parms[0] != '' && ( in_array( $par, User
::getAllGroups() ) ||
in_array( $par, $symsForAll ) ) ) {
51 $this->requestedGroup
= $par;
52 $un = $request->getText( 'username' );
53 } elseif ( count( $parms ) == 2 ) {
54 $this->requestedGroup
= $parms[0];
57 $this->requestedGroup
= $request->getVal( 'group' );
58 $un = ( $par != '' ) ?
$par : $request->getText( 'username' );
60 if ( in_array( $this->requestedGroup
, $symsForAll ) ) {
61 $this->requestedGroup
= '';
63 $this->editsOnly
= $request->getBool( 'editsOnly' );
64 $this->creationSort
= $request->getBool( 'creationSort' );
65 $this->including
= $including;
67 $this->requestedUser
= '';
69 $username = Title
::makeTitleSafe( NS_USER
, $un );
70 if( ! is_null( $username ) ) {
71 $this->requestedUser
= $username->getText();
74 parent
::__construct();
80 function getIndexField() {
81 return $this->creationSort ?
'user_id' : 'user_name';
87 function getQueryInfo() {
88 $dbr = wfGetDB( DB_SLAVE
);
90 // Don't show hidden names
91 if( !$this->getUser()->isAllowed('hideuser') ) {
92 $conds[] = 'ipb_deleted IS NULL';
97 if( $this->requestedGroup
!= '' ) {
98 $conds['ug_group'] = $this->requestedGroup
;
100 //$options['USE INDEX'] = $this->creationSort ? 'PRIMARY' : 'user_name';
102 if( $this->requestedUser
!= '' ) {
103 # Sorted either by account creation or name
104 if( $this->creationSort
) {
105 $conds[] = 'user_id >= ' . intval( User
::idFromName( $this->requestedUser
) );
107 $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser
);
110 if( $this->editsOnly
) {
111 $conds[] = 'user_editcount > 0';
114 $options['GROUP BY'] = $this->creationSort ?
'user_id' : 'user_name';
117 'tables' => array( 'user', 'user_groups', 'ipblocks'),
119 $this->creationSort ?
'MAX(user_name) AS user_name' : 'user_name',
120 $this->creationSort ?
'user_id' : 'MAX(user_id) AS user_id',
121 'MAX(user_editcount) AS edits',
122 'COUNT(ug_group) AS numgroups',
123 'MAX(ug_group) AS singlegroup', // the usergroup if there is only one
124 'MIN(user_registration) AS creation',
125 'MAX(ipb_deleted) AS ipb_deleted' // block/hide status
127 'options' => $options,
128 'join_conds' => array(
129 'user_groups' => array( 'LEFT JOIN', 'user_id=ug_user' ),
130 'ipblocks' => array( 'LEFT JOIN', 'user_id=ipb_user AND ipb_deleted=1 AND ipb_auto=0' ),
135 wfRunHooks( 'SpecialListusersQueryInfo', array( $this, &$query ) );
143 function formatRow( $row ) {
144 if ( $row->user_id
== 0 ) { #Bug 16487
148 $userName = $row->user_name
;
150 $ulinks = Linker
::userLink( $row->user_id
, $userName );
151 $ulinks .= Linker
::userToolLinks( $row->user_id
, $userName );
153 $lang = $this->getLanguage();
156 $groups_list = self
::getGroups( $row->user_id
);
157 if( !$this->including
&& count( $groups_list ) > 0 ) {
159 foreach( $groups_list as $group )
160 $list[] = self
::buildGroupLink( $group, $userName );
161 $groups = $lang->commaList( $list );
164 $item = $lang->specialList( $ulinks, $groups );
165 if( $row->ipb_deleted
) {
166 $item = "<span class=\"deleted\">$item</span>";
171 if ( !$this->including
&& $wgEdititis ) {
172 $edits = ' [' . $this->msg( 'usereditcount' )->numParams( $row->edits
)->escaped() . ']';
176 # Some rows may be NULL
177 if( !$this->including
&& $row->creation
) {
178 $user = $this->getUser();
179 $d = $lang->userDate( $row->creation
, $user );
180 $t = $lang->userTime( $row->creation
, $user );
181 $created = $this->msg( 'usercreated', $d, $t, $row->user_name
)->escaped();
182 $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
185 wfRunHooks( 'SpecialListusersFormatRow', array( &$item, $row ) );
186 return "<li>{$item}{$edits}{$created}</li>";
189 function doBatchLookups() {
190 $batch = new LinkBatch();
191 # Give some pointers to make user links
192 foreach ( $this->mResult
as $row ) {
193 $batch->add( NS_USER
, $row->user_name
);
194 $batch->add( NS_USER_TALK
, $row->user_name
);
197 $this->mResult
->rewind();
203 function getPageHeader( ) {
206 list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
209 $out = Xml
::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-listusers-form' ) ) .
210 Xml
::fieldset( $this->msg( 'listusers' )->text() ) .
211 Html
::hidden( 'title', $self );
214 $out .= Xml
::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
215 Xml
::input( 'username', 20, $this->requestedUser
, array( 'id' => 'offset' ) ) . ' ';
217 # Group drop-down list
218 $out .= Xml
::label( $this->msg( 'group' )->text(), 'group' ) . ' ' .
219 Xml
::openElement('select', array( 'name' => 'group', 'id' => 'group' ) ) .
220 Xml
::option( $this->msg( 'group-all' )->text(), '' );
221 foreach( $this->getAllGroups() as $group => $groupText )
222 $out .= Xml
::option( $groupText, $group, $group == $this->requestedGroup
);
223 $out .= Xml
::closeElement( 'select' ) . '<br />';
224 $out .= Xml
::checkLabel( $this->msg( 'listusers-editsonly' )->text(), 'editsOnly', 'editsOnly', $this->editsOnly
);
226 $out .= Xml
::checkLabel( $this->msg( 'listusers-creationsort' )->text(), 'creationSort', 'creationSort', $this->creationSort
);
229 wfRunHooks( 'SpecialListusersHeaderForm', array( $this, &$out ) );
231 # Submit button and form bottom
232 $out .= Html
::hidden( 'limit', $this->mLimit
);
233 $out .= Xml
::submitButton( $this->msg( 'allpagessubmit' )->text() );
234 wfRunHooks( 'SpecialListusersHeader', array( $this, &$out ) );
235 $out .= Xml
::closeElement( 'fieldset' ) .
236 Xml
::closeElement( 'form' );
242 * Get a list of all explicit groups
245 function getAllGroups() {
247 foreach( User
::getAllGroups() as $group ) {
248 $result[$group] = User
::getGroupName( $group );
255 * Preserve group and username offset parameters when paging
258 function getDefaultQuery() {
259 $query = parent
::getDefaultQuery();
260 if( $this->requestedGroup
!= '' ) {
261 $query['group'] = $this->requestedGroup
;
263 if( $this->requestedUser
!= '' ) {
264 $query['username'] = $this->requestedUser
;
266 wfRunHooks( 'SpecialListusersDefaultQuery', array( $this, &$query ) );
271 * Get a list of groups the specified user belongs to
273 * @param $uid Integer: user id
276 protected static function getGroups( $uid ) {
277 $user = User
::newFromId( $uid );
278 $groups = array_diff( $user->getEffectiveGroups(), User
::getImplicitGroups() );
283 * Format a link to a group description page
285 * @param $group String: group name
286 * @param $username String Username
289 protected static function buildGroupLink( $group, $username ) {
290 return User
::makeGroupLinkHtml( $group, htmlspecialchars( User
::getGroupMember( $group, $username ) ) );
295 * @ingroup SpecialPage
297 class SpecialListUsers
extends SpecialPage
{
302 public function __construct() {
303 parent
::__construct( 'Listusers' );
304 $this->mIncludable
= true;
308 * Show the special page
310 * @param $par string (optional) A group to list users from
312 public function execute( $par ) {
314 $this->outputHeader();
316 $up = new UsersPager( $this->getContext(), $par, $this->including() );
318 # getBody() first to check, if empty
319 $usersbody = $up->getBody();
322 if ( !$this->including() ) {
323 $s = $up->getPageHeader();
327 $s .= $up->getNavigationBar();
328 $s .= Html
::rawElement( 'ul', array(), $usersbody );
329 $s .= $up->getNavigationBar();
331 $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
334 $this->getOutput()->addHTML( $s );