3 * Special page which uses a ChangesList to show query results.
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.
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.
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
21 * @ingroup SpecialPage
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
;
32 * Special page which uses a ChangesList to show query results.
33 * @todo Way too many public functions, most of them should be protected
35 * @ingroup SpecialPage
37 abstract class ChangesListSpecialPage
extends SpecialPage
{
39 * Maximum length of a tag description in UTF-8 characters.
40 * Longer descriptions will be truncated.
42 const TAG_DESC_CHARACTER_LIMIT
= 120;
45 * Preference name for saved queries. Subclasses that use saved queries should override this.
48 protected static $savedQueriesPreferenceName;
51 * Preference name for 'days'. Subclasses should override this.
54 protected static $daysPreferenceName;
57 * Preference name for 'limit'. Subclasses should override this.
60 protected static $limitPreferenceName;
63 * Preference name for collapsing the active filter display. Subclasses should override this.
66 protected static $collapsedPreferenceName;
71 /** @var FormOptions */
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.
79 * Definition information for the filters and their groups
81 * The value is $groupDefinition, a parameter to the ChangesListFilterGroup constructor.
82 * However, priority is dynamically added for the core groups, to ease maintenance.
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.
88 * @var array $filterGroupDefinitions
90 private $filterGroupDefinitions;
92 // Same format as filterGroupDefinitions, but for a single group (reviewStatus)
93 // that is registered conditionally.
94 private $legacyReviewStatusFilterGroupDefinition;
96 // Single filter group registered conditionally
97 private $reviewStatusFilterGroupDefinition;
99 // Single filter group registered conditionally
100 private $hideCategorizationFilterDefinition;
103 * Filter groups, and their contained filters
104 * This is an associative array (with group name as key) of ChangesListFilterGroup objects.
106 * @var array $filterGroups
108 protected $filterGroups = [];
110 public function __construct( $name, $restriction ) {
111 parent
::__construct( $name, $restriction );
113 $nonRevisionTypes = [ RC_LOG
];
114 Hooks
::run( 'SpecialWatchlistGetNonRevisionTypes', [ &$nonRevisionTypes ] );
116 $this->filterGroupDefinitions
= [
118 'name' => 'registration',
119 'title' => 'rcfilters-filtergroup-registration',
120 'class' => ChangesListBooleanFilterGroup
::class,
124 // rcshowhideliu-show, rcshowhideliu-hide,
126 'showHideSuffix' => 'showhideliu',
128 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
129 &$query_options, &$join_conds
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'] );
137 'isReplacedInStructuredUi' => true,
141 'name' => 'hideanons',
142 // rcshowhideanons-show, rcshowhideanons-hide,
144 'showHideSuffix' => 'showhideanons',
146 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
147 &$query_options, &$join_conds
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'] );
155 'isReplacedInStructuredUi' => true,
161 'name' => 'userExpLevel',
162 'title' => 'rcfilters-filtergroup-user-experience-level',
163 'class' => ChangesListStringOptionsFilterGroup
::class,
164 'isFullCoverage' => true,
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' );
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' );
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';
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';
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';
218 'default' => ChangesListStringOptionsFilterGroup
::NONE
,
219 'queryCallable' => [ $this, 'filterOnUserExperienceLevel' ],
223 'name' => 'authorship',
224 'title' => 'rcfilters-filtergroup-authorship',
225 'class' => ChangesListBooleanFilterGroup
::class,
228 'name' => 'hidemyself',
229 'label' => 'rcfilters-filter-editsbyself-label',
230 'description' => 'rcfilters-filter-editsbyself-description',
231 // rcshowhidemine-show, rcshowhidemine-hide,
233 'showHideSuffix' => 'showhidemine',
235 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
236 &$query_options, &$join_conds
238 $actorQuery = ActorMigration
::newMigration()->getWhere( $dbr, 'rc_user', $ctx->getUser() );
239 $tables +
= $actorQuery['tables'];
240 $join_conds +
= $actorQuery['joins'];
241 $conds[] = 'NOT(' . $actorQuery['conds'] . ')';
243 'cssClassSuffix' => 'self',
244 'isRowApplicableCallable' => function ( $ctx, $rc ) {
245 return $ctx->getUser()->equals( $rc->getPerformer() );
249 'name' => 'hidebyothers',
250 'label' => 'rcfilters-filter-editsbyother-label',
251 'description' => 'rcfilters-filter-editsbyother-description',
253 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
254 &$query_options, &$join_conds
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'];
262 'cssClassSuffix' => 'others',
263 'isRowApplicableCallable' => function ( $ctx, $rc ) {
264 return !$ctx->getUser()->equals( $rc->getPerformer() );
271 'name' => 'automated',
272 'title' => 'rcfilters-filtergroup-automated',
273 'class' => ChangesListBooleanFilterGroup
::class,
276 'name' => 'hidebots',
277 'label' => 'rcfilters-filter-bots-label',
278 'description' => 'rcfilters-filter-bots-description',
279 // rcshowhidebots-show, rcshowhidebots-hide,
281 'showHideSuffix' => 'showhidebots',
283 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
284 &$query_options, &$join_conds
286 $conds['rc_bot'] = 0;
288 'cssClassSuffix' => 'bot',
289 'isRowApplicableCallable' => function ( $ctx, $rc ) {
290 return $rc->getAttribute( 'rc_bot' );
294 'name' => 'hidehumans',
295 'label' => 'rcfilters-filter-humans-label',
296 'description' => 'rcfilters-filter-humans-description',
298 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
299 &$query_options, &$join_conds
301 $conds['rc_bot'] = 1;
303 'cssClassSuffix' => 'human',
304 'isRowApplicableCallable' => function ( $ctx, $rc ) {
305 return !$rc->getAttribute( 'rc_bot' );
311 // significance (conditional)
314 'name' => 'significance',
315 'title' => 'rcfilters-filtergroup-significance',
316 'class' => ChangesListBooleanFilterGroup
::class,
320 'name' => 'hideminor',
321 'label' => 'rcfilters-filter-minor-label',
322 'description' => 'rcfilters-filter-minor-description',
323 // rcshowhideminor-show, rcshowhideminor-hide,
325 'showHideSuffix' => 'showhideminor',
327 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
328 &$query_options, &$join_conds
330 $conds[] = 'rc_minor = 0';
332 'cssClassSuffix' => 'minor',
333 'isRowApplicableCallable' => function ( $ctx, $rc ) {
334 return $rc->getAttribute( 'rc_minor' );
338 'name' => 'hidemajor',
339 'label' => 'rcfilters-filter-major-label',
340 'description' => 'rcfilters-filter-major-description',
342 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
343 &$query_options, &$join_conds
345 $conds[] = 'rc_minor = 1';
347 'cssClassSuffix' => 'major',
348 'isRowApplicableCallable' => function ( $ctx, $rc ) {
349 return !$rc->getAttribute( 'rc_minor' );
356 'name' => 'lastRevision',
357 'title' => 'rcfilters-filtergroup-lastrevision',
358 'class' => ChangesListBooleanFilterGroup
::class,
362 'name' => 'hidelastrevision',
363 'label' => 'rcfilters-filter-lastrevision-label',
364 'description' => 'rcfilters-filter-lastrevision-description',
366 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
367 &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
368 $conds[] = $dbr->makeList(
370 'rc_this_oldid <> page_latest',
371 'rc_type' => $nonRevisionTypes,
376 'cssClassSuffix' => 'last',
377 'isRowApplicableCallable' => function ( $ctx, $rc ) {
378 return $rc->getAttribute( 'rc_this_oldid' ) === $rc->getAttribute( 'page_latest' );
382 'name' => 'hidepreviousrevisions',
383 'label' => 'rcfilters-filter-previousrevision-label',
384 'description' => 'rcfilters-filter-previousrevision-description',
386 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
387 &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
388 $conds[] = $dbr->makeList(
390 'rc_this_oldid = page_latest',
391 'rc_type' => $nonRevisionTypes,
396 'cssClassSuffix' => 'previous',
397 'isRowApplicableCallable' => function ( $ctx, $rc ) {
398 return $rc->getAttribute( 'rc_this_oldid' ) !== $rc->getAttribute( 'page_latest' );
404 // With extensions, there can be change types that will not be hidden by any of these.
406 'name' => 'changeType',
407 'title' => 'rcfilters-filtergroup-changetype',
408 'class' => ChangesListBooleanFilterGroup
::class,
412 'name' => 'hidepageedits',
413 'label' => 'rcfilters-filter-pageedits-label',
414 'description' => 'rcfilters-filter-pageedits-description',
417 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
418 &$query_options, &$join_conds
420 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_EDIT
);
422 'cssClassSuffix' => 'src-mw-edit',
423 'isRowApplicableCallable' => function ( $ctx, $rc ) {
424 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_EDIT
;
428 'name' => 'hidenewpages',
429 'label' => 'rcfilters-filter-newpages-label',
430 'description' => 'rcfilters-filter-newpages-description',
433 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
434 &$query_options, &$join_conds
436 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_NEW
);
438 'cssClassSuffix' => 'src-mw-new',
439 'isRowApplicableCallable' => function ( $ctx, $rc ) {
440 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_NEW
;
444 // hidecategorization
448 'label' => 'rcfilters-filter-logactions-label',
449 'description' => 'rcfilters-filter-logactions-description',
452 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
453 &$query_options, &$join_conds
455 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_LOG
);
457 'cssClassSuffix' => 'src-mw-log',
458 'isRowApplicableCallable' => function ( $ctx, $rc ) {
459 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_LOG
;
467 $this->legacyReviewStatusFilterGroupDefinition
= [
469 'name' => 'legacyReviewStatus',
470 'title' => 'rcfilters-filtergroup-reviewstatus',
471 'class' => ChangesListBooleanFilterGroup
::class,
474 'name' => 'hidepatrolled',
475 // rcshowhidepatr-show, rcshowhidepatr-hide
477 'showHideSuffix' => 'showhidepatr',
479 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
480 &$query_options, &$join_conds
482 $conds['rc_patrolled'] = RecentChange
::PRC_UNPATROLLED
;
484 'isReplacedInStructuredUi' => true,
487 'name' => 'hideunpatrolled',
489 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
490 &$query_options, &$join_conds
492 $conds[] = 'rc_patrolled != ' . RecentChange
::PRC_UNPATROLLED
;
494 'isReplacedInStructuredUi' => true,
500 $this->reviewStatusFilterGroupDefinition
= [
502 'name' => 'reviewStatus',
503 'title' => 'rcfilters-filtergroup-reviewstatus',
504 'class' => ChangesListStringOptionsFilterGroup
::class,
505 'isFullCoverage' => true,
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
;
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
;
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
;
536 'default' => ChangesListStringOptionsFilterGroup
::NONE
,
537 'queryCallable' => function ( $specialPageClassName, $ctx, $dbr,
538 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selected
540 if ( $selected === [] ) {
543 $rcPatrolledValues = [
544 'unpatrolled' => RecentChange
::PRC_UNPATROLLED
,
545 'manual' => RecentChange
::PRC_PATROLLED
,
546 'auto' => RecentChange
::PRC_AUTOPATROLLED
,
548 // e.g. rc_patrolled IN (0, 2)
549 $conds['rc_patrolled'] = array_map( function ( $s ) use ( $rcPatrolledValues ) {
550 return $rcPatrolledValues[ $s ];
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',
565 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
566 &$query_options, &$join_conds
568 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_CATEGORIZE
);
570 'cssClassSuffix' => 'src-mw-categorize',
571 'isRowApplicableCallable' => function ( $ctx, $rc ) {
572 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_CATEGORIZE
;
578 * Check if filters are in conflict and guaranteed to return no results.
582 protected function areFiltersInConflict() {
583 $opts = $this->getOptions();
584 /** @var ChangesListFilterGroup $group */
585 foreach ( $this->getFilterGroups() as $group ) {
586 if ( $group->getConflictingGroups() ) {
589 " specifies conflicts with other groups but these are not supported yet."
593 /** @var ChangesListFilter $conflictingFilter */
594 foreach ( $group->getConflictingFilters() as $conflictingFilter ) {
595 if ( $conflictingFilter->activelyInConflictWithGroup( $group, $opts ) ) {
600 /** @var ChangesListFilter $filter */
601 foreach ( $group->getFilters() as $filter ) {
602 /** @var ChangesListFilter $conflictingFilter */
603 foreach ( $filter->getConflictingFilters() as $conflictingFilter ) {
605 $conflictingFilter->activelyInConflictWithFilter( $filter, $opts ) &&
606 $filter->activelyInConflictWithFilter( $conflictingFilter, $opts )
620 * @param string|null $subpage
622 public function execute( $subpage ) {
623 $this->rcSubpage
= $subpage;
625 $this->considerActionsForDefaultSavedQuery( $subpage );
627 $opts = $this->getOptions();
629 $rows = $this->getRows();
630 if ( $rows === false ) {
631 $rows = new FakeResultWrapper( [] );
634 // Used by Structured UI app to get results without MW chrome
635 if ( $this->getRequest()->getVal( 'action' ) === 'render' ) {
636 $this->getOutput()->setArticleBodyOnly( true );
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 );
645 if ( $this->getUser()->isAnon() !==
646 $this->getRequest()->getFuzzyBool( 'isAnon' )
648 $this->getOutput()->setStatusCode( 205 );
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 );
669 $this->outputHeader();
671 $this->webOutput( $rows, $opts );
674 } catch ( DBQueryTimeoutError
$timeoutException ) {
675 MWExceptionHandler
::logException( $timeoutException );
678 $this->outputHeader();
681 $this->getOutput()->setStatusCode( 500 );
682 $this->webOutputHeader( 0, $opts );
683 $this->outputTimeout();
686 if ( $this->getConfig()->get( 'EnableWANCacheReaper' ) ) {
687 // Clean up any bad page entries for titles showing up in RC
688 DeferredUpdates
::addUpdate( new WANCacheReapUpdate(
690 LoggerFactory
::getInstance( 'objectcache' )
694 $this->includeRcFiltersApp();
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.
702 * @param string $subpage
704 protected function considerActionsForDefaultSavedQuery( $subpage ) {
705 if ( !$this->isStructuredFilterUiEnabled() ||
$this->including() ) {
709 $knownParams = $this->getRequest()->getValues(
710 ...array_keys( $this->getOptions()->getAllValues() )
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 );
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
725 // Get the saved queries data and parse it
726 $savedQueries = FormatJson
::decode(
727 $this->getUser()->getOption( static::$savedQueriesPreferenceName ),
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' ];
738 // Build the entire parameter list
739 $query = array_merge(
740 $defaultQuery[ 'params' ],
741 $defaultQuery[ 'highlights' ],
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 ) );
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',
761 // Add the class that tells the frontend it is still loading
763 $this->getOutput()->addBodyClasses( 'mw-rcfilters-ui-loading' );
770 * @see $wgRCLinkDays in DefaultSettings.php.
771 * @see $wgRCFilterByAge in DefaultSettings.php.
774 protected function getLinkDays() {
775 $linkDays = $this->getConfig()->get( 'RCLinkDays' );
776 $filterByAge = $this->getConfig()->get( 'RCFilterByAge' );
777 $maxAge = $this->getConfig()->get( 'RCMaxAge' );
778 if ( $filterByAge ) {
779 // Trim it to only links which are within $wgRCMaxAge.
780 // Note that we allow one link higher than the max for things like
781 // "age 56 days" being accessible through the "60 days" link.
784 $maxAgeDays = $maxAge / ( 3600 * 24 );
785 foreach ( $linkDays as $i => $days ) {
786 if ( $days >= $maxAgeDays ) {
787 array_splice( $linkDays, $i +
1 );
797 * Include the modules and configuration for the RCFilters app.
798 * Conditional on the user having the feature enabled.
800 * If it is disabled, add a <body> class marking that
802 protected function includeRcFiltersApp() {
803 $out = $this->getOutput();
804 if ( $this->isStructuredFilterUiEnabled() && !$this->including() ) {
805 $jsData = $this->getStructuredFilterJsData();
807 foreach ( $jsData['messageKeys'] as $key ) {
808 $messages[$key] = $this->msg( $key )->plain();
811 $out->addBodyClasses( 'mw-rcfilters-enabled' );
812 $collapsed = $this->getUser()->getBoolOption( static::$collapsedPreferenceName );
814 $out->addBodyClasses( 'mw-rcfilters-collapsed' );
817 // These config and message exports should be moved into a ResourceLoader data module (T201574)
818 $out->addJsConfigVars( 'wgStructuredChangeFilters', $jsData['groups'] );
819 $out->addJsConfigVars( 'wgStructuredChangeFiltersMessages', $messages );
820 $out->addJsConfigVars( 'wgStructuredChangeFiltersCollapsedState', $collapsed );
822 $out->addJsConfigVars(
823 'StructuredChangeFiltersDisplayConfig',
825 'maxDays' => (int)$this->getConfig()->get( 'RCMaxAge' ) / ( 24 * 3600 ), // Translate to days
826 'limitArray' => $this->getConfig()->get( 'RCLinkLimits' ),
827 'limitDefault' => $this->getDefaultLimit(),
828 'daysArray' => $this->getLinkDays(),
829 'daysDefault' => $this->getDefaultDays(),
833 $out->addJsConfigVars(
834 'wgStructuredChangeFiltersSavedQueriesPreferenceName',
835 static::$savedQueriesPreferenceName
837 $out->addJsConfigVars(
838 'wgStructuredChangeFiltersLimitPreferenceName',
839 static::$limitPreferenceName
841 $out->addJsConfigVars(
842 'wgStructuredChangeFiltersDaysPreferenceName',
843 static::$daysPreferenceName
845 $out->addJsConfigVars(
846 'wgStructuredChangeFiltersCollapsedPreferenceName',
847 static::$collapsedPreferenceName
850 $out->addBodyClasses( 'mw-rcfilters-disabled' );
855 * Get essential data about getRcFiltersConfigVars() for change detection.
857 * @internal For use by Resources.php only.
858 * @see ResourceLoaderModule::getDefinitionSummary() and ResourceLoaderModule::getVersionHash()
859 * @param ResourceLoaderContext $context
862 public static function getRcFiltersConfigSummary( ResourceLoaderContext
$context ) {
864 // Reduce version computation by avoiding Message parsing
865 'RCFiltersChangeTags' => self
::getChangeTagListSummary( $context ),
866 'StructuredChangeFiltersEditWatchlistUrl' =>
867 SpecialPage
::getTitleFor( 'EditWatchlist' )->getLocalURL()
872 * Get config vars to export with the mediawiki.rcfilters.filters.ui module.
874 * @internal For use by Resources.php only.
875 * @param ResourceLoaderContext $context
878 public static function getRcFiltersConfigVars( ResourceLoaderContext
$context ) {
880 'RCFiltersChangeTags' => self
::getChangeTagList( $context ),
881 'StructuredChangeFiltersEditWatchlistUrl' =>
882 SpecialPage
::getTitleFor( 'EditWatchlist' )->getLocalURL()
887 * Get (cheap to compute) information about change tags.
889 * Returns an array of associative arrays with information about each tag:
890 * - name: Tag name (string)
891 * - labelMsg: Short description message (Message object)
892 * - descriptionMsg: Long description message (Message object)
893 * - cssClass: CSS class to use for RC entries with this tag
894 * - hits: Number of RC entries that have this tag
896 * @param ResourceLoaderContext $context
897 * @return array[] Information about each tag
899 protected static function getChangeTagInfo( ResourceLoaderContext
$context ) {
900 $explicitlyDefinedTags = array_fill_keys( ChangeTags
::listExplicitlyDefinedTags(), 0 );
901 $softwareActivatedTags = array_fill_keys( ChangeTags
::listSoftwareActivatedTags(), 0 );
903 $tagStats = ChangeTags
::tagUsageStatistics();
904 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
907 foreach ( $tagHitCounts as $tagName => $hits ) {
910 // Only get active tags
911 isset( $explicitlyDefinedTags[ $tagName ] ) ||
912 isset( $softwareActivatedTags[ $tagName ] )
914 // Only get tags with more than 0 hits
917 $labelMsg = ChangeTags
::tagShortDescriptionMessage( $tagName, $context );
918 if ( $labelMsg === false ) {
919 // Tag is hidden, skip it
924 // 'label' and 'description' filled in by getChangeTagList()
925 'labelMsg' => $labelMsg,
926 'descriptionMsg' => ChangeTags
::tagLongDescriptionMessage( $tagName, $context ),
927 'cssClass' => Sanitizer
::escapeClass( 'mw-tag-' . $tagName ),
936 * Get information about change tags for use in getRcFiltersConfigSummary().
938 * This expands labelMsg and descriptionMsg to the raw values of each message, which captures
939 * changes in the messages but avoids the expensive step of parsing them.
941 * @param ResourceLoaderContext $context
942 * @return array[] Result of getChangeTagInfo(), with messages expanded to raw contents
944 protected static function getChangeTagListSummary( ResourceLoaderContext
$context ) {
945 $tags = self
::getChangeTagInfo( $context );
946 foreach ( $tags as &$tagInfo ) {
947 $tagInfo['labelMsg'] = $tagInfo['labelMsg']->plain();
948 if ( $tagInfo['descriptionMsg'] ) {
949 $tagInfo['descriptionMsg'] = $tagInfo['descriptionMsg']->plain();
956 * Get information about change tags to export to JS via getRcFiltersConfigVars().
958 * This removes labelMsg and descriptionMsg, and adds label and description, which are parsed,
959 * stripped and (in the case of description) truncated versions of these messages. Message
960 * parsing is expensive, so to detect whether the tag list has changed, use
961 * getChangeTagListSummary() instead.
963 * @param ResourceLoaderContext $context
964 * @return array[] Result of getChangeTagInfo(), with messages parsed, stripped and truncated
966 protected static function getChangeTagList( ResourceLoaderContext
$context ) {
967 $tags = self
::getChangeTagInfo( $context );
968 $language = Language
::factory( $context->getLanguage() );
969 foreach ( $tags as &$tagInfo ) {
970 $tagInfo['label'] = Sanitizer
::stripAllTags( $tagInfo['labelMsg']->parse() );
971 $tagInfo['description'] = $tagInfo['descriptionMsg'] ?
972 $language->truncateForVisual(
973 Sanitizer
::stripAllTags( $tagInfo['descriptionMsg']->parse() ),
974 self
::TAG_DESC_CHARACTER_LIMIT
977 unset( $tagInfo['labelMsg'] );
978 unset( $tagInfo['descriptionMsg'] );
981 // Instead of sorting by hit count (disabled for now), sort by display name
982 usort( $tags, function ( $a, $b ) {
983 return strcasecmp( $a['label'], $b['label'] );
989 * Add the "no results" message to the output
991 protected function outputNoResults() {
992 $this->getOutput()->addHTML(
993 '<div class="mw-changeslist-empty">' .
994 $this->msg( 'recentchanges-noresult' )->parse() .
1000 * Add the "timeout" message to the output
1002 protected function outputTimeout() {
1003 $this->getOutput()->addHTML(
1004 '<div class="mw-changeslist-empty mw-changeslist-timeout">' .
1005 $this->msg( 'recentchanges-timeout' )->parse() .
1011 * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
1013 * @return bool|IResultWrapper Result or false
1015 public function getRows() {
1016 $opts = $this->getOptions();
1021 $query_options = [];
1023 $this->buildQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
1025 return $this->doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
1029 * Get the current FormOptions for this request
1031 * @return FormOptions
1033 public function getOptions() {
1034 if ( $this->rcOptions
=== null ) {
1035 $this->rcOptions
= $this->setup( $this->rcSubpage
);
1038 return $this->rcOptions
;
1042 * Register all filters and their groups (including those from hooks), plus handle
1043 * conflicts and defaults.
1045 * You might want to customize these in the same method, in subclasses. You can
1046 * call getFilterGroup to access a group, and (on the group) getFilter to access a
1047 * filter, then make necessary modfications to the filter or group (e.g. with
1050 protected function registerFilters() {
1051 $this->registerFiltersFromDefinitions( $this->filterGroupDefinitions
);
1053 // Make sure this is not being transcluded (we don't want to show this
1054 // information to all users just because the user that saves the edit can
1055 // patrol or is logged in)
1056 if ( !$this->including() && $this->getUser()->useRCPatrol() ) {
1057 $this->registerFiltersFromDefinitions( $this->legacyReviewStatusFilterGroupDefinition
);
1058 $this->registerFiltersFromDefinitions( $this->reviewStatusFilterGroupDefinition
);
1061 $changeTypeGroup = $this->getFilterGroup( 'changeType' );
1063 if ( $this->getConfig()->get( 'RCWatchCategoryMembership' ) ) {
1064 $transformedHideCategorizationDef = $this->transformFilterDefinition(
1065 $this->hideCategorizationFilterDefinition
1068 $transformedHideCategorizationDef['group'] = $changeTypeGroup;
1070 $hideCategorization = new ChangesListBooleanFilter(
1071 $transformedHideCategorizationDef
1075 Hooks
::run( 'ChangesListSpecialPageStructuredFilters', [ $this ] );
1077 $this->registerFiltersFromDefinitions( [] );
1079 $userExperienceLevel = $this->getFilterGroup( 'userExpLevel' );
1080 $registered = $userExperienceLevel->getFilter( 'registered' );
1081 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'newcomer' ) );
1082 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'learner' ) );
1083 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'experienced' ) );
1085 $categoryFilter = $changeTypeGroup->getFilter( 'hidecategorization' );
1086 $logactionsFilter = $changeTypeGroup->getFilter( 'hidelog' );
1087 $pagecreationFilter = $changeTypeGroup->getFilter( 'hidenewpages' );
1089 $significanceTypeGroup = $this->getFilterGroup( 'significance' );
1090 $hideMinorFilter = $significanceTypeGroup->getFilter( 'hideminor' );
1092 // categoryFilter is conditional; see registerFilters
1093 if ( $categoryFilter !== null ) {
1094 $hideMinorFilter->conflictsWith(
1096 'rcfilters-hideminor-conflicts-typeofchange-global',
1097 'rcfilters-hideminor-conflicts-typeofchange',
1098 'rcfilters-typeofchange-conflicts-hideminor'
1101 $hideMinorFilter->conflictsWith(
1103 'rcfilters-hideminor-conflicts-typeofchange-global',
1104 'rcfilters-hideminor-conflicts-typeofchange',
1105 'rcfilters-typeofchange-conflicts-hideminor'
1107 $hideMinorFilter->conflictsWith(
1108 $pagecreationFilter,
1109 'rcfilters-hideminor-conflicts-typeofchange-global',
1110 'rcfilters-hideminor-conflicts-typeofchange',
1111 'rcfilters-typeofchange-conflicts-hideminor'
1116 * Transforms filter definition to prepare it for constructor.
1118 * See overrides of this method as well.
1120 * @param array $filterDefinition Original filter definition
1122 * @return array Transformed definition
1124 protected function transformFilterDefinition( array $filterDefinition ) {
1125 return $filterDefinition;
1129 * Register filters from a definition object
1131 * Array specifying groups and their filters; see Filter and
1132 * ChangesListFilterGroup constructors.
1134 * There is light processing to simplify core maintenance.
1135 * @param array $definition
1136 * @phan-param array<int,array{class:string}> $definition
1138 protected function registerFiltersFromDefinitions( array $definition ) {
1139 $autoFillPriority = -1;
1140 foreach ( $definition as $groupDefinition ) {
1141 if ( !isset( $groupDefinition['priority'] ) ) {
1142 $groupDefinition['priority'] = $autoFillPriority;
1144 // If it's explicitly specified, start over the auto-fill
1145 $autoFillPriority = $groupDefinition['priority'];
1148 $autoFillPriority--;
1150 $className = $groupDefinition['class'];
1151 unset( $groupDefinition['class'] );
1153 foreach ( $groupDefinition['filters'] as &$filterDefinition ) {
1154 $filterDefinition = $this->transformFilterDefinition( $filterDefinition );
1157 $this->registerFilterGroup( new $className( $groupDefinition ) );
1162 * @return array The legacy show/hide toggle filters
1164 protected function getLegacyShowHideFilters() {
1166 foreach ( $this->filterGroups
as $group ) {
1167 if ( $group instanceof ChangesListBooleanFilterGroup
) {
1168 foreach ( $group->getFilters() as $key => $filter ) {
1169 if ( $filter->displaysOnUnstructuredUi( $this ) ) {
1170 $filters[ $key ] = $filter;
1179 * Register all the filters, including legacy hook-driven ones.
1180 * Then create a FormOptions object with options as specified by the user
1182 * @param string $parameters
1184 * @return FormOptions
1186 public function setup( $parameters ) {
1187 $this->registerFilters();
1189 $opts = $this->getDefaultOptions();
1191 $opts = $this->fetchOptionsFromRequest( $opts );
1193 // Give precedence to subpage syntax
1194 if ( $parameters !== null ) {
1195 $this->parseParameters( $parameters, $opts );
1198 $this->validateOptions( $opts );
1204 * Get a FormOptions object containing the default options. By default, returns
1205 * some basic options. The filters listed explicitly here are overriden in this
1206 * method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters,
1207 * and more) are structured. Structured filters are overriden in registerFilters.
1210 * @return FormOptions
1212 public function getDefaultOptions() {
1213 $opts = new FormOptions();
1214 $structuredUI = $this->isStructuredFilterUiEnabled();
1215 // If urlversion=2 is set, ignore the filter defaults and set them all to false/empty
1216 $useDefaults = $this->getRequest()->getInt( 'urlversion' ) !== 2;
1218 /** @var ChangesListFilterGroup $filterGroup */
1219 foreach ( $this->filterGroups
as $filterGroup ) {
1220 $filterGroup->addOptions( $opts, $useDefaults, $structuredUI );
1223 $opts->add( 'namespace', '', FormOptions
::STRING );
1224 $opts->add( 'invert', false );
1225 $opts->add( 'associated', false );
1226 $opts->add( 'urlversion', 1 );
1227 $opts->add( 'tagfilter', '' );
1229 $opts->add( 'days', $this->getDefaultDays(), FormOptions
::FLOAT );
1230 $opts->add( 'limit', $this->getDefaultLimit(), FormOptions
::INT );
1232 $opts->add( 'from', '' );
1238 * Register a structured changes list filter group
1240 * @param ChangesListFilterGroup $group
1242 public function registerFilterGroup( ChangesListFilterGroup
$group ) {
1243 $groupName = $group->getName();
1245 $this->filterGroups
[$groupName] = $group;
1249 * Gets the currently registered filters groups
1251 * @return array Associative array of ChangesListFilterGroup objects, with group name as key
1253 protected function getFilterGroups() {
1254 return $this->filterGroups
;
1258 * Gets a specified ChangesListFilterGroup by name
1260 * @param string $groupName Name of group
1262 * @return ChangesListFilterGroup|null Group, or null if not registered
1264 public function getFilterGroup( $groupName ) {
1265 return $this->filterGroups
[$groupName] ??
null;
1268 // Currently, this intentionally only includes filters that display
1269 // in the structured UI. This can be changed easily, though, if we want
1270 // to include data on filters that use the unstructured UI. messageKeys is a
1271 // special top-level value, with the value being an array of the message keys to
1272 // send to the client.
1275 * Gets structured filter information needed by JS
1277 * @return array Associative array
1278 * * array $return['groups'] Group data
1279 * * array $return['messageKeys'] Array of message keys
1281 public function getStructuredFilterJsData() {
1284 'messageKeys' => [],
1287 usort( $this->filterGroups
, function ( $a, $b ) {
1288 return $b->getPriority() <=> $a->getPriority();
1291 foreach ( $this->filterGroups
as $groupName => $group ) {
1292 $groupOutput = $group->getJsData( $this );
1293 if ( $groupOutput !== null ) {
1294 $output['messageKeys'] = array_merge(
1295 $output['messageKeys'],
1296 $groupOutput['messageKeys']
1299 unset( $groupOutput['messageKeys'] );
1300 $output['groups'][] = $groupOutput;
1308 * Fetch values for a FormOptions object from the WebRequest associated with this instance.
1310 * Intended for subclassing, e.g. to add a backwards-compatibility layer.
1312 * @param FormOptions $opts
1313 * @return FormOptions
1315 protected function fetchOptionsFromRequest( $opts ) {
1316 $opts->fetchValuesFromRequest( $this->getRequest() );
1322 * Process $par and put options found in $opts. Used when including the page.
1324 * @param string $par
1325 * @param FormOptions $opts
1327 public function parseParameters( $par, FormOptions
$opts ) {
1328 $stringParameterNameSet = [];
1329 $hideParameterNameSet = [];
1331 // URL parameters can be per-group, like 'userExpLevel',
1332 // or per-filter, like 'hideminor'.
1334 foreach ( $this->filterGroups
as $filterGroup ) {
1335 if ( $filterGroup instanceof ChangesListStringOptionsFilterGroup
) {
1336 $stringParameterNameSet[$filterGroup->getName()] = true;
1337 } elseif ( $filterGroup instanceof ChangesListBooleanFilterGroup
) {
1338 foreach ( $filterGroup->getFilters() as $filter ) {
1339 $hideParameterNameSet[$filter->getName()] = true;
1344 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
1345 foreach ( $bits as $bit ) {
1347 if ( isset( $hideParameterNameSet[$bit] ) ) {
1348 // hidefoo => hidefoo=true
1350 } elseif ( isset( $hideParameterNameSet["hide$bit"] ) ) {
1351 // foo => hidefoo=false
1352 $opts["hide$bit"] = false;
1353 } elseif ( preg_match( '/^(.*)=(.*)$/', $bit, $m ) ) {
1354 if ( isset( $stringParameterNameSet[$m[1]] ) ) {
1355 $opts[$m[1]] = $m[2];
1362 * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
1364 * @param FormOptions $opts
1366 public function validateOptions( FormOptions
$opts ) {
1367 $isContradictory = $this->fixContradictoryOptions( $opts );
1368 $isReplaced = $this->replaceOldOptions( $opts );
1370 if ( $isContradictory ||
$isReplaced ) {
1371 $query = wfArrayToCgi( $this->convertParamsForLink( $opts->getChangedValues() ) );
1372 $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
1375 $opts->validateIntBounds( 'limit', 0, 5000 );
1376 $opts->validateBounds( 'days', 0, $this->getConfig()->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
1380 * Fix invalid options by resetting pairs that should never appear together.
1382 * @param FormOptions $opts
1383 * @return bool True if any option was reset
1385 private function fixContradictoryOptions( FormOptions
$opts ) {
1386 $fixed = $this->fixBackwardsCompatibilityOptions( $opts );
1388 foreach ( $this->filterGroups
as $filterGroup ) {
1389 if ( $filterGroup instanceof ChangesListBooleanFilterGroup
) {
1390 $filters = $filterGroup->getFilters();
1392 if ( count( $filters ) === 1 ) {
1393 // legacy boolean filters should not be considered
1397 $allInGroupEnabled = array_reduce(
1399 function ( $carry, $filter ) use ( $opts ) {
1400 return $carry && $opts[ $filter->getName() ];
1402 /* initialValue */ count( $filters ) > 0
1405 if ( $allInGroupEnabled ) {
1406 foreach ( $filters as $filter ) {
1407 $opts[ $filter->getName() ] = false;
1419 * Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards
1422 * This is deprecated and may be removed.
1424 * @param FormOptions $opts
1425 * @return bool True if this change was mode
1427 private function fixBackwardsCompatibilityOptions( FormOptions
$opts ) {
1428 if ( $opts['hideanons'] && $opts['hideliu'] ) {
1429 $opts->reset( 'hideanons' );
1430 if ( !$opts['hidebots'] ) {
1431 $opts->reset( 'hideliu' );
1432 $opts['hidehumans'] = 1;
1442 * Replace old options with their structured UI equivalents
1444 * @param FormOptions $opts
1445 * @return bool True if the change was made
1447 public function replaceOldOptions( FormOptions
$opts ) {
1448 if ( !$this->isStructuredFilterUiEnabled() ) {
1454 // At this point 'hideanons' and 'hideliu' cannot be both true,
1455 // because fixBackwardsCompatibilityOptions resets (at least) 'hideanons' in such case
1456 if ( $opts[ 'hideanons' ] ) {
1457 $opts->reset( 'hideanons' );
1458 $opts[ 'userExpLevel' ] = 'registered';
1462 if ( $opts[ 'hideliu' ] ) {
1463 $opts->reset( 'hideliu' );
1464 $opts[ 'userExpLevel' ] = 'unregistered';
1468 if ( $this->getFilterGroup( 'legacyReviewStatus' ) ) {
1469 if ( $opts[ 'hidepatrolled' ] ) {
1470 $opts->reset( 'hidepatrolled' );
1471 $opts[ 'reviewStatus' ] = 'unpatrolled';
1475 if ( $opts[ 'hideunpatrolled' ] ) {
1476 $opts->reset( 'hideunpatrolled' );
1477 $opts[ 'reviewStatus' ] = implode(
1478 ChangesListStringOptionsFilterGroup
::SEPARATOR
,
1479 [ 'manual', 'auto' ]
1489 * Convert parameters values from true/false to 1/0
1490 * so they are not omitted by wfArrayToCgi()
1493 * @param array $params
1496 protected function convertParamsForLink( $params ) {
1497 foreach ( $params as &$value ) {
1498 if ( $value === false ) {
1507 * Sets appropriate tables, fields, conditions, etc. depending on which filters
1508 * the user requested.
1510 * @param array &$tables Array of tables; see IDatabase::select $table
1511 * @param array &$fields Array of fields; see IDatabase::select $vars
1512 * @param array &$conds Array of conditions; see IDatabase::select $conds
1513 * @param array &$query_options Array of query options; see IDatabase::select $options
1514 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1515 * @param FormOptions $opts
1517 protected function buildQuery( &$tables, &$fields, &$conds, &$query_options,
1518 &$join_conds, FormOptions
$opts
1520 $dbr = $this->getDB();
1521 $isStructuredUI = $this->isStructuredFilterUiEnabled();
1523 /** @var ChangesListFilterGroup $filterGroup */
1524 foreach ( $this->filterGroups
as $filterGroup ) {
1525 $filterGroup->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1526 $query_options, $join_conds, $opts, $isStructuredUI );
1529 // Namespace filtering
1530 if ( $opts[ 'namespace' ] !== '' ) {
1531 $namespaces = explode( ';', $opts[ 'namespace' ] );
1533 $namespaces = $this->expandSymbolicNamespaceFilters( $namespaces );
1535 if ( $opts[ 'associated' ] ) {
1536 $namespaceInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
1537 $associatedNamespaces = array_map(
1538 function ( $ns ) use ( $namespaceInfo ){
1539 return $namespaceInfo->getAssociated( $ns );
1543 function ( $ns ) use ( $namespaceInfo ) {
1544 return $namespaceInfo->hasTalkNamespace( $ns );
1548 $namespaces = array_unique( array_merge( $namespaces, $associatedNamespaces ) );
1551 if ( count( $namespaces ) === 1 ) {
1552 $operator = $opts[ 'invert' ] ?
'!=' : '=';
1553 $value = $dbr->addQuotes( reset( $namespaces ) );
1555 $operator = $opts[ 'invert' ] ?
'NOT IN' : 'IN';
1556 sort( $namespaces );
1557 $value = '(' . $dbr->makeList( $namespaces ) . ')';
1559 $conds[] = "rc_namespace $operator $value";
1563 $cutoff_unixtime = time() - $opts['days'] * 3600 * 24;
1564 $cutoff = $dbr->timestamp( $cutoff_unixtime );
1566 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
1567 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW
, $cutoff ) ) {
1568 $cutoff = $dbr->timestamp( $opts['from'] );
1570 $opts->reset( 'from' );
1573 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
1579 * @param array $tables Array of tables; see IDatabase::select $table
1580 * @param array $fields Array of fields; see IDatabase::select $vars
1581 * @param array $conds Array of conditions; see IDatabase::select $conds
1582 * @param array $query_options Array of query options; see IDatabase::select $options
1583 * @param array $join_conds Array of join conditions; see IDatabase::select $join_conds
1584 * @param FormOptions $opts
1585 * @return bool|IResultWrapper Result or false
1587 protected function doMainQuery( $tables, $fields, $conds,
1588 $query_options, $join_conds, FormOptions
$opts
1590 $rcQuery = RecentChange
::getQueryInfo();
1591 $tables = array_merge( $tables, $rcQuery['tables'] );
1592 $fields = array_merge( $rcQuery['fields'], $fields );
1593 $join_conds = array_merge( $join_conds, $rcQuery['joins'] );
1595 ChangeTags
::modifyDisplayQuery(
1604 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
1610 $dbr = $this->getDB();
1612 return $dbr->select(
1622 protected function runMainQueryHook( &$tables, &$fields, &$conds,
1623 &$query_options, &$join_conds, $opts
1626 'ChangesListSpecialPageQuery',
1627 [ $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ]
1632 * Return a IDatabase object for reading
1636 protected function getDB() {
1637 return wfGetDB( DB_REPLICA
);
1641 * Send header output to the OutputPage object, only called if not using feeds
1643 * @param int $rowCount Number of database rows
1644 * @param FormOptions $opts
1646 private function webOutputHeader( $rowCount, $opts ) {
1647 if ( !$this->including() ) {
1648 $this->outputFeedLinks();
1649 $this->doHeader( $opts, $rowCount );
1654 * Send output to the OutputPage object, only called if not used feeds
1656 * @param IResultWrapper $rows Database rows
1657 * @param FormOptions $opts
1659 public function webOutput( $rows, $opts ) {
1660 $this->webOutputHeader( $rows->numRows(), $opts );
1662 $this->outputChangesList( $rows, $opts );
1666 * Output feed links.
1668 public function outputFeedLinks() {
1669 // nothing by default
1673 * Build and output the actual changes list.
1675 * @param IResultWrapper $rows Database rows
1676 * @param FormOptions $opts
1678 abstract public function outputChangesList( $rows, $opts );
1681 * Set the text to be displayed above the changes
1683 * @param FormOptions $opts
1684 * @param int $numRows Number of rows in the result to show after this header
1686 public function doHeader( $opts, $numRows ) {
1687 $this->setTopText( $opts );
1689 // @todo Lots of stuff should be done here.
1691 $this->setBottomText( $opts );
1695 * Send the text to be displayed before the options.
1696 * Should use $this->getOutput()->addWikiTextAsInterface()
1697 * or similar methods to print the text.
1699 * @param FormOptions $opts
1701 public function setTopText( FormOptions
$opts ) {
1702 // nothing by default
1706 * Send the text to be displayed after the options.
1707 * Should use $this->getOutput()->addWikiTextAsInterface()
1708 * or similar methods to print the text.
1710 * @param FormOptions $opts
1712 public function setBottomText( FormOptions
$opts ) {
1713 // nothing by default
1717 * Get options to be displayed in a form
1718 * @todo This should handle options returned by getDefaultOptions().
1719 * @todo Not called by anything in this class (but is in subclasses), should be
1720 * called by something… doHeader() maybe?
1722 * @param FormOptions $opts
1725 public function getExtraOptions( $opts ) {
1730 * Return the legend displayed within the fieldset
1734 public function makeLegend() {
1735 $context = $this->getContext();
1736 $user = $context->getUser();
1737 # The legend showing what the letters and stuff mean
1738 $legend = Html
::openElement( 'dl' ) . "\n";
1739 # Iterates through them and gets the messages for both letter and tooltip
1740 $legendItems = $context->getConfig()->get( 'RecentChangesFlags' );
1741 if ( !( $user->useRCPatrol() ||
$user->useNPPatrol() ) ) {
1742 unset( $legendItems['unpatrolled'] );
1744 foreach ( $legendItems as $key => $item ) { # generate items of the legend
1745 $label = $item['legend'] ??
$item['title'];
1746 $letter = $item['letter'];
1747 $cssClass = $item['class'] ??
$key;
1749 $legend .= Html
::element( 'dt',
1750 [ 'class' => $cssClass ], $context->msg( $letter )->text()
1752 Html
::rawElement( 'dd',
1753 [ 'class' => Sanitizer
::escapeClass( 'mw-changeslist-legend-' . $key ) ],
1754 $context->msg( $label )->parse()
1758 $legend .= Html
::rawElement( 'dt',
1759 [ 'class' => 'mw-plusminus-pos' ],
1760 $context->msg( 'recentchanges-legend-plusminus' )->parse()
1762 $legend .= Html
::element(
1764 [ 'class' => 'mw-changeslist-legend-plusminus' ],
1765 $context->msg( 'recentchanges-label-plusminus' )->text()
1767 $legend .= Html
::closeElement( 'dl' ) . "\n";
1769 $legendHeading = $this->isStructuredFilterUiEnabled() ?
1770 $context->msg( 'rcfilters-legend-heading' )->parse() :
1771 $context->msg( 'recentchanges-legend-heading' )->parse();
1774 $collapsedState = $this->getRequest()->getCookie( 'changeslist-state' );
1775 $collapsedClass = $collapsedState === 'collapsed' ?
' mw-collapsed' : '';
1778 '<div class="mw-changeslist-legend mw-collapsible' . $collapsedClass . '">' .
1780 '<div class="mw-collapsible-content">' . $legend . '</div>' .
1787 * Add page-specific modules.
1789 protected function addModules() {
1790 $out = $this->getOutput();
1791 // Styles and behavior for the legend box (see makeLegend())
1792 $out->addModuleStyles( [
1793 'mediawiki.interface.helpers.styles',
1794 'mediawiki.special.changeslist.legend',
1795 'mediawiki.special.changeslist',
1797 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
1799 if ( $this->isStructuredFilterUiEnabled() && !$this->including() ) {
1800 $out->addModules( 'mediawiki.rcfilters.filters.ui' );
1801 $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
1805 protected function getGroupName() {
1810 * Filter on users' experience levels; this will not be called if nothing is
1813 * @param string $specialPageClassName Class name of current special page
1814 * @param IContextSource $context Context, for e.g. user
1815 * @param IDatabase $dbr Database, for addQuotes, makeList, and similar
1816 * @param array &$tables Array of tables; see IDatabase::select $table
1817 * @param array &$fields Array of fields; see IDatabase::select $vars
1818 * @param array &$conds Array of conditions; see IDatabase::select $conds
1819 * @param array &$query_options Array of query options; see IDatabase::select $options
1820 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1821 * @param array $selectedExpLevels The allowed active values, sorted
1822 * @param int $now Number of seconds since the UNIX epoch, or 0 if not given
1825 public function filterOnUserExperienceLevel( $specialPageClassName, $context, $dbr,
1826 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now = 0
1828 global $wgLearnerEdits,
1829 $wgExperiencedUserEdits,
1830 $wgLearnerMemberSince,
1831 $wgExperiencedUserMemberSince;
1835 // If all levels are selected, don't filter
1836 if ( count( $selectedExpLevels ) === $LEVEL_COUNT ) {
1840 // both 'registered' and 'unregistered', experience levels, if any, are included in 'registered'
1842 in_array( 'registered', $selectedExpLevels ) &&
1843 in_array( 'unregistered', $selectedExpLevels )
1848 $actorMigration = ActorMigration
::newMigration();
1849 $actorQuery = $actorMigration->getJoin( 'rc_user' );
1850 $tables +
= $actorQuery['tables'];
1851 $join_conds +
= $actorQuery['joins'];
1853 // 'registered' but not 'unregistered', experience levels, if any, are included in 'registered'
1855 in_array( 'registered', $selectedExpLevels ) &&
1856 !in_array( 'unregistered', $selectedExpLevels )
1858 $conds[] = $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] );
1862 if ( $selectedExpLevels === [ 'unregistered' ] ) {
1863 $conds[] = $actorMigration->isAnon( $actorQuery['fields']['rc_user'] );
1868 $join_conds['user'] = [ 'LEFT JOIN', $actorQuery['fields']['rc_user'] . ' = user_id' ];
1873 $secondsPerDay = 86400;
1874 $learnerCutoff = $now - $wgLearnerMemberSince * $secondsPerDay;
1875 $experiencedUserCutoff = $now - $wgExperiencedUserMemberSince * $secondsPerDay;
1877 $aboveNewcomer = $dbr->makeList(
1879 'user_editcount >= ' . intval( $wgLearnerEdits ),
1880 'user_registration <= ' . $dbr->addQuotes( $dbr->timestamp( $learnerCutoff ) ),
1885 $aboveLearner = $dbr->makeList(
1887 'user_editcount >= ' . intval( $wgExperiencedUserEdits ),
1888 'user_registration <= ' .
1889 $dbr->addQuotes( $dbr->timestamp( $experiencedUserCutoff ) ),
1896 if ( in_array( 'unregistered', $selectedExpLevels ) ) {
1897 $selectedExpLevels = array_diff( $selectedExpLevels, [ 'unregistered' ] );
1898 $conditions[] = $actorMigration->isAnon( $actorQuery['fields']['rc_user'] );
1901 if ( $selectedExpLevels === [ 'newcomer' ] ) {
1902 $conditions[] = "NOT ( $aboveNewcomer )";
1903 } elseif ( $selectedExpLevels === [ 'learner' ] ) {
1904 $conditions[] = $dbr->makeList(
1905 [ $aboveNewcomer, "NOT ( $aboveLearner )" ],
1908 } elseif ( $selectedExpLevels === [ 'experienced' ] ) {
1909 $conditions[] = $aboveLearner;
1910 } elseif ( $selectedExpLevels === [ 'learner', 'newcomer' ] ) {
1911 $conditions[] = "NOT ( $aboveLearner )";
1912 } elseif ( $selectedExpLevels === [ 'experienced', 'newcomer' ] ) {
1913 $conditions[] = $dbr->makeList(
1914 [ "NOT ( $aboveNewcomer )", $aboveLearner ],
1917 } elseif ( $selectedExpLevels === [ 'experienced', 'learner' ] ) {
1918 $conditions[] = $aboveNewcomer;
1919 } elseif ( $selectedExpLevels === [ 'experienced', 'learner', 'newcomer' ] ) {
1920 $conditions[] = $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] );
1923 if ( count( $conditions ) > 1 ) {
1924 $conds[] = $dbr->makeList( $conditions, IDatabase
::LIST_OR
);
1925 } elseif ( count( $conditions ) === 1 ) {
1926 $conds[] = reset( $conditions );
1931 * Check whether the structured filter UI is enabled
1935 public function isStructuredFilterUiEnabled() {
1936 if ( $this->getRequest()->getBool( 'rcfilters' ) ) {
1940 return static::checkStructuredFilterUiEnabled( $this->getUser() );
1944 * Static method to check whether StructuredFilter UI is enabled for the given user
1950 public static function checkStructuredFilterUiEnabled( $user ) {
1951 if ( $user instanceof Config
) {
1952 wfDeprecated( __METHOD__
. ' with Config argument', '1.34' );
1953 $user = func_get_arg( 1 );
1955 return !$user->getOption( 'rcenhancedfilters-disable' );
1959 * Get the default value of the number of changes to display when loading
1965 public function getDefaultLimit() {
1966 return $this->getUser()->getIntOption( static::$limitPreferenceName );
1970 * Get the default value of the number of days to display when loading
1972 * Supports fractional values, and should be cast to a float.
1977 public function getDefaultDays() {
1978 return floatval( $this->getUser()->getOption( static::$daysPreferenceName ) );
1981 private function expandSymbolicNamespaceFilters( array $namespaces ) {
1982 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
1983 $symbolicFilters = [
1984 'all-contents' => $nsInfo->getSubjectNamespaces(),
1985 'all-discussions' => $nsInfo->getTalkNamespaces(),
1987 $additionalNamespaces = [];
1988 foreach ( $symbolicFilters as $name => $values ) {
1989 if ( in_array( $name, $namespaces ) ) {
1990 $additionalNamespaces = array_merge( $additionalNamespaces, $values );
1993 $namespaces = array_diff( $namespaces, array_keys( $symbolicFilters ) );
1994 $namespaces = array_merge( $namespaces, $additionalNamespaces );
1995 return array_unique( $namespaces );