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 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Rdbms\ResultWrapper;
  26 use Wikimedia\Rdbms\FakeResultWrapper;
  27
  28 /**
  29  * A special page that lists last changes made to the wiki
  30  *
  31  * @ingroup SpecialPage
  32  */
  33 class SpecialRecentChanges extends ChangesListSpecialPage {
  34
  35         private $watchlistFilterGroupDefinition;
  36
  37         // @codingStandardsIgnoreStart Needed "useless" override to change parameters.
  38         public function __construct( $name = 'Recentchanges', $restriction = '' ) {
  39                 parent::__construct( $name, $restriction );
  40
  41                 $this->watchlistFilterGroupDefinition = [
  42                         'name' => 'watchlist',
  43                         'title' => 'rcfilters-filtergroup-watchlist',
  44                         'class' => ChangesListStringOptionsFilterGroup::class,
  45                         'priority' => -9,
  46                         'isFullCoverage' => true,
  47                         'filters' => [
  48                                 [
  49                                         'name' => 'watched',
  50                                         'label' => 'rcfilters-filter-watchlist-watched-label',
  51                                         'description' => 'rcfilters-filter-watchlist-watched-description',
  52                                         'cssClassSuffix' => 'watched',
  53                                         'isRowApplicableCallable' => function ( $ctx, $rc ) {
  54                                                 return $rc->getAttribute( 'wl_user' );
  55                                         }
  56                                 ],
  57                                 [
  58                                         'name' => 'watchednew',
  59                                         'label' => 'rcfilters-filter-watchlist-watchednew-label',
  60                                         'description' => 'rcfilters-filter-watchlist-watchednew-description',
  61                                         'cssClassSuffix' => 'watchednew',
  62                                         'isRowApplicableCallable' => function ( $ctx, $rc ) {
  63                                                 return $rc->getAttribute( 'wl_user' ) &&
  64                                                         $rc->getAttribute( 'rc_timestamp' ) &&
  65                                                         $rc->getAttribute( 'wl_notificationtimestamp' ) &&
  66                                                         $rc->getAttribute( 'rc_timestamp' ) >= $rc->getAttribute( 'wl_notificationtimestamp' );
  67                                         },
  68                                 ],
  69                                 [
  70                                         'name' => 'notwatched',
  71                                         'label' => 'rcfilters-filter-watchlist-notwatched-label',
  72                                         'description' => 'rcfilters-filter-watchlist-notwatched-description',
  73                                         'cssClassSuffix' => 'notwatched',
  74                                         'isRowApplicableCallable' => function ( $ctx, $rc ) {
  75                                                 return $rc->getAttribute( 'wl_user' ) === null;
  76                                         },
  77                                 ]
  78                         ],
  79                         'default' => ChangesListStringOptionsFilterGroup::NONE,
  80                         'queryCallable' => function ( $specialPageClassName, $context, $dbr,
  81                                 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedValues ) {
  82                                 sort( $selectedValues );
  83                                 $notwatchedCond = 'wl_user IS NULL';
  84                                 $watchedCond = 'wl_user IS NOT NULL';
  85                                 $newCond = 'rc_timestamp >= wl_notificationtimestamp';
  86
  87                                 if ( $selectedValues === [ 'notwatched' ] ) {
  88                                         $conds[] = $notwatchedCond;
  89                                         return;
  90                                 }
  91
  92                                 if ( $selectedValues === [ 'watched' ] ) {
  93                                         $conds[] = $watchedCond;
  94                                         return;
  95                                 }
  96
  97                                 if ( $selectedValues === [ 'watchednew' ] ) {
  98                                         $conds[] = $dbr->makeList( [
  99                                                 $watchedCond,
 100                                                 $newCond
 101                                         ], LIST_AND );
 102                                         return;
 103                                 }
 104
 105                                 if ( $selectedValues === [ 'notwatched', 'watched' ] ) {
 106                                         // no filters
 107                                         return;
 108                                 }
 109
 110                                 if ( $selectedValues === [ 'notwatched', 'watchednew' ] ) {
 111                                         $conds[] = $dbr->makeList( [
 112                                                 $notwatchedCond,
 113                                                 $dbr->makeList( [
 114                                                         $watchedCond,
 115                                                         $newCond
 116                                                 ], LIST_AND )
 117                                         ], LIST_OR );
 118                                         return;
 119                                 }
 120
 121                                 if ( $selectedValues === [ 'watched', 'watchednew' ] ) {
 122                                         $conds[] = $watchedCond;
 123                                         return;
 124                                 }
 125
 126                                 if ( $selectedValues === [ 'notwatched', 'watched', 'watchednew' ] ) {
 127                                         // no filters
 128                                         return;
 129                                 }
 130                         }
 131                 ];
 132         }
 133         // @codingStandardsIgnoreEnd
 134
 135         /**
 136          * Main execution point
 137          *
 138          * @param string $subpage
 139          */
 140         public function execute( $subpage ) {
 141                 // Backwards-compatibility: redirect to new feed URLs
 142                 $feedFormat = $this->getRequest()->getVal( 'feed' );
 143                 if ( !$this->including() && $feedFormat ) {
 144                         $query = $this->getFeedQuery();
 145                         $query['feedformat'] = $feedFormat === 'atom' ? 'atom' : 'rss';
 146                         $this->getOutput()->redirect( wfAppendQuery( wfScript( 'api' ), $query ) );
 147
 148                         return;
 149                 }
 150
 151                 // 10 seconds server-side caching max
 152                 $out = $this->getOutput();
 153                 $out->setCdnMaxage( 10 );
 154                 // Check if the client has a cached version
 155                 $lastmod = $this->checkLastModified();
 156                 if ( $lastmod === false ) {
 157                         return;
 158                 }
 159
 160                 $this->addHelpLink(
 161                         '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Recent_changes',
 162                         true
 163                 );
 164                 parent::execute( $subpage );
 165
 166                 if ( $this->isStructuredFilterUiEnabled() ) {
 167                         $jsData = $this->getStructuredFilterJsData();
 168
 169                         $messages = [];
 170                         foreach ( $jsData['messageKeys'] as $key ) {
 171                                 $messages[$key] = $this->msg( $key )->plain();
 172                         }
 173
 174                         $out->addHTML(
 175                                 ResourceLoader::makeInlineScript(
 176                                         ResourceLoader::makeMessageSetScript( $messages )
 177                                 )
 178                         );
 179
 180                         $experimentalStructuredChangeFilters =
 181                                 $this->getConfig()->get( 'StructuredChangeFiltersEnableExperimentalViews' );
 182
 183                         $out->addJsConfigVars( 'wgStructuredChangeFilters', $jsData['groups'] );
 184                         $out->addJsConfigVars(
 185                                 'wgStructuredChangeFiltersEnableSaving',
 186                                 $this->getConfig()->get( 'StructuredChangeFiltersEnableSaving' )
 187                         );
 188                         $out->addJsConfigVars(
 189                                 'wgStructuredChangeFiltersEnableExperimentalViews',
 190                                 $experimentalStructuredChangeFilters
 191                         );
 192                         $out->addJsConfigVars(
 193                                 'wgStructuredChangeFiltersEnableLiveUpdate',
 194                                 $this->getConfig()->get( 'StructuredChangeFiltersEnableLiveUpdate' )
 195                         );
 196                         if ( $experimentalStructuredChangeFilters ) {
 197                                 $out->addJsConfigVars(
 198                                         'wgRCFiltersChangeTags',
 199                                         $this->buildChangeTagList()
 200                                 );
 201                         }
 202                 }
 203         }
 204
 205         /**
 206          * Fetch the change tags list for the front end
 207          *
 208          * @return Array Tag data
 209          */
 210         protected function buildChangeTagList() {
 211                 $explicitlyDefinedTags = array_fill_keys( ChangeTags::listExplicitlyDefinedTags(), 0 );
 212                 $softwareActivatedTags = array_fill_keys( ChangeTags::listSoftwareActivatedTags(), 0 );
 213
 214                 // Hit counts disabled for perf reasons, see T169997
 215                 /*
 216                 $tagStats = ChangeTags::tagUsageStatistics();
 217                 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
 218
 219                 // Sort by hits
 220                 arsort( $tagHitCounts );
 221                 */
 222                 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags );
 223
 224                 // Build the list and data
 225                 $result = [];
 226                 foreach ( $tagHitCounts as $tagName => $hits ) {
 227                         if (
 228                                 // Only get active tags
 229                                 isset( $explicitlyDefinedTags[ $tagName ] ) ||
 230                                 isset( $softwareActivatedTags[ $tagName ] )
 231                         ) {
 232                                 // Parse description
 233                                 $desc = ChangeTags::tagLongDescriptionMessage( $tagName, $this->getContext() );
 234
 235                                 $result[] = [
 236                                         'name' => $tagName,
 237                                         'label' => Sanitizer::stripAllTags(
 238                                                 ChangeTags::tagDescription( $tagName, $this->getContext() )
 239                                         ),
 240                                         'description' => $desc ? Sanitizer::stripAllTags( $desc->parse() ) : '',
 241                                         'cssClass' => Sanitizer::escapeClass( 'mw-tag-' . $tagName ),
 242                                         'hits' => $hits,
 243                                 ];
 244                         }
 245                 }
 246
 247                 // Instead of sorting by hit count (disabled, see above), sort by display name
 248                 usort( $result, function ( $a, $b ) {
 249                         return strcasecmp( $a['label'], $b['label'] );
 250                 } );
 251
 252                 return $result;
 253         }
 254
 255         /**
 256          * @inheritdoc
 257          */
 258         protected function transformFilterDefinition( array $filterDefinition ) {
 259                 if ( isset( $filterDefinition['showHideSuffix'] ) ) {
 260                         $filterDefinition['showHide'] = 'rc' . $filterDefinition['showHideSuffix'];
 261                 }
 262
 263                 return $filterDefinition;
 264         }
 265
 266         /**
 267          * @inheritdoc
 268          */
 269         protected function registerFilters() {
 270                 parent::registerFilters();
 271
 272                 if (
 273                         !$this->including() &&
 274                         $this->getUser()->isLoggedIn() &&
 275                         $this->getUser()->isAllowed( 'viewmywatchlist' )
 276                 ) {
 277                         $this->registerFiltersFromDefinitions( [ $this->watchlistFilterGroupDefinition ] );
 278                         $watchlistGroup = $this->getFilterGroup( 'watchlist' );
 279                         $watchlistGroup->getFilter( 'watched' )->setAsSupersetOf(
 280                                 $watchlistGroup->getFilter( 'watchednew' )
 281                         );
 282                 }
 283
 284                 $user = $this->getUser();
 285
 286                 $significance = $this->getFilterGroup( 'significance' );
 287                 $hideMinor = $significance->getFilter( 'hideminor' );
 288                 $hideMinor->setDefault( $user->getBoolOption( 'hideminor' ) );
 289
 290                 $automated = $this->getFilterGroup( 'automated' );
 291                 $hideBots = $automated->getFilter( 'hidebots' );
 292                 $hideBots->setDefault( true );
 293
 294                 $reviewStatus = $this->getFilterGroup( 'reviewStatus' );
 295                 if ( $reviewStatus !== null ) {
 296                         // Conditional on feature being available and rights
 297                         $hidePatrolled = $reviewStatus->getFilter( 'hidepatrolled' );
 298                         $hidePatrolled->setDefault( $user->getBoolOption( 'hidepatrolled' ) );
 299                 }
 300
 301                 $changeType = $this->getFilterGroup( 'changeType' );
 302                 $hideCategorization = $changeType->getFilter( 'hidecategorization' );
 303                 if ( $hideCategorization !== null ) {
 304                         // Conditional on feature being available
 305                         $hideCategorization->setDefault( $user->getBoolOption( 'hidecategorization' ) );
 306                 }
 307         }
 308
 309         /**
 310          * Get a FormOptions object containing the default options
 311          *
 312          * @return FormOptions
 313          */
 314         public function getDefaultOptions() {
 315                 $opts = parent::getDefaultOptions();
 316                 $user = $this->getUser();
 317
 318                 $opts->add( 'days', $user->getIntOption( 'rcdays' ), FormOptions::FLOAT );
 319                 $opts->add( 'limit', $user->getIntOption( 'rclimit' ) );
 320                 $opts->add( 'from', '' );
 321
 322                 $opts->add( 'categories', '' );
 323                 $opts->add( 'categories_any', false );
 324                 $opts->add( 'tagfilter', '' );
 325
 326                 return $opts;
 327         }
 328
 329         /**
 330          * Get all custom filters
 331          *
 332          * @return array Map of filter URL param names to properties (msg/default)
 333          */
 334         protected function getCustomFilters() {
 335                 if ( $this->customFilters === null ) {
 336                         $this->customFilters = parent::getCustomFilters();
 337                         Hooks::run( 'SpecialRecentChangesFilters', [ $this, &$this->customFilters ], '1.23' );
 338                 }
 339
 340                 return $this->customFilters;
 341         }
 342
 343         /**
 344          * Process $par and put options found in $opts. Used when including the page.
 345          *
 346          * @param string $par
 347          * @param FormOptions $opts
 348          */
 349         public function parseParameters( $par, FormOptions $opts ) {
 350                 parent::parseParameters( $par, $opts );
 351
 352                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
 353                 foreach ( $bits as $bit ) {
 354                         if ( is_numeric( $bit ) ) {
 355                                 $opts['limit'] = $bit;
 356                         }
 357
 358                         $m = [];
 359                         if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
 360                                 $opts['limit'] = $m[1];
 361                         }
 362                         if ( preg_match( '/^days=(\d+(?:\.\d+)?)$/', $bit, $m ) ) {
 363                                 $opts['days'] = $m[1];
 364                         }
 365                         if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
 366                                 $opts['namespace'] = $m[1];
 367                         }
 368                         if ( preg_match( '/^tagfilter=(.*)$/', $bit, $m ) ) {
 369                                 $opts['tagfilter'] = $m[1];
 370                         }
 371                 }
 372         }
 373
 374         public function validateOptions( FormOptions $opts ) {
 375                 $opts->validateIntBounds( 'limit', 0, 5000 );
 376                 parent::validateOptions( $opts );
 377         }
 378
 379         /**
 380          * @inheritdoc
 381          */
 382         protected function buildQuery( &$tables, &$fields, &$conds,
 383                 &$query_options, &$join_conds, FormOptions $opts
 384         ) {
 385                 $dbr = $this->getDB();
 386                 parent::buildQuery( $tables, $fields, $conds,
 387                         $query_options, $join_conds, $opts );
 388
 389                 // Calculate cutoff
 390                 $cutoff_unixtime = time() - ( $opts['days'] * 86400 );
 391                 $cutoff = $dbr->timestamp( $cutoff_unixtime );
 392
 393                 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
 394                 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW, $cutoff ) ) {
 395                         $cutoff = $dbr->timestamp( $opts['from'] );
 396                 } else {
 397                         $opts->reset( 'from' );
 398                 }
 399
 400                 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
 401         }
 402
 403         /**
 404          * @inheritdoc
 405          */
 406         protected function doMainQuery( $tables, $fields, $conds, $query_options,
 407                 $join_conds, FormOptions $opts
 408         ) {
 409                 $dbr = $this->getDB();
 410                 $user = $this->getUser();
 411
 412                 $tables[] = 'recentchanges';
 413                 $fields = array_merge( RecentChange::selectFields(), $fields );
 414
 415                 // JOIN on watchlist for users
 416                 if ( $user->isLoggedIn() && $user->isAllowed( 'viewmywatchlist' ) ) {
 417                         $tables[] = 'watchlist';
 418                         $fields[] = 'wl_user';
 419                         $fields[] = 'wl_notificationtimestamp';
 420                         $join_conds['watchlist'] = [ 'LEFT JOIN', [
 421                                 'wl_user' => $user->getId(),
 422                                 'wl_title=rc_title',
 423                                 'wl_namespace=rc_namespace'
 424                         ] ];
 425                 }
 426
 427                 // JOIN on page, used for 'last revision' filter highlight
 428                 $tables[] = 'page';
 429                 $fields[] = 'page_latest';
 430                 $join_conds['page'] = [ 'LEFT JOIN', 'rc_cur_id=page_id' ];
 431
 432                 ChangeTags::modifyDisplayQuery(
 433                         $tables,
 434                         $fields,
 435                         $conds,
 436                         $join_conds,
 437                         $query_options,
 438                         $opts['tagfilter']
 439                 );
 440
 441                 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
 442                         $opts )
 443                 ) {
 444                         return false;
 445                 }
 446
 447                 if ( $this->areFiltersInConflict() ) {
 448                         return false;
 449                 }
 450
 451                 // array_merge() is used intentionally here so that hooks can, should
 452                 // they so desire, override the ORDER BY / LIMIT condition(s); prior to
 453                 // MediaWiki 1.26 this used to use the plus operator instead, which meant
 454                 // that extensions weren't able to change these conditions
 455                 $query_options = array_merge( [
 456                         'ORDER BY' => 'rc_timestamp DESC',
 457                         'LIMIT' => $opts['limit'] ], $query_options );
 458                 $rows = $dbr->select(
 459                         $tables,
 460                         $fields,
 461                         // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
 462                         // knowledge to use an index merge if it wants (it may use some other index though).
 463                         $conds + [ 'rc_new' => [ 0, 1 ] ],
 464                         __METHOD__,
 465                         $query_options,
 466                         $join_conds
 467                 );
 468
 469                 // Build the final data
 470                 if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
 471                         $this->filterByCategories( $rows, $opts );
 472                 }
 473
 474                 return $rows;
 475         }
 476
 477         protected function runMainQueryHook( &$tables, &$fields, &$conds,
 478                 &$query_options, &$join_conds, $opts
 479         ) {
 480                 return parent::runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds, $opts )
 481                         && Hooks::run(
 482                                 'SpecialRecentChangesQuery',
 483                                 [ &$conds, &$tables, &$join_conds, $opts, &$query_options, &$fields ],
 484                                 '1.23'
 485                         );
 486         }
 487
 488         protected function getDB() {
 489                 return wfGetDB( DB_REPLICA, 'recentchanges' );
 490         }
 491
 492         public function outputFeedLinks() {
 493                 $this->addFeedLinks( $this->getFeedQuery() );
 494         }
 495
 496         /**
 497          * Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.
 498          *
 499          * @return array
 500          */
 501         protected function getFeedQuery() {
 502                 $query = array_filter( $this->getOptions()->getAllValues(), function ( $value ) {
 503                         // API handles empty parameters in a different way
 504                         return $value !== '';
 505                 } );
 506                 $query['action'] = 'feedrecentchanges';
 507                 $feedLimit = $this->getConfig()->get( 'FeedLimit' );
 508                 if ( $query['limit'] > $feedLimit ) {
 509                         $query['limit'] = $feedLimit;
 510                 }
 511
 512                 return $query;
 513         }
 514
 515         /**
 516          * Build and output the actual changes list.
 517          *
 518          * @param ResultWrapper $rows Database rows
 519          * @param FormOptions $opts
 520          */
 521         public function outputChangesList( $rows, $opts ) {
 522                 $limit = $opts['limit'];
 523
 524                 $showWatcherCount = $this->getConfig()->get( 'RCShowWatchingUsers' )
 525                         && $this->getUser()->getOption( 'shownumberswatching' );
 526                 $watcherCache = [];
 527
 528                 $dbr = $this->getDB();
 529
 530                 $counter = 1;
 531                 $list = ChangesList::newFromContext( $this->getContext(), $this->filterGroups );
 532                 $list->initChangesListRows( $rows );
 533
 534                 $userShowHiddenCats = $this->getUser()->getBoolOption( 'showhiddencats' );
 535                 $rclistOutput = $list->beginRecentChangesList();
 536                 if ( $this->isStructuredFilterUiEnabled() ) {
 537                         $rclistOutput .= $this->makeLegend();
 538                 }
 539
 540                 foreach ( $rows as $obj ) {
 541                         if ( $limit == 0 ) {
 542                                 break;
 543                         }
 544                         $rc = RecentChange::newFromRow( $obj );
 545
 546                         # Skip CatWatch entries for hidden cats based on user preference
 547                         if (
 548                                 $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE &&
 549                                 !$userShowHiddenCats &&
 550                                 $rc->getParam( 'hidden-cat' )
 551                         ) {
 552                                 continue;
 553                         }
 554
 555                         $rc->counter = $counter++;
 556                         # Check if the page has been updated since the last visit
 557                         if ( $this->getConfig()->get( 'ShowUpdatedMarker' )
 558                                 && !empty( $obj->wl_notificationtimestamp )
 559                         ) {
 560                                 $rc->notificationtimestamp = ( $obj->rc_timestamp >= $obj->wl_notificationtimestamp );
 561                         } else {
 562                                 $rc->notificationtimestamp = false; // Default
 563                         }
 564                         # Check the number of users watching the page
 565                         $rc->numberofWatchingusers = 0; // Default
 566                         if ( $showWatcherCount && $obj->rc_namespace >= 0 ) {
 567                                 if ( !isset( $watcherCache[$obj->rc_namespace][$obj->rc_title] ) ) {
 568                                         $watcherCache[$obj->rc_namespace][$obj->rc_title] =
 569                                                 MediaWikiServices::getInstance()->getWatchedItemStore()->countWatchers(
 570                                                         new TitleValue( (int)$obj->rc_namespace, $obj->rc_title )
 571                                                 );
 572                                 }
 573                                 $rc->numberofWatchingusers = $watcherCache[$obj->rc_namespace][$obj->rc_title];
 574                         }
 575
 576                         $changeLine = $list->recentChangesLine( $rc, !empty( $obj->wl_user ), $counter );
 577                         if ( $changeLine !== false ) {
 578                                 $rclistOutput .= $changeLine;
 579                                 --$limit;
 580                         }
 581                 }
 582                 $rclistOutput .= $list->endRecentChangesList();
 583
 584                 if ( $rows->numRows() === 0 ) {
 585                         $this->outputNoResults();
 586                         if ( !$this->including() ) {
 587                                 $this->getOutput()->setStatusCode( 404 );
 588                         }
 589                 } else {
 590                         $this->getOutput()->addHTML( $rclistOutput );
 591                 }
 592         }
 593
 594         /**
 595          * Set the text to be displayed above the changes
 596          *
 597          * @param FormOptions $opts
 598          * @param int $numRows Number of rows in the result to show after this header
 599          */
 600         public function doHeader( $opts, $numRows ) {
 601                 $this->setTopText( $opts );
 602
 603                 $defaults = $opts->getAllValues();
 604                 $nondefaults = $opts->getChangedValues();
 605
 606                 $panel = [];
 607                 if ( !$this->isStructuredFilterUiEnabled() ) {
 608                         $panel[] = $this->makeLegend();
 609                 }
 610                 $panel[] = $this->optionsPanel( $defaults, $nondefaults, $numRows );
 611                 $panel[] = '<hr />';
 612
 613                 $extraOpts = $this->getExtraOptions( $opts );
 614                 $extraOptsCount = count( $extraOpts );
 615                 $count = 0;
 616                 $submit = ' ' . Xml::submitButton( $this->msg( 'recentchanges-submit' )->text() );
 617
 618                 $out = Xml::openElement( 'table', [ 'class' => 'mw-recentchanges-table' ] );
 619                 foreach ( $extraOpts as $name => $optionRow ) {
 620                         # Add submit button to the last row only
 621                         ++$count;
 622                         $addSubmit = ( $count === $extraOptsCount ) ? $submit : '';
 623
 624                         $out .= Xml::openElement( 'tr' );
 625                         if ( is_array( $optionRow ) ) {
 626                                 $out .= Xml::tags(
 627                                         'td',
 628                                         [ 'class' => 'mw-label mw-' . $name . '-label' ],
 629                                         $optionRow[0]
 630                                 );
 631                                 $out .= Xml::tags(
 632                                         'td',
 633                                         [ 'class' => 'mw-input' ],
 634                                         $optionRow[1] . $addSubmit
 635                                 );
 636                         } else {
 637                                 $out .= Xml::tags(
 638                                         'td',
 639                                         [ 'class' => 'mw-input', 'colspan' => 2 ],
 640                                         $optionRow . $addSubmit
 641                                 );
 642                         }
 643                         $out .= Xml::closeElement( 'tr' );
 644                 }
 645                 $out .= Xml::closeElement( 'table' );
 646
 647                 $unconsumed = $opts->getUnconsumedValues();
 648                 foreach ( $unconsumed as $key => $value ) {
 649                         $out .= Html::hidden( $key, $value );
 650                 }
 651
 652                 $t = $this->getPageTitle();
 653                 $out .= Html::hidden( 'title', $t->getPrefixedText() );
 654                 $form = Xml::tags( 'form', [ 'action' => wfScript() ], $out );
 655                 $panel[] = $form;
 656                 $panelString = implode( "\n", $panel );
 657
 658                 $rcoptions = Xml::fieldset(
 659                         $this->msg( 'recentchanges-legend' )->text(),
 660                         $panelString,
 661                         [ 'class' => 'rcoptions' ]
 662                 );
 663
 664                 // Insert a placeholder for RCFilters
 665                 if ( $this->getUser()->getOption( 'rcenhancedfilters' ) ) {
 666                         $rcfilterContainer = Html::element(
 667                                 'div',
 668                                 [ 'class' => 'rcfilters-container' ]
 669                         );
 670
 671                         $loadingContainer = Html::rawElement(
 672                                 'div',
 673                                 [ 'class' => 'rcfilters-spinner' ],
 674                                 Html::element(
 675                                         'div',
 676                                         [ 'class' => 'rcfilters-spinner-bounce' ]
 677                                 )
 678                         );
 679
 680                         // Wrap both with rcfilters-head
 681                         $this->getOutput()->addHTML(
 682                                 Html::rawElement(
 683                                         'div',
 684                                         [ 'class' => 'rcfilters-head' ],
 685                                         $rcfilterContainer . $rcoptions
 686                                 )
 687                         );
 688
 689                         // Add spinner
 690                         $this->getOutput()->addHTML( $loadingContainer );
 691                 } else {
 692                         $this->getOutput()->addHTML( $rcoptions );
 693                 }
 694
 695                 $this->setBottomText( $opts );
 696         }
 697
 698         /**
 699          * Send the text to be displayed above the options
 700          *
 701          * @param FormOptions $opts Unused
 702          */
 703         function setTopText( FormOptions $opts ) {
 704                 global $wgContLang;
 705
 706                 $message = $this->msg( 'recentchangestext' )->inContentLanguage();
 707                 if ( !$message->isDisabled() ) {
 708                         $this->getOutput()->addWikiText(
 709                                 Html::rawElement( 'div',
 710                                         [
 711                                                 'class' => 'mw-recentchanges-toplinks',
 712                                                 'lang' => $wgContLang->getHtmlCode(),
 713                                                 'dir' => $wgContLang->getDir()
 714                                         ],
 715                                         "\n" . $message->plain() . "\n"
 716                                 ),
 717                                 /* $lineStart */ true,
 718                                 /* $interface */ false
 719                         );
 720                 }
 721         }
 722
 723         /**
 724          * Get options to be displayed in a form
 725          *
 726          * @param FormOptions $opts
 727          * @return array
 728          */
 729         function getExtraOptions( $opts ) {
 730                 $opts->consumeValues( [
 731                         'namespace', 'invert', 'associated', 'tagfilter', 'categories', 'categories_any'
 732                 ] );
 733
 734                 $extraOpts = [];
 735                 $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );
 736
 737                 if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
 738                         $extraOpts['category'] = $this->categoryFilterForm( $opts );
 739                 }
 740
 741                 $tagFilter = ChangeTags::buildTagFilterSelector(
 742                         $opts['tagfilter'], false, $this->getContext() );
 743                 if ( count( $tagFilter ) ) {
 744                         $extraOpts['tagfilter'] = $tagFilter;
 745                 }
 746
 747                 // Don't fire the hook for subclasses. (Or should we?)
 748                 if ( $this->getName() === 'Recentchanges' ) {
 749                         Hooks::run( 'SpecialRecentChangesPanel', [ &$extraOpts, $opts ] );
 750                 }
 751
 752                 return $extraOpts;
 753         }
 754
 755         /**
 756          * Check whether the structured filter UI is enabled
 757          *
 758          * @return bool
 759          */
 760         protected function isStructuredFilterUiEnabled() {
 761                 return $this->getUser()->getOption(
 762                         'rcenhancedfilters'
 763                 );
 764         }
 765
 766         /**
 767          * Add page-specific modules.
 768          */
 769         protected function addModules() {
 770                 parent::addModules();
 771                 $out = $this->getOutput();
 772                 $out->addModules( 'mediawiki.special.recentchanges' );
 773                 if ( $this->isStructuredFilterUiEnabled() ) {
 774                         $out->addModules( 'mediawiki.rcfilters.filters.ui' );
 775                         $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
 776                 }
 777         }
 778
 779         /**
 780          * Get last modified date, for client caching
 781          * Don't use this if we are using the patrol feature, patrol changes don't
 782          * update the timestamp
 783          *
 784          * @return string|bool
 785          */
 786         public function checkLastModified() {
 787                 $dbr = $this->getDB();
 788                 $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', false, __METHOD__ );
 789
 790                 return $lastmod;
 791         }
 792
 793         /**
 794          * Creates the choose namespace selection
 795          *
 796          * @param FormOptions $opts
 797          * @return string
 798          */
 799         protected function namespaceFilterForm( FormOptions $opts ) {
 800                 $nsSelect = Html::namespaceSelector(
 801                         [ 'selected' => $opts['namespace'], 'all' => '' ],
 802                         [ 'name' => 'namespace', 'id' => 'namespace' ]
 803                 );
 804                 $nsLabel = Xml::label( $this->msg( 'namespace' )->text(), 'namespace' );
 805                 $invert = Xml::checkLabel(
 806                         $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
 807                         $opts['invert'],
 808                         [ 'title' => $this->msg( 'tooltip-invert' )->text() ]
 809                 );
 810                 $associated = Xml::checkLabel(
 811                         $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
 812                         $opts['associated'],
 813                         [ 'title' => $this->msg( 'tooltip-namespace_association' )->text() ]
 814                 );
 815
 816                 return [ $nsLabel, "$nsSelect $invert $associated" ];
 817         }
 818
 819         /**
 820          * Create an input to filter changes by categories
 821          *
 822          * @param FormOptions $opts
 823          * @return array
 824          */
 825         protected function categoryFilterForm( FormOptions $opts ) {
 826                 list( $label, $input ) = Xml::inputLabelSep( $this->msg( 'rc_categories' )->text(),
 827                         'categories', 'mw-categories', false, $opts['categories'] );
 828
 829                 $input .= ' ' . Xml::checkLabel( $this->msg( 'rc_categories_any' )->text(),
 830                         'categories_any', 'mw-categories_any', $opts['categories_any'] );
 831
 832                 return [ $label, $input ];
 833         }
 834
 835         /**
 836          * Filter $rows by categories set in $opts
 837          *
 838          * @param ResultWrapper $rows Database rows
 839          * @param FormOptions $opts
 840          */
 841         function filterByCategories( &$rows, FormOptions $opts ) {
 842                 $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );
 843
 844                 if ( !count( $categories ) ) {
 845                         return;
 846                 }
 847
 848                 # Filter categories
 849                 $cats = [];
 850                 foreach ( $categories as $cat ) {
 851                         $cat = trim( $cat );
 852                         if ( $cat == '' ) {
 853                                 continue;
 854                         }
 855                         $cats[] = $cat;
 856                 }
 857
 858                 # Filter articles
 859                 $articles = [];
 860                 $a2r = [];
 861                 $rowsarr = [];
 862                 foreach ( $rows as $k => $r ) {
 863                         $nt = Title::makeTitle( $r->rc_namespace, $r->rc_title );
 864                         $id = $nt->getArticleID();
 865                         if ( $id == 0 ) {
 866                                 continue; # Page might have been deleted...
 867                         }
 868                         if ( !in_array( $id, $articles ) ) {
 869                                 $articles[] = $id;
 870                         }
 871                         if ( !isset( $a2r[$id] ) ) {
 872                                 $a2r[$id] = [];
 873                         }
 874                         $a2r[$id][] = $k;
 875                         $rowsarr[$k] = $r;
 876                 }
 877
 878                 # Shortcut?
 879                 if ( !count( $articles ) || !count( $cats ) ) {
 880                         return;
 881                 }
 882
 883                 # Look up
 884                 $catFind = new CategoryFinder;
 885                 $catFind->seed( $articles, $cats, $opts['categories_any'] ? 'OR' : 'AND' );
 886                 $match = $catFind->run();
 887
 888                 # Filter
 889                 $newrows = [];
 890                 foreach ( $match as $id ) {
 891                         foreach ( $a2r[$id] as $rev ) {
 892                                 $k = $rev;
 893                                 $newrows[$k] = $rowsarr[$k];
 894                         }
 895                 }
 896                 $rows = new FakeResultWrapper( array_values( $newrows ) );
 897         }
 898
 899         /**
 900          * Makes change an option link which carries all the other options
 901          *
 902          * @param string $title Title
 903          * @param array $override Options to override
 904          * @param array $options Current options
 905          * @param bool $active Whether to show the link in bold
 906          * @return string
 907          */
 908         function makeOptionsLink( $title, $override, $options, $active = false ) {
 909                 $params = $this->convertParamsForLink( $override + $options );
 910
 911                 if ( $active ) {
 912                         $title = new HtmlArmor( '<strong>' . htmlspecialchars( $title ) . '</strong>' );
 913                 }
 914
 915                 return $this->getLinkRenderer()->makeKnownLink( $this->getPageTitle(), $title, [
 916                         'data-params' => json_encode( $override ),
 917                         'data-keys' => implode( ',', array_keys( $override ) ),
 918                 ], $params );
 919         }
 920
 921         /**
 922          * Creates the options panel.
 923          *
 924          * @param array $defaults
 925          * @param array $nondefaults
 926          * @param int $numRows Number of rows in the result to show after this header
 927          * @return string
 928          */
 929         function optionsPanel( $defaults, $nondefaults, $numRows ) {
 930                 $options = $nondefaults + $defaults;
 931
 932                 $note = '';
 933                 $msg = $this->msg( 'rclegend' );
 934                 if ( !$msg->isDisabled() ) {
 935                         $note .= '<div class="mw-rclegend">' . $msg->parse() . "</div>\n";
 936                 }
 937
 938                 $lang = $this->getLanguage();
 939                 $user = $this->getUser();
 940                 $config = $this->getConfig();
 941                 if ( $options['from'] ) {
 942                         $resetLink = $this->makeOptionsLink( $this->msg( 'rclistfromreset' ),
 943                                 [ 'from' => '' ], $nondefaults );
 944
 945                         $note .= $this->msg( 'rcnotefrom' )
 946                                 ->numParams( $options['limit'] )
 947                                 ->params(
 948                                         $lang->userTimeAndDate( $options['from'], $user ),
 949                                         $lang->userDate( $options['from'], $user ),
 950                                         $lang->userTime( $options['from'], $user )
 951                                 )
 952                                 ->numParams( $numRows )
 953                                 ->parse() . ' ' .
 954                                 Html::rawElement(
 955                                         'span',
 956                                         [ 'class' => 'rcoptions-listfromreset' ],
 957                                         $this->msg( 'parentheses' )->rawParams( $resetLink )->parse()
 958                                 ) .
 959                                 '<br />';
 960                 }
 961
 962                 # Sort data for display and make sure it's unique after we've added user data.
 963                 $linkLimits = $config->get( 'RCLinkLimits' );
 964                 $linkLimits[] = $options['limit'];
 965                 sort( $linkLimits );
 966                 $linkLimits = array_unique( $linkLimits );
 967
 968                 $linkDays = $config->get( 'RCLinkDays' );
 969                 $linkDays[] = $options['days'];
 970                 sort( $linkDays );
 971                 $linkDays = array_unique( $linkDays );
 972
 973                 // limit links
 974                 $cl = [];
 975                 foreach ( $linkLimits as $value ) {
 976                         $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
 977                                 [ 'limit' => $value ], $nondefaults, $value == $options['limit'] );
 978                 }
 979                 $cl = $lang->pipeList( $cl );
 980
 981                 // day links, reset 'from' to none
 982                 $dl = [];
 983                 foreach ( $linkDays as $value ) {
 984                         $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
 985                                 [ 'days' => $value, 'from' => '' ], $nondefaults, $value == $options['days'] );
 986                 }
 987                 $dl = $lang->pipeList( $dl );
 988
 989                 $showhide = [ 'show', 'hide' ];
 990
 991                 $links = [];
 992
 993                 $filterGroups = $this->getFilterGroups();
 994
 995                 $context = $this->getContext();
 996                 foreach ( $filterGroups as $groupName => $group ) {
 997                         if ( !$group->isPerGroupRequestParameter() ) {
 998                                 foreach ( $group->getFilters() as $key => $filter ) {
 999                                         if ( $filter->displaysOnUnstructuredUi( $this ) ) {
1000                                                 $msg = $filter->getShowHide();
1001                                                 $linkMessage = $this->msg( $msg . '-' . $showhide[1 - $options[$key]] );
1002                                                 // Extensions can define additional filters, but don't need to define the corresponding
1003                                                 // messages. If they don't exist, just fall back to 'show' and 'hide'.
1004                                                 if ( !$linkMessage->exists() ) {
1005                                                         $linkMessage = $this->msg( $showhide[1 - $options[$key]] );
1006                                                 }
1007
1008                                                 $link = $this->makeOptionsLink( $linkMessage->text(),
1009                                                         [ $key => 1 - $options[$key] ], $nondefaults );
1010
1011                                                 $attribs = [
1012                                                         'class' => "$msg rcshowhideoption",
1013                                                         'data-filter-name' => $filter->getName(),
1014                                                 ];
1015
1016                                                 if ( $filter->isFeatureAvailableOnStructuredUi( $this ) ) {
1017                                                         $attribs['data-feature-in-structured-ui'] = true;
1018                                                 }
1019
1020                                                 $links[] = Html::rawElement(
1021                                                         'span',
1022                                                         $attribs,
1023                                                         $this->msg( $msg )->rawParams( $link )->escaped()
1024                                                 );
1025                                         }
1026                                 }
1027                         }
1028                 }
1029
1030                 // show from this onward link
1031                 $timestamp = wfTimestampNow();
1032                 $now = $lang->userTimeAndDate( $timestamp, $user );
1033                 $timenow = $lang->userTime( $timestamp, $user );
1034                 $datenow = $lang->userDate( $timestamp, $user );
1035                 $pipedLinks = '<span class="rcshowhide">' . $lang->pipeList( $links ) . '</span>';
1036
1037                 $rclinks = '<span class="rclinks">' . $this->msg( 'rclinks' )->rawParams( $cl, $dl, '' )
1038                         ->parse() . '</span>';
1039
1040                 $rclistfrom = '<span class="rclistfrom">' . $this->makeOptionsLink(
1041                         $this->msg( 'rclistfrom' )->rawParams( $now, $timenow, $datenow )->parse(),
1042                         [ 'from' => $timestamp ],
1043                         $nondefaults
1044                 ) . '</span>';
1045
1046                 return "{$note}$rclinks<br />$pipedLinks<br />$rclistfrom";
1047         }
1048
1049         public function isIncludable() {
1050                 return true;
1051         }
1052
1053         protected function getCacheTTL() {
1054                 return 60 * 5;
1055         }
1056 }