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