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 $par string 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                 $conds[] = 'ipb_deleted IS NULL'; // don't show hidden names
  97                 $conds[] = "rc_log_type IS NULL OR rc_log_type != 'newusers'";
  98                 $conds[] = "rc_timestamp >= '{$dbr->timestamp( wfTimestamp( TS_UNIX ) - $this->RCMaxAge*24*3600 )}'";
  99
 100                 if( $this->requestedUser != '' ) {
 101                         $conds[] = 'rc_user_text >= ' . $dbr->addQuotes( $this->requestedUser );
 102                 }
 103
 104                 $query = array(
 105                         'tables' => array( 'recentchanges', 'user', 'ipblocks' ),
 106                         'fields' => array( 'user_name' => 'rc_user_text', // inheritance
 107                                 'rc_user_text', // for Pager
 108                                 'user_id',
 109                                 'recentedits' => 'COUNT(*)',
 110                                 'blocked' => 'MAX(ipb_user)'
 111                         ),
 112                         'options' => array(
 113                                 'GROUP BY' => array( 'rc_user_text', 'user_id' ),
 114                                 'USE INDEX' => array( 'recentchanges' => 'rc_user_text' )
 115                         ),
 116                         'join_conds' => array(
 117                                 'user' => array( 'INNER JOIN', 'rc_user_text=user_name' ),
 118                                 'ipblocks' => array( 'LEFT JOIN', 'user_id=ipb_user AND ipb_auto=0 AND ipb_deleted=1' ),
 119                         ),
 120                         'conds' => $conds
 121                 );
 122                 return $query;
 123         }
 124
 125         function formatRow( $row ) {
 126                 $userName = $row->user_name;
 127
 128                 $ulinks = Linker::userLink( $row->user_id, $userName );
 129                 $ulinks .= Linker::userToolLinks( $row->user_id, $userName );
 130
 131                 $lang = $this->getLanguage();
 132
 133                 $list = array();
 134                 $user = User::newFromId( $row->user_id );
 135
 136                 // User right filter
 137                 foreach( $this->hideRights as $right ) {
 138                         // Calling User::getRights() within the loop so that
 139                         // if the hideRights() filter is empty, we don't have to
 140                         // trigger the lazy-init of the big userrights array in the
 141                         // User object
 142                         if ( in_array( $right, $user->getRights() ) ) {
 143                                 return '';
 144                         }
 145                 }
 146
 147                 // User group filter
 148                 // Note: This is a different loop than for user rights,
 149                 // because we're reusing it to build the group links
 150                 // at the same time
 151                 foreach( $user->getGroups() as $group ) {
 152                         if ( in_array( $group, $this->hideGroups ) ) {
 153                                 return '';
 154                         }
 155                         $list[] = self::buildGroupLink( $group, $userName );
 156                 }
 157
 158                 $groups = $lang->commaList( $list );
 159
 160                 $item = $lang->specialList( $ulinks, $groups );
 161                 $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
 162                         ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
 163                 $blocked = $row->blocked ? ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';
 164
 165                 return Html::rawElement( 'li', array(), "{$item} [{$count}]{$blocked}" );
 166         }
 167
 168         function getPageHeader() {
 169                 global $wgScript;
 170
 171                 $self = $this->getTitle();
 172                 $limit = $this->mLimit ? Html::hidden( 'limit', $this->mLimit ) : '';
 173
 174                 $out = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ); # Form tag
 175                 $out .= Xml::fieldset( $this->msg( 'activeusers' )->text() ) . "\n";
 176                 $out .= Html::hidden( 'title', $self->getPrefixedDBkey() ) . $limit . "\n";
 177
 178                 $out .= Xml::inputLabel( $this->msg( 'activeusers-from' )->text(),
 179                         'username', 'offset', 20, $this->requestedUser ) . '<br />';# Username field
 180
 181                 $out .= Xml::checkLabel( $this->msg( 'activeusers-hidebots' )->text(),
 182                         'hidebots', 'hidebots', $this->opts->getValue( 'hidebots' ) );
 183
 184                 $out .= Xml::checkLabel( $this->msg( 'activeusers-hidesysops' )->text(),
 185                         'hidesysops', 'hidesysops', $this->opts->getValue( 'hidesysops' ) ) . '<br />';
 186
 187                 $out .= Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n";# Submit button and form bottom
 188                 $out .= Xml::closeElement( 'fieldset' );
 189                 $out .= Xml::closeElement( 'form' );
 190
 191                 return $out;
 192         }
 193 }
 194
 195 /**
 196  * @ingroup SpecialPage
 197  */
 198 class SpecialActiveUsers extends SpecialPage {
 199
 200         /**
 201          * Constructor
 202          */
 203         public function __construct() {
 204                 parent::__construct( 'Activeusers' );
 205         }
 206
 207         /**
 208          * Show the special page
 209          *
 210          * @param $par Mixed: parameter passed to the page or null
 211          */
 212         public function execute( $par ) {
 213                 global $wgActiveUserDays;
 214
 215                 $this->setHeaders();
 216                 $this->outputHeader();
 217
 218                 $out = $this->getOutput();
 219                 $out->wrapWikiMsg( "<div class='mw-activeusers-intro'>\n$1\n</div>",
 220                         array( 'activeusers-intro', $this->getLanguage()->formatNum( $wgActiveUserDays ) ) );
 221
 222                 $up = new ActiveUsersPager( $this->getContext(), null, $par );
 223
 224                 # getBody() first to check, if empty
 225                 $usersbody = $up->getBody();
 226
 227                 $out->addHTML( $up->getPageHeader() );
 228                 if ( $usersbody ) {
 229                         $out->addHTML(
 230                                 $up->getNavigationBar() .
 231                                 Html::rawElement( 'ul', array(), $usersbody ) .
 232                                 $up->getNavigationBar()
 233                         );
 234                 } else {
 235                         $out->addWikiMsg( 'activeusers-noresult' );
 236                 }
 237         }
 238
 239 }