includes/specials/SpecialActiveusers.php

   1 <?php
   2 /**
   3  * Implements Special:Activeusers
   4  *
   5  * Copyright © 2008 Aaron Schulz
   6  *
   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.
  11  *
  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.
  16  *
  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
  21  *
  22  * @file
  23  * @ingroup SpecialPage
  24  */
  25
  26 /**
  27  * This class is used to get a list of active users. The ones with specials
  28  * rights (sysop, bureaucrat, developer) will have them displayed
  29  * next to their names.
  30  *
  31  * @ingroup SpecialPage
  32  */
  33 class ActiveUsersPager extends UsersPager {
  34
  35         /**
  36          * @var FormOptions
  37          */
  38         protected $opts;
  39
  40         /**
  41          * @var Array
  42          */
  43         protected $hideGroups = array();
  44
  45         /**
  46          * @var Array
  47          */
  48         protected $hideRights = array();
  49
  50         /**
  51          * @param $context IContextSource
  52          * @param $group null Unused
  53          * @param string $par Parameter passed to the page
  54          */
  55         function __construct( IContextSource $context = null, $group = null, $par = null ) {
  56                 global $wgActiveUserDays;
  57
  58                 parent::__construct( $context );
  59
  60                 $this->RCMaxAge = $wgActiveUserDays;
  61                 $un = $this->getRequest()->getText( 'username', $par );
  62                 $this->requestedUser = '';
  63                 if ( $un != '' ) {
  64                         $username = Title::makeTitleSafe( NS_USER, $un );
  65                         if( !is_null( $username ) ) {
  66                                 $this->requestedUser = $username->getText();
  67                         }
  68                 }
  69
  70                 $this->setupOptions();
  71         }
  72
  73         public function setupOptions() {
  74                 $this->opts = new FormOptions();
  75
  76                 $this->opts->add( 'hidebots', false, FormOptions::BOOL );
  77                 $this->opts->add( 'hidesysops', false, FormOptions::BOOL );
  78
  79                 $this->opts->fetchValuesFromRequest( $this->getRequest() );
  80
  81                 if ( $this->opts->getValue( 'hidebots' ) == 1 ) {
  82                         $this->hideRights[] = 'bot';
  83                 }
  84                 if ( $this->opts->getValue( 'hidesysops' ) == 1 ) {
  85                         $this->hideGroups[] = 'sysop';
  86                 }
  87         }
  88
  89         function getIndexField() {
  90                 return 'rc_user_text';
  91         }
  92
  93         function getQueryInfo() {
  94                 $dbr = wfGetDB( DB_SLAVE );
  95                 $conds = array( 'rc_user > 0' ); // Users - no anons
  96                 if( !$this->getUser()->isAllowed( 'hideuser' ) ) {
  97                         $conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0'; // don't show hidden names
  98                 }
  99                 $conds[] = 'rc_log_type IS NULL OR rc_log_type != ' . $dbr->addQuotes( 'newusers' );
 100                 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes(
 101                         $dbr->timestamp( wfTimestamp( TS_UNIX ) - $this->RCMaxAge*24*3600 ) );
 102
 103                 if( $this->requestedUser != '' ) {
 104                         $conds[] = 'rc_user_text >= ' . $dbr->addQuotes( $this->requestedUser );
 105                 }
 106
 107                 return array(
 108                         'tables' => array( 'recentchanges', 'ipblocks' ),
 109                         'fields' => array(
 110                                 'user_name' => 'rc_user_text', // for Pager inheritance
 111                                 'rc_user_text', // for Pager
 112                                 'user_id' => 'rc_user',
 113                                 'recentedits' => 'COUNT(*)',
 114                                 'ipb_deleted' => 'MAX(ipb_deleted)'
 115                         ),
 116                         'options' => array(
 117                                 'GROUP BY' => array( 'rc_user_text', 'user_id' ),
 118                                 'USE INDEX' => array( 'recentchanges' => 'rc_user_text' )
 119                         ),
 120                         'join_conds' => array( // check for suppression blocks
 121                                 'ipblocks' => array( 'LEFT JOIN', array(
 122                                         'rc_user=ipb_user',
 123                                         'ipb_auto' => 0 # avoid duplicate blocks
 124                                 )),
 125                         ),
 126                         'conds' => $conds
 127                 );
 128         }
 129
 130         function formatRow( $row ) {
 131                 $userName = $row->user_name;
 132
 133                 $ulinks = Linker::userLink( $row->user_id, $userName );
 134                 $ulinks .= Linker::userToolLinks( $row->user_id, $userName );
 135
 136                 $lang = $this->getLanguage();
 137
 138                 $list = array();
 139                 $user = User::newFromId( $row->user_id );
 140
 141                 // User right filter
 142                 foreach( $this->hideRights as $right ) {
 143                         // Calling User::getRights() within the loop so that
 144                         // if the hideRights() filter is empty, we don't have to
 145                         // trigger the lazy-init of the big userrights array in the
 146                         // User object
 147                         if ( in_array( $right, $user->getRights() ) ) {
 148                                 return '';
 149                         }
 150                 }
 151
 152                 // User group filter
 153                 // Note: This is a different loop than for user rights,
 154                 // because we're reusing it to build the group links
 155                 // at the same time
 156                 foreach( $user->getGroups() as $group ) {
 157                         if ( in_array( $group, $this->hideGroups ) ) {
 158                                 return '';
 159                         }
 160                         $list[] = self::buildGroupLink( $group, $userName );
 161                 }
 162
 163                 $groups = $lang->commaList( $list );
 164
 165                 $item = $lang->specialList( $ulinks, $groups );
 166                 if( $row->ipb_deleted ) {
 167                         $item = "<span class=\"deleted\">$item</span>";
 168                 }
 169                 $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
 170                         ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
 171                 $blocked = !is_null( $row->ipb_deleted ) ? ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';
 172
 173                 return Html::rawElement( 'li', array(), "{$item} [{$count}]{$blocked}" );
 174         }
 175
 176         function getPageHeader() {
 177                 global $wgScript;
 178
 179                 $self = $this->getTitle();
 180                 $limit = $this->mLimit ? Html::hidden( 'limit', $this->mLimit ) : '';
 181
 182                 $out = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ); # Form tag
 183                 $out .= Xml::fieldset( $this->msg( 'activeusers' )->text() ) . "\n";
 184                 $out .= Html::hidden( 'title', $self->getPrefixedDBkey() ) . $limit . "\n";
 185
 186                 $out .= Xml::inputLabel( $this->msg( 'activeusers-from' )->text(),
 187                         'username', 'offset', 20, $this->requestedUser ) . '<br />';# Username field
 188
 189                 $out .= Xml::checkLabel( $this->msg( 'activeusers-hidebots' )->text(),
 190                         'hidebots', 'hidebots', $this->opts->getValue( 'hidebots' ) );
 191
 192                 $out .= Xml::checkLabel( $this->msg( 'activeusers-hidesysops' )->text(),
 193                         'hidesysops', 'hidesysops', $this->opts->getValue( 'hidesysops' ) ) . '<br />';
 194
 195                 $out .= Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n";# Submit button and form bottom
 196                 $out .= Xml::closeElement( 'fieldset' );
 197                 $out .= Xml::closeElement( 'form' );
 198
 199                 return $out;
 200         }
 201 }
 202
 203 /**
 204  * @ingroup SpecialPage
 205  */
 206 class SpecialActiveUsers extends SpecialPage {
 207
 208         /**
 209          * Constructor
 210          */
 211         public function __construct() {
 212                 parent::__construct( 'Activeusers' );
 213         }
 214
 215         /**
 216          * Show the special page
 217          *
 218          * @param $par Mixed: parameter passed to the page or null
 219          */
 220         public function execute( $par ) {
 221                 global $wgActiveUserDays;
 222
 223                 $this->setHeaders();
 224                 $this->outputHeader();
 225
 226                 $out = $this->getOutput();
 227                 $out->wrapWikiMsg( "<div class='mw-activeusers-intro'>\n$1\n</div>",
 228                         array( 'activeusers-intro', $this->getLanguage()->formatNum( $wgActiveUserDays ) ) );
 229
 230                 $up = new ActiveUsersPager( $this->getContext(), null, $par );
 231
 232                 # getBody() first to check, if empty
 233                 $usersbody = $up->getBody();
 234
 235                 $out->addHTML( $up->getPageHeader() );
 236                 if ( $usersbody ) {
 237                         $out->addHTML(
 238                                 $up->getNavigationBar() .
 239                                 Html::rawElement( 'ul', array(), $usersbody ) .
 240                                 $up->getNavigationBar()
 241                         );
 242                 } else {
 243                         $out->addWikiMsg( 'activeusers-noresult' );
 244                 }
 245         }
 246
 247         protected function getGroupName() {
 248                 return 'users';
 249         }
 250 }