includes/specialpage/ChangesListSpecialPage.php

   1 <?php
   2 /**
   3  * Special page which uses a ChangesList to show query results.
   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 use MediaWiki\Logger\LoggerFactory;
  24 use Wikimedia\Rdbms\ResultWrapper;
  25 use Wikimedia\Rdbms\FakeResultWrapper;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * Special page which uses a ChangesList to show query results.
  30  * @todo Way too many public functions, most of them should be protected
  31  *
  32  * @ingroup SpecialPage
  33  */
  34 abstract class ChangesListSpecialPage extends SpecialPage {
  35         /**
  36          * Preference name for saved queries. Subclasses that use saved queries should override this.
  37          * @var string
  38          */
  39         protected static $savedQueriesPreferenceName;
  40
  41         /** @var string */
  42         protected $rcSubpage;
  43
  44         /** @var FormOptions */
  45         protected $rcOptions;
  46
  47         /** @var array */
  48         protected $customFilters;
  49
  50         // Order of both groups and filters is significant; first is top-most priority,
  51         // descending from there.
  52         // 'showHideSuffix' is a shortcut to and avoid spelling out
  53         // details specific to subclasses here.
  54         /**
  55          * Definition information for the filters and their groups
  56          *
  57          * The value is $groupDefinition, a parameter to the ChangesListFilterGroup constructor.
  58          * However, priority is dynamically added for the core groups, to ease maintenance.
  59          *
  60          * Groups are displayed to the user in the structured UI.  However, if necessary,
  61          * all of the filters in a group can be configured to only display on the
  62          * unstuctured UI, in which case you don't need a group title.  This is done in
  63          * getFilterGroupDefinitionFromLegacyCustomFilters, for example.
  64          *
  65          * @var array $filterGroupDefinitions
  66          */
  67         private $filterGroupDefinitions;
  68
  69         // Same format as filterGroupDefinitions, but for a single group (reviewStatus)
  70         // that is registered conditionally.
  71         private $reviewStatusFilterGroupDefinition;
  72
  73         // Single filter registered conditionally
  74         private $hideCategorizationFilterDefinition;
  75
  76         /**
  77          * Filter groups, and their contained filters
  78          * This is an associative array (with group name as key) of ChangesListFilterGroup objects.
  79          *
  80          * @var array $filterGroups
  81          */
  82         protected $filterGroups = [];
  83
  84         public function __construct( $name, $restriction ) {
  85                 parent::__construct( $name, $restriction );
  86
  87                 $nonRevisionTypes = [ RC_LOG ];
  88                 Hooks::run( 'SpecialWatchlistGetNonRevisionTypes', [ &$nonRevisionTypes ] );
  89
  90                 $this->filterGroupDefinitions = [
  91                         [
  92                                 'name' => 'registration',
  93                                 'title' => 'rcfilters-filtergroup-registration',
  94                                 'class' => ChangesListBooleanFilterGroup::class,
  95                                 'filters' => [
  96                                         [
  97                                                 'name' => 'hideliu',
  98                                                 // rcshowhideliu-show, rcshowhideliu-hide,
  99                                                 // wlshowhideliu
 100                                                 'showHideSuffix' => 'showhideliu',
 101                                                 'default' => false,
 102                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 103                                                         &$query_options, &$join_conds
 104                                                 ) {
 105                                                         $conds[] = 'rc_user = 0';
 106                                                 },
 107                                                 'isReplacedInStructuredUi' => true,
 108
 109                                         ],
 110                                         [
 111                                                 'name' => 'hideanons',
 112                                                 // rcshowhideanons-show, rcshowhideanons-hide,
 113                                                 // wlshowhideanons
 114                                                 'showHideSuffix' => 'showhideanons',
 115                                                 'default' => false,
 116                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 117                                                         &$query_options, &$join_conds
 118                                                 ) {
 119                                                         $conds[] = 'rc_user != 0';
 120                                                 },
 121                                                 'isReplacedInStructuredUi' => true,
 122                                         ]
 123                                 ],
 124                         ],
 125
 126                         [
 127                                 'name' => 'userExpLevel',
 128                                 'title' => 'rcfilters-filtergroup-userExpLevel',
 129                                 'class' => ChangesListStringOptionsFilterGroup::class,
 130                                 'isFullCoverage' => true,
 131                                 'filters' => [
 132                                         [
 133                                                 'name' => 'unregistered',
 134                                                 'label' => 'rcfilters-filter-user-experience-level-unregistered-label',
 135                                                 'description' => 'rcfilters-filter-user-experience-level-unregistered-description',
 136                                                 'cssClassSuffix' => 'user-unregistered',
 137                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 138                                                         return !$rc->getAttribute( 'rc_user' );
 139                                                 }
 140                                         ],
 141                                         [
 142                                                 'name' => 'registered',
 143                                                 'label' => 'rcfilters-filter-user-experience-level-registered-label',
 144                                                 'description' => 'rcfilters-filter-user-experience-level-registered-description',
 145                                                 'cssClassSuffix' => 'user-registered',
 146                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 147                                                         return $rc->getAttribute( 'rc_user' );
 148                                                 }
 149                                         ],
 150                                         [
 151                                                 'name' => 'newcomer',
 152                                                 'label' => 'rcfilters-filter-user-experience-level-newcomer-label',
 153                                                 'description' => 'rcfilters-filter-user-experience-level-newcomer-description',
 154                                                 'cssClassSuffix' => 'user-newcomer',
 155                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 156                                                         $performer = $rc->getPerformer();
 157                                                         return $performer && $performer->isLoggedIn() &&
 158                                                                 $performer->getExperienceLevel() === 'newcomer';
 159                                                 }
 160                                         ],
 161                                         [
 162                                                 'name' => 'learner',
 163                                                 'label' => 'rcfilters-filter-user-experience-level-learner-label',
 164                                                 'description' => 'rcfilters-filter-user-experience-level-learner-description',
 165                                                 'cssClassSuffix' => 'user-learner',
 166                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 167                                                         $performer = $rc->getPerformer();
 168                                                         return $performer && $performer->isLoggedIn() &&
 169                                                                 $performer->getExperienceLevel() === 'learner';
 170                                                 },
 171                                         ],
 172                                         [
 173                                                 'name' => 'experienced',
 174                                                 'label' => 'rcfilters-filter-user-experience-level-experienced-label',
 175                                                 'description' => 'rcfilters-filter-user-experience-level-experienced-description',
 176                                                 'cssClassSuffix' => 'user-experienced',
 177                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 178                                                         $performer = $rc->getPerformer();
 179                                                         return $performer && $performer->isLoggedIn() &&
 180                                                                 $performer->getExperienceLevel() === 'experienced';
 181                                                 },
 182                                         ]
 183                                 ],
 184                                 'default' => ChangesListStringOptionsFilterGroup::NONE,
 185                                 'queryCallable' => [ $this, 'filterOnUserExperienceLevel' ],
 186                         ],
 187
 188                         [
 189                                 'name' => 'authorship',
 190                                 'title' => 'rcfilters-filtergroup-authorship',
 191                                 'class' => ChangesListBooleanFilterGroup::class,
 192                                 'filters' => [
 193                                         [
 194                                                 'name' => 'hidemyself',
 195                                                 'label' => 'rcfilters-filter-editsbyself-label',
 196                                                 'description' => 'rcfilters-filter-editsbyself-description',
 197                                                 // rcshowhidemine-show, rcshowhidemine-hide,
 198                                                 // wlshowhidemine
 199                                                 'showHideSuffix' => 'showhidemine',
 200                                                 'default' => false,
 201                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 202                                                         &$query_options, &$join_conds
 203                                                 ) {
 204                                                         $user = $ctx->getUser();
 205                                                         $conds[] = 'rc_user_text != ' . $dbr->addQuotes( $user->getName() );
 206                                                 },
 207                                                 'cssClassSuffix' => 'self',
 208                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 209                                                         return $ctx->getUser()->equals( $rc->getPerformer() );
 210                                                 },
 211                                         ],
 212                                         [
 213                                                 'name' => 'hidebyothers',
 214                                                 'label' => 'rcfilters-filter-editsbyother-label',
 215                                                 'description' => 'rcfilters-filter-editsbyother-description',
 216                                                 'default' => false,
 217                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 218                                                         &$query_options, &$join_conds
 219                                                 ) {
 220                                                         $user = $ctx->getUser();
 221                                                         $conds[] = 'rc_user_text = ' . $dbr->addQuotes( $user->getName() );
 222                                                 },
 223                                                 'cssClassSuffix' => 'others',
 224                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 225                                                         return !$ctx->getUser()->equals( $rc->getPerformer() );
 226                                                 },
 227                                         ]
 228                                 ]
 229                         ],
 230
 231                         [
 232                                 'name' => 'automated',
 233                                 'title' => 'rcfilters-filtergroup-automated',
 234                                 'class' => ChangesListBooleanFilterGroup::class,
 235                                 'filters' => [
 236                                         [
 237                                                 'name' => 'hidebots',
 238                                                 'label' => 'rcfilters-filter-bots-label',
 239                                                 'description' => 'rcfilters-filter-bots-description',
 240                                                 // rcshowhidebots-show, rcshowhidebots-hide,
 241                                                 // wlshowhidebots
 242                                                 'showHideSuffix' => 'showhidebots',
 243                                                 'default' => false,
 244                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 245                                                         &$query_options, &$join_conds
 246                                                 ) {
 247                                                         $conds[] = 'rc_bot = 0';
 248                                                 },
 249                                                 'cssClassSuffix' => 'bot',
 250                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 251                                                         return $rc->getAttribute( 'rc_bot' );
 252                                                 },
 253                                         ],
 254                                         [
 255                                                 'name' => 'hidehumans',
 256                                                 'label' => 'rcfilters-filter-humans-label',
 257                                                 'description' => 'rcfilters-filter-humans-description',
 258                                                 'default' => false,
 259                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 260                                                         &$query_options, &$join_conds
 261                                                 ) {
 262                                                         $conds[] = 'rc_bot = 1';
 263                                                 },
 264                                                 'cssClassSuffix' => 'human',
 265                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 266                                                         return !$rc->getAttribute( 'rc_bot' );
 267                                                 },
 268                                         ]
 269                                 ]
 270                         ],
 271
 272                         // reviewStatus (conditional)
 273
 274                         [
 275                                 'name' => 'significance',
 276                                 'title' => 'rcfilters-filtergroup-significance',
 277                                 'class' => ChangesListBooleanFilterGroup::class,
 278                                 'priority' => -6,
 279                                 'filters' => [
 280                                         [
 281                                                 'name' => 'hideminor',
 282                                                 'label' => 'rcfilters-filter-minor-label',
 283                                                 'description' => 'rcfilters-filter-minor-description',
 284                                                 // rcshowhideminor-show, rcshowhideminor-hide,
 285                                                 // wlshowhideminor
 286                                                 'showHideSuffix' => 'showhideminor',
 287                                                 'default' => false,
 288                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 289                                                         &$query_options, &$join_conds
 290                                                 ) {
 291                                                         $conds[] = 'rc_minor = 0';
 292                                                 },
 293                                                 'cssClassSuffix' => 'minor',
 294                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 295                                                         return $rc->getAttribute( 'rc_minor' );
 296                                                 }
 297                                         ],
 298                                         [
 299                                                 'name' => 'hidemajor',
 300                                                 'label' => 'rcfilters-filter-major-label',
 301                                                 'description' => 'rcfilters-filter-major-description',
 302                                                 'default' => false,
 303                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 304                                                         &$query_options, &$join_conds
 305                                                 ) {
 306                                                         $conds[] = 'rc_minor = 1';
 307                                                 },
 308                                                 'cssClassSuffix' => 'major',
 309                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 310                                                         return !$rc->getAttribute( 'rc_minor' );
 311                                                 }
 312                                         ]
 313                                 ]
 314                         ],
 315
 316                         [
 317                                 'name' => 'lastRevision',
 318                                 'title' => 'rcfilters-filtergroup-lastRevision',
 319                                 'class' => ChangesListBooleanFilterGroup::class,
 320                                 'priority' => -7,
 321                                 'filters' => [
 322                                         [
 323                                                 'name' => 'hidelastrevision',
 324                                                 'label' => 'rcfilters-filter-lastrevision-label',
 325                                                 'description' => 'rcfilters-filter-lastrevision-description',
 326                                                 'default' => false,
 327                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 328                                                         &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
 329                                                         $conds[] = $dbr->makeList(
 330                                                                 [
 331                                                                         'rc_this_oldid <> page_latest',
 332                                                                         'rc_type' => $nonRevisionTypes,
 333                                                                 ],
 334                                                                 LIST_OR
 335                                                         );
 336                                                 },
 337                                                 'cssClassSuffix' => 'last',
 338                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 339                                                         return $rc->getAttribute( 'rc_this_oldid' ) === $rc->getAttribute( 'page_latest' );
 340                                                 }
 341                                         ],
 342                                         [
 343                                                 'name' => 'hidepreviousrevisions',
 344                                                 'label' => 'rcfilters-filter-previousrevision-label',
 345                                                 'description' => 'rcfilters-filter-previousrevision-description',
 346                                                 'default' => false,
 347                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 348                                                         &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
 349                                                         $conds[] = $dbr->makeList(
 350                                                                 [
 351                                                                         'rc_this_oldid = page_latest',
 352                                                                         'rc_type' => $nonRevisionTypes,
 353                                                                 ],
 354                                                                 LIST_OR
 355                                                         );
 356                                                 },
 357                                                 'cssClassSuffix' => 'previous',
 358                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 359                                                         return $rc->getAttribute( 'rc_this_oldid' ) !== $rc->getAttribute( 'page_latest' );
 360                                                 }
 361                                         ]
 362                                 ]
 363                         ],
 364
 365                         // With extensions, there can be change types that will not be hidden by any of these.
 366                         [
 367                                 'name' => 'changeType',
 368                                 'title' => 'rcfilters-filtergroup-changetype',
 369                                 'class' => ChangesListBooleanFilterGroup::class,
 370                                 'priority' => -8,
 371                                 'filters' => [
 372                                         [
 373                                                 'name' => 'hidepageedits',
 374                                                 'label' => 'rcfilters-filter-pageedits-label',
 375                                                 'description' => 'rcfilters-filter-pageedits-description',
 376                                                 'default' => false,
 377                                                 'priority' => -2,
 378                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 379                                                         &$query_options, &$join_conds
 380                                                 ) {
 381                                                         $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_EDIT );
 382                                                 },
 383                                                 'cssClassSuffix' => 'src-mw-edit',
 384                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 385                                                         return $rc->getAttribute( 'rc_source' ) === RecentChange::SRC_EDIT;
 386                                                 },
 387                                         ],
 388                                         [
 389                                                 'name' => 'hidenewpages',
 390                                                 'label' => 'rcfilters-filter-newpages-label',
 391                                                 'description' => 'rcfilters-filter-newpages-description',
 392                                                 'default' => false,
 393                                                 'priority' => -3,
 394                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 395                                                         &$query_options, &$join_conds
 396                                                 ) {
 397                                                         $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_NEW );
 398                                                 },
 399                                                 'cssClassSuffix' => 'src-mw-new',
 400                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 401                                                         return $rc->getAttribute( 'rc_source' ) === RecentChange::SRC_NEW;
 402                                                 },
 403                                         ],
 404
 405                                         // hidecategorization
 406
 407                                         [
 408                                                 'name' => 'hidelog',
 409                                                 'label' => 'rcfilters-filter-logactions-label',
 410                                                 'description' => 'rcfilters-filter-logactions-description',
 411                                                 'default' => false,
 412                                                 'priority' => -5,
 413                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 414                                                         &$query_options, &$join_conds
 415                                                 ) {
 416                                                         $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_LOG );
 417                                                 },
 418                                                 'cssClassSuffix' => 'src-mw-log',
 419                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 420                                                         return $rc->getAttribute( 'rc_source' ) === RecentChange::SRC_LOG;
 421                                                 }
 422                                         ],
 423                                 ],
 424                         ],
 425
 426                 ];
 427
 428                 $this->reviewStatusFilterGroupDefinition = [
 429                         [
 430                                 'name' => 'reviewStatus',
 431                                 'title' => 'rcfilters-filtergroup-reviewstatus',
 432                                 'class' => ChangesListBooleanFilterGroup::class,
 433                                 'priority' => -5,
 434                                 'filters' => [
 435                                         [
 436                                                 'name' => 'hidepatrolled',
 437                                                 'label' => 'rcfilters-filter-patrolled-label',
 438                                                 'description' => 'rcfilters-filter-patrolled-description',
 439                                                 // rcshowhidepatr-show, rcshowhidepatr-hide
 440                                                 // wlshowhidepatr
 441                                                 'showHideSuffix' => 'showhidepatr',
 442                                                 'default' => false,
 443                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 444                                                         &$query_options, &$join_conds
 445                                                 ) {
 446                                                         $conds[] = 'rc_patrolled = 0';
 447                                                 },
 448                                                 'cssClassSuffix' => 'patrolled',
 449                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 450                                                         return $rc->getAttribute( 'rc_patrolled' );
 451                                                 },
 452                                         ],
 453                                         [
 454                                                 'name' => 'hideunpatrolled',
 455                                                 'label' => 'rcfilters-filter-unpatrolled-label',
 456                                                 'description' => 'rcfilters-filter-unpatrolled-description',
 457                                                 'default' => false,
 458                                                 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 459                                                         &$query_options, &$join_conds
 460                                                 ) {
 461                                                         $conds[] = 'rc_patrolled = 1';
 462                                                 },
 463                                                 'cssClassSuffix' => 'unpatrolled',
 464                                                 'isRowApplicableCallable' => function ( $ctx, $rc ) {
 465                                                         return !$rc->getAttribute( 'rc_patrolled' );
 466                                                 },
 467                                         ],
 468                                 ],
 469                         ]
 470                 ];
 471
 472                 $this->hideCategorizationFilterDefinition = [
 473                         'name' => 'hidecategorization',
 474                         'label' => 'rcfilters-filter-categorization-label',
 475                         'description' => 'rcfilters-filter-categorization-description',
 476                         // rcshowhidecategorization-show, rcshowhidecategorization-hide.
 477                         // wlshowhidecategorization
 478                         'showHideSuffix' => 'showhidecategorization',
 479                         'default' => false,
 480                         'priority' => -4,
 481                         'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
 482                                 &$query_options, &$join_conds
 483                         ) {
 484                                 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_CATEGORIZE );
 485                         },
 486                         'cssClassSuffix' => 'src-mw-categorize',
 487                         'isRowApplicableCallable' => function ( $ctx, $rc ) {
 488                                 return $rc->getAttribute( 'rc_source' ) === RecentChange::SRC_CATEGORIZE;
 489                         },
 490                 ];
 491         }
 492
 493         /**
 494          * Check if filters are in conflict and guaranteed to return no results.
 495          *
 496          * @return bool
 497          */
 498         protected function areFiltersInConflict() {
 499                 $opts = $this->getOptions();
 500                 /** @var ChangesListFilterGroup $group */
 501                 foreach ( $this->getFilterGroups() as $group ) {
 502                         if ( $group->getConflictingGroups() ) {
 503                                 wfLogWarning(
 504                                         $group->getName() .
 505                                         " specifies conflicts with other groups but these are not supported yet."
 506                                 );
 507                         }
 508
 509                         /** @var ChangesListFilter $conflictingFilter */
 510                         foreach ( $group->getConflictingFilters() as $conflictingFilter ) {
 511                                 if ( $conflictingFilter->activelyInConflictWithGroup( $group, $opts ) ) {
 512                                         return true;
 513                                 }
 514                         }
 515
 516                         /** @var ChangesListFilter $filter */
 517                         foreach ( $group->getFilters() as $filter ) {
 518                                 /** @var ChangesListFilter $conflictingFilter */
 519                                 foreach ( $filter->getConflictingFilters() as $conflictingFilter ) {
 520                                         if (
 521                                                 $conflictingFilter->activelyInConflictWithFilter( $filter, $opts ) &&
 522                                                 $filter->activelyInConflictWithFilter( $conflictingFilter, $opts )
 523                                         ) {
 524                                                 return true;
 525                                         }
 526                                 }
 527
 528                         }
 529
 530                 }
 531
 532                 return false;
 533         }
 534
 535         /**
 536          * Main execution point
 537          *
 538          * @param string $subpage
 539          */
 540         public function execute( $subpage ) {
 541                 $this->rcSubpage = $subpage;
 542
 543                 $rows = $this->getRows();
 544                 $opts = $this->getOptions();
 545                 if ( $rows === false ) {
 546                         $rows = new FakeResultWrapper( [] );
 547                 }
 548
 549                 // Used by Structured UI app to get results without MW chrome
 550                 if ( $this->getRequest()->getVal( 'action' ) === 'render' ) {
 551                         $this->getOutput()->setArticleBodyOnly( true );
 552                 }
 553
 554                 // Used by "live update" and "view newest" to check
 555                 // if there's new changes with minimal data transfer
 556                 if ( $this->getRequest()->getBool( 'peek' ) ) {
 557                         $code = $rows->numRows() > 0 ? 200 : 204;
 558                         $this->getOutput()->setStatusCode( $code );
 559                         return;
 560                 }
 561
 562                 $batch = new LinkBatch;
 563                 foreach ( $rows as $row ) {
 564                         $batch->add( NS_USER, $row->rc_user_text );
 565                         $batch->add( NS_USER_TALK, $row->rc_user_text );
 566                         $batch->add( $row->rc_namespace, $row->rc_title );
 567                         if ( $row->rc_source === RecentChange::SRC_LOG ) {
 568                                 $formatter = LogFormatter::newFromRow( $row );
 569                                 foreach ( $formatter->getPreloadTitles() as $title ) {
 570                                         $batch->addObj( $title );
 571                                 }
 572                         }
 573                 }
 574                 $batch->execute();
 575
 576                 $this->setHeaders();
 577                 $this->outputHeader();
 578                 $this->addModules();
 579                 $this->webOutput( $rows, $opts );
 580
 581                 $rows->free();
 582
 583                 if ( $this->getConfig()->get( 'EnableWANCacheReaper' ) ) {
 584                         // Clean up any bad page entries for titles showing up in RC
 585                         DeferredUpdates::addUpdate( new WANCacheReapUpdate(
 586                                 $this->getDB(),
 587                                 LoggerFactory::getInstance( 'objectcache' )
 588                         ) );
 589                 }
 590
 591                 $this->includeRcFiltersApp();
 592         }
 593
 594         /**
 595          * Include the modules and configuration for the RCFilters app.
 596          * Conditional on the user having the feature enabled.
 597          *
 598          * If it is disabled, add a <body> class marking that
 599          */
 600         protected function includeRcFiltersApp() {
 601                 $out = $this->getOutput();
 602                 if ( $this->isStructuredFilterUiEnabled() ) {
 603                         $jsData = $this->getStructuredFilterJsData();
 604
 605                         $messages = [];
 606                         foreach ( $jsData['messageKeys'] as $key ) {
 607                                 $messages[$key] = $this->msg( $key )->plain();
 608                         }
 609
 610                         $out->addBodyClasses( 'mw-rcfilters-enabled' );
 611
 612                         $out->addHTML(
 613                                 ResourceLoader::makeInlineScript(
 614                                         ResourceLoader::makeMessageSetScript( $messages )
 615                                 )
 616                         );
 617
 618                         $out->addJsConfigVars( 'wgStructuredChangeFilters', $jsData['groups'] );
 619
 620                         $out->addJsConfigVars(
 621                                 'wgRCFiltersChangeTags',
 622                                 $this->buildChangeTagList()
 623                         );
 624                         $out->addJsConfigVars(
 625                                 'StructuredChangeFiltersDisplayConfig',
 626                                 [
 627                                         'maxDays' => (int)$this->getConfig()->get( 'RCMaxAge' ) / ( 24 * 3600 ), // Translate to days
 628                                         'limitArray' => $this->getConfig()->get( 'RCLinkLimits' ),
 629                                         'limitDefault' => $this->getDefaultLimit(),
 630                                         'daysArray' => $this->getConfig()->get( 'RCLinkDays' ),
 631                                         'daysDefault' => $this->getDefaultDays(),
 632                                 ]
 633                         );
 634
 635                         $out->addJsConfigVars(
 636                                 'StructuredChangeFiltersLiveUpdatePollingRate',
 637                                 $this->getConfig()->get( 'StructuredChangeFiltersLiveUpdatePollingRate' )
 638                         );
 639
 640                         if ( static::$savedQueriesPreferenceName ) {
 641                                 $savedQueries = FormatJson::decode(
 642                                         $this->getUser()->getOption( static::$savedQueriesPreferenceName )
 643                                 );
 644                                 if ( $savedQueries && isset( $savedQueries->default ) ) {
 645                                         // If there is a default saved query, show a loading spinner,
 646                                         // since the frontend is going to reload the results
 647                                         $out->addBodyClasses( 'mw-rcfilters-ui-loading' );
 648                                 }
 649                                 $out->addJsConfigVars(
 650                                         'wgStructuredChangeFiltersSavedQueriesPreferenceName',
 651                                         static::$savedQueriesPreferenceName
 652                                 );
 653                         }
 654                 } else {
 655                         $out->addBodyClasses( 'mw-rcfilters-disabled' );
 656                 }
 657         }
 658
 659         /**
 660          * Fetch the change tags list for the front end
 661          *
 662          * @return Array Tag data
 663          */
 664         protected function buildChangeTagList() {
 665                 $explicitlyDefinedTags = array_fill_keys( ChangeTags::listExplicitlyDefinedTags(), 0 );
 666                 $softwareActivatedTags = array_fill_keys( ChangeTags::listSoftwareActivatedTags(), 0 );
 667
 668                 // Hit counts disabled for perf reasons, see T169997
 669                 /*
 670                 $tagStats = ChangeTags::tagUsageStatistics();
 671                 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
 672
 673                 // Sort by hits
 674                 arsort( $tagHitCounts );
 675                 */
 676                 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags );
 677
 678                 // Build the list and data
 679                 $result = [];
 680                 foreach ( $tagHitCounts as $tagName => $hits ) {
 681                         if (
 682                                 // Only get active tags
 683                                 isset( $explicitlyDefinedTags[ $tagName ] ) ||
 684                                 isset( $softwareActivatedTags[ $tagName ] )
 685                         ) {
 686                                 // Parse description
 687                                 $desc = ChangeTags::tagLongDescriptionMessage( $tagName, $this->getContext() );
 688
 689                                 $result[] = [
 690                                         'name' => $tagName,
 691                                         'label' => Sanitizer::stripAllTags(
 692                                                 ChangeTags::tagDescription( $tagName, $this->getContext() )
 693                                         ),
 694                                         'description' => $desc ? Sanitizer::stripAllTags( $desc->parse() ) : '',
 695                                         'cssClass' => Sanitizer::escapeClass( 'mw-tag-' . $tagName ),
 696                                         'hits' => $hits,
 697                                 ];
 698                         }
 699                 }
 700
 701                 // Instead of sorting by hit count (disabled, see above), sort by display name
 702                 usort( $result, function ( $a, $b ) {
 703                         return strcasecmp( $a['label'], $b['label'] );
 704                 } );
 705
 706                 return $result;
 707         }
 708
 709         /**
 710          * Add the "no results" message to the output
 711          */
 712         protected function outputNoResults() {
 713                 $this->getOutput()->addHTML(
 714                         '<div class="mw-changeslist-empty">' .
 715                         $this->msg( 'recentchanges-noresult' )->parse() .
 716                         '</div>'
 717                 );
 718         }
 719
 720         /**
 721          * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
 722          *
 723          * @return bool|ResultWrapper Result or false
 724          */
 725         public function getRows() {
 726                 $opts = $this->getOptions();
 727
 728                 $tables = [];
 729                 $fields = [];
 730                 $conds = [];
 731                 $query_options = [];
 732                 $join_conds = [];
 733                 $this->buildQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
 734
 735                 return $this->doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
 736         }
 737
 738         /**
 739          * Get the current FormOptions for this request
 740          *
 741          * @return FormOptions
 742          */
 743         public function getOptions() {
 744                 if ( $this->rcOptions === null ) {
 745                         $this->rcOptions = $this->setup( $this->rcSubpage );
 746                 }
 747
 748                 return $this->rcOptions;
 749         }
 750
 751         /**
 752          * Register all filters and their groups (including those from hooks), plus handle
 753          * conflicts and defaults.
 754          *
 755          * You might want to customize these in the same method, in subclasses.  You can
 756          * call getFilterGroup to access a group, and (on the group) getFilter to access a
 757          * filter, then make necessary modfications to the filter or group (e.g. with
 758          * setDefault).
 759          */
 760         protected function registerFilters() {
 761                 $this->registerFiltersFromDefinitions( $this->filterGroupDefinitions );
 762
 763                 // Make sure this is not being transcluded (we don't want to show this
 764                 // information to all users just because the user that saves the edit can
 765                 // patrol or is logged in)
 766                 if ( !$this->including() && $this->getUser()->useRCPatrol() ) {
 767                         $this->registerFiltersFromDefinitions( $this->reviewStatusFilterGroupDefinition );
 768                 }
 769
 770                 $changeTypeGroup = $this->getFilterGroup( 'changeType' );
 771
 772                 if ( $this->getConfig()->get( 'RCWatchCategoryMembership' ) ) {
 773                         $transformedHideCategorizationDef = $this->transformFilterDefinition(
 774                                 $this->hideCategorizationFilterDefinition
 775                         );
 776
 777                         $transformedHideCategorizationDef['group'] = $changeTypeGroup;
 778
 779                         $hideCategorization = new ChangesListBooleanFilter(
 780                                 $transformedHideCategorizationDef
 781                         );
 782                 }
 783
 784                 Hooks::run( 'ChangesListSpecialPageStructuredFilters', [ $this ] );
 785
 786                 $unstructuredGroupDefinition =
 787                         $this->getFilterGroupDefinitionFromLegacyCustomFilters(
 788                                 $this->getCustomFilters()
 789                         );
 790                 $this->registerFiltersFromDefinitions( [ $unstructuredGroupDefinition ] );
 791
 792                 $userExperienceLevel = $this->getFilterGroup( 'userExpLevel' );
 793                 $registered = $userExperienceLevel->getFilter( 'registered' );
 794                 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'newcomer' ) );
 795                 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'learner' ) );
 796                 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'experienced' ) );
 797
 798                 $categoryFilter = $changeTypeGroup->getFilter( 'hidecategorization' );
 799                 $logactionsFilter = $changeTypeGroup->getFilter( 'hidelog' );
 800                 $pagecreationFilter = $changeTypeGroup->getFilter( 'hidenewpages' );
 801
 802                 $significanceTypeGroup = $this->getFilterGroup( 'significance' );
 803                 $hideMinorFilter = $significanceTypeGroup->getFilter( 'hideminor' );
 804
 805                 // categoryFilter is conditional; see registerFilters
 806                 if ( $categoryFilter !== null ) {
 807                         $hideMinorFilter->conflictsWith(
 808                                 $categoryFilter,
 809                                 'rcfilters-hideminor-conflicts-typeofchange-global',
 810                                 'rcfilters-hideminor-conflicts-typeofchange',
 811                                 'rcfilters-typeofchange-conflicts-hideminor'
 812                         );
 813                 }
 814                 $hideMinorFilter->conflictsWith(
 815                         $logactionsFilter,
 816                         'rcfilters-hideminor-conflicts-typeofchange-global',
 817                         'rcfilters-hideminor-conflicts-typeofchange',
 818                         'rcfilters-typeofchange-conflicts-hideminor'
 819                 );
 820                 $hideMinorFilter->conflictsWith(
 821                         $pagecreationFilter,
 822                         'rcfilters-hideminor-conflicts-typeofchange-global',
 823                         'rcfilters-hideminor-conflicts-typeofchange',
 824                         'rcfilters-typeofchange-conflicts-hideminor'
 825                 );
 826         }
 827
 828         /**
 829          * Transforms filter definition to prepare it for constructor.
 830          *
 831          * See overrides of this method as well.
 832          *
 833          * @param array $filterDefinition Original filter definition
 834          *
 835          * @return array Transformed definition
 836          */
 837         protected function transformFilterDefinition( array $filterDefinition ) {
 838                 return $filterDefinition;
 839         }
 840
 841         /**
 842          * Register filters from a definition object
 843          *
 844          * Array specifying groups and their filters; see Filter and
 845          * ChangesListFilterGroup constructors.
 846          *
 847          * There is light processing to simplify core maintenance.
 848          * @param array $definition
 849          */
 850         protected function registerFiltersFromDefinitions( array $definition ) {
 851                 $autoFillPriority = -1;
 852                 foreach ( $definition as $groupDefinition ) {
 853                         if ( !isset( $groupDefinition['priority'] ) ) {
 854                                 $groupDefinition['priority'] = $autoFillPriority;
 855                         } else {
 856                                 // If it's explicitly specified, start over the auto-fill
 857                                 $autoFillPriority = $groupDefinition['priority'];
 858                         }
 859
 860                         $autoFillPriority--;
 861
 862                         $className = $groupDefinition['class'];
 863                         unset( $groupDefinition['class'] );
 864
 865                         foreach ( $groupDefinition['filters'] as &$filterDefinition ) {
 866                                 $filterDefinition = $this->transformFilterDefinition( $filterDefinition );
 867                         }
 868
 869                         $this->registerFilterGroup( new $className( $groupDefinition ) );
 870                 }
 871         }
 872
 873         /**
 874          * Get filter group definition from legacy custom filters
 875          *
 876          * @param array $customFilters Custom filters from legacy hooks
 877          * @return array Group definition
 878          */
 879         protected function getFilterGroupDefinitionFromLegacyCustomFilters( array $customFilters ) {
 880                 // Special internal unstructured group
 881                 $unstructuredGroupDefinition = [
 882                         'name' => 'unstructured',
 883                         'class' => ChangesListBooleanFilterGroup::class,
 884                         'priority' => -1, // Won't display in structured
 885                         'filters' => [],
 886                 ];
 887
 888                 foreach ( $customFilters as $name => $params ) {
 889                         $unstructuredGroupDefinition['filters'][] = [
 890                                 'name' => $name,
 891                                 'showHide' => $params['msg'],
 892                                 'default' => $params['default'],
 893                         ];
 894                 }
 895
 896                 return $unstructuredGroupDefinition;
 897         }
 898
 899         /**
 900          * Register all the filters, including legacy hook-driven ones.
 901          * Then create a FormOptions object with options as specified by the user
 902          *
 903          * @param array $parameters
 904          *
 905          * @return FormOptions
 906          */
 907         public function setup( $parameters ) {
 908                 $this->registerFilters();
 909
 910                 $opts = $this->getDefaultOptions();
 911
 912                 $opts = $this->fetchOptionsFromRequest( $opts );
 913
 914                 // Give precedence to subpage syntax
 915                 if ( $parameters !== null ) {
 916                         $this->parseParameters( $parameters, $opts );
 917                 }
 918
 919                 $this->validateOptions( $opts );
 920
 921                 return $opts;
 922         }
 923
 924         /**
 925          * Get a FormOptions object containing the default options. By default, returns
 926          * some basic options.  The filters listed explicitly here are overriden in this
 927          * method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters,
 928          * and more) are structured.  Structured filters are overriden in registerFilters.
 929          * not here.
 930          *
 931          * @return FormOptions
 932          */
 933         public function getDefaultOptions() {
 934                 $opts = new FormOptions();
 935                 $structuredUI = $this->isStructuredFilterUiEnabled();
 936                 // If urlversion=2 is set, ignore the filter defaults and set them all to false/empty
 937                 $useDefaults = $this->getRequest()->getInt( 'urlversion' ) !== 2;
 938
 939                 // Add all filters
 940                 /** @var ChangesListFilterGroup $filterGroup */
 941                 foreach ( $this->filterGroups as $filterGroup ) {
 942                         // URL parameters can be per-group, like 'userExpLevel',
 943                         // or per-filter, like 'hideminor'.
 944                         if ( $filterGroup->isPerGroupRequestParameter() ) {
 945                                 $opts->add( $filterGroup->getName(), $useDefaults ? $filterGroup->getDefault() : '' );
 946                         } else {
 947                                 /** @var ChangesListBooleanFilter $filter */
 948                                 foreach ( $filterGroup->getFilters() as $filter ) {
 949                                         $opts->add( $filter->getName(), $useDefaults ? $filter->getDefault( $structuredUI ) : false );
 950                                 }
 951                         }
 952                 }
 953
 954                 $opts->add( 'namespace', '', FormOptions::STRING );
 955                 $opts->add( 'invert', false );
 956                 $opts->add( 'associated', false );
 957                 $opts->add( 'urlversion', 1 );
 958                 $opts->add( 'tagfilter', '' );
 959
 960                 return $opts;
 961         }
 962
 963         /**
 964          * Register a structured changes list filter group
 965          *
 966          * @param ChangesListFilterGroup $group
 967          */
 968         public function registerFilterGroup( ChangesListFilterGroup $group ) {
 969                 $groupName = $group->getName();
 970
 971                 $this->filterGroups[$groupName] = $group;
 972         }
 973
 974         /**
 975          * Gets the currently registered filters groups
 976          *
 977          * @return array Associative array of ChangesListFilterGroup objects, with group name as key
 978          */
 979         protected function getFilterGroups() {
 980                 return $this->filterGroups;
 981         }
 982
 983         /**
 984          * Gets a specified ChangesListFilterGroup by name
 985          *
 986          * @param string $groupName Name of group
 987          *
 988          * @return ChangesListFilterGroup|null Group, or null if not registered
 989          */
 990         public function getFilterGroup( $groupName ) {
 991                 return isset( $this->filterGroups[$groupName] ) ?
 992                         $this->filterGroups[$groupName] :
 993                         null;
 994         }
 995
 996         // Currently, this intentionally only includes filters that display
 997         // in the structured UI.  This can be changed easily, though, if we want
 998         // to include data on filters that use the unstructured UI.  messageKeys is a
 999         // special top-level value, with the value being an array of the message keys to
1000         // send to the client.
1001         /**
1002          * Gets structured filter information needed by JS
1003          *
1004          * @return array Associative array
1005          * * array $return['groups'] Group data
1006          * * array $return['messageKeys'] Array of message keys
1007          */
1008         public function getStructuredFilterJsData() {
1009                 $output = [
1010                         'groups' => [],
1011                         'messageKeys' => [],
1012                 ];
1013
1014                 usort( $this->filterGroups, function ( $a, $b ) {
1015                         return $b->getPriority() - $a->getPriority();
1016                 } );
1017
1018                 foreach ( $this->filterGroups as $groupName => $group ) {
1019                         $groupOutput = $group->getJsData( $this );
1020                         if ( $groupOutput !== null ) {
1021                                 $output['messageKeys'] = array_merge(
1022                                         $output['messageKeys'],
1023                                         $groupOutput['messageKeys']
1024                                 );
1025
1026                                 unset( $groupOutput['messageKeys'] );
1027                                 $output['groups'][] = $groupOutput;
1028                         }
1029                 }
1030
1031                 return $output;
1032         }
1033
1034         /**
1035          * Get custom show/hide filters using deprecated ChangesListSpecialPageFilters
1036          * hook.
1037          *
1038          * @return array Map of filter URL param names to properties (msg/default)
1039          */
1040         protected function getCustomFilters() {
1041                 if ( $this->customFilters === null ) {
1042                         $this->customFilters = [];
1043                         Hooks::run( 'ChangesListSpecialPageFilters', [ $this, &$this->customFilters ], '1.29' );
1044                 }
1045
1046                 return $this->customFilters;
1047         }
1048
1049         /**
1050          * Fetch values for a FormOptions object from the WebRequest associated with this instance.
1051          *
1052          * Intended for subclassing, e.g. to add a backwards-compatibility layer.
1053          *
1054          * @param FormOptions $opts
1055          * @return FormOptions
1056          */
1057         protected function fetchOptionsFromRequest( $opts ) {
1058                 $opts->fetchValuesFromRequest( $this->getRequest() );
1059
1060                 return $opts;
1061         }
1062
1063         /**
1064          * Process $par and put options found in $opts. Used when including the page.
1065          *
1066          * @param string $par
1067          * @param FormOptions $opts
1068          */
1069         public function parseParameters( $par, FormOptions $opts ) {
1070                 $stringParameterNameSet = [];
1071                 $hideParameterNameSet = [];
1072
1073                 // URL parameters can be per-group, like 'userExpLevel',
1074                 // or per-filter, like 'hideminor'.
1075
1076                 foreach ( $this->filterGroups as $filterGroup ) {
1077                         if ( $filterGroup->isPerGroupRequestParameter() ) {
1078                                 $stringParameterNameSet[$filterGroup->getName()] = true;
1079                         } elseif ( $filterGroup->getType() === ChangesListBooleanFilterGroup::TYPE ) {
1080                                 foreach ( $filterGroup->getFilters() as $filter ) {
1081                                         $hideParameterNameSet[$filter->getName()] = true;
1082                                 }
1083                         }
1084                 }
1085
1086                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
1087                 foreach ( $bits as $bit ) {
1088                         $m = [];
1089                         if ( isset( $hideParameterNameSet[$bit] ) ) {
1090                                 // hidefoo => hidefoo=true
1091                                 $opts[$bit] = true;
1092                         } elseif ( isset( $hideParameterNameSet["hide$bit"] ) ) {
1093                                 // foo => hidefoo=false
1094                                 $opts["hide$bit"] = false;
1095                         } elseif ( preg_match( '/^(.*)=(.*)$/', $bit, $m ) ) {
1096                                 if ( isset( $stringParameterNameSet[$m[1]] ) ) {
1097                                         $opts[$m[1]] = $m[2];
1098                                 }
1099                         }
1100                 }
1101         }
1102
1103         /**
1104          * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
1105          *
1106          * @param FormOptions $opts
1107          */
1108         public function validateOptions( FormOptions $opts ) {
1109                 if ( $this->fixContradictoryOptions( $opts ) ) {
1110                         $query = wfArrayToCgi( $this->convertParamsForLink( $opts->getChangedValues() ) );
1111                         $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
1112                 }
1113         }
1114
1115         /**
1116          * Fix invalid options by resetting pairs that should never appear together.
1117          *
1118          * @param FormOptions $opts
1119          * @return bool True if any option was reset
1120          */
1121         private function fixContradictoryOptions( FormOptions $opts ) {
1122                 $fixed = $this->fixBackwardsCompatibilityOptions( $opts );
1123
1124                 foreach ( $this->filterGroups as $filterGroup ) {
1125                         if ( $filterGroup instanceof ChangesListBooleanFilterGroup ) {
1126                                 $filters = $filterGroup->getFilters();
1127
1128                                 if ( count( $filters ) === 1 ) {
1129                                         // legacy boolean filters should not be considered
1130                                         continue;
1131                                 }
1132
1133                                 $allInGroupEnabled = array_reduce(
1134                                         $filters,
1135                                         function ( $carry, $filter ) use ( $opts ) {
1136                                                 return $carry && $opts[ $filter->getName() ];
1137                                         },
1138                                         /* initialValue */ count( $filters ) > 0
1139                                 );
1140
1141                                 if ( $allInGroupEnabled ) {
1142                                         foreach ( $filters as $filter ) {
1143                                                 $opts[ $filter->getName() ] = false;
1144                                         }
1145
1146                                         $fixed = true;
1147                                 }
1148                         }
1149                 }
1150
1151                 return $fixed;
1152         }
1153
1154         /**
1155          * Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards
1156          * compatibility.
1157          *
1158          * This is deprecated and may be removed.
1159          *
1160          * @param FormOptions $opts
1161          * @return bool True if this change was mode
1162          */
1163         private function fixBackwardsCompatibilityOptions( FormOptions $opts ) {
1164                 if ( $opts['hideanons'] && $opts['hideliu'] ) {
1165                         $opts->reset( 'hideanons' );
1166                         if ( !$opts['hidebots'] ) {
1167                                 $opts->reset( 'hideliu' );
1168                                 $opts['hidehumans'] = 1;
1169                         }
1170
1171                         return true;
1172                 }
1173
1174                 return false;
1175         }
1176
1177         /**
1178          * Convert parameters values from true/false to 1/0
1179          * so they are not omitted by wfArrayToCgi()
1180          * Bug 36524
1181          *
1182          * @param array $params
1183          * @return array
1184          */
1185         protected function convertParamsForLink( $params ) {
1186                 foreach ( $params as &$value ) {
1187                         if ( $value === false ) {
1188                                 $value = '0';
1189                         }
1190                 }
1191                 unset( $value );
1192                 return $params;
1193         }
1194
1195         /**
1196          * Sets appropriate tables, fields, conditions, etc. depending on which filters
1197          * the user requested.
1198          *
1199          * @param array &$tables Array of tables; see IDatabase::select $table
1200          * @param array &$fields Array of fields; see IDatabase::select $vars
1201          * @param array &$conds Array of conditions; see IDatabase::select $conds
1202          * @param array &$query_options Array of query options; see IDatabase::select $options
1203          * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1204          * @param FormOptions $opts
1205          */
1206         protected function buildQuery( &$tables, &$fields, &$conds, &$query_options,
1207                 &$join_conds, FormOptions $opts
1208         ) {
1209                 $dbr = $this->getDB();
1210                 $isStructuredUI = $this->isStructuredFilterUiEnabled();
1211
1212                 foreach ( $this->filterGroups as $filterGroup ) {
1213                         // URL parameters can be per-group, like 'userExpLevel',
1214                         // or per-filter, like 'hideminor'.
1215                         if ( $filterGroup->isPerGroupRequestParameter() ) {
1216                                 $filterGroup->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1217                                         $query_options, $join_conds, $opts[$filterGroup->getName()] );
1218                         } else {
1219                                 foreach ( $filterGroup->getFilters() as $filter ) {
1220                                         if ( $filter->isActive( $opts, $isStructuredUI ) ) {
1221                                                 $filter->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1222                                                         $query_options, $join_conds );
1223                                         }
1224                                 }
1225                         }
1226                 }
1227
1228                 // Namespace filtering
1229                 if ( $opts[ 'namespace' ] !== '' ) {
1230                         $namespaces = explode( ';', $opts[ 'namespace' ] );
1231
1232                         if ( $opts[ 'associated' ] ) {
1233                                 $associatedNamespaces = array_map(
1234                                         function ( $ns ) {
1235                                                 return MWNamespace::getAssociated( $ns );
1236                                         },
1237                                         $namespaces
1238                                 );
1239                                 $namespaces = array_unique( array_merge( $namespaces, $associatedNamespaces ) );
1240                         }
1241
1242                         if ( count( $namespaces ) === 1 ) {
1243                                 $operator = $opts[ 'invert' ] ? '!=' : '=';
1244                                 $value = $dbr->addQuotes( reset( $namespaces ) );
1245                         } else {
1246                                 $operator = $opts[ 'invert' ] ? 'NOT IN' : 'IN';
1247                                 sort( $namespaces );
1248                                 $value = '(' . $dbr->makeList( $namespaces ) . ')';
1249                         }
1250                         $conds[] = "rc_namespace $operator $value";
1251                 }
1252         }
1253
1254         /**
1255          * Process the query
1256          *
1257          * @param array $tables Array of tables; see IDatabase::select $table
1258          * @param array $fields Array of fields; see IDatabase::select $vars
1259          * @param array $conds Array of conditions; see IDatabase::select $conds
1260          * @param array $query_options Array of query options; see IDatabase::select $options
1261          * @param array $join_conds Array of join conditions; see IDatabase::select $join_conds
1262          * @param FormOptions $opts
1263          * @return bool|ResultWrapper Result or false
1264          */
1265         protected function doMainQuery( $tables, $fields, $conds,
1266                 $query_options, $join_conds, FormOptions $opts
1267         ) {
1268                 $tables[] = 'recentchanges';
1269                 $fields = array_merge( RecentChange::selectFields(), $fields );
1270
1271                 ChangeTags::modifyDisplayQuery(
1272                         $tables,
1273                         $fields,
1274                         $conds,
1275                         $join_conds,
1276                         $query_options,
1277                         ''
1278                 );
1279
1280                 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
1281                         $opts )
1282                 ) {
1283                         return false;
1284                 }
1285
1286                 $dbr = $this->getDB();
1287
1288                 return $dbr->select(
1289                         $tables,
1290                         $fields,
1291                         $conds,
1292                         __METHOD__,
1293                         $query_options,
1294                         $join_conds
1295                 );
1296         }
1297
1298         protected function runMainQueryHook( &$tables, &$fields, &$conds,
1299                 &$query_options, &$join_conds, $opts
1300         ) {
1301                 return Hooks::run(
1302                         'ChangesListSpecialPageQuery',
1303                         [ $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ]
1304                 );
1305         }
1306
1307         /**
1308          * Return a IDatabase object for reading
1309          *
1310          * @return IDatabase
1311          */
1312         protected function getDB() {
1313                 return wfGetDB( DB_REPLICA );
1314         }
1315
1316         /**
1317          * Send output to the OutputPage object, only called if not used feeds
1318          *
1319          * @param ResultWrapper $rows Database rows
1320          * @param FormOptions $opts
1321          */
1322         public function webOutput( $rows, $opts ) {
1323                 if ( !$this->including() ) {
1324                         $this->outputFeedLinks();
1325                         $this->doHeader( $opts, $rows->numRows() );
1326                 }
1327
1328                 $this->outputChangesList( $rows, $opts );
1329         }
1330
1331         /**
1332          * Output feed links.
1333          */
1334         public function outputFeedLinks() {
1335                 // nothing by default
1336         }
1337
1338         /**
1339          * Build and output the actual changes list.
1340          *
1341          * @param ResultWrapper $rows Database rows
1342          * @param FormOptions $opts
1343          */
1344         abstract public function outputChangesList( $rows, $opts );
1345
1346         /**
1347          * Set the text to be displayed above the changes
1348          *
1349          * @param FormOptions $opts
1350          * @param int $numRows Number of rows in the result to show after this header
1351          */
1352         public function doHeader( $opts, $numRows ) {
1353                 $this->setTopText( $opts );
1354
1355                 // @todo Lots of stuff should be done here.
1356
1357                 $this->setBottomText( $opts );
1358         }
1359
1360         /**
1361          * Send the text to be displayed before the options. Should use $this->getOutput()->addWikiText()
1362          * or similar methods to print the text.
1363          *
1364          * @param FormOptions $opts
1365          */
1366         public function setTopText( FormOptions $opts ) {
1367                 // nothing by default
1368         }
1369
1370         /**
1371          * Send the text to be displayed after the options. Should use $this->getOutput()->addWikiText()
1372          * or similar methods to print the text.
1373          *
1374          * @param FormOptions $opts
1375          */
1376         public function setBottomText( FormOptions $opts ) {
1377                 // nothing by default
1378         }
1379
1380         /**
1381          * Get options to be displayed in a form
1382          * @todo This should handle options returned by getDefaultOptions().
1383          * @todo Not called by anything in this class (but is in subclasses), should be
1384          * called by something… doHeader() maybe?
1385          *
1386          * @param FormOptions $opts
1387          * @return array
1388          */
1389         public function getExtraOptions( $opts ) {
1390                 return [];
1391         }
1392
1393         /**
1394          * Return the legend displayed within the fieldset
1395          *
1396          * @return string
1397          */
1398         public function makeLegend() {
1399                 $context = $this->getContext();
1400                 $user = $context->getUser();
1401                 # The legend showing what the letters and stuff mean
1402                 $legend = Html::openElement( 'dl' ) . "\n";
1403                 # Iterates through them and gets the messages for both letter and tooltip
1404                 $legendItems = $context->getConfig()->get( 'RecentChangesFlags' );
1405                 if ( !( $user->useRCPatrol() || $user->useNPPatrol() ) ) {
1406                         unset( $legendItems['unpatrolled'] );
1407                 }
1408                 foreach ( $legendItems as $key => $item ) { # generate items of the legend
1409                         $label = isset( $item['legend'] ) ? $item['legend'] : $item['title'];
1410                         $letter = $item['letter'];
1411                         $cssClass = isset( $item['class'] ) ? $item['class'] : $key;
1412
1413                         $legend .= Html::element( 'dt',
1414                                 [ 'class' => $cssClass ], $context->msg( $letter )->text()
1415                         ) . "\n" .
1416                         Html::rawElement( 'dd',
1417                                 [ 'class' => Sanitizer::escapeClass( 'mw-changeslist-legend-' . $key ) ],
1418                                 $context->msg( $label )->parse()
1419                         ) . "\n";
1420                 }
1421                 # (+-123)
1422                 $legend .= Html::rawElement( 'dt',
1423                         [ 'class' => 'mw-plusminus-pos' ],
1424                         $context->msg( 'recentchanges-legend-plusminus' )->parse()
1425                 ) . "\n";
1426                 $legend .= Html::element(
1427                         'dd',
1428                         [ 'class' => 'mw-changeslist-legend-plusminus' ],
1429                         $context->msg( 'recentchanges-label-plusminus' )->text()
1430                 ) . "\n";
1431                 $legend .= Html::closeElement( 'dl' ) . "\n";
1432
1433                 $legendHeading = $this->isStructuredFilterUiEnabled() ?
1434                         $context->msg( 'rcfilters-legend-heading' )->parse() :
1435                         $context->msg( 'recentchanges-legend-heading' )->parse();
1436
1437                 # Collapsible
1438                 $legend =
1439                         '<div class="mw-changeslist-legend">' .
1440                                 $legendHeading .
1441                                 '<div class="mw-collapsible-content">' . $legend . '</div>' .
1442                         '</div>';
1443
1444                 return $legend;
1445         }
1446
1447         /**
1448          * Add page-specific modules.
1449          */
1450         protected function addModules() {
1451                 $out = $this->getOutput();
1452                 // Styles and behavior for the legend box (see makeLegend())
1453                 $out->addModuleStyles( [
1454                         'mediawiki.special.changeslist.legend',
1455                         'mediawiki.special.changeslist',
1456                 ] );
1457                 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
1458
1459                 if ( $this->isStructuredFilterUiEnabled() ) {
1460                         $out->addModules( 'mediawiki.rcfilters.filters.ui' );
1461                         $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
1462                 }
1463         }
1464
1465         protected function getGroupName() {
1466                 return 'changes';
1467         }
1468
1469         /**
1470          * Filter on users' experience levels; this will not be called if nothing is
1471          * selected.
1472          *
1473          * @param string $specialPageClassName Class name of current special page
1474          * @param IContextSource $context Context, for e.g. user
1475          * @param IDatabase $dbr Database, for addQuotes, makeList, and similar
1476          * @param array &$tables Array of tables; see IDatabase::select $table
1477          * @param array &$fields Array of fields; see IDatabase::select $vars
1478          * @param array &$conds Array of conditions; see IDatabase::select $conds
1479          * @param array &$query_options Array of query options; see IDatabase::select $options
1480          * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1481          * @param array $selectedExpLevels The allowed active values, sorted
1482          * @param int $now Number of seconds since the UNIX epoch, or 0 if not given
1483          *   (optional)
1484          */
1485         public function filterOnUserExperienceLevel( $specialPageClassName, $context, $dbr,
1486                 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now = 0
1487         ) {
1488                 global $wgLearnerEdits,
1489                         $wgExperiencedUserEdits,
1490                         $wgLearnerMemberSince,
1491                         $wgExperiencedUserMemberSince;
1492
1493                 $LEVEL_COUNT = 5;
1494
1495                 // If all levels are selected, don't filter
1496                 if ( count( $selectedExpLevels ) === $LEVEL_COUNT ) {
1497                         return;
1498                 }
1499
1500                 // both 'registered' and 'unregistered', experience levels, if any, are included in 'registered'
1501                 if (
1502                         in_array( 'registered', $selectedExpLevels ) &&
1503                         in_array( 'unregistered', $selectedExpLevels )
1504                 ) {
1505                         return;
1506                 }
1507
1508                 // 'registered' but not 'unregistered', experience levels, if any, are included in 'registered'
1509                 if (
1510                         in_array( 'registered', $selectedExpLevels ) &&
1511                         !in_array( 'unregistered', $selectedExpLevels )
1512                 ) {
1513                         $conds[] = 'rc_user != 0';
1514                         return;
1515                 }
1516
1517                 if ( $selectedExpLevels === [ 'unregistered' ] ) {
1518                         $conds[] = 'rc_user = 0';
1519                         return;
1520                 }
1521
1522                 $tables[] = 'user';
1523                 $join_conds['user'] = [ 'LEFT JOIN', 'rc_user = user_id' ];
1524
1525                 if ( $now === 0 ) {
1526                         $now = time();
1527                 }
1528                 $secondsPerDay = 86400;
1529                 $learnerCutoff = $now - $wgLearnerMemberSince * $secondsPerDay;
1530                 $experiencedUserCutoff = $now - $wgExperiencedUserMemberSince * $secondsPerDay;
1531
1532                 $aboveNewcomer = $dbr->makeList(
1533                         [
1534                                 'user_editcount >= ' . intval( $wgLearnerEdits ),
1535                                 'user_registration <= ' . $dbr->addQuotes( $dbr->timestamp( $learnerCutoff ) ),
1536                         ],
1537                         IDatabase::LIST_AND
1538                 );
1539
1540                 $aboveLearner = $dbr->makeList(
1541                         [
1542                                 'user_editcount >= ' . intval( $wgExperiencedUserEdits ),
1543                                 'user_registration <= ' .
1544                                         $dbr->addQuotes( $dbr->timestamp( $experiencedUserCutoff ) ),
1545                         ],
1546                         IDatabase::LIST_AND
1547                 );
1548
1549                 $conditions = [];
1550
1551                 if ( in_array( 'unregistered', $selectedExpLevels ) ) {
1552                         $selectedExpLevels = array_diff( $selectedExpLevels, [ 'unregistered' ] );
1553                         $conditions[] = 'rc_user = 0';
1554                 }
1555
1556                 if ( $selectedExpLevels === [ 'newcomer' ] ) {
1557                         $conditions[] = "NOT ( $aboveNewcomer )";
1558                 } elseif ( $selectedExpLevels === [ 'learner' ] ) {
1559                         $conditions[] = $dbr->makeList(
1560                                 [ $aboveNewcomer, "NOT ( $aboveLearner )" ],
1561                                 IDatabase::LIST_AND
1562                         );
1563                 } elseif ( $selectedExpLevels === [ 'experienced' ] ) {
1564                         $conditions[] = $aboveLearner;
1565                 } elseif ( $selectedExpLevels === [ 'learner', 'newcomer' ] ) {
1566                         $conditions[] = "NOT ( $aboveLearner )";
1567                 } elseif ( $selectedExpLevels === [ 'experienced', 'newcomer' ] ) {
1568                         $conditions[] = $dbr->makeList(
1569                                 [ "NOT ( $aboveNewcomer )", $aboveLearner ],
1570                                 IDatabase::LIST_OR
1571                         );
1572                 } elseif ( $selectedExpLevels === [ 'experienced', 'learner' ] ) {
1573                         $conditions[] = $aboveNewcomer;
1574                 } elseif ( $selectedExpLevels === [ 'experienced', 'learner', 'newcomer' ] ) {
1575                         $conditions[] = 'rc_user != 0';
1576                 }
1577
1578                 if ( count( $conditions ) > 1 ) {
1579                         $conds[] = $dbr->makeList( $conditions, IDatabase::LIST_OR );
1580                 } elseif ( count( $conditions ) === 1 ) {
1581                         $conds[] = reset( $conditions );
1582                 }
1583         }
1584
1585         /**
1586          * Check whether the structured filter UI is enabled
1587          *
1588          * @return bool
1589          */
1590         public function isStructuredFilterUiEnabled() {
1591                 if ( $this->getRequest()->getBool( 'rcfilters' ) ) {
1592                         return true;
1593                 }
1594
1595                 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1596                         return !$this->getUser()->getOption( 'rcenhancedfilters-disable' );
1597                 } else {
1598                         return $this->getUser()->getOption( 'rcenhancedfilters' );
1599                 }
1600         }
1601
1602         /**
1603          * Check whether the structured filter UI is enabled by default (regardless of
1604          * this particular user's setting)
1605          *
1606          * @return bool
1607          */
1608         public function isStructuredFilterUiEnabledByDefault() {
1609                 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1610                         return !$this->getUser()->getDefaultOption( 'rcenhancedfilters-disable' );
1611                 } else {
1612                         return $this->getUser()->getDefaultOption( 'rcenhancedfilters' );
1613                 }
1614         }
1615
1616         abstract function getDefaultLimit();
1617
1618         /**
1619          * Get the default value of the number of days to display when loading
1620          * the result set.
1621          * Supports fractional values, and should be cast to a float.
1622          *
1623          * @return float
1624          */
1625         abstract function getDefaultDays();
1626 }