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
23 use MediaWiki\Logger\LoggerFactory
;
24 use Wikimedia\Rdbms\ResultWrapper
;
25 use Wikimedia\Rdbms\FakeResultWrapper
;
26 use Wikimedia\Rdbms\IDatabase
;
29 * Special page which uses a ChangesList to show query results.
30 * @todo Way too many public functions, most of them should be protected
32 * @ingroup SpecialPage
34 abstract class ChangesListSpecialPage
extends SpecialPage
{
36 * Preference name for saved queries. Subclasses that use saved queries should override this.
39 protected static $savedQueriesPreferenceName;
44 /** @var FormOptions */
48 protected $customFilters;
50 // Order of both groups and filters is significant; first is top-most priority,
51 // descending from there.
52 // 'showHideSuffix' is a shortcut to and avoid spelling out
53 // details specific to subclasses here.
55 * Definition information for the filters and their groups
57 * The value is $groupDefinition, a parameter to the ChangesListFilterGroup constructor.
58 * However, priority is dynamically added for the core groups, to ease maintenance.
60 * Groups are displayed to the user in the structured UI. However, if necessary,
61 * all of the filters in a group can be configured to only display on the
62 * unstuctured UI, in which case you don't need a group title. This is done in
63 * getFilterGroupDefinitionFromLegacyCustomFilters, for example.
65 * @var array $filterGroupDefinitions
67 private $filterGroupDefinitions;
69 // Same format as filterGroupDefinitions, but for a single group (reviewStatus)
70 // that is registered conditionally.
71 private $reviewStatusFilterGroupDefinition;
73 // Single filter registered conditionally
74 private $hideCategorizationFilterDefinition;
77 * Filter groups, and their contained filters
78 * This is an associative array (with group name as key) of ChangesListFilterGroup objects.
80 * @var array $filterGroups
82 protected $filterGroups = [];
84 public function __construct( $name, $restriction ) {
85 parent
::__construct( $name, $restriction );
87 $nonRevisionTypes = [ RC_LOG
];
88 Hooks
::run( 'SpecialWatchlistGetNonRevisionTypes', [ &$nonRevisionTypes ] );
90 $this->filterGroupDefinitions
= [
92 'name' => 'registration',
93 'title' => 'rcfilters-filtergroup-registration',
94 'class' => ChangesListBooleanFilterGroup
::class,
98 // rcshowhideliu-show, rcshowhideliu-hide,
100 'showHideSuffix' => 'showhideliu',
102 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
103 &$query_options, &$join_conds
105 $conds[] = 'rc_user = 0';
107 'isReplacedInStructuredUi' => true,
111 'name' => 'hideanons',
112 // rcshowhideanons-show, rcshowhideanons-hide,
114 'showHideSuffix' => 'showhideanons',
116 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
117 &$query_options, &$join_conds
119 $conds[] = 'rc_user != 0';
121 'isReplacedInStructuredUi' => true,
127 'name' => 'userExpLevel',
128 'title' => 'rcfilters-filtergroup-userExpLevel',
129 'class' => ChangesListStringOptionsFilterGroup
::class,
130 'isFullCoverage' => true,
133 'name' => 'unregistered',
134 'label' => 'rcfilters-filter-user-experience-level-unregistered-label',
135 'description' => 'rcfilters-filter-user-experience-level-unregistered-description',
136 'cssClassSuffix' => 'user-unregistered',
137 'isRowApplicableCallable' => function ( $ctx, $rc ) {
138 return !$rc->getAttribute( 'rc_user' );
142 'name' => 'registered',
143 'label' => 'rcfilters-filter-user-experience-level-registered-label',
144 'description' => 'rcfilters-filter-user-experience-level-registered-description',
145 'cssClassSuffix' => 'user-registered',
146 'isRowApplicableCallable' => function ( $ctx, $rc ) {
147 return $rc->getAttribute( 'rc_user' );
151 'name' => 'newcomer',
152 'label' => 'rcfilters-filter-user-experience-level-newcomer-label',
153 'description' => 'rcfilters-filter-user-experience-level-newcomer-description',
154 'cssClassSuffix' => 'user-newcomer',
155 'isRowApplicableCallable' => function ( $ctx, $rc ) {
156 $performer = $rc->getPerformer();
157 return $performer && $performer->isLoggedIn() &&
158 $performer->getExperienceLevel() === 'newcomer';
163 'label' => 'rcfilters-filter-user-experience-level-learner-label',
164 'description' => 'rcfilters-filter-user-experience-level-learner-description',
165 'cssClassSuffix' => 'user-learner',
166 'isRowApplicableCallable' => function ( $ctx, $rc ) {
167 $performer = $rc->getPerformer();
168 return $performer && $performer->isLoggedIn() &&
169 $performer->getExperienceLevel() === 'learner';
173 'name' => 'experienced',
174 'label' => 'rcfilters-filter-user-experience-level-experienced-label',
175 'description' => 'rcfilters-filter-user-experience-level-experienced-description',
176 'cssClassSuffix' => 'user-experienced',
177 'isRowApplicableCallable' => function ( $ctx, $rc ) {
178 $performer = $rc->getPerformer();
179 return $performer && $performer->isLoggedIn() &&
180 $performer->getExperienceLevel() === 'experienced';
184 'default' => ChangesListStringOptionsFilterGroup
::NONE
,
185 'queryCallable' => [ $this, 'filterOnUserExperienceLevel' ],
189 'name' => 'authorship',
190 'title' => 'rcfilters-filtergroup-authorship',
191 'class' => ChangesListBooleanFilterGroup
::class,
194 'name' => 'hidemyself',
195 'label' => 'rcfilters-filter-editsbyself-label',
196 'description' => 'rcfilters-filter-editsbyself-description',
197 // rcshowhidemine-show, rcshowhidemine-hide,
199 'showHideSuffix' => 'showhidemine',
201 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
202 &$query_options, &$join_conds
204 $user = $ctx->getUser();
205 $conds[] = 'rc_user_text != ' . $dbr->addQuotes( $user->getName() );
207 'cssClassSuffix' => 'self',
208 'isRowApplicableCallable' => function ( $ctx, $rc ) {
209 return $ctx->getUser()->equals( $rc->getPerformer() );
213 'name' => 'hidebyothers',
214 'label' => 'rcfilters-filter-editsbyother-label',
215 'description' => 'rcfilters-filter-editsbyother-description',
217 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
218 &$query_options, &$join_conds
220 $user = $ctx->getUser();
221 $conds[] = 'rc_user_text = ' . $dbr->addQuotes( $user->getName() );
223 'cssClassSuffix' => 'others',
224 'isRowApplicableCallable' => function ( $ctx, $rc ) {
225 return !$ctx->getUser()->equals( $rc->getPerformer() );
232 'name' => 'automated',
233 'title' => 'rcfilters-filtergroup-automated',
234 'class' => ChangesListBooleanFilterGroup
::class,
237 'name' => 'hidebots',
238 'label' => 'rcfilters-filter-bots-label',
239 'description' => 'rcfilters-filter-bots-description',
240 // rcshowhidebots-show, rcshowhidebots-hide,
242 'showHideSuffix' => 'showhidebots',
244 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
245 &$query_options, &$join_conds
247 $conds[] = 'rc_bot = 0';
249 'cssClassSuffix' => 'bot',
250 'isRowApplicableCallable' => function ( $ctx, $rc ) {
251 return $rc->getAttribute( 'rc_bot' );
255 'name' => 'hidehumans',
256 'label' => 'rcfilters-filter-humans-label',
257 'description' => 'rcfilters-filter-humans-description',
259 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
260 &$query_options, &$join_conds
262 $conds[] = 'rc_bot = 1';
264 'cssClassSuffix' => 'human',
265 'isRowApplicableCallable' => function ( $ctx, $rc ) {
266 return !$rc->getAttribute( 'rc_bot' );
272 // reviewStatus (conditional)
275 'name' => 'significance',
276 'title' => 'rcfilters-filtergroup-significance',
277 'class' => ChangesListBooleanFilterGroup
::class,
281 'name' => 'hideminor',
282 'label' => 'rcfilters-filter-minor-label',
283 'description' => 'rcfilters-filter-minor-description',
284 // rcshowhideminor-show, rcshowhideminor-hide,
286 'showHideSuffix' => 'showhideminor',
288 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
289 &$query_options, &$join_conds
291 $conds[] = 'rc_minor = 0';
293 'cssClassSuffix' => 'minor',
294 'isRowApplicableCallable' => function ( $ctx, $rc ) {
295 return $rc->getAttribute( 'rc_minor' );
299 'name' => 'hidemajor',
300 'label' => 'rcfilters-filter-major-label',
301 'description' => 'rcfilters-filter-major-description',
303 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
304 &$query_options, &$join_conds
306 $conds[] = 'rc_minor = 1';
308 'cssClassSuffix' => 'major',
309 'isRowApplicableCallable' => function ( $ctx, $rc ) {
310 return !$rc->getAttribute( 'rc_minor' );
317 'name' => 'lastRevision',
318 'title' => 'rcfilters-filtergroup-lastRevision',
319 'class' => ChangesListBooleanFilterGroup
::class,
323 'name' => 'hidelastrevision',
324 'label' => 'rcfilters-filter-lastrevision-label',
325 'description' => 'rcfilters-filter-lastrevision-description',
327 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
328 &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
329 $conds[] = $dbr->makeList(
331 'rc_this_oldid <> page_latest',
332 'rc_type' => $nonRevisionTypes,
337 'cssClassSuffix' => 'last',
338 'isRowApplicableCallable' => function ( $ctx, $rc ) {
339 return $rc->getAttribute( 'rc_this_oldid' ) === $rc->getAttribute( 'page_latest' );
343 'name' => 'hidepreviousrevisions',
344 'label' => 'rcfilters-filter-previousrevision-label',
345 'description' => 'rcfilters-filter-previousrevision-description',
347 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
348 &$query_options, &$join_conds ) use ( $nonRevisionTypes ) {
349 $conds[] = $dbr->makeList(
351 'rc_this_oldid = page_latest',
352 'rc_type' => $nonRevisionTypes,
357 'cssClassSuffix' => 'previous',
358 'isRowApplicableCallable' => function ( $ctx, $rc ) {
359 return $rc->getAttribute( 'rc_this_oldid' ) !== $rc->getAttribute( 'page_latest' );
365 // With extensions, there can be change types that will not be hidden by any of these.
367 'name' => 'changeType',
368 'title' => 'rcfilters-filtergroup-changetype',
369 'class' => ChangesListBooleanFilterGroup
::class,
373 'name' => 'hidepageedits',
374 'label' => 'rcfilters-filter-pageedits-label',
375 'description' => 'rcfilters-filter-pageedits-description',
378 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
379 &$query_options, &$join_conds
381 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_EDIT
);
383 'cssClassSuffix' => 'src-mw-edit',
384 'isRowApplicableCallable' => function ( $ctx, $rc ) {
385 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_EDIT
;
389 'name' => 'hidenewpages',
390 'label' => 'rcfilters-filter-newpages-label',
391 'description' => 'rcfilters-filter-newpages-description',
394 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
395 &$query_options, &$join_conds
397 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_NEW
);
399 'cssClassSuffix' => 'src-mw-new',
400 'isRowApplicableCallable' => function ( $ctx, $rc ) {
401 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_NEW
;
405 // hidecategorization
409 'label' => 'rcfilters-filter-logactions-label',
410 'description' => 'rcfilters-filter-logactions-description',
413 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
414 &$query_options, &$join_conds
416 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_LOG
);
418 'cssClassSuffix' => 'src-mw-log',
419 'isRowApplicableCallable' => function ( $ctx, $rc ) {
420 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_LOG
;
428 $this->reviewStatusFilterGroupDefinition
= [
430 'name' => 'reviewStatus',
431 'title' => 'rcfilters-filtergroup-reviewstatus',
432 'class' => ChangesListBooleanFilterGroup
::class,
436 'name' => 'hidepatrolled',
437 'label' => 'rcfilters-filter-patrolled-label',
438 'description' => 'rcfilters-filter-patrolled-description',
439 // rcshowhidepatr-show, rcshowhidepatr-hide
441 'showHideSuffix' => 'showhidepatr',
443 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
444 &$query_options, &$join_conds
446 $conds[] = 'rc_patrolled = 0';
448 'cssClassSuffix' => 'patrolled',
449 'isRowApplicableCallable' => function ( $ctx, $rc ) {
450 return $rc->getAttribute( 'rc_patrolled' );
454 'name' => 'hideunpatrolled',
455 'label' => 'rcfilters-filter-unpatrolled-label',
456 'description' => 'rcfilters-filter-unpatrolled-description',
458 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
459 &$query_options, &$join_conds
461 $conds[] = 'rc_patrolled = 1';
463 'cssClassSuffix' => 'unpatrolled',
464 'isRowApplicableCallable' => function ( $ctx, $rc ) {
465 return !$rc->getAttribute( 'rc_patrolled' );
472 $this->hideCategorizationFilterDefinition
= [
473 'name' => 'hidecategorization',
474 'label' => 'rcfilters-filter-categorization-label',
475 'description' => 'rcfilters-filter-categorization-description',
476 // rcshowhidecategorization-show, rcshowhidecategorization-hide.
477 // wlshowhidecategorization
478 'showHideSuffix' => 'showhidecategorization',
481 'queryCallable' => function ( $specialClassName, $ctx, $dbr, &$tables, &$fields, &$conds,
482 &$query_options, &$join_conds
484 $conds[] = 'rc_type != ' . $dbr->addQuotes( RC_CATEGORIZE
);
486 'cssClassSuffix' => 'src-mw-categorize',
487 'isRowApplicableCallable' => function ( $ctx, $rc ) {
488 return $rc->getAttribute( 'rc_source' ) === RecentChange
::SRC_CATEGORIZE
;
494 * Check if filters are in conflict and guaranteed to return no results.
498 protected function areFiltersInConflict() {
499 $opts = $this->getOptions();
500 /** @var ChangesListFilterGroup $group */
501 foreach ( $this->getFilterGroups() as $group ) {
502 if ( $group->getConflictingGroups() ) {
505 " specifies conflicts with other groups but these are not supported yet."
509 /** @var ChangesListFilter $conflictingFilter */
510 foreach ( $group->getConflictingFilters() as $conflictingFilter ) {
511 if ( $conflictingFilter->activelyInConflictWithGroup( $group, $opts ) ) {
516 /** @var ChangesListFilter $filter */
517 foreach ( $group->getFilters() as $filter ) {
518 /** @var ChangesListFilter $conflictingFilter */
519 foreach ( $filter->getConflictingFilters() as $conflictingFilter ) {
521 $conflictingFilter->activelyInConflictWithFilter( $filter, $opts ) &&
522 $filter->activelyInConflictWithFilter( $conflictingFilter, $opts )
536 * Main execution point
538 * @param string $subpage
540 public function execute( $subpage ) {
541 $this->rcSubpage
= $subpage;
543 $this->considerActionsForDefaultSavedQuery();
545 $rows = $this->getRows();
546 $opts = $this->getOptions();
547 if ( $rows === false ) {
548 $rows = new FakeResultWrapper( [] );
551 // Used by Structured UI app to get results without MW chrome
552 if ( $this->getRequest()->getVal( 'action' ) === 'render' ) {
553 $this->getOutput()->setArticleBodyOnly( true );
556 // Used by "live update" and "view newest" to check
557 // if there's new changes with minimal data transfer
558 if ( $this->getRequest()->getBool( 'peek' ) ) {
559 $code = $rows->numRows() > 0 ?
200 : 204;
560 $this->getOutput()->setStatusCode( $code );
564 $batch = new LinkBatch
;
565 foreach ( $rows as $row ) {
566 $batch->add( NS_USER
, $row->rc_user_text
);
567 $batch->add( NS_USER_TALK
, $row->rc_user_text
);
568 $batch->add( $row->rc_namespace
, $row->rc_title
);
569 if ( $row->rc_source
=== RecentChange
::SRC_LOG
) {
570 $formatter = LogFormatter
::newFromRow( $row );
571 foreach ( $formatter->getPreloadTitles() as $title ) {
572 $batch->addObj( $title );
579 $this->outputHeader();
581 $this->webOutput( $rows, $opts );
585 if ( $this->getConfig()->get( 'EnableWANCacheReaper' ) ) {
586 // Clean up any bad page entries for titles showing up in RC
587 DeferredUpdates
::addUpdate( new WANCacheReapUpdate(
589 LoggerFactory
::getInstance( 'objectcache' )
593 $this->includeRcFiltersApp();
597 * Check whether or not the page should load defaults, and if so, whether
598 * a default saved query is relevant to be redirected to. If it is relevant,
599 * redirect properly with all necessary query parameters.
601 protected function considerActionsForDefaultSavedQuery() {
602 if ( !$this->isStructuredFilterUiEnabled() ) {
606 $knownParams = call_user_func_array(
607 [ $this->getRequest(), 'getValues' ],
608 array_keys( $this->getOptions()->getAllValues() )
611 // HACK: Temporarily until we can properly define "sticky" filters and parameters,
612 // we need to exclude several parameters we know should not be counted towards preventing
613 // the loading of defaults.
614 $excludedParams = [ 'limit' => '', 'days' => '', 'enhanced' => '', 'from' => '' ];
615 $knownParams = array_diff_key( $knownParams, $excludedParams );
618 // If there are NO known parameters in the URL request
619 // (that are not excluded) then we need to check into loading
620 // the default saved query
621 count( $knownParams ) === 0
623 // Get the saved queries data and parse it
624 $savedQueries = FormatJson
::decode(
625 $this->getUser()->getOption( static::$savedQueriesPreferenceName ),
629 if ( $savedQueries && isset( $savedQueries[ 'default' ] ) ) {
630 // Only load queries that are 'version' 2, since those
631 // have parameter representation
632 if ( isset( $savedQueries[ 'version' ] ) && $savedQueries[ 'version' ] === '2' ) {
633 $savedQueryDefaultID = $savedQueries[ 'default' ];
634 $defaultQuery = $savedQueries[ 'queries' ][ $savedQueryDefaultID ][ 'data' ];
636 // Build the entire parameter list
637 $query = array_merge(
638 $defaultQuery[ 'params' ],
639 $defaultQuery[ 'highlights' ],
644 // Add to the query any parameters that we may have ignored before
645 // but are still valid and requested in the URL
646 $query = array_merge( $this->getRequest()->getValues(), $query );
647 unset( $query[ 'title' ] );
648 $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
650 // There's a default, but the version is not 2, and the server can't
651 // actually recognize the query itself. This happens if it is before
652 // the conversion, so we need to tell the UI to reload saved query as
653 // it does the conversion to version 2
654 $this->getOutput()->addJsConfigVars(
655 'wgStructuredChangeFiltersDefaultSavedQueryExists',
659 // Add the class that tells the frontend it is still loading
661 $this->getOutput()->addBodyClasses( 'mw-rcfilters-ui-loading' );
668 * Include the modules and configuration for the RCFilters app.
669 * Conditional on the user having the feature enabled.
671 * If it is disabled, add a <body> class marking that
673 protected function includeRcFiltersApp() {
674 $out = $this->getOutput();
675 if ( $this->isStructuredFilterUiEnabled() ) {
676 $jsData = $this->getStructuredFilterJsData();
679 foreach ( $jsData['messageKeys'] as $key ) {
680 $messages[$key] = $this->msg( $key )->plain();
683 $out->addBodyClasses( 'mw-rcfilters-enabled' );
686 ResourceLoader
::makeInlineScript(
687 ResourceLoader
::makeMessageSetScript( $messages )
691 $out->addJsConfigVars( 'wgStructuredChangeFilters', $jsData['groups'] );
693 $out->addJsConfigVars(
694 'wgRCFiltersChangeTags',
695 $this->getChangeTagList()
697 $out->addJsConfigVars(
698 'StructuredChangeFiltersDisplayConfig',
700 'maxDays' => (int)$this->getConfig()->get( 'RCMaxAge' ) / ( 24 * 3600 ), // Translate to days
701 'limitArray' => $this->getConfig()->get( 'RCLinkLimits' ),
702 'limitDefault' => $this->getDefaultLimit(),
703 'daysArray' => $this->getConfig()->get( 'RCLinkDays' ),
704 'daysDefault' => $this->getDefaultDays(),
708 $out->addJsConfigVars(
709 'wgStructuredChangeFiltersSavedQueriesPreferenceName',
710 static::$savedQueriesPreferenceName
713 $out->addJsConfigVars(
714 'StructuredChangeFiltersLiveUpdatePollingRate',
715 $this->getConfig()->get( 'StructuredChangeFiltersLiveUpdatePollingRate' )
718 $out->addBodyClasses( 'mw-rcfilters-disabled' );
723 * Fetch the change tags list for the front end
725 * @return Array Tag data
727 protected function getChangeTagList() {
728 $cache = ObjectCache
::getMainWANInstance();
729 $context = $this->getContext();
730 return $cache->getWithSetCallback(
731 $cache->makeKey( 'changeslistspecialpage-changetags', $context->getLanguage()->getCode() ),
732 $cache::TTL_MINUTE
* 10,
733 function () use ( $context ) {
734 $explicitlyDefinedTags = array_fill_keys( ChangeTags
::listExplicitlyDefinedTags(), 0 );
735 $softwareActivatedTags = array_fill_keys( ChangeTags
::listSoftwareActivatedTags(), 0 );
737 // Hit counts disabled for perf reasons, see T169997
739 $tagStats = ChangeTags::tagUsageStatistics();
740 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
743 arsort( $tagHitCounts );
745 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags );
747 // Build the list and data
749 foreach ( $tagHitCounts as $tagName => $hits ) {
751 // Only get active tags
752 isset( $explicitlyDefinedTags[ $tagName ] ) ||
753 isset( $softwareActivatedTags[ $tagName ] )
756 $desc = ChangeTags
::tagLongDescriptionMessage( $tagName, $context );
760 'label' => Sanitizer
::stripAllTags(
761 ChangeTags
::tagDescription( $tagName, $context )
763 'description' => $desc ? Sanitizer
::stripAllTags( $desc->parse() ) : '',
764 'cssClass' => Sanitizer
::escapeClass( 'mw-tag-' . $tagName ),
770 // Instead of sorting by hit count (disabled, see above), sort by display name
771 usort( $result, function ( $a, $b ) {
772 return strcasecmp( $a['label'], $b['label'] );
784 * Add the "no results" message to the output
786 protected function outputNoResults() {
787 $this->getOutput()->addHTML(
788 '<div class="mw-changeslist-empty">' .
789 $this->msg( 'recentchanges-noresult' )->parse() .
795 * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
797 * @return bool|ResultWrapper Result or false
799 public function getRows() {
800 $opts = $this->getOptions();
807 $this->buildQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
809 return $this->doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
813 * Get the current FormOptions for this request
815 * @return FormOptions
817 public function getOptions() {
818 if ( $this->rcOptions
=== null ) {
819 $this->rcOptions
= $this->setup( $this->rcSubpage
);
822 return $this->rcOptions
;
826 * Register all filters and their groups (including those from hooks), plus handle
827 * conflicts and defaults.
829 * You might want to customize these in the same method, in subclasses. You can
830 * call getFilterGroup to access a group, and (on the group) getFilter to access a
831 * filter, then make necessary modfications to the filter or group (e.g. with
834 protected function registerFilters() {
835 $this->registerFiltersFromDefinitions( $this->filterGroupDefinitions
);
837 // Make sure this is not being transcluded (we don't want to show this
838 // information to all users just because the user that saves the edit can
839 // patrol or is logged in)
840 if ( !$this->including() && $this->getUser()->useRCPatrol() ) {
841 $this->registerFiltersFromDefinitions( $this->reviewStatusFilterGroupDefinition
);
844 $changeTypeGroup = $this->getFilterGroup( 'changeType' );
846 if ( $this->getConfig()->get( 'RCWatchCategoryMembership' ) ) {
847 $transformedHideCategorizationDef = $this->transformFilterDefinition(
848 $this->hideCategorizationFilterDefinition
851 $transformedHideCategorizationDef['group'] = $changeTypeGroup;
853 $hideCategorization = new ChangesListBooleanFilter(
854 $transformedHideCategorizationDef
858 Hooks
::run( 'ChangesListSpecialPageStructuredFilters', [ $this ] );
860 $unstructuredGroupDefinition =
861 $this->getFilterGroupDefinitionFromLegacyCustomFilters(
862 $this->getCustomFilters()
864 $this->registerFiltersFromDefinitions( [ $unstructuredGroupDefinition ] );
866 $userExperienceLevel = $this->getFilterGroup( 'userExpLevel' );
867 $registered = $userExperienceLevel->getFilter( 'registered' );
868 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'newcomer' ) );
869 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'learner' ) );
870 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'experienced' ) );
872 $categoryFilter = $changeTypeGroup->getFilter( 'hidecategorization' );
873 $logactionsFilter = $changeTypeGroup->getFilter( 'hidelog' );
874 $pagecreationFilter = $changeTypeGroup->getFilter( 'hidenewpages' );
876 $significanceTypeGroup = $this->getFilterGroup( 'significance' );
877 $hideMinorFilter = $significanceTypeGroup->getFilter( 'hideminor' );
879 // categoryFilter is conditional; see registerFilters
880 if ( $categoryFilter !== null ) {
881 $hideMinorFilter->conflictsWith(
883 'rcfilters-hideminor-conflicts-typeofchange-global',
884 'rcfilters-hideminor-conflicts-typeofchange',
885 'rcfilters-typeofchange-conflicts-hideminor'
888 $hideMinorFilter->conflictsWith(
890 'rcfilters-hideminor-conflicts-typeofchange-global',
891 'rcfilters-hideminor-conflicts-typeofchange',
892 'rcfilters-typeofchange-conflicts-hideminor'
894 $hideMinorFilter->conflictsWith(
896 'rcfilters-hideminor-conflicts-typeofchange-global',
897 'rcfilters-hideminor-conflicts-typeofchange',
898 'rcfilters-typeofchange-conflicts-hideminor'
903 * Transforms filter definition to prepare it for constructor.
905 * See overrides of this method as well.
907 * @param array $filterDefinition Original filter definition
909 * @return array Transformed definition
911 protected function transformFilterDefinition( array $filterDefinition ) {
912 return $filterDefinition;
916 * Register filters from a definition object
918 * Array specifying groups and their filters; see Filter and
919 * ChangesListFilterGroup constructors.
921 * There is light processing to simplify core maintenance.
922 * @param array $definition
924 protected function registerFiltersFromDefinitions( array $definition ) {
925 $autoFillPriority = -1;
926 foreach ( $definition as $groupDefinition ) {
927 if ( !isset( $groupDefinition['priority'] ) ) {
928 $groupDefinition['priority'] = $autoFillPriority;
930 // If it's explicitly specified, start over the auto-fill
931 $autoFillPriority = $groupDefinition['priority'];
936 $className = $groupDefinition['class'];
937 unset( $groupDefinition['class'] );
939 foreach ( $groupDefinition['filters'] as &$filterDefinition ) {
940 $filterDefinition = $this->transformFilterDefinition( $filterDefinition );
943 $this->registerFilterGroup( new $className( $groupDefinition ) );
948 * Get filter group definition from legacy custom filters
950 * @param array $customFilters Custom filters from legacy hooks
951 * @return array Group definition
953 protected function getFilterGroupDefinitionFromLegacyCustomFilters( array $customFilters ) {
954 // Special internal unstructured group
955 $unstructuredGroupDefinition = [
956 'name' => 'unstructured',
957 'class' => ChangesListBooleanFilterGroup
::class,
958 'priority' => -1, // Won't display in structured
962 foreach ( $customFilters as $name => $params ) {
963 $unstructuredGroupDefinition['filters'][] = [
965 'showHide' => $params['msg'],
966 'default' => $params['default'],
970 return $unstructuredGroupDefinition;
974 * @return array The legacy show/hide toggle filters
976 protected function getLegacyShowHideFilters() {
978 foreach ( $this->filterGroups
as $group ) {
979 if ( $group instanceof ChangesListBooleanFilterGroup
) {
980 foreach ( $group->getFilters() as $key => $filter ) {
981 if ( $filter->displaysOnUnstructuredUi( $this ) ) {
982 $filters[ $key ] = $filter;
991 * Register all the filters, including legacy hook-driven ones.
992 * Then create a FormOptions object with options as specified by the user
994 * @param array $parameters
996 * @return FormOptions
998 public function setup( $parameters ) {
999 $this->registerFilters();
1001 $opts = $this->getDefaultOptions();
1003 $opts = $this->fetchOptionsFromRequest( $opts );
1005 // Give precedence to subpage syntax
1006 if ( $parameters !== null ) {
1007 $this->parseParameters( $parameters, $opts );
1010 $this->validateOptions( $opts );
1016 * Get a FormOptions object containing the default options. By default, returns
1017 * some basic options. The filters listed explicitly here are overriden in this
1018 * method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters,
1019 * and more) are structured. Structured filters are overriden in registerFilters.
1022 * @return FormOptions
1024 public function getDefaultOptions() {
1025 $opts = new FormOptions();
1026 $structuredUI = $this->isStructuredFilterUiEnabled();
1027 // If urlversion=2 is set, ignore the filter defaults and set them all to false/empty
1028 $useDefaults = $this->getRequest()->getInt( 'urlversion' ) !== 2;
1030 /** @var ChangesListFilterGroup $filterGroup */
1031 foreach ( $this->filterGroups
as $filterGroup ) {
1032 $filterGroup->addOptions( $opts, $useDefaults, $structuredUI );
1035 $opts->add( 'namespace', '', FormOptions
::STRING );
1036 $opts->add( 'invert', false );
1037 $opts->add( 'associated', false );
1038 $opts->add( 'urlversion', 1 );
1039 $opts->add( 'tagfilter', '' );
1041 $opts->add( 'days', $this->getDefaultDays(), FormOptions
::FLOAT );
1042 $opts->add( 'limit', $this->getDefaultLimit(), FormOptions
::INT );
1044 $opts->add( 'from', '' );
1050 * Register a structured changes list filter group
1052 * @param ChangesListFilterGroup $group
1054 public function registerFilterGroup( ChangesListFilterGroup
$group ) {
1055 $groupName = $group->getName();
1057 $this->filterGroups
[$groupName] = $group;
1061 * Gets the currently registered filters groups
1063 * @return array Associative array of ChangesListFilterGroup objects, with group name as key
1065 protected function getFilterGroups() {
1066 return $this->filterGroups
;
1070 * Gets a specified ChangesListFilterGroup by name
1072 * @param string $groupName Name of group
1074 * @return ChangesListFilterGroup|null Group, or null if not registered
1076 public function getFilterGroup( $groupName ) {
1077 return isset( $this->filterGroups
[$groupName] ) ?
1078 $this->filterGroups
[$groupName] :
1082 // Currently, this intentionally only includes filters that display
1083 // in the structured UI. This can be changed easily, though, if we want
1084 // to include data on filters that use the unstructured UI. messageKeys is a
1085 // special top-level value, with the value being an array of the message keys to
1086 // send to the client.
1088 * Gets structured filter information needed by JS
1090 * @return array Associative array
1091 * * array $return['groups'] Group data
1092 * * array $return['messageKeys'] Array of message keys
1094 public function getStructuredFilterJsData() {
1097 'messageKeys' => [],
1100 usort( $this->filterGroups
, function ( $a, $b ) {
1101 return $b->getPriority() - $a->getPriority();
1104 foreach ( $this->filterGroups
as $groupName => $group ) {
1105 $groupOutput = $group->getJsData( $this );
1106 if ( $groupOutput !== null ) {
1107 $output['messageKeys'] = array_merge(
1108 $output['messageKeys'],
1109 $groupOutput['messageKeys']
1112 unset( $groupOutput['messageKeys'] );
1113 $output['groups'][] = $groupOutput;
1121 * Get custom show/hide filters using deprecated ChangesListSpecialPageFilters
1124 * @return array Map of filter URL param names to properties (msg/default)
1126 protected function getCustomFilters() {
1127 if ( $this->customFilters
=== null ) {
1128 $this->customFilters
= [];
1129 Hooks
::run( 'ChangesListSpecialPageFilters', [ $this, &$this->customFilters
], '1.29' );
1132 return $this->customFilters
;
1136 * Fetch values for a FormOptions object from the WebRequest associated with this instance.
1138 * Intended for subclassing, e.g. to add a backwards-compatibility layer.
1140 * @param FormOptions $opts
1141 * @return FormOptions
1143 protected function fetchOptionsFromRequest( $opts ) {
1144 $opts->fetchValuesFromRequest( $this->getRequest() );
1150 * Process $par and put options found in $opts. Used when including the page.
1152 * @param string $par
1153 * @param FormOptions $opts
1155 public function parseParameters( $par, FormOptions
$opts ) {
1156 $stringParameterNameSet = [];
1157 $hideParameterNameSet = [];
1159 // URL parameters can be per-group, like 'userExpLevel',
1160 // or per-filter, like 'hideminor'.
1162 foreach ( $this->filterGroups
as $filterGroup ) {
1163 if ( $filterGroup instanceof ChangesListStringOptionsFilterGroup
) {
1164 $stringParameterNameSet[$filterGroup->getName()] = true;
1165 } elseif ( $filterGroup instanceof ChangesListBooleanFilterGroup
) {
1166 foreach ( $filterGroup->getFilters() as $filter ) {
1167 $hideParameterNameSet[$filter->getName()] = true;
1172 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
1173 foreach ( $bits as $bit ) {
1175 if ( isset( $hideParameterNameSet[$bit] ) ) {
1176 // hidefoo => hidefoo=true
1178 } elseif ( isset( $hideParameterNameSet["hide$bit"] ) ) {
1179 // foo => hidefoo=false
1180 $opts["hide$bit"] = false;
1181 } elseif ( preg_match( '/^(.*)=(.*)$/', $bit, $m ) ) {
1182 if ( isset( $stringParameterNameSet[$m[1]] ) ) {
1183 $opts[$m[1]] = $m[2];
1190 * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
1192 * @param FormOptions $opts
1194 public function validateOptions( FormOptions
$opts ) {
1195 $isContradictory = $this->fixContradictoryOptions( $opts );
1196 $isReplaced = $this->replaceOldOptions( $opts );
1198 if ( $isContradictory ||
$isReplaced ) {
1199 $query = wfArrayToCgi( $this->convertParamsForLink( $opts->getChangedValues() ) );
1200 $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
1203 $opts->validateIntBounds( 'limit', 0, 5000 );
1204 $opts->validateBounds( 'days', 0, $this->getConfig()->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
1208 * Fix invalid options by resetting pairs that should never appear together.
1210 * @param FormOptions $opts
1211 * @return bool True if any option was reset
1213 private function fixContradictoryOptions( FormOptions
$opts ) {
1214 $fixed = $this->fixBackwardsCompatibilityOptions( $opts );
1216 foreach ( $this->filterGroups
as $filterGroup ) {
1217 if ( $filterGroup instanceof ChangesListBooleanFilterGroup
) {
1218 $filters = $filterGroup->getFilters();
1220 if ( count( $filters ) === 1 ) {
1221 // legacy boolean filters should not be considered
1225 $allInGroupEnabled = array_reduce(
1227 function ( $carry, $filter ) use ( $opts ) {
1228 return $carry && $opts[ $filter->getName() ];
1230 /* initialValue */ count( $filters ) > 0
1233 if ( $allInGroupEnabled ) {
1234 foreach ( $filters as $filter ) {
1235 $opts[ $filter->getName() ] = false;
1247 * Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards
1250 * This is deprecated and may be removed.
1252 * @param FormOptions $opts
1253 * @return bool True if this change was mode
1255 private function fixBackwardsCompatibilityOptions( FormOptions
$opts ) {
1256 if ( $opts['hideanons'] && $opts['hideliu'] ) {
1257 $opts->reset( 'hideanons' );
1258 if ( !$opts['hidebots'] ) {
1259 $opts->reset( 'hideliu' );
1260 $opts['hidehumans'] = 1;
1270 * Replace old options 'hideanons' or 'hideliu' with structured UI equivalent
1272 * @param FormOptions $opts
1273 * @return bool True if the change was made
1275 public function replaceOldOptions( FormOptions
$opts ) {
1276 if ( !$this->isStructuredFilterUiEnabled() ) {
1280 // At this point 'hideanons' and 'hideliu' cannot be both true,
1281 // because fixBackwardsCompatibilityOptions resets (at least) 'hideanons' in such case
1282 if ( $opts[ 'hideanons' ] ) {
1283 $opts->reset( 'hideanons' );
1284 $opts[ 'userExpLevel' ] = 'registered';
1288 if ( $opts[ 'hideliu' ] ) {
1289 $opts->reset( 'hideliu' );
1290 $opts[ 'userExpLevel' ] = 'unregistered';
1298 * Convert parameters values from true/false to 1/0
1299 * so they are not omitted by wfArrayToCgi()
1302 * @param array $params
1305 protected function convertParamsForLink( $params ) {
1306 foreach ( $params as &$value ) {
1307 if ( $value === false ) {
1316 * Sets appropriate tables, fields, conditions, etc. depending on which filters
1317 * the user requested.
1319 * @param array &$tables Array of tables; see IDatabase::select $table
1320 * @param array &$fields Array of fields; see IDatabase::select $vars
1321 * @param array &$conds Array of conditions; see IDatabase::select $conds
1322 * @param array &$query_options Array of query options; see IDatabase::select $options
1323 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1324 * @param FormOptions $opts
1326 protected function buildQuery( &$tables, &$fields, &$conds, &$query_options,
1327 &$join_conds, FormOptions
$opts
1329 $dbr = $this->getDB();
1330 $isStructuredUI = $this->isStructuredFilterUiEnabled();
1332 /** @var ChangesListFilterGroup $filterGroup */
1333 foreach ( $this->filterGroups
as $filterGroup ) {
1334 $filterGroup->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1335 $query_options, $join_conds, $opts, $isStructuredUI );
1338 // Namespace filtering
1339 if ( $opts[ 'namespace' ] !== '' ) {
1340 $namespaces = explode( ';', $opts[ 'namespace' ] );
1342 if ( $opts[ 'associated' ] ) {
1343 $associatedNamespaces = array_map(
1345 return MWNamespace
::getAssociated( $ns );
1349 $namespaces = array_unique( array_merge( $namespaces, $associatedNamespaces ) );
1352 if ( count( $namespaces ) === 1 ) {
1353 $operator = $opts[ 'invert' ] ?
'!=' : '=';
1354 $value = $dbr->addQuotes( reset( $namespaces ) );
1356 $operator = $opts[ 'invert' ] ?
'NOT IN' : 'IN';
1357 sort( $namespaces );
1358 $value = '(' . $dbr->makeList( $namespaces ) . ')';
1360 $conds[] = "rc_namespace $operator $value";
1364 $cutoff_unixtime = time() - $opts['days'] * 3600 * 24;
1365 $cutoff = $dbr->timestamp( $cutoff_unixtime );
1367 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
1368 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW
, $cutoff ) ) {
1369 $cutoff = $dbr->timestamp( $opts['from'] );
1371 $opts->reset( 'from' );
1374 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
1380 * @param array $tables Array of tables; see IDatabase::select $table
1381 * @param array $fields Array of fields; see IDatabase::select $vars
1382 * @param array $conds Array of conditions; see IDatabase::select $conds
1383 * @param array $query_options Array of query options; see IDatabase::select $options
1384 * @param array $join_conds Array of join conditions; see IDatabase::select $join_conds
1385 * @param FormOptions $opts
1386 * @return bool|ResultWrapper Result or false
1388 protected function doMainQuery( $tables, $fields, $conds,
1389 $query_options, $join_conds, FormOptions
$opts
1391 $tables[] = 'recentchanges';
1392 $fields = array_merge( RecentChange
::selectFields(), $fields );
1394 ChangeTags
::modifyDisplayQuery(
1403 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
1409 $dbr = $this->getDB();
1411 return $dbr->select(
1421 protected function runMainQueryHook( &$tables, &$fields, &$conds,
1422 &$query_options, &$join_conds, $opts
1425 'ChangesListSpecialPageQuery',
1426 [ $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ]
1431 * Return a IDatabase object for reading
1435 protected function getDB() {
1436 return wfGetDB( DB_REPLICA
);
1440 * Send output to the OutputPage object, only called if not used feeds
1442 * @param ResultWrapper $rows Database rows
1443 * @param FormOptions $opts
1445 public function webOutput( $rows, $opts ) {
1446 if ( !$this->including() ) {
1447 $this->outputFeedLinks();
1448 $this->doHeader( $opts, $rows->numRows() );
1451 $this->outputChangesList( $rows, $opts );
1455 * Output feed links.
1457 public function outputFeedLinks() {
1458 // nothing by default
1462 * Build and output the actual changes list.
1464 * @param ResultWrapper $rows Database rows
1465 * @param FormOptions $opts
1467 abstract public function outputChangesList( $rows, $opts );
1470 * Set the text to be displayed above the changes
1472 * @param FormOptions $opts
1473 * @param int $numRows Number of rows in the result to show after this header
1475 public function doHeader( $opts, $numRows ) {
1476 $this->setTopText( $opts );
1478 // @todo Lots of stuff should be done here.
1480 $this->setBottomText( $opts );
1484 * Send the text to be displayed before the options. Should use $this->getOutput()->addWikiText()
1485 * or similar methods to print the text.
1487 * @param FormOptions $opts
1489 public function setTopText( FormOptions
$opts ) {
1490 // nothing by default
1494 * Send the text to be displayed after the options. Should use $this->getOutput()->addWikiText()
1495 * or similar methods to print the text.
1497 * @param FormOptions $opts
1499 public function setBottomText( FormOptions
$opts ) {
1500 // nothing by default
1504 * Get options to be displayed in a form
1505 * @todo This should handle options returned by getDefaultOptions().
1506 * @todo Not called by anything in this class (but is in subclasses), should be
1507 * called by something… doHeader() maybe?
1509 * @param FormOptions $opts
1512 public function getExtraOptions( $opts ) {
1517 * Return the legend displayed within the fieldset
1521 public function makeLegend() {
1522 $context = $this->getContext();
1523 $user = $context->getUser();
1524 # The legend showing what the letters and stuff mean
1525 $legend = Html
::openElement( 'dl' ) . "\n";
1526 # Iterates through them and gets the messages for both letter and tooltip
1527 $legendItems = $context->getConfig()->get( 'RecentChangesFlags' );
1528 if ( !( $user->useRCPatrol() ||
$user->useNPPatrol() ) ) {
1529 unset( $legendItems['unpatrolled'] );
1531 foreach ( $legendItems as $key => $item ) { # generate items of the legend
1532 $label = isset( $item['legend'] ) ?
$item['legend'] : $item['title'];
1533 $letter = $item['letter'];
1534 $cssClass = isset( $item['class'] ) ?
$item['class'] : $key;
1536 $legend .= Html
::element( 'dt',
1537 [ 'class' => $cssClass ], $context->msg( $letter )->text()
1539 Html
::rawElement( 'dd',
1540 [ 'class' => Sanitizer
::escapeClass( 'mw-changeslist-legend-' . $key ) ],
1541 $context->msg( $label )->parse()
1545 $legend .= Html
::rawElement( 'dt',
1546 [ 'class' => 'mw-plusminus-pos' ],
1547 $context->msg( 'recentchanges-legend-plusminus' )->parse()
1549 $legend .= Html
::element(
1551 [ 'class' => 'mw-changeslist-legend-plusminus' ],
1552 $context->msg( 'recentchanges-label-plusminus' )->text()
1554 $legend .= Html
::closeElement( 'dl' ) . "\n";
1556 $legendHeading = $this->isStructuredFilterUiEnabled() ?
1557 $context->msg( 'rcfilters-legend-heading' )->parse() :
1558 $context->msg( 'recentchanges-legend-heading' )->parse();
1561 $collapsedState = $this->getRequest()->getCookie( 'changeslist-state' );
1562 $collapsedClass = $collapsedState === 'collapsed' ?
' mw-collapsed' : '';
1564 '<div class="mw-changeslist-legend mw-collapsible' . $collapsedClass . '">' .
1566 '<div class="mw-collapsible-content">' . $legend . '</div>' .
1573 * Add page-specific modules.
1575 protected function addModules() {
1576 $out = $this->getOutput();
1577 // Styles and behavior for the legend box (see makeLegend())
1578 $out->addModuleStyles( [
1579 'mediawiki.special.changeslist.legend',
1580 'mediawiki.special.changeslist',
1582 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
1584 if ( $this->isStructuredFilterUiEnabled() ) {
1585 $out->addModules( 'mediawiki.rcfilters.filters.ui' );
1586 $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
1590 protected function getGroupName() {
1595 * Filter on users' experience levels; this will not be called if nothing is
1598 * @param string $specialPageClassName Class name of current special page
1599 * @param IContextSource $context Context, for e.g. user
1600 * @param IDatabase $dbr Database, for addQuotes, makeList, and similar
1601 * @param array &$tables Array of tables; see IDatabase::select $table
1602 * @param array &$fields Array of fields; see IDatabase::select $vars
1603 * @param array &$conds Array of conditions; see IDatabase::select $conds
1604 * @param array &$query_options Array of query options; see IDatabase::select $options
1605 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1606 * @param array $selectedExpLevels The allowed active values, sorted
1607 * @param int $now Number of seconds since the UNIX epoch, or 0 if not given
1610 public function filterOnUserExperienceLevel( $specialPageClassName, $context, $dbr,
1611 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now = 0
1613 global $wgLearnerEdits,
1614 $wgExperiencedUserEdits,
1615 $wgLearnerMemberSince,
1616 $wgExperiencedUserMemberSince;
1620 // If all levels are selected, don't filter
1621 if ( count( $selectedExpLevels ) === $LEVEL_COUNT ) {
1625 // both 'registered' and 'unregistered', experience levels, if any, are included in 'registered'
1627 in_array( 'registered', $selectedExpLevels ) &&
1628 in_array( 'unregistered', $selectedExpLevels )
1633 // 'registered' but not 'unregistered', experience levels, if any, are included in 'registered'
1635 in_array( 'registered', $selectedExpLevels ) &&
1636 !in_array( 'unregistered', $selectedExpLevels )
1638 $conds[] = 'rc_user != 0';
1642 if ( $selectedExpLevels === [ 'unregistered' ] ) {
1643 $conds[] = 'rc_user = 0';
1648 $join_conds['user'] = [ 'LEFT JOIN', 'rc_user = user_id' ];
1653 $secondsPerDay = 86400;
1654 $learnerCutoff = $now - $wgLearnerMemberSince * $secondsPerDay;
1655 $experiencedUserCutoff = $now - $wgExperiencedUserMemberSince * $secondsPerDay;
1657 $aboveNewcomer = $dbr->makeList(
1659 'user_editcount >= ' . intval( $wgLearnerEdits ),
1660 'user_registration <= ' . $dbr->addQuotes( $dbr->timestamp( $learnerCutoff ) ),
1665 $aboveLearner = $dbr->makeList(
1667 'user_editcount >= ' . intval( $wgExperiencedUserEdits ),
1668 'user_registration <= ' .
1669 $dbr->addQuotes( $dbr->timestamp( $experiencedUserCutoff ) ),
1676 if ( in_array( 'unregistered', $selectedExpLevels ) ) {
1677 $selectedExpLevels = array_diff( $selectedExpLevels, [ 'unregistered' ] );
1678 $conditions[] = 'rc_user = 0';
1681 if ( $selectedExpLevels === [ 'newcomer' ] ) {
1682 $conditions[] = "NOT ( $aboveNewcomer )";
1683 } elseif ( $selectedExpLevels === [ 'learner' ] ) {
1684 $conditions[] = $dbr->makeList(
1685 [ $aboveNewcomer, "NOT ( $aboveLearner )" ],
1688 } elseif ( $selectedExpLevels === [ 'experienced' ] ) {
1689 $conditions[] = $aboveLearner;
1690 } elseif ( $selectedExpLevels === [ 'learner', 'newcomer' ] ) {
1691 $conditions[] = "NOT ( $aboveLearner )";
1692 } elseif ( $selectedExpLevels === [ 'experienced', 'newcomer' ] ) {
1693 $conditions[] = $dbr->makeList(
1694 [ "NOT ( $aboveNewcomer )", $aboveLearner ],
1697 } elseif ( $selectedExpLevels === [ 'experienced', 'learner' ] ) {
1698 $conditions[] = $aboveNewcomer;
1699 } elseif ( $selectedExpLevels === [ 'experienced', 'learner', 'newcomer' ] ) {
1700 $conditions[] = 'rc_user != 0';
1703 if ( count( $conditions ) > 1 ) {
1704 $conds[] = $dbr->makeList( $conditions, IDatabase
::LIST_OR
);
1705 } elseif ( count( $conditions ) === 1 ) {
1706 $conds[] = reset( $conditions );
1711 * Check whether the structured filter UI is enabled
1715 public function isStructuredFilterUiEnabled() {
1716 if ( $this->getRequest()->getBool( 'rcfilters' ) ) {
1720 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1721 return !$this->getUser()->getOption( 'rcenhancedfilters-disable' );
1723 return $this->getUser()->getOption( 'rcenhancedfilters' );
1728 * Check whether the structured filter UI is enabled by default (regardless of
1729 * this particular user's setting)
1733 public function isStructuredFilterUiEnabledByDefault() {
1734 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1735 return !$this->getUser()->getDefaultOption( 'rcenhancedfilters-disable' );
1737 return $this->getUser()->getDefaultOption( 'rcenhancedfilters' );
1741 abstract function getDefaultLimit();
1744 * Get the default value of the number of days to display when loading
1746 * Supports fractional values, and should be cast to a float.
1750 abstract function getDefaultDays();