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          * @var FormOptions
  36          */
  37         protected $opts;
  38
  39         /**
  40          * @var array
  41          */
  42         protected $hideGroups = array();
  43
  44         /**
  45          * @var array
  46          */
  47         protected $hideRights = array();
  48
  49         /**
  50          * @var array
  51          */
  52         private $blockStatusByUid;
  53
  54         /**
  55          * @param IContextSource $context
  56          * @param null $group Unused
  57          * @param string $par Parameter passed to the page
  58          */
  59         function __construct( IContextSource $context = null, $group = null, $par = null ) {
  60                 parent::__construct( $context );
  61
  62                 $this->RCMaxAge = $this->getConfig()->get( 'ActiveUserDays' );
  63                 $un = $this->getRequest()->getText( 'username', $par );
  64                 $this->requestedUser = '';
  65                 if ( $un != '' ) {
  66                         $username = Title::makeTitleSafe( NS_USER, $un );
  67                         if ( !is_null( $username ) ) {
  68                                 $this->requestedUser = $username->getText();
  69                         }
  70                 }
  71
  72                 $this->setupOptions();
  73         }
  74
  75         public function setupOptions() {
  76                 $this->opts = new FormOptions();
  77
  78                 $this->opts->add( 'hidebots', false, FormOptions::BOOL );
  79                 $this->opts->add( 'hidesysops', false, FormOptions::BOOL );
  80
  81                 $this->opts->fetchValuesFromRequest( $this->getRequest() );
  82
  83                 if ( $this->opts->getValue( 'hidebots' ) == 1 ) {
  84                         $this->hideRights[] = 'bot';
  85                 }
  86                 if ( $this->opts->getValue( 'hidesysops' ) == 1 ) {
  87                         $this->hideGroups[] = 'sysop';
  88                 }
  89         }
  90
  91         function getIndexField() {
  92                 return 'qcc_title';
  93         }
  94
  95         function getQueryInfo() {
  96                 $dbr = $this->getDatabase();
  97
  98                 $activeUserSeconds = $this->getConfig()->get( 'ActiveUserDays' ) * 86400;
  99                 $timestamp = $dbr->timestamp( wfTimestamp( TS_UNIX ) - $activeUserSeconds );
 100                 $conds = array(
 101                         'qcc_type' => 'activeusers',
 102                         'qcc_namespace' => NS_USER,
 103                         'user_name = qcc_title',
 104                         'rc_user_text = qcc_title',
 105                         'rc_type != ' . $dbr->addQuotes( RC_EXTERNAL ), // Don't count wikidata.
 106                         'rc_log_type IS NULL OR rc_log_type != ' . $dbr->addQuotes( 'newusers' ),
 107                         'rc_timestamp >= ' . $dbr->addQuotes( $timestamp ),
 108                 );
 109                 if ( $this->requestedUser != '' ) {
 110                         $conds[] = 'qcc_title >= ' . $dbr->addQuotes( $this->requestedUser );
 111                 }
 112                 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
 113                         $conds[] = 'NOT EXISTS (' . $dbr->selectSQLText(
 114                                 'ipblocks', '1', array( 'ipb_user=user_id', 'ipb_deleted' => 1 )
 115                         ) . ')';
 116                 }
 117
 118                 if ( $dbr->implicitGroupby() ) {
 119                         $options = array( 'GROUP BY' => array( 'qcc_title' ) );
 120                 } else {
 121                         $options = array( 'GROUP BY' => array( 'user_name', 'user_id', 'qcc_title' ) );
 122                 }
 123
 124                 return array(
 125                         'tables' => array( 'querycachetwo', 'user', 'recentchanges' ),
 126                         'fields' => array( 'user_name', 'user_id', 'recentedits' => 'COUNT(*)', 'qcc_title' ),
 127                         'options' => $options,
 128                         'conds' => $conds
 129                 );
 130         }
 131
 132         function doBatchLookups() {
 133                 parent::doBatchLookups();
 134
 135                 $uids = array();
 136                 foreach ( $this->mResult as $row ) {
 137                         $uids[] = $row->user_id;
 138                 }
 139                 // Fetch the block status of the user for showing "(blocked)" text and for
 140                 // striking out names of suppressed users when privileged user views the list.
 141                 // Although the first query already hits the block table for un-privileged, this
 142                 // is done in two queries to avoid huge quicksorts and to make COUNT(*) correct.
 143                 $dbr = $this->getDatabase();
 144                 $res = $dbr->select( 'ipblocks',
 145                         array( 'ipb_user', 'MAX(ipb_deleted) AS block_status' ),
 146                         array( 'ipb_user' => $uids ),
 147                         __METHOD__,
 148                         array( 'GROUP BY' => array( 'ipb_user' ) )
 149                 );
 150                 $this->blockStatusByUid = array();
 151                 foreach ( $res as $row ) {
 152                         $this->blockStatusByUid[$row->ipb_user] = $row->block_status; // 0 or 1
 153                 }
 154                 $this->mResult->seek( 0 );
 155         }
 156
 157         function formatRow( $row ) {
 158                 $userName = $row->user_name;
 159
 160                 $ulinks = Linker::userLink( $row->user_id, $userName );
 161                 $ulinks .= Linker::userToolLinks( $row->user_id, $userName );
 162
 163                 $lang = $this->getLanguage();
 164
 165                 $list = array();
 166                 $user = User::newFromId( $row->user_id );
 167
 168                 // User right filter
 169                 foreach ( $this->hideRights as $right ) {
 170                         // Calling User::getRights() within the loop so that
 171                         // if the hideRights() filter is empty, we don't have to
 172                         // trigger the lazy-init of the big userrights array in the
 173                         // User object
 174                         if ( in_array( $right, $user->getRights() ) ) {
 175                                 return '';
 176                         }
 177                 }
 178
 179                 // User group filter
 180                 // Note: This is a different loop than for user rights,
 181                 // because we're reusing it to build the group links
 182                 // at the same time
 183                 $groups_list = self::getGroups( intval( $row->user_id ), $this->userGroupCache );
 184                 foreach ( $groups_list as $group ) {
 185                         if ( in_array( $group, $this->hideGroups ) ) {
 186                                 return '';
 187                         }
 188                         $list[] = self::buildGroupLink( $group, $userName );
 189                 }
 190
 191                 $groups = $lang->commaList( $list );
 192
 193                 $item = $lang->specialList( $ulinks, $groups );
 194
 195                 $isBlocked = isset( $this->blockStatusByUid[$row->user_id] );
 196                 if ( $isBlocked && $this->blockStatusByUid[$row->user_id] == 1 ) {
 197                         $item = "<span class=\"deleted\">$item</span>";
 198                 }
 199                 $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
 200                         ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
 201                 $blocked = $isBlocked ? ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';
 202
 203                 return Html::rawElement( 'li', array(), "{$item} [{$count}]{$blocked}" );
 204         }
 205
 206         function getPageHeader() {
 207                 $self = $this->getTitle();
 208                 $limit = $this->mLimit ? Html::hidden( 'limit', $this->mLimit ) : '';
 209
 210                 # Form tag
 211                 $out = Xml::openElement( 'form', array( 'method' => 'get', 'action' => wfScript() ) );
 212                 $out .= Xml::fieldset( $this->msg( 'activeusers' )->text() ) . "\n";
 213                 $out .= Html::hidden( 'title', $self->getPrefixedDBkey() ) . $limit . "\n";
 214
 215                 # Username field (with autocompletion support)
 216                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 217                 $out .= Xml::inputLabel(
 218                         $this->msg( 'activeusers-from' )->text(),
 219                         'username',
 220                         'offset',
 221                         20,
 222                         $this->requestedUser,
 223                         array(
 224                                 'class' => 'mw-ui-input-inline mw-autocomplete-user',
 225                                 'tabindex' => 1,
 226                                 'autofocus' => $this->requestedUser === '',
 227                         )
 228                 ) . '<br />';
 229
 230                 $out .= Xml::checkLabel( $this->msg( 'activeusers-hidebots' )->text(),
 231                         'hidebots', 'hidebots', $this->opts->getValue( 'hidebots' ), array( 'tabindex' => 2 ) );
 232
 233                 $out .= Xml::checkLabel(
 234                         $this->msg( 'activeusers-hidesysops' )->text(),
 235                         'hidesysops',
 236                         'hidesysops',
 237                         $this->opts->getValue( 'hidesysops' ),
 238                         array( 'tabindex' => 3 )
 239                 ) . '<br />';
 240
 241                 # Submit button and form bottom
 242                 $out .= Xml::submitButton(
 243                         $this->msg( 'activeusers-submit' )->text(),
 244                         array( 'tabindex' => 4 )
 245                 ) . "\n";
 246                 $out .= Xml::closeElement( 'fieldset' );
 247                 $out .= Xml::closeElement( 'form' );
 248
 249                 return $out;
 250         }
 251 }
 252
 253 /**
 254  * @ingroup SpecialPage
 255  */
 256 class SpecialActiveUsers extends SpecialPage {
 257
 258         /**
 259          * Constructor
 260          */
 261         public function __construct() {
 262                 parent::__construct( 'Activeusers' );
 263         }
 264
 265         /**
 266          * Show the special page
 267          *
 268          * @param string $par Parameter passed to the page or null
 269          */
 270         public function execute( $par ) {
 271                 $days = $this->getConfig()->get( 'ActiveUserDays' );
 272
 273                 $this->setHeaders();
 274                 $this->outputHeader();
 275
 276                 $out = $this->getOutput();
 277                 $out->wrapWikiMsg( "<div class='mw-activeusers-intro'>\n$1\n</div>",
 278                         array( 'activeusers-intro', $this->getLanguage()->formatNum( $days ) ) );
 279
 280                 // Mention the level of cache staleness...
 281                 $dbr = wfGetDB( DB_SLAVE, 'recentchanges' );
 282                 $rcMax = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)' );
 283                 if ( $rcMax ) {
 284                         $cTime = $dbr->selectField( 'querycache_info',
 285                                 'qci_timestamp',
 286                                 array( 'qci_type' => 'activeusers' )
 287                         );
 288                         if ( $cTime ) {
 289                                 $secondsOld = wfTimestamp( TS_UNIX, $rcMax ) - wfTimestamp( TS_UNIX, $cTime );
 290                         } else {
 291                                 $rcMin = $dbr->selectField( 'recentchanges', 'MIN(rc_timestamp)' );
 292                                 $secondsOld = time() - wfTimestamp( TS_UNIX, $rcMin );
 293                         }
 294                         if ( $secondsOld > 0 ) {
 295                                 $out->addWikiMsg( 'cachedspecial-viewing-cached-ttl',
 296                                 $this->getLanguage()->formatDuration( $secondsOld ) );
 297                         }
 298                 }
 299
 300                 $up = new ActiveUsersPager( $this->getContext(), null, $par );
 301
 302                 # getBody() first to check, if empty
 303                 $usersbody = $up->getBody();
 304
 305                 $out->addHTML( $up->getPageHeader() );
 306                 if ( $usersbody ) {
 307                         $out->addHTML(
 308                                 $up->getNavigationBar() .
 309                                 Html::rawElement( 'ul', array(), $usersbody ) .
 310                                 $up->getNavigationBar()
 311                         );
 312                 } else {
 313                         $out->addWikiMsg( 'activeusers-noresult' );
 314                 }
 315         }
 316
 317         protected function getGroupName() {
 318                 return 'users';
 319         }
 320 }