8b448281c528ef3bf52eb6424fe099c924e3b54a
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 array (Default null)
40 * @param $including boolean Whether this page is being transcluded in
43 function __construct( IContextSource
$context = null, $par = null, $including = null ) {
45 $this->setContext( $context );
48 $request = $this->getRequest();
49 $par = ( $par !== null ) ?
$par : '';
50 $parms = explode( '/', $par );
51 $symsForAll = array( '*', 'user' );
52 if ( $parms[0] != '' && ( in_array( $par, User
::getAllGroups() ) ||
in_array( $par, $symsForAll ) ) ) {
53 $this->requestedGroup
= $par;
54 $un = $request->getText( 'username' );
55 } elseif ( count( $parms ) == 2 ) {
56 $this->requestedGroup
= $parms[0];
59 $this->requestedGroup
= $request->getVal( 'group' );
60 $un = ( $par != '' ) ?
$par : $request->getText( 'username' );
62 if ( in_array( $this->requestedGroup
, $symsForAll ) ) {
63 $this->requestedGroup
= '';
65 $this->editsOnly
= $request->getBool( 'editsOnly' );
66 $this->creationSort
= $request->getBool( 'creationSort' );
67 $this->including
= $including;
69 $this->requestedUser
= '';
71 $username = Title
::makeTitleSafe( NS_USER
, $un );
72 if( ! is_null( $username ) ) {
73 $this->requestedUser
= $username->getText();
76 parent
::__construct();
82 function getIndexField() {
83 return $this->creationSort ?
'user_id' : 'user_name';
89 function getQueryInfo() {
90 $dbr = wfGetDB( DB_SLAVE
);
92 // Don't show hidden names
93 if( !$this->getUser()->isAllowed( 'hideuser' ) ) {
94 $conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
99 if( $this->requestedGroup
!= '' ) {
100 $conds['ug_group'] = $this->requestedGroup
;
102 //$options['USE INDEX'] = $this->creationSort ? 'PRIMARY' : 'user_name';
104 if( $this->requestedUser
!= '' ) {
105 # Sorted either by account creation or name
106 if( $this->creationSort
) {
107 $conds[] = 'user_id >= ' . intval( User
::idFromName( $this->requestedUser
) );
109 $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser
);
112 if( $this->editsOnly
) {
113 $conds[] = 'user_editcount > 0';
116 $options['GROUP BY'] = $this->creationSort ?
'user_id' : 'user_name';
119 'tables' => array( 'user', 'user_groups', 'ipblocks'),
121 'user_name' => $this->creationSort ?
'MAX(user_name)' : 'user_name',
122 'user_id' => $this->creationSort ?
'user_id' : 'MAX(user_id)',
123 'edits' => 'MAX(user_editcount)',
124 'numgroups' => 'COUNT(ug_group)',
125 'singlegroup' => 'MAX(ug_group)', // the usergroup if there is only one
126 'creation' => 'MIN(user_registration)',
127 'ipb_deleted' => 'MAX(ipb_deleted)' // block/hide status
129 'options' => $options,
130 'join_conds' => array(
131 'user_groups' => array( 'LEFT JOIN', 'user_id=ug_user' ),
132 'ipblocks' => array( 'LEFT JOIN', array(
140 wfRunHooks( 'SpecialListusersQueryInfo', array( $this, &$query ) );
148 function formatRow( $row ) {
149 if ( $row->user_id
== 0 ) { #Bug 16487
153 $userName = $row->user_name
;
155 $ulinks = Linker
::userLink( $row->user_id
, $userName );
156 $ulinks .= Linker
::userToolLinks( $row->user_id
, $userName );
158 $lang = $this->getLanguage();
161 $groups_list = self
::getGroups( $row->user_id
);
162 if( !$this->including
&& count( $groups_list ) > 0 ) {
164 foreach( $groups_list as $group )
165 $list[] = self
::buildGroupLink( $group, $userName );
166 $groups = $lang->commaList( $list );
169 $item = $lang->specialList( $ulinks, $groups );
170 if( $row->ipb_deleted
) {
171 $item = "<span class=\"deleted\">$item</span>";
176 if ( !$this->including
&& $wgEdititis ) {
177 $edits = ' [' . $this->msg( 'usereditcount' )->numParams( $row->edits
)->escaped() . ']';
181 # Some rows may be NULL
182 if( !$this->including
&& $row->creation
) {
183 $user = $this->getUser();
184 $d = $lang->userDate( $row->creation
, $user );
185 $t = $lang->userTime( $row->creation
, $user );
186 $created = $this->msg( 'usercreated', $d, $t, $row->user_name
)->escaped();
187 $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
189 $blocked = !is_null( $row->ipb_deleted
) ?
' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';
191 wfRunHooks( 'SpecialListusersFormatRow', array( &$item, $row ) );
192 return Html
::rawElement( 'li', array(), "{$item}{$edits}{$created}{$blocked}" );
195 function doBatchLookups() {
196 $batch = new LinkBatch();
197 # Give some pointers to make user links
198 foreach ( $this->mResult
as $row ) {
199 $batch->add( NS_USER
, $row->user_name
);
200 $batch->add( NS_USER_TALK
, $row->user_name
);
203 $this->mResult
->rewind();
209 function getPageHeader( ) {
212 list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
215 $out = Xml
::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-listusers-form' ) ) .
216 Xml
::fieldset( $this->msg( 'listusers' )->text() ) .
217 Html
::hidden( 'title', $self );
220 $out .= Xml
::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
221 Xml
::input( 'username', 20, $this->requestedUser
, array( 'id' => 'offset' ) ) . ' ';
223 # Group drop-down list
224 $out .= Xml
::label( $this->msg( 'group' )->text(), 'group' ) . ' ' .
225 Xml
::openElement('select', array( 'name' => 'group', 'id' => 'group' ) ) .
226 Xml
::option( $this->msg( 'group-all' )->text(), '' );
227 foreach( $this->getAllGroups() as $group => $groupText )
228 $out .= Xml
::option( $groupText, $group, $group == $this->requestedGroup
);
229 $out .= Xml
::closeElement( 'select' ) . '<br />';
230 $out .= Xml
::checkLabel( $this->msg( 'listusers-editsonly' )->text(), 'editsOnly', 'editsOnly', $this->editsOnly
);
232 $out .= Xml
::checkLabel( $this->msg( 'listusers-creationsort' )->text(), 'creationSort', 'creationSort', $this->creationSort
);
235 wfRunHooks( 'SpecialListusersHeaderForm', array( $this, &$out ) );
237 # Submit button and form bottom
238 $out .= Html
::hidden( 'limit', $this->mLimit
);
239 $out .= Xml
::submitButton( $this->msg( 'allpagessubmit' )->text() );
240 wfRunHooks( 'SpecialListusersHeader', array( $this, &$out ) );
241 $out .= Xml
::closeElement( 'fieldset' ) .
242 Xml
::closeElement( 'form' );
248 * Get a list of all explicit groups
251 function getAllGroups() {
253 foreach( User
::getAllGroups() as $group ) {
254 $result[$group] = User
::getGroupName( $group );
261 * Preserve group and username offset parameters when paging
264 function getDefaultQuery() {
265 $query = parent
::getDefaultQuery();
266 if( $this->requestedGroup
!= '' ) {
267 $query['group'] = $this->requestedGroup
;
269 if( $this->requestedUser
!= '' ) {
270 $query['username'] = $this->requestedUser
;
272 wfRunHooks( 'SpecialListusersDefaultQuery', array( $this, &$query ) );
277 * Get a list of groups the specified user belongs to
279 * @param $uid Integer: user id
282 protected static function getGroups( $uid ) {
283 $user = User
::newFromId( $uid );
284 $groups = array_diff( $user->getEffectiveGroups(), User
::getImplicitGroups() );
289 * Format a link to a group description page
291 * @param $group String: group name
292 * @param $username String Username
295 protected static function buildGroupLink( $group, $username ) {
296 return User
::makeGroupLinkHtml( $group, htmlspecialchars( User
::getGroupMember( $group, $username ) ) );
301 * @ingroup SpecialPage
303 class SpecialListUsers
extends IncludableSpecialPage
{
308 public function __construct() {
309 parent
::__construct( 'Listusers' );
313 * Show the special page
315 * @param $par string (optional) A group to list users from
317 public function execute( $par ) {
319 $this->outputHeader();
321 $up = new UsersPager( $this->getContext(), $par, $this->including() );
323 # getBody() first to check, if empty
324 $usersbody = $up->getBody();
327 if ( !$this->including() ) {
328 $s = $up->getPageHeader();
332 $s .= $up->getNavigationBar();
333 $s .= Html
::rawElement( 'ul', array(), $usersbody );
334 $s .= $up->getNavigationBar();
336 $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
339 $this->getOutput()->addHTML( $s );