includes/specials/SpecialListusers.php

   1 <?php
   2 /**
   3  * Implements Special:Listusers
   4  *
   5  * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
   6  * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
   7  * 2006 Rob Church <robchur@gmail.com>
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  * @ingroup SpecialPage
  26  */
  27
  28 /**
  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.
  32  *
  33  * @ingroup SpecialPage
  34  */
  35 class UsersPager extends AlphabeticPager {
  36
  37         function __construct( IContextSource $context = null, $par = null ) {
  38                 if ( $context ) {
  39                         $this->setContext( $context );
  40                 }
  41
  42                 $request = $this->getRequest();
  43                 $parms = explode( '/', ($par = ( $par !== null ) ? $par : '' ) );
  44                 $symsForAll = array( '*', 'user' );
  45                 if ( $parms[0] != '' && ( in_array( $par, User::getAllGroups() ) || in_array( $par, $symsForAll ) ) ) {
  46                         $this->requestedGroup = $par;
  47                         $un = $request->getText( 'username' );
  48                 } elseif ( count( $parms ) == 2 ) {
  49                         $this->requestedGroup = $parms[0];
  50                         $un = $parms[1];
  51                 } else {
  52                         $this->requestedGroup = $request->getVal( 'group' );
  53                         $un = ( $par != '' ) ? $par : $request->getText( 'username' );
  54                 }
  55                 if ( in_array( $this->requestedGroup, $symsForAll ) ) {
  56                         $this->requestedGroup = '';
  57                 }
  58                 $this->editsOnly = $request->getBool( 'editsOnly' );
  59                 $this->creationSort = $request->getBool( 'creationSort' );
  60
  61                 $this->requestedUser = '';
  62                 if ( $un != '' ) {
  63                         $username = Title::makeTitleSafe( NS_USER, $un );
  64                         if( ! is_null( $username ) ) {
  65                                 $this->requestedUser = $username->getText();
  66                         }
  67                 }
  68                 parent::__construct();
  69         }
  70
  71         function getIndexField() {
  72                 return $this->creationSort ? 'user_id' : 'user_name';
  73         }
  74
  75         function getQueryInfo() {
  76                 $dbr = wfGetDB( DB_SLAVE );
  77                 $conds = array();
  78                 // Don't show hidden names
  79                 if( !$this->getUser()->isAllowed('hideuser') ) {
  80                         $conds[] = 'ipb_deleted IS NULL';
  81                 }
  82
  83                 $options = array();
  84
  85                 if( $this->requestedGroup != '' ) {
  86                         $conds['ug_group'] = $this->requestedGroup;
  87                 } else {
  88                         //$options['USE INDEX'] = $this->creationSort ? 'PRIMARY' : 'user_name';
  89                 }
  90                 if( $this->requestedUser != '' ) {
  91                         # Sorted either by account creation or name
  92                         if( $this->creationSort ) {
  93                                 $conds[] = 'user_id >= ' . intval( User::idFromName( $this->requestedUser ) );
  94                         } else {
  95                                 $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser );
  96                         }
  97                 }
  98                 if( $this->editsOnly ) {
  99                         $conds[] = 'user_editcount > 0';
 100                 }
 101
 102                 $options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';
 103
 104                 $query = array(
 105                         'tables' => array( 'user', 'user_groups', 'ipblocks'),
 106                         'fields' => array(
 107                                 $this->creationSort ? 'MAX(user_name) AS user_name' : 'user_name',
 108                                 $this->creationSort ? 'user_id' : 'MAX(user_id) AS user_id',
 109                                 'MAX(user_editcount) AS edits',
 110                                 'COUNT(ug_group) AS numgroups',
 111                                 'MAX(ug_group) AS singlegroup', // the usergroup if there is only one
 112                                 'MIN(user_registration) AS creation',
 113                                 'MAX(ipb_deleted) AS ipb_deleted' // block/hide status
 114                         ),
 115                         'options' => $options,
 116                         'join_conds' => array(
 117                                 'user_groups' => array( 'LEFT JOIN', 'user_id=ug_user' ),
 118                                 'ipblocks' => array( 'LEFT JOIN', 'user_id=ipb_user AND ipb_deleted=1 AND ipb_auto=0' ),
 119                         ),
 120                         'conds' => $conds
 121                 );
 122
 123                 wfRunHooks( 'SpecialListusersQueryInfo', array( $this, &$query ) );
 124                 return $query;
 125         }
 126
 127         function formatRow( $row ) {
 128                 if ($row->user_id == 0) #Bug 16487
 129                         return '';
 130
 131                 $userPage = Title::makeTitle( NS_USER, $row->user_name );
 132                 $name = Linker::link( $userPage, htmlspecialchars( $userPage->getText() ) );
 133
 134                 $lang = $this->getLanguage();
 135
 136                 $groups_list = self::getGroups( $row->user_id );
 137                 if( count( $groups_list ) > 0 ) {
 138                         $list = array();
 139                         foreach( $groups_list as $group )
 140                                 $list[] = self::buildGroupLink( $group, $userPage->getText() );
 141                         $groups = $lang->commaList( $list );
 142                 } else {
 143                         $groups = '';
 144                 }
 145
 146                 $item = $lang->specialList( $name, $groups );
 147                 if( $row->ipb_deleted ) {
 148                         $item = "<span class=\"deleted\">$item</span>";
 149                 }
 150
 151                 global $wgEdititis;
 152                 if ( $wgEdititis ) {
 153                         $editCount = $lang->formatNum( $row->edits );
 154                         $edits = ' [' . wfMsgExt( 'usereditcount', array( 'parsemag', 'escape' ), $editCount ) . ']';
 155                 } else {
 156                         $edits = '';
 157                 }
 158
 159                 $created = '';
 160                 # Some rows may be NULL
 161                 if( $row->creation ) {
 162                         $d = $lang->date( wfTimestamp( TS_MW, $row->creation ), true );
 163                         $t = $lang->time( wfTimestamp( TS_MW, $row->creation ), true );
 164                         $created = ' (' . wfMsgExt( 'usercreated', array( 'parsemag', 'escape' ), $d, $t, $row->user_name ) . ')';
 165                 }
 166
 167                 wfRunHooks( 'SpecialListusersFormatRow', array( &$item, $row ) );
 168                 return "<li>{$item}{$edits}{$created}</li>";
 169         }
 170
 171         function getBody() {
 172                 if( !$this->mQueryDone ) {
 173                         $this->doQuery();
 174                 }
 175                 $this->mResult->rewind();
 176                 $batch = new LinkBatch;
 177                 foreach ( $this->mResult as $row ) {
 178                         $batch->addObj( Title::makeTitleSafe( NS_USER, $row->user_name ) );
 179                 }
 180                 $batch->execute();
 181                 $this->mResult->rewind();
 182                 return parent::getBody();
 183         }
 184
 185         function getPageHeader( ) {
 186                 global $wgScript;
 187                 $self = $this->getTitle();
 188
 189                 # Form tag
 190                 $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-listusers-form' ) ) .
 191                         Xml::fieldset( wfMsg( 'listusers' ) ) .
 192                         Html::hidden( 'title', $self->getPrefixedDbKey() );
 193
 194                 # Username field
 195                 $out .= Xml::label( wfMsg( 'listusersfrom' ), 'offset' ) . ' ' .
 196                         Xml::input( 'username', 20, $this->requestedUser, array( 'id' => 'offset' ) ) . ' ';
 197
 198                 # Group drop-down list
 199                 $out .= Xml::label( wfMsg( 'group' ), 'group' ) . ' ' .
 200                         Xml::openElement('select',  array( 'name' => 'group', 'id' => 'group' ) ) .
 201                         Xml::option( wfMsg( 'group-all' ), '' );
 202                 foreach( $this->getAllGroups() as $group => $groupText )
 203                         $out .= Xml::option( $groupText, $group, $group == $this->requestedGroup );
 204                 $out .= Xml::closeElement( 'select' ) . '<br />';
 205                 $out .= Xml::checkLabel( wfMsg('listusers-editsonly'), 'editsOnly', 'editsOnly', $this->editsOnly );
 206                 $out .= '&#160;';
 207                 $out .= Xml::checkLabel( wfMsg('listusers-creationsort'), 'creationSort', 'creationSort', $this->creationSort );
 208                 $out .= '<br />';
 209
 210                 wfRunHooks( 'SpecialListusersHeaderForm', array( $this, &$out ) );
 211
 212                 # Submit button and form bottom
 213                 $out .= Html::hidden( 'limit', $this->mLimit );
 214                 $out .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
 215                 wfRunHooks( 'SpecialListusersHeader', array( $this, &$out ) );
 216                 $out .= Xml::closeElement( 'fieldset' ) .
 217                         Xml::closeElement( 'form' );
 218
 219                 return $out;
 220         }
 221
 222         /**
 223          * Get a list of all explicit groups
 224          * @return array
 225          */
 226         function getAllGroups() {
 227                 $result = array();
 228                 foreach( User::getAllGroups() as $group ) {
 229                         $result[$group] = User::getGroupName( $group );
 230                 }
 231                 asort( $result );
 232                 return $result;
 233         }
 234
 235         /**
 236          * Preserve group and username offset parameters when paging
 237          * @return array
 238          */
 239         function getDefaultQuery() {
 240                 $query = parent::getDefaultQuery();
 241                 if( $this->requestedGroup != '' )
 242                         $query['group'] = $this->requestedGroup;
 243                 if( $this->requestedUser != '' )
 244                         $query['username'] = $this->requestedUser;
 245                 wfRunHooks( 'SpecialListusersDefaultQuery', array( $this, &$query ) );
 246                 return $query;
 247         }
 248
 249         /**
 250          * Get a list of groups the specified user belongs to
 251          *
 252          * @param $uid Integer: user id
 253          * @return array
 254          */
 255         protected static function getGroups( $uid ) {
 256                 $user = User::newFromId( $uid );
 257                 $groups = array_diff( $user->getEffectiveGroups(), User::getImplicitGroups() );
 258                 return $groups;
 259         }
 260
 261         /**
 262          * Format a link to a group description page
 263          *
 264          * @param $group String: group name
 265          * @return string
 266          */
 267         protected static function buildGroupLink( $group, $username ) {
 268                 return User::makeGroupLinkHtml( $group, htmlspecialchars( User::getGroupMember( $group, $username ) ) );
 269         }
 270 }
 271
 272 /**
 273  * @ingroup SpecialPage
 274  */
 275 class SpecialListUsers extends SpecialPage {
 276
 277         /**
 278          * Constructor
 279          */
 280         public function __construct() {
 281                 parent::__construct( 'Listusers' );
 282         }
 283
 284         /**
 285          * Show the special page
 286          *
 287          * @param $par string (optional) A group to list users from
 288          */
 289         public function execute( $par ) {
 290                 $this->setHeaders();
 291                 $this->outputHeader();
 292
 293                 $up = new UsersPager( $this->getContext(), $par );
 294
 295                 # getBody() first to check, if empty
 296                 $usersbody = $up->getBody();
 297
 298                 $s = $up->getPageHeader();
 299                 if( $usersbody ) {
 300                         $s .= $up->getNavigationBar();
 301                         $s .= Html::rawElement( 'ul', array(), $usersbody );
 302                         $s .= $up->getNavigationBar();
 303                 } else {
 304                         $s .= wfMessage( 'listusers-noresult' )->parseAsBlock();
 305                 }
 306
 307                 $this->getOutput()->addHTML( $s );
 308         }
 309 }