includes/specialpage/ChangesListSpecialPage.php

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