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