includes/specials/SpecialRecentchanges.php

   1 <?php
   2 /**
   3  * Implements Special:Recentchanges
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * A special page that lists last changes made to the wiki
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialRecentChanges extends IncludableSpecialPage {
  30         var $rcOptions, $rcSubpage;
  31         protected $customFilters;
  32
  33         public function __construct( $name = 'Recentchanges' ) {
  34                 parent::__construct( $name );
  35         }
  36
  37         /**
  38          * Get a FormOptions object containing the default options
  39          *
  40          * @return FormOptions
  41          */
  42         public function getDefaultOptions() {
  43                 $opts = new FormOptions();
  44
  45                 $opts->add( 'days', $this->getUser()->getIntOption( 'rcdays' ) );
  46                 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
  47                 $opts->add( 'from', '' );
  48
  49                 $opts->add( 'hideminor', $this->getUser()->getBoolOption( 'hideminor' ) );
  50                 $opts->add( 'hidebots', true );
  51                 $opts->add( 'hideanons', false );
  52                 $opts->add( 'hideliu', false );
  53                 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'hidepatrolled' ) );
  54                 $opts->add( 'hidemyself', false );
  55
  56                 $opts->add( 'namespace', '', FormOptions::INTNULL );
  57                 $opts->add( 'invert', false );
  58                 $opts->add( 'associated', false );
  59
  60                 $opts->add( 'categories', '' );
  61                 $opts->add( 'categories_any', false );
  62                 $opts->add( 'tagfilter', '' );
  63
  64                 return $opts;
  65         }
  66
  67         /**
  68          * Create a FormOptions object with options as specified by the user
  69          *
  70          * @param array $parameters
  71          *
  72          * @return FormOptions
  73          */
  74         public function setup( $parameters ) {
  75                 $opts = $this->getDefaultOptions();
  76
  77                 foreach ( $this->getCustomFilters() as $key => $params ) {
  78                         $opts->add( $key, $params['default'] );
  79                 }
  80
  81                 $opts->fetchValuesFromRequest( $this->getRequest() );
  82
  83                 // Give precedence to subpage syntax
  84                 if ( $parameters !== null ) {
  85                         $this->parseParameters( $parameters, $opts );
  86                 }
  87
  88                 $opts->validateIntBounds( 'limit', 0, 5000 );
  89
  90                 return $opts;
  91         }
  92
  93         /**
  94          * Get custom show/hide filters
  95          *
  96          * @return array Map of filter URL param names to properties (msg/default)
  97          */
  98         protected function getCustomFilters() {
  99                 if ( $this->customFilters === null ) {
 100                         $this->customFilters = array();
 101                         wfRunHooks( 'SpecialRecentChangesFilters', array( $this, &$this->customFilters ) );
 102                 }
 103
 104                 return $this->customFilters;
 105         }
 106
 107         /**
 108          * Create a FormOptions object specific for feed requests and return it
 109          *
 110          * @return FormOptions
 111          */
 112         public function feedSetup() {
 113                 global $wgFeedLimit;
 114                 $opts = $this->getDefaultOptions();
 115                 $opts->fetchValuesFromRequest( $this->getRequest() );
 116                 $opts->validateIntBounds( 'limit', 0, $wgFeedLimit );
 117
 118                 return $opts;
 119         }
 120
 121         /**
 122          * Get the current FormOptions for this request
 123          */
 124         public function getOptions() {
 125                 if ( $this->rcOptions === null ) {
 126                         if ( $this->including() ) {
 127                                 $isFeed = false;
 128                         } else {
 129                                 $isFeed = (bool)$this->getRequest()->getVal( 'feed' );
 130                         }
 131                         $this->rcOptions = $isFeed ? $this->feedSetup() : $this->setup( $this->rcSubpage );
 132                 }
 133
 134                 return $this->rcOptions;
 135         }
 136
 137         /**
 138          * Main execution point
 139          *
 140          * @param string $subpage
 141          */
 142         public function execute( $subpage ) {
 143                 $this->rcSubpage = $subpage;
 144                 $feedFormat = $this->including() ? null : $this->getRequest()->getVal( 'feed' );
 145
 146                 # 10 seconds server-side caching max
 147                 $this->getOutput()->setSquidMaxage( 10 );
 148                 # Check if the client has a cached version
 149                 $lastmod = $this->checkLastModified( $feedFormat );
 150                 if ( $lastmod === false ) {
 151                         return;
 152                 }
 153
 154                 $opts = $this->getOptions();
 155                 $this->setHeaders();
 156                 $this->outputHeader();
 157                 $this->addRecentChangesJS();
 158
 159                 // Fetch results, prepare a batch link existence check query
 160                 $conds = $this->buildMainQueryConds( $opts );
 161                 $rows = $this->doMainQuery( $conds, $opts );
 162                 if ( $rows === false ) {
 163                         if ( !$this->including() ) {
 164                                 $this->doHeader( $opts );
 165                         }
 166
 167                         return;
 168                 }
 169
 170                 if ( !$feedFormat ) {
 171                         $batch = new LinkBatch;
 172                         foreach ( $rows as $row ) {
 173                                 $batch->add( NS_USER, $row->rc_user_text );
 174                                 $batch->add( NS_USER_TALK, $row->rc_user_text );
 175                                 $batch->add( $row->rc_namespace, $row->rc_title );
 176                         }
 177                         $batch->execute();
 178                 }
 179                 if ( $feedFormat ) {
 180                         list( $changesFeed, $formatter ) = $this->getFeedObject( $feedFormat );
 181                         /** @var ChangesFeed $changesFeed */
 182                         $changesFeed->execute( $formatter, $rows, $lastmod, $opts );
 183                 } else {
 184                         $this->webOutput( $rows, $opts );
 185                 }
 186
 187                 $rows->free();
 188         }
 189
 190         /**
 191          * Return an array with a ChangesFeed object and ChannelFeed object
 192          *
 193          * @param string $feedFormat Feed's format (either 'rss' or 'atom')
 194          * @return array
 195          */
 196         public function getFeedObject( $feedFormat ) {
 197                 $changesFeed = new ChangesFeed( $feedFormat, 'rcfeed' );
 198                 $formatter = $changesFeed->getFeedObject(
 199                         $this->msg( 'recentchanges' )->inContentLanguage()->text(),
 200                         $this->msg( 'recentchanges-feed-description' )->inContentLanguage()->text(),
 201                         $this->getTitle()->getFullURL()
 202                 );
 203
 204                 return array( $changesFeed, $formatter );
 205         }
 206
 207         /**
 208          * Process $par and put options found if $opts
 209          * Mainly used when including the page
 210          *
 211          * @param string $par
 212          * @param FormOptions $opts
 213          */
 214         public function parseParameters( $par, FormOptions $opts ) {
 215                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
 216                 foreach ( $bits as $bit ) {
 217                         if ( 'hidebots' === $bit ) {
 218                                 $opts['hidebots'] = true;
 219                         }
 220                         if ( 'bots' === $bit ) {
 221                                 $opts['hidebots'] = false;
 222                         }
 223                         if ( 'hideminor' === $bit ) {
 224                                 $opts['hideminor'] = true;
 225                         }
 226                         if ( 'minor' === $bit ) {
 227                                 $opts['hideminor'] = false;
 228                         }
 229                         if ( 'hideliu' === $bit ) {
 230                                 $opts['hideliu'] = true;
 231                         }
 232                         if ( 'hidepatrolled' === $bit ) {
 233                                 $opts['hidepatrolled'] = true;
 234                         }
 235                         if ( 'hideanons' === $bit ) {
 236                                 $opts['hideanons'] = true;
 237                         }
 238                         if ( 'hidemyself' === $bit ) {
 239                                 $opts['hidemyself'] = true;
 240                         }
 241
 242                         if ( is_numeric( $bit ) ) {
 243                                 $opts['limit'] = $bit;
 244                         }
 245
 246                         $m = array();
 247                         if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
 248                                 $opts['limit'] = $m[1];
 249                         }
 250                         if ( preg_match( '/^days=(\d+)$/', $bit, $m ) ) {
 251                                 $opts['days'] = $m[1];
 252                         }
 253                         if ( preg_match( '/^namespace=(\d+)$/', $bit, $m ) ) {
 254                                 $opts['namespace'] = $m[1];
 255                         }
 256                 }
 257         }
 258
 259         /**
 260          * Get last modified date, for client caching
 261          * Don't use this if we are using the patrol feature, patrol changes don't
 262          * update the timestamp
 263          *
 264          * @param string $feedFormat
 265          * @return string|bool
 266          */
 267         public function checkLastModified( $feedFormat ) {
 268                 $dbr = wfGetDB( DB_SLAVE );
 269                 $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', false, __METHOD__ );
 270                 if ( $feedFormat || !$this->getUser()->useRCPatrol() ) {
 271                         if ( $lastmod && $this->getOutput()->checkLastModified( $lastmod ) ) {
 272                                 # Client cache fresh and headers sent, nothing more to do.
 273                                 return false;
 274                         }
 275                 }
 276
 277                 return $lastmod;
 278         }
 279
 280         /**
 281          * Return an array of conditions depending of options set in $opts
 282          *
 283          * @param FormOptions $opts
 284          * @return array
 285          */
 286         public function buildMainQueryConds( FormOptions $opts ) {
 287                 $dbr = wfGetDB( DB_SLAVE );
 288                 $conds = array();
 289
 290                 # It makes no sense to hide both anons and logged-in users
 291                 # Where this occurs, force anons to be shown
 292                 $forcebot = false;
 293                 if ( $opts['hideanons'] && $opts['hideliu'] ) {
 294                         # Check if the user wants to show bots only
 295                         if ( $opts['hidebots'] ) {
 296                                 $opts['hideanons'] = false;
 297                         } else {
 298                                 $forcebot = true;
 299                                 $opts['hidebots'] = false;
 300                         }
 301                 }
 302
 303                 // Calculate cutoff
 304                 $cutoff_unixtime = time() - ( $opts['days'] * 86400 );
 305                 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime % 86400 );
 306                 $cutoff = $dbr->timestamp( $cutoff_unixtime );
 307
 308                 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
 309                 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW, $cutoff ) ) {
 310                         $cutoff = $dbr->timestamp( $opts['from'] );
 311                 } else {
 312                         $opts->reset( 'from' );
 313                 }
 314
 315                 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
 316
 317                 $hidePatrol = $this->getUser()->useRCPatrol() && $opts['hidepatrolled'];
 318                 $hideLoggedInUsers = $opts['hideliu'] && !$forcebot;
 319                 $hideAnonymousUsers = $opts['hideanons'] && !$forcebot;
 320
 321                 if ( $opts['hideminor'] ) {
 322                         $conds['rc_minor'] = 0;
 323                 }
 324                 if ( $opts['hidebots'] ) {
 325                         $conds['rc_bot'] = 0;
 326                 }
 327                 if ( $hidePatrol ) {
 328                         $conds['rc_patrolled'] = 0;
 329                 }
 330                 if ( $forcebot ) {
 331                         $conds['rc_bot'] = 1;
 332                 }
 333                 if ( $hideLoggedInUsers ) {
 334                         $conds[] = 'rc_user = 0';
 335                 }
 336                 if ( $hideAnonymousUsers ) {
 337                         $conds[] = 'rc_user != 0';
 338                 }
 339
 340                 if ( $opts['hidemyself'] ) {
 341                         if ( $this->getUser()->getId() ) {
 342                                 $conds[] = 'rc_user != ' . $dbr->addQuotes( $this->getUser()->getId() );
 343                         } else {
 344                                 $conds[] = 'rc_user_text != ' . $dbr->addQuotes( $this->getUser()->getName() );
 345                         }
 346                 }
 347
 348                 # Namespace filtering
 349                 if ( $opts['namespace'] !== '' ) {
 350                         $selectedNS = $dbr->addQuotes( $opts['namespace'] );
 351                         $operator = $opts['invert'] ? '!=' : '=';
 352                         $boolean = $opts['invert'] ? 'AND' : 'OR';
 353
 354                         # namespace association (bug 2429)
 355                         if ( !$opts['associated'] ) {
 356                                 $condition = "rc_namespace $operator $selectedNS";
 357                         } else {
 358                                 # Also add the associated namespace
 359                                 $associatedNS = $dbr->addQuotes(
 360                                         MWNamespace::getAssociated( $opts['namespace'] )
 361                                 );
 362                                 $condition = "(rc_namespace $operator $selectedNS "
 363                                         . $boolean
 364                                         . " rc_namespace $operator $associatedNS)";
 365                         }
 366
 367                         $conds[] = $condition;
 368                 }
 369
 370                 return $conds;
 371         }
 372
 373         /**
 374          * Process the query
 375          *
 376          * @param array $conds
 377          * @param FormOptions $opts
 378          * @return bool|ResultWrapper Result or false (for Recentchangeslinked only)
 379          */
 380         public function doMainQuery( $conds, $opts ) {
 381                 $tables = array( 'recentchanges' );
 382                 $join_conds = array();
 383                 $query_options = array(
 384                         'USE INDEX' => array( 'recentchanges' => 'rc_timestamp' )
 385                 );
 386
 387                 $uid = $this->getUser()->getId();
 388                 $dbr = wfGetDB( DB_SLAVE );
 389                 $limit = $opts['limit'];
 390                 $namespace = $opts['namespace'];
 391                 $invert = $opts['invert'];
 392                 $associated = $opts['associated'];
 393
 394                 $fields = RecentChange::selectFields();
 395                 // JOIN on watchlist for users
 396                 if ( $uid && $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
 397                         $tables[] = 'watchlist';
 398                         $fields[] = 'wl_user';
 399                         $fields[] = 'wl_notificationtimestamp';
 400                         $join_conds['watchlist'] = array( 'LEFT JOIN', array(
 401                                 'wl_user' => $uid,
 402                                 'wl_title=rc_title',
 403                                 'wl_namespace=rc_namespace'
 404                         ) );
 405                 }
 406                 if ( $this->getUser()->isAllowed( 'rollback' ) ) {
 407                         $tables[] = 'page';
 408                         $fields[] = 'page_latest';
 409                         $join_conds['page'] = array( 'LEFT JOIN', 'rc_cur_id=page_id' );
 410                 }
 411                 // Tag stuff.
 412                 ChangeTags::modifyDisplayQuery(
 413                         $tables,
 414                         $fields,
 415                         $conds,
 416                         $join_conds,
 417                         $query_options,
 418                         $opts['tagfilter']
 419                 );
 420
 421                 if ( !wfRunHooks( 'SpecialRecentChangesQuery',
 422                         array( &$conds, &$tables, &$join_conds, $opts, &$query_options, &$fields ) )
 423                 ) {
 424                         return false;
 425                 }
 426
 427                 // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
 428                 // knowledge to use an index merge if it wants (it may use some other index though).
 429                 return $dbr->select(
 430                         $tables,
 431                         $fields,
 432                         $conds + array( 'rc_new' => array( 0, 1 ) ),
 433                         __METHOD__,
 434                         array( 'ORDER BY' => 'rc_timestamp DESC', 'LIMIT' => $limit ) + $query_options,
 435                         $join_conds
 436                 );
 437         }
 438
 439         /**
 440          * Send output to the OutputPage object, only called if not used feeds
 441          *
 442          * @param array $rows Database rows
 443          * @param FormOptions $opts
 444          */
 445         public function webOutput( $rows, $opts ) {
 446                 global $wgRCShowWatchingUsers, $wgShowUpdatedMarker, $wgAllowCategorizedRecentChanges;
 447
 448                 // Build the final data
 449
 450                 if ( $wgAllowCategorizedRecentChanges ) {
 451                         $this->filterByCategories( $rows, $opts );
 452                 }
 453
 454                 $limit = $opts['limit'];
 455
 456                 $showWatcherCount = $wgRCShowWatchingUsers && $this->getUser()->getOption( 'shownumberswatching' );
 457                 $watcherCache = array();
 458
 459                 $dbr = wfGetDB( DB_SLAVE );
 460
 461                 $counter = 1;
 462                 $list = ChangesList::newFromContext( $this->getContext() );
 463
 464                 $rclistOutput = $list->beginRecentChangesList();
 465                 foreach ( $rows as $obj ) {
 466                         if ( $limit == 0 ) {
 467                                 break;
 468                         }
 469                         $rc = RecentChange::newFromRow( $obj );
 470                         $rc->counter = $counter++;
 471                         # Check if the page has been updated since the last visit
 472                         if ( $wgShowUpdatedMarker && !empty( $obj->wl_notificationtimestamp ) ) {
 473                                 $rc->notificationtimestamp = ( $obj->rc_timestamp >= $obj->wl_notificationtimestamp );
 474                         } else {
 475                                 $rc->notificationtimestamp = false; // Default
 476                         }
 477                         # Check the number of users watching the page
 478                         $rc->numberofWatchingusers = 0; // Default
 479                         if ( $showWatcherCount && $obj->rc_namespace >= 0 ) {
 480                                 if ( !isset( $watcherCache[$obj->rc_namespace][$obj->rc_title] ) ) {
 481                                         $watcherCache[$obj->rc_namespace][$obj->rc_title] =
 482                                                 $dbr->selectField(
 483                                                         'watchlist',
 484                                                         'COUNT(*)',
 485                                                         array(
 486                                                                 'wl_namespace' => $obj->rc_namespace,
 487                                                                 'wl_title' => $obj->rc_title,
 488                                                         ),
 489                                                         __METHOD__ . '-watchers'
 490                                                 );
 491                                 }
 492                                 $rc->numberofWatchingusers = $watcherCache[$obj->rc_namespace][$obj->rc_title];
 493                         }
 494
 495                         $changeLine = $list->recentChangesLine( $rc, !empty( $obj->wl_user ), $counter );
 496                         if ( $changeLine !== false ) {
 497                                 $rclistOutput .= $changeLine;
 498                                 --$limit;
 499                         }
 500                 }
 501                 $rclistOutput .= $list->endRecentChangesList();
 502
 503                 // Print things out
 504
 505                 if ( !$this->including() ) {
 506                         // Output options box
 507                         $this->doHeader( $opts );
 508                 }
 509
 510                 // And now for the content
 511                 $feedQuery = $this->getFeedQuery();
 512                 if ( $feedQuery !== '' ) {
 513                         $this->getOutput()->setFeedAppendQuery( $feedQuery );
 514                 } else {
 515                         $this->getOutput()->setFeedAppendQuery( false );
 516                 }
 517
 518                 if ( $rows->numRows() === 0 ) {
 519                         $this->getOutput()->wrapWikiMsg(
 520                                 "<div class='mw-changeslist-empty'>\n$1\n</div>", 'recentchanges-noresult'
 521                         );
 522                 } else {
 523                         $this->getOutput()->addHTML( $rclistOutput );
 524                 }
 525         }
 526
 527         /**
 528          * Get the query string to append to feed link URLs.
 529          *
 530          * @return string
 531          */
 532         public function getFeedQuery() {
 533                 global $wgFeedLimit;
 534
 535                 $this->getOptions()->validateIntBounds( 'limit', 0, $wgFeedLimit );
 536                 $options = $this->getOptions()->getChangedValues();
 537
 538                 // wfArrayToCgi() omits options set to null or false
 539                 foreach ( $options as &$value ) {
 540                         if ( $value === false ) {
 541                                 $value = '0';
 542                         }
 543                 }
 544                 unset( $value );
 545
 546                 return wfArrayToCgi( $options );
 547         }
 548
 549         /**
 550          * Return the text to be displayed above the changes
 551          *
 552          * @param FormOptions $opts
 553          * @return string XHTML
 554          */
 555         public function doHeader( $opts ) {
 556                 global $wgScript;
 557
 558                 $this->setTopText( $opts );
 559
 560                 $defaults = $opts->getAllValues();
 561                 $nondefaults = $opts->getChangedValues();
 562
 563                 $panel = array();
 564                 $panel[] = $this->optionsPanel( $defaults, $nondefaults );
 565                 $panel[] = '<hr />';
 566
 567                 $extraOpts = $this->getExtraOptions( $opts );
 568                 $extraOptsCount = count( $extraOpts );
 569                 $count = 0;
 570                 $submit = ' ' . Xml::submitbutton( $this->msg( 'allpagessubmit' )->text() );
 571
 572                 $out = Xml::openElement( 'table', array( 'class' => 'mw-recentchanges-table' ) );
 573                 foreach ( $extraOpts as $name => $optionRow ) {
 574                         # Add submit button to the last row only
 575                         ++$count;
 576                         $addSubmit = ( $count === $extraOptsCount ) ? $submit : '';
 577
 578                         $out .= Xml::openElement( 'tr' );
 579                         if ( is_array( $optionRow ) ) {
 580                                 $out .= Xml::tags(
 581                                         'td',
 582                                         array( 'class' => 'mw-label mw-' . $name . '-label' ),
 583                                         $optionRow[0]
 584                                 );
 585                                 $out .= Xml::tags(
 586                                         'td',
 587                                         array( 'class' => 'mw-input' ),
 588                                         $optionRow[1] . $addSubmit
 589                                 );
 590                         } else {
 591                                 $out .= Xml::tags(
 592                                         'td',
 593                                         array( 'class' => 'mw-input', 'colspan' => 2 ),
 594                                         $optionRow . $addSubmit
 595                                 );
 596                         }
 597                         $out .= Xml::closeElement( 'tr' );
 598                 }
 599                 $out .= Xml::closeElement( 'table' );
 600
 601                 $unconsumed = $opts->getUnconsumedValues();
 602                 foreach ( $unconsumed as $key => $value ) {
 603                         $out .= Html::hidden( $key, $value );
 604                 }
 605
 606                 $t = $this->getTitle();
 607                 $out .= Html::hidden( 'title', $t->getPrefixedText() );
 608                 $form = Xml::tags( 'form', array( 'action' => $wgScript ), $out );
 609                 $panel[] = $form;
 610                 $panelString = implode( "\n", $panel );
 611
 612                 $this->getOutput()->addHTML(
 613                         Xml::fieldset(
 614                                 $this->msg( 'recentchanges-legend' )->text(),
 615                                 $panelString,
 616                                 array( 'class' => 'rcoptions' )
 617                         )
 618                 );
 619
 620                 $this->setBottomText( $opts );
 621         }
 622
 623         /**
 624          * Get options to be displayed in a form
 625          *
 626          * @param FormOptions $opts
 627          * @return array
 628          */
 629         function getExtraOptions( $opts ) {
 630                 $opts->consumeValues( array(
 631                         'namespace', 'invert', 'associated', 'tagfilter', 'categories', 'categories_any'
 632                 ) );
 633
 634                 $extraOpts = array();
 635                 $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );
 636
 637                 global $wgAllowCategorizedRecentChanges;
 638                 if ( $wgAllowCategorizedRecentChanges ) {
 639                         $extraOpts['category'] = $this->categoryFilterForm( $opts );
 640                 }
 641
 642                 $tagFilter = ChangeTags::buildTagFilterSelector( $opts['tagfilter'] );
 643                 if ( count( $tagFilter ) ) {
 644                         $extraOpts['tagfilter'] = $tagFilter;
 645                 }
 646
 647                 // Don't fire the hook for subclasses. (Or should we?)
 648                 if ( $this->getName() === 'Recentchanges' ) {
 649                         wfRunHooks( 'SpecialRecentChangesPanel', array( &$extraOpts, $opts ) );
 650                 }
 651
 652                 return $extraOpts;
 653         }
 654
 655         /**
 656          * Send the text to be displayed above the options
 657          *
 658          * @param FormOptions $opts Unused
 659          */
 660         function setTopText( FormOptions $opts ) {
 661                 global $wgContLang;
 662
 663                 $message = $this->msg( 'recentchangestext' )->inContentLanguage();
 664                 if ( !$message->isDisabled() ) {
 665                         $this->getOutput()->addWikiText(
 666                                 Html::rawElement( 'p',
 667                                         array( 'lang' => $wgContLang->getCode(), 'dir' => $wgContLang->getDir() ),
 668                                         "\n" . $message->plain() . "\n"
 669                                 ),
 670                                 /* $lineStart */ false,
 671                                 /* $interface */ false
 672                         );
 673                 }
 674         }
 675
 676         /**
 677          * Send the text to be displayed after the options, for use in subclasses.
 678          *
 679          * @param FormOptions $opts
 680          */
 681         function setBottomText( FormOptions $opts ) {
 682         }
 683
 684         /**
 685          * Creates the choose namespace selection
 686          *
 687          * @todo Uses radio buttons (HASHAR)
 688          * @param FormOptions $opts
 689          * @return string
 690          */
 691         protected function namespaceFilterForm( FormOptions $opts ) {
 692                 $nsSelect = Html::namespaceSelector(
 693                         array( 'selected' => $opts['namespace'], 'all' => '' ),
 694                         array( 'name' => 'namespace', 'id' => 'namespace' )
 695                 );
 696                 $nsLabel = Xml::label( $this->msg( 'namespace' )->text(), 'namespace' );
 697                 $invert = Xml::checkLabel(
 698                         $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
 699                         $opts['invert'],
 700                         array( 'title' => $this->msg( 'tooltip-invert' )->text() )
 701                 );
 702                 $associated = Xml::checkLabel(
 703                         $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
 704                         $opts['associated'],
 705                         array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
 706                 );
 707
 708                 return array( $nsLabel, "$nsSelect $invert $associated" );
 709         }
 710
 711         /**
 712          * Create a input to filter changes by categories
 713          *
 714          * @param FormOptions $opts
 715          * @return array
 716          */
 717         protected function categoryFilterForm( FormOptions $opts ) {
 718                 list( $label, $input ) = Xml::inputLabelSep( $this->msg( 'rc_categories' )->text(),
 719                         'categories', 'mw-categories', false, $opts['categories'] );
 720
 721                 $input .= ' ' . Xml::checkLabel( $this->msg( 'rc_categories_any' )->text(),
 722                         'categories_any', 'mw-categories_any', $opts['categories_any'] );
 723
 724                 return array( $label, $input );
 725         }
 726
 727         /**
 728          * Filter $rows by categories set in $opts
 729          *
 730          * @param array $rows Database rows
 731          * @param FormOptions $opts
 732          */
 733         function filterByCategories( &$rows, FormOptions $opts ) {
 734                 $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );
 735
 736                 if ( !count( $categories ) ) {
 737                         return;
 738                 }
 739
 740                 # Filter categories
 741                 $cats = array();
 742                 foreach ( $categories as $cat ) {
 743                         $cat = trim( $cat );
 744                         if ( $cat == '' ) {
 745                                 continue;
 746                         }
 747                         $cats[] = $cat;
 748                 }
 749
 750                 # Filter articles
 751                 $articles = array();
 752                 $a2r = array();
 753                 $rowsarr = array();
 754                 foreach ( $rows as $k => $r ) {
 755                         $nt = Title::makeTitle( $r->rc_namespace, $r->rc_title );
 756                         $id = $nt->getArticleID();
 757                         if ( $id == 0 ) {
 758                                 continue; # Page might have been deleted...
 759                         }
 760                         if ( !in_array( $id, $articles ) ) {
 761                                 $articles[] = $id;
 762                         }
 763                         if ( !isset( $a2r[$id] ) ) {
 764                                 $a2r[$id] = array();
 765                         }
 766                         $a2r[$id][] = $k;
 767                         $rowsarr[$k] = $r;
 768                 }
 769
 770                 # Shortcut?
 771                 if ( !count( $articles ) || !count( $cats ) ) {
 772                         return;
 773                 }
 774
 775                 # Look up
 776                 $c = new Categoryfinder;
 777                 $c->seed( $articles, $cats, $opts['categories_any'] ? 'OR' : 'AND' );
 778                 $match = $c->run();
 779
 780                 # Filter
 781                 $newrows = array();
 782                 foreach ( $match as $id ) {
 783                         foreach ( $a2r[$id] as $rev ) {
 784                                 $k = $rev;
 785                                 $newrows[$k] = $rowsarr[$k];
 786                         }
 787                 }
 788                 $rows = $newrows;
 789         }
 790
 791         /**
 792          * Makes change an option link which carries all the other options
 793          *
 794          * @param string $title Title
 795          * @param array $override Options to override
 796          * @param array $options Current options
 797          * @param bool $active Whether to show the link in bold
 798          * @return string
 799          */
 800         function makeOptionsLink( $title, $override, $options, $active = false ) {
 801                 $params = $override + $options;
 802
 803                 // Bug 36524: false values have be converted to "0" otherwise
 804                 // wfArrayToCgi() will omit it them.
 805                 foreach ( $params as &$value ) {
 806                         if ( $value === false ) {
 807                                 $value = '0';
 808                         }
 809                 }
 810                 unset( $value );
 811
 812                 $text = htmlspecialchars( $title );
 813                 if ( $active ) {
 814                         $text = '<strong>' . $text . '</strong>';
 815                 }
 816
 817                 return Linker::linkKnown( $this->getTitle(), $text, array(), $params );
 818         }
 819
 820         /**
 821          * Creates the options panel.
 822          *
 823          * @param array $defaults
 824          * @param array $nondefaults
 825          * @return string
 826          */
 827         function optionsPanel( $defaults, $nondefaults ) {
 828                 global $wgRCLinkLimits, $wgRCLinkDays;
 829
 830                 $options = $nondefaults + $defaults;
 831
 832                 $note = '';
 833                 $msg = $this->msg( 'rclegend' );
 834                 if ( !$msg->isDisabled() ) {
 835                         $note .= '<div class="mw-rclegend">' . $msg->parse() . "</div>\n";
 836                 }
 837
 838                 $lang = $this->getLanguage();
 839                 $user = $this->getUser();
 840                 if ( $options['from'] ) {
 841                         $note .= $this->msg( 'rcnotefrom' )->numParams( $options['limit'] )->params(
 842                                 $lang->userTimeAndDate( $options['from'], $user ),
 843                                 $lang->userDate( $options['from'], $user ),
 844                                 $lang->userTime( $options['from'], $user ) )->parse() . '<br />';
 845                 }
 846
 847                 # Sort data for display and make sure it's unique after we've added user data.
 848                 $linkLimits = $wgRCLinkLimits;
 849                 $linkLimits[] = $options['limit'];
 850                 sort( $linkLimits );
 851                 $linkLimits = array_unique( $linkLimits );
 852
 853                 $linkDays = $wgRCLinkDays;
 854                 $linkDays[] = $options['days'];
 855                 sort( $linkDays );
 856                 $linkDays = array_unique( $linkDays );
 857
 858                 // limit links
 859                 $cl = array();
 860                 foreach ( $linkLimits as $value ) {
 861                         $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
 862                                 array( 'limit' => $value ), $nondefaults, $value == $options['limit'] );
 863                 }
 864                 $cl = $lang->pipeList( $cl );
 865
 866                 // day links, reset 'from' to none
 867                 $dl = array();
 868                 foreach ( $linkDays as $value ) {
 869                         $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
 870                                 array( 'days' => $value, 'from' => '' ), $nondefaults, $value == $options['days'] );
 871                 }
 872                 $dl = $lang->pipeList( $dl );
 873
 874                 // show/hide links
 875                 $showhide = array( $this->msg( 'show' )->text(), $this->msg( 'hide' )->text() );
 876                 $filters = array(
 877                         'hideminor' => 'rcshowhideminor',
 878                         'hidebots' => 'rcshowhidebots',
 879                         'hideanons' => 'rcshowhideanons',
 880                         'hideliu' => 'rcshowhideliu',
 881                         'hidepatrolled' => 'rcshowhidepatr',
 882                         'hidemyself' => 'rcshowhidemine'
 883                 );
 884                 foreach ( $this->getCustomFilters() as $key => $params ) {
 885                         $filters[$key] = $params['msg'];
 886                 }
 887                 // Disable some if needed
 888                 if ( !$user->useRCPatrol() ) {
 889                         unset( $filters['hidepatrolled'] );
 890                 }
 891
 892                 $links = array();
 893                 foreach ( $filters as $key => $msg ) {
 894                         $link = $this->makeOptionsLink( $showhide[1 - $options[$key]],
 895                                 array( $key => 1 - $options[$key] ), $nondefaults );
 896                         $links[] = $this->msg( $msg )->rawParams( $link )->escaped();
 897                 }
 898
 899                 // show from this onward link
 900                 $timestamp = wfTimestampNow();
 901                 $now = $lang->userTimeAndDate( $timestamp, $user );
 902                 $tl = $this->makeOptionsLink(
 903                         $now, array( 'from' => $timestamp ), $nondefaults
 904                 );
 905
 906                 $rclinks = $this->msg( 'rclinks' )->rawParams( $cl, $dl, $lang->pipeList( $links ) )
 907                         ->parse();
 908                 $rclistfrom = $this->msg( 'rclistfrom' )->rawParams( $tl )->parse();
 909
 910                 return "{$note}$rclinks<br />$rclistfrom";
 911         }
 912
 913         /**
 914          * Add JavaScript to the page
 915          */
 916         function addRecentChangesJS() {
 917                 $this->getOutput()->addModules( array(
 918                         'mediawiki.special.recentchanges',
 919                 ) );
 920         }
 921
 922         protected function getGroupName() {
 923                 return 'changes';
 924         }
 925 }