Merge "Sanity check "stashedtexthash" param before checking memcached"
[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 : 304;
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 'wgStructuredChangeFiltersEnableLiveUpdate',
607 $this->getConfig()->get( 'StructuredChangeFiltersEnableLiveUpdate' )
608 );
609 $out->addJsConfigVars(
610 'wgRCFiltersChangeTags',
611 $this->buildChangeTagList()
612 );
613 $out->addJsConfigVars(
614 'StructuredChangeFiltersDisplayConfig',
615 [
616 'maxDays' => (int)$this->getConfig()->get( 'RCMaxAge' ) / ( 24 * 3600 ), // Translate to days
617 'limitArray' => $this->getConfig()->get( 'RCLinkLimits' ),
618 'limitDefault' => $this->getDefaultLimit(),
619 'daysArray' => $this->getConfig()->get( 'RCLinkDays' ),
620 'daysDefault' => $this->getDefaultDays(),
621 ]
622 );
623 } else {
624 $out->addBodyClasses( 'mw-rcfilters-disabled' );
625 }
626 }
627
628 /**
629 * Fetch the change tags list for the front end
630 *
631 * @return Array Tag data
632 */
633 protected function buildChangeTagList() {
634 $explicitlyDefinedTags = array_fill_keys( ChangeTags::listExplicitlyDefinedTags(), 0 );
635 $softwareActivatedTags = array_fill_keys( ChangeTags::listSoftwareActivatedTags(), 0 );
636
637 // Hit counts disabled for perf reasons, see T169997
638 /*
639 $tagStats = ChangeTags::tagUsageStatistics();
640 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
641
642 // Sort by hits
643 arsort( $tagHitCounts );
644 */
645 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags );
646
647 // Build the list and data
648 $result = [];
649 foreach ( $tagHitCounts as $tagName => $hits ) {
650 if (
651 // Only get active tags
652 isset( $explicitlyDefinedTags[ $tagName ] ) ||
653 isset( $softwareActivatedTags[ $tagName ] )
654 ) {
655 // Parse description
656 $desc = ChangeTags::tagLongDescriptionMessage( $tagName, $this->getContext() );
657
658 $result[] = [
659 'name' => $tagName,
660 'label' => Sanitizer::stripAllTags(
661 ChangeTags::tagDescription( $tagName, $this->getContext() )
662 ),
663 'description' => $desc ? Sanitizer::stripAllTags( $desc->parse() ) : '',
664 'cssClass' => Sanitizer::escapeClass( 'mw-tag-' . $tagName ),
665 'hits' => $hits,
666 ];
667 }
668 }
669
670 // Instead of sorting by hit count (disabled, see above), sort by display name
671 usort( $result, function ( $a, $b ) {
672 return strcasecmp( $a['label'], $b['label'] );
673 } );
674
675 return $result;
676 }
677
678 /**
679 * Add the "no results" message to the output
680 */
681 protected function outputNoResults() {
682 $this->getOutput()->addHTML(
683 '<div class="mw-changeslist-empty">' .
684 $this->msg( 'recentchanges-noresult' )->parse() .
685 '</div>'
686 );
687 }
688
689 /**
690 * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
691 *
692 * @return bool|ResultWrapper Result or false
693 */
694 public function getRows() {
695 $opts = $this->getOptions();
696
697 $tables = [];
698 $fields = [];
699 $conds = [];
700 $query_options = [];
701 $join_conds = [];
702 $this->buildQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
703
704 return $this->doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
705 }
706
707 /**
708 * Get the current FormOptions for this request
709 *
710 * @return FormOptions
711 */
712 public function getOptions() {
713 if ( $this->rcOptions === null ) {
714 $this->rcOptions = $this->setup( $this->rcSubpage );
715 }
716
717 return $this->rcOptions;
718 }
719
720 /**
721 * Register all filters and their groups (including those from hooks), plus handle
722 * conflicts and defaults.
723 *
724 * You might want to customize these in the same method, in subclasses. You can
725 * call getFilterGroup to access a group, and (on the group) getFilter to access a
726 * filter, then make necessary modfications to the filter or group (e.g. with
727 * setDefault).
728 */
729 protected function registerFilters() {
730 $this->registerFiltersFromDefinitions( $this->filterGroupDefinitions );
731
732 // Make sure this is not being transcluded (we don't want to show this
733 // information to all users just because the user that saves the edit can
734 // patrol or is logged in)
735 if ( !$this->including() && $this->getUser()->useRCPatrol() ) {
736 $this->registerFiltersFromDefinitions( $this->reviewStatusFilterGroupDefinition );
737 }
738
739 $changeTypeGroup = $this->getFilterGroup( 'changeType' );
740
741 if ( $this->getConfig()->get( 'RCWatchCategoryMembership' ) ) {
742 $transformedHideCategorizationDef = $this->transformFilterDefinition(
743 $this->hideCategorizationFilterDefinition
744 );
745
746 $transformedHideCategorizationDef['group'] = $changeTypeGroup;
747
748 $hideCategorization = new ChangesListBooleanFilter(
749 $transformedHideCategorizationDef
750 );
751 }
752
753 Hooks::run( 'ChangesListSpecialPageStructuredFilters', [ $this ] );
754
755 $unstructuredGroupDefinition =
756 $this->getFilterGroupDefinitionFromLegacyCustomFilters(
757 $this->getCustomFilters()
758 );
759 $this->registerFiltersFromDefinitions( [ $unstructuredGroupDefinition ] );
760
761 $userExperienceLevel = $this->getFilterGroup( 'userExpLevel' );
762 $registered = $userExperienceLevel->getFilter( 'registered' );
763 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'newcomer' ) );
764 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'learner' ) );
765 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'experienced' ) );
766
767 $categoryFilter = $changeTypeGroup->getFilter( 'hidecategorization' );
768 $logactionsFilter = $changeTypeGroup->getFilter( 'hidelog' );
769 $pagecreationFilter = $changeTypeGroup->getFilter( 'hidenewpages' );
770
771 $significanceTypeGroup = $this->getFilterGroup( 'significance' );
772 $hideMinorFilter = $significanceTypeGroup->getFilter( 'hideminor' );
773
774 // categoryFilter is conditional; see registerFilters
775 if ( $categoryFilter !== null ) {
776 $hideMinorFilter->conflictsWith(
777 $categoryFilter,
778 'rcfilters-hideminor-conflicts-typeofchange-global',
779 'rcfilters-hideminor-conflicts-typeofchange',
780 'rcfilters-typeofchange-conflicts-hideminor'
781 );
782 }
783 $hideMinorFilter->conflictsWith(
784 $logactionsFilter,
785 'rcfilters-hideminor-conflicts-typeofchange-global',
786 'rcfilters-hideminor-conflicts-typeofchange',
787 'rcfilters-typeofchange-conflicts-hideminor'
788 );
789 $hideMinorFilter->conflictsWith(
790 $pagecreationFilter,
791 'rcfilters-hideminor-conflicts-typeofchange-global',
792 'rcfilters-hideminor-conflicts-typeofchange',
793 'rcfilters-typeofchange-conflicts-hideminor'
794 );
795 }
796
797 /**
798 * Transforms filter definition to prepare it for constructor.
799 *
800 * See overrides of this method as well.
801 *
802 * @param array $filterDefinition Original filter definition
803 *
804 * @return array Transformed definition
805 */
806 protected function transformFilterDefinition( array $filterDefinition ) {
807 return $filterDefinition;
808 }
809
810 /**
811 * Register filters from a definition object
812 *
813 * Array specifying groups and their filters; see Filter and
814 * ChangesListFilterGroup constructors.
815 *
816 * There is light processing to simplify core maintenance.
817 * @param array $definition
818 */
819 protected function registerFiltersFromDefinitions( array $definition ) {
820 $autoFillPriority = -1;
821 foreach ( $definition as $groupDefinition ) {
822 if ( !isset( $groupDefinition['priority'] ) ) {
823 $groupDefinition['priority'] = $autoFillPriority;
824 } else {
825 // If it's explicitly specified, start over the auto-fill
826 $autoFillPriority = $groupDefinition['priority'];
827 }
828
829 $autoFillPriority--;
830
831 $className = $groupDefinition['class'];
832 unset( $groupDefinition['class'] );
833
834 foreach ( $groupDefinition['filters'] as &$filterDefinition ) {
835 $filterDefinition = $this->transformFilterDefinition( $filterDefinition );
836 }
837
838 $this->registerFilterGroup( new $className( $groupDefinition ) );
839 }
840 }
841
842 /**
843 * Get filter group definition from legacy custom filters
844 *
845 * @param array $customFilters Custom filters from legacy hooks
846 * @return array Group definition
847 */
848 protected function getFilterGroupDefinitionFromLegacyCustomFilters( array $customFilters ) {
849 // Special internal unstructured group
850 $unstructuredGroupDefinition = [
851 'name' => 'unstructured',
852 'class' => ChangesListBooleanFilterGroup::class,
853 'priority' => -1, // Won't display in structured
854 'filters' => [],
855 ];
856
857 foreach ( $customFilters as $name => $params ) {
858 $unstructuredGroupDefinition['filters'][] = [
859 'name' => $name,
860 'showHide' => $params['msg'],
861 'default' => $params['default'],
862 ];
863 }
864
865 return $unstructuredGroupDefinition;
866 }
867
868 /**
869 * Register all the filters, including legacy hook-driven ones.
870 * Then create a FormOptions object with options as specified by the user
871 *
872 * @param array $parameters
873 *
874 * @return FormOptions
875 */
876 public function setup( $parameters ) {
877 $this->registerFilters();
878
879 $opts = $this->getDefaultOptions();
880
881 $opts = $this->fetchOptionsFromRequest( $opts );
882
883 // Give precedence to subpage syntax
884 if ( $parameters !== null ) {
885 $this->parseParameters( $parameters, $opts );
886 }
887
888 $this->validateOptions( $opts );
889
890 return $opts;
891 }
892
893 /**
894 * Get a FormOptions object containing the default options. By default, returns
895 * some basic options. The filters listed explicitly here are overriden in this
896 * method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters,
897 * and more) are structured. Structured filters are overriden in registerFilters.
898 * not here.
899 *
900 * @return FormOptions
901 */
902 public function getDefaultOptions() {
903 $opts = new FormOptions();
904 $structuredUI = $this->isStructuredFilterUiEnabled();
905 // If urlversion=2 is set, ignore the filter defaults and set them all to false/empty
906 $useDefaults = $this->getRequest()->getInt( 'urlversion' ) !== 2;
907
908 // Add all filters
909 /** @var ChangesListFilterGroup $filterGroup */
910 foreach ( $this->filterGroups as $filterGroup ) {
911 // URL parameters can be per-group, like 'userExpLevel',
912 // or per-filter, like 'hideminor'.
913 if ( $filterGroup->isPerGroupRequestParameter() ) {
914 $opts->add( $filterGroup->getName(), $useDefaults ? $filterGroup->getDefault() : '' );
915 } else {
916 /** @var ChangesListBooleanFilter $filter */
917 foreach ( $filterGroup->getFilters() as $filter ) {
918 $opts->add( $filter->getName(), $useDefaults ? $filter->getDefault( $structuredUI ) : false );
919 }
920 }
921 }
922
923 $opts->add( 'namespace', '', FormOptions::STRING );
924 $opts->add( 'invert', false );
925 $opts->add( 'associated', false );
926 $opts->add( 'urlversion', 1 );
927 $opts->add( 'tagfilter', '' );
928
929 return $opts;
930 }
931
932 /**
933 * Register a structured changes list filter group
934 *
935 * @param ChangesListFilterGroup $group
936 */
937 public function registerFilterGroup( ChangesListFilterGroup $group ) {
938 $groupName = $group->getName();
939
940 $this->filterGroups[$groupName] = $group;
941 }
942
943 /**
944 * Gets the currently registered filters groups
945 *
946 * @return array Associative array of ChangesListFilterGroup objects, with group name as key
947 */
948 protected function getFilterGroups() {
949 return $this->filterGroups;
950 }
951
952 /**
953 * Gets a specified ChangesListFilterGroup by name
954 *
955 * @param string $groupName Name of group
956 *
957 * @return ChangesListFilterGroup|null Group, or null if not registered
958 */
959 public function getFilterGroup( $groupName ) {
960 return isset( $this->filterGroups[$groupName] ) ?
961 $this->filterGroups[$groupName] :
962 null;
963 }
964
965 // Currently, this intentionally only includes filters that display
966 // in the structured UI. This can be changed easily, though, if we want
967 // to include data on filters that use the unstructured UI. messageKeys is a
968 // special top-level value, with the value being an array of the message keys to
969 // send to the client.
970 /**
971 * Gets structured filter information needed by JS
972 *
973 * @return array Associative array
974 * * array $return['groups'] Group data
975 * * array $return['messageKeys'] Array of message keys
976 */
977 public function getStructuredFilterJsData() {
978 $output = [
979 'groups' => [],
980 'messageKeys' => [],
981 ];
982
983 usort( $this->filterGroups, function ( $a, $b ) {
984 return $b->getPriority() - $a->getPriority();
985 } );
986
987 foreach ( $this->filterGroups as $groupName => $group ) {
988 $groupOutput = $group->getJsData( $this );
989 if ( $groupOutput !== null ) {
990 $output['messageKeys'] = array_merge(
991 $output['messageKeys'],
992 $groupOutput['messageKeys']
993 );
994
995 unset( $groupOutput['messageKeys'] );
996 $output['groups'][] = $groupOutput;
997 }
998 }
999
1000 return $output;
1001 }
1002
1003 /**
1004 * Get custom show/hide filters using deprecated ChangesListSpecialPageFilters
1005 * hook.
1006 *
1007 * @return array Map of filter URL param names to properties (msg/default)
1008 */
1009 protected function getCustomFilters() {
1010 if ( $this->customFilters === null ) {
1011 $this->customFilters = [];
1012 Hooks::run( 'ChangesListSpecialPageFilters', [ $this, &$this->customFilters ], '1.29' );
1013 }
1014
1015 return $this->customFilters;
1016 }
1017
1018 /**
1019 * Fetch values for a FormOptions object from the WebRequest associated with this instance.
1020 *
1021 * Intended for subclassing, e.g. to add a backwards-compatibility layer.
1022 *
1023 * @param FormOptions $opts
1024 * @return FormOptions
1025 */
1026 protected function fetchOptionsFromRequest( $opts ) {
1027 $opts->fetchValuesFromRequest( $this->getRequest() );
1028
1029 return $opts;
1030 }
1031
1032 /**
1033 * Process $par and put options found in $opts. Used when including the page.
1034 *
1035 * @param string $par
1036 * @param FormOptions $opts
1037 */
1038 public function parseParameters( $par, FormOptions $opts ) {
1039 $stringParameterNameSet = [];
1040 $hideParameterNameSet = [];
1041
1042 // URL parameters can be per-group, like 'userExpLevel',
1043 // or per-filter, like 'hideminor'.
1044
1045 foreach ( $this->filterGroups as $filterGroup ) {
1046 if ( $filterGroup->isPerGroupRequestParameter() ) {
1047 $stringParameterNameSet[$filterGroup->getName()] = true;
1048 } elseif ( $filterGroup->getType() === ChangesListBooleanFilterGroup::TYPE ) {
1049 foreach ( $filterGroup->getFilters() as $filter ) {
1050 $hideParameterNameSet[$filter->getName()] = true;
1051 }
1052 }
1053 }
1054
1055 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
1056 foreach ( $bits as $bit ) {
1057 $m = [];
1058 if ( isset( $hideParameterNameSet[$bit] ) ) {
1059 // hidefoo => hidefoo=true
1060 $opts[$bit] = true;
1061 } elseif ( isset( $hideParameterNameSet["hide$bit"] ) ) {
1062 // foo => hidefoo=false
1063 $opts["hide$bit"] = false;
1064 } elseif ( preg_match( '/^(.*)=(.*)$/', $bit, $m ) ) {
1065 if ( isset( $stringParameterNameSet[$m[1]] ) ) {
1066 $opts[$m[1]] = $m[2];
1067 }
1068 }
1069 }
1070 }
1071
1072 /**
1073 * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
1074 *
1075 * @param FormOptions $opts
1076 */
1077 public function validateOptions( FormOptions $opts ) {
1078 if ( $this->fixContradictoryOptions( $opts ) ) {
1079 $query = wfArrayToCgi( $this->convertParamsForLink( $opts->getChangedValues() ) );
1080 $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
1081 }
1082 }
1083
1084 /**
1085 * Fix invalid options by resetting pairs that should never appear together.
1086 *
1087 * @param FormOptions $opts
1088 * @return bool True if any option was reset
1089 */
1090 private function fixContradictoryOptions( FormOptions $opts ) {
1091 $fixed = $this->fixBackwardsCompatibilityOptions( $opts );
1092
1093 foreach ( $this->filterGroups as $filterGroup ) {
1094 if ( $filterGroup instanceof ChangesListBooleanFilterGroup ) {
1095 $filters = $filterGroup->getFilters();
1096
1097 if ( count( $filters ) === 1 ) {
1098 // legacy boolean filters should not be considered
1099 continue;
1100 }
1101
1102 $allInGroupEnabled = array_reduce(
1103 $filters,
1104 function ( $carry, $filter ) use ( $opts ) {
1105 return $carry && $opts[ $filter->getName() ];
1106 },
1107 /* initialValue */ count( $filters ) > 0
1108 );
1109
1110 if ( $allInGroupEnabled ) {
1111 foreach ( $filters as $filter ) {
1112 $opts[ $filter->getName() ] = false;
1113 }
1114
1115 $fixed = true;
1116 }
1117 }
1118 }
1119
1120 return $fixed;
1121 }
1122
1123 /**
1124 * Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards
1125 * compatibility.
1126 *
1127 * This is deprecated and may be removed.
1128 *
1129 * @param FormOptions $opts
1130 * @return bool True if this change was mode
1131 */
1132 private function fixBackwardsCompatibilityOptions( FormOptions $opts ) {
1133 if ( $opts['hideanons'] && $opts['hideliu'] ) {
1134 $opts->reset( 'hideanons' );
1135 if ( !$opts['hidebots'] ) {
1136 $opts->reset( 'hideliu' );
1137 $opts['hidehumans'] = 1;
1138 }
1139
1140 return true;
1141 }
1142
1143 return false;
1144 }
1145
1146 /**
1147 * Convert parameters values from true/false to 1/0
1148 * so they are not omitted by wfArrayToCgi()
1149 * Bug 36524
1150 *
1151 * @param array $params
1152 * @return array
1153 */
1154 protected function convertParamsForLink( $params ) {
1155 foreach ( $params as &$value ) {
1156 if ( $value === false ) {
1157 $value = '0';
1158 }
1159 }
1160 unset( $value );
1161 return $params;
1162 }
1163
1164 /**
1165 * Sets appropriate tables, fields, conditions, etc. depending on which filters
1166 * the user requested.
1167 *
1168 * @param array &$tables Array of tables; see IDatabase::select $table
1169 * @param array &$fields Array of fields; see IDatabase::select $vars
1170 * @param array &$conds Array of conditions; see IDatabase::select $conds
1171 * @param array &$query_options Array of query options; see IDatabase::select $options
1172 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1173 * @param FormOptions $opts
1174 */
1175 protected function buildQuery( &$tables, &$fields, &$conds, &$query_options,
1176 &$join_conds, FormOptions $opts
1177 ) {
1178 $dbr = $this->getDB();
1179 $isStructuredUI = $this->isStructuredFilterUiEnabled();
1180
1181 foreach ( $this->filterGroups as $filterGroup ) {
1182 // URL parameters can be per-group, like 'userExpLevel',
1183 // or per-filter, like 'hideminor'.
1184 if ( $filterGroup->isPerGroupRequestParameter() ) {
1185 $filterGroup->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1186 $query_options, $join_conds, $opts[$filterGroup->getName()] );
1187 } else {
1188 foreach ( $filterGroup->getFilters() as $filter ) {
1189 if ( $filter->isActive( $opts, $isStructuredUI ) ) {
1190 $filter->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1191 $query_options, $join_conds );
1192 }
1193 }
1194 }
1195 }
1196
1197 // Namespace filtering
1198 if ( $opts[ 'namespace' ] !== '' ) {
1199 $namespaces = explode( ';', $opts[ 'namespace' ] );
1200
1201 if ( $opts[ 'associated' ] ) {
1202 $associatedNamespaces = array_map(
1203 function ( $ns ) {
1204 return MWNamespace::getAssociated( $ns );
1205 },
1206 $namespaces
1207 );
1208 $namespaces = array_unique( array_merge( $namespaces, $associatedNamespaces ) );
1209 }
1210
1211 if ( count( $namespaces ) === 1 ) {
1212 $operator = $opts[ 'invert' ] ? '!=' : '=';
1213 $value = $dbr->addQuotes( reset( $namespaces ) );
1214 } else {
1215 $operator = $opts[ 'invert' ] ? 'NOT IN' : 'IN';
1216 sort( $namespaces );
1217 $value = '(' . $dbr->makeList( $namespaces ) . ')';
1218 }
1219 $conds[] = "rc_namespace $operator $value";
1220 }
1221 }
1222
1223 /**
1224 * Process the query
1225 *
1226 * @param array $tables Array of tables; see IDatabase::select $table
1227 * @param array $fields Array of fields; see IDatabase::select $vars
1228 * @param array $conds Array of conditions; see IDatabase::select $conds
1229 * @param array $query_options Array of query options; see IDatabase::select $options
1230 * @param array $join_conds Array of join conditions; see IDatabase::select $join_conds
1231 * @param FormOptions $opts
1232 * @return bool|ResultWrapper Result or false
1233 */
1234 protected function doMainQuery( $tables, $fields, $conds,
1235 $query_options, $join_conds, FormOptions $opts
1236 ) {
1237 $tables[] = 'recentchanges';
1238 $fields = array_merge( RecentChange::selectFields(), $fields );
1239
1240 ChangeTags::modifyDisplayQuery(
1241 $tables,
1242 $fields,
1243 $conds,
1244 $join_conds,
1245 $query_options,
1246 ''
1247 );
1248
1249 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
1250 $opts )
1251 ) {
1252 return false;
1253 }
1254
1255 $dbr = $this->getDB();
1256
1257 return $dbr->select(
1258 $tables,
1259 $fields,
1260 $conds,
1261 __METHOD__,
1262 $query_options,
1263 $join_conds
1264 );
1265 }
1266
1267 protected function runMainQueryHook( &$tables, &$fields, &$conds,
1268 &$query_options, &$join_conds, $opts
1269 ) {
1270 return Hooks::run(
1271 'ChangesListSpecialPageQuery',
1272 [ $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ]
1273 );
1274 }
1275
1276 /**
1277 * Return a IDatabase object for reading
1278 *
1279 * @return IDatabase
1280 */
1281 protected function getDB() {
1282 return wfGetDB( DB_REPLICA );
1283 }
1284
1285 /**
1286 * Send output to the OutputPage object, only called if not used feeds
1287 *
1288 * @param ResultWrapper $rows Database rows
1289 * @param FormOptions $opts
1290 */
1291 public function webOutput( $rows, $opts ) {
1292 if ( !$this->including() ) {
1293 $this->outputFeedLinks();
1294 $this->doHeader( $opts, $rows->numRows() );
1295 }
1296
1297 $this->outputChangesList( $rows, $opts );
1298 }
1299
1300 /**
1301 * Output feed links.
1302 */
1303 public function outputFeedLinks() {
1304 // nothing by default
1305 }
1306
1307 /**
1308 * Build and output the actual changes list.
1309 *
1310 * @param ResultWrapper $rows Database rows
1311 * @param FormOptions $opts
1312 */
1313 abstract public function outputChangesList( $rows, $opts );
1314
1315 /**
1316 * Set the text to be displayed above the changes
1317 *
1318 * @param FormOptions $opts
1319 * @param int $numRows Number of rows in the result to show after this header
1320 */
1321 public function doHeader( $opts, $numRows ) {
1322 $this->setTopText( $opts );
1323
1324 // @todo Lots of stuff should be done here.
1325
1326 $this->setBottomText( $opts );
1327 }
1328
1329 /**
1330 * Send the text to be displayed before the options. Should use $this->getOutput()->addWikiText()
1331 * or similar methods to print the text.
1332 *
1333 * @param FormOptions $opts
1334 */
1335 public function setTopText( FormOptions $opts ) {
1336 // nothing by default
1337 }
1338
1339 /**
1340 * Send the text to be displayed after the options. Should use $this->getOutput()->addWikiText()
1341 * or similar methods to print the text.
1342 *
1343 * @param FormOptions $opts
1344 */
1345 public function setBottomText( FormOptions $opts ) {
1346 // nothing by default
1347 }
1348
1349 /**
1350 * Get options to be displayed in a form
1351 * @todo This should handle options returned by getDefaultOptions().
1352 * @todo Not called by anything in this class (but is in subclasses), should be
1353 * called by something… doHeader() maybe?
1354 *
1355 * @param FormOptions $opts
1356 * @return array
1357 */
1358 public function getExtraOptions( $opts ) {
1359 return [];
1360 }
1361
1362 /**
1363 * Return the legend displayed within the fieldset
1364 *
1365 * @return string
1366 */
1367 public function makeLegend() {
1368 $context = $this->getContext();
1369 $user = $context->getUser();
1370 # The legend showing what the letters and stuff mean
1371 $legend = Html::openElement( 'dl' ) . "\n";
1372 # Iterates through them and gets the messages for both letter and tooltip
1373 $legendItems = $context->getConfig()->get( 'RecentChangesFlags' );
1374 if ( !( $user->useRCPatrol() || $user->useNPPatrol() ) ) {
1375 unset( $legendItems['unpatrolled'] );
1376 }
1377 foreach ( $legendItems as $key => $item ) { # generate items of the legend
1378 $label = isset( $item['legend'] ) ? $item['legend'] : $item['title'];
1379 $letter = $item['letter'];
1380 $cssClass = isset( $item['class'] ) ? $item['class'] : $key;
1381
1382 $legend .= Html::element( 'dt',
1383 [ 'class' => $cssClass ], $context->msg( $letter )->text()
1384 ) . "\n" .
1385 Html::rawElement( 'dd',
1386 [ 'class' => Sanitizer::escapeClass( 'mw-changeslist-legend-' . $key ) ],
1387 $context->msg( $label )->parse()
1388 ) . "\n";
1389 }
1390 # (+-123)
1391 $legend .= Html::rawElement( 'dt',
1392 [ 'class' => 'mw-plusminus-pos' ],
1393 $context->msg( 'recentchanges-legend-plusminus' )->parse()
1394 ) . "\n";
1395 $legend .= Html::element(
1396 'dd',
1397 [ 'class' => 'mw-changeslist-legend-plusminus' ],
1398 $context->msg( 'recentchanges-label-plusminus' )->text()
1399 ) . "\n";
1400 $legend .= Html::closeElement( 'dl' ) . "\n";
1401
1402 $legendHeading = $this->isStructuredFilterUiEnabled() ?
1403 $context->msg( 'rcfilters-legend-heading' )->parse() :
1404 $context->msg( 'recentchanges-legend-heading' )->parse();
1405
1406 # Collapsible
1407 $legend =
1408 '<div class="mw-changeslist-legend">' .
1409 $legendHeading .
1410 '<div class="mw-collapsible-content">' . $legend . '</div>' .
1411 '</div>';
1412
1413 return $legend;
1414 }
1415
1416 /**
1417 * Add page-specific modules.
1418 */
1419 protected function addModules() {
1420 $out = $this->getOutput();
1421 // Styles and behavior for the legend box (see makeLegend())
1422 $out->addModuleStyles( [
1423 'mediawiki.special.changeslist.legend',
1424 'mediawiki.special.changeslist',
1425 ] );
1426 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
1427
1428 if ( $this->isStructuredFilterUiEnabled() ) {
1429 $out->addModules( 'mediawiki.rcfilters.filters.ui' );
1430 $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
1431 }
1432 }
1433
1434 protected function getGroupName() {
1435 return 'changes';
1436 }
1437
1438 /**
1439 * Filter on users' experience levels; this will not be called if nothing is
1440 * selected.
1441 *
1442 * @param string $specialPageClassName Class name of current special page
1443 * @param IContextSource $context Context, for e.g. user
1444 * @param IDatabase $dbr Database, for addQuotes, makeList, and similar
1445 * @param array &$tables Array of tables; see IDatabase::select $table
1446 * @param array &$fields Array of fields; see IDatabase::select $vars
1447 * @param array &$conds Array of conditions; see IDatabase::select $conds
1448 * @param array &$query_options Array of query options; see IDatabase::select $options
1449 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1450 * @param array $selectedExpLevels The allowed active values, sorted
1451 * @param int $now Number of seconds since the UNIX epoch, or 0 if not given
1452 * (optional)
1453 */
1454 public function filterOnUserExperienceLevel( $specialPageClassName, $context, $dbr,
1455 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now = 0
1456 ) {
1457 global $wgLearnerEdits,
1458 $wgExperiencedUserEdits,
1459 $wgLearnerMemberSince,
1460 $wgExperiencedUserMemberSince;
1461
1462 $LEVEL_COUNT = 5;
1463
1464 // If all levels are selected, don't filter
1465 if ( count( $selectedExpLevels ) === $LEVEL_COUNT ) {
1466 return;
1467 }
1468
1469 // both 'registered' and 'unregistered', experience levels, if any, are included in 'registered'
1470 if (
1471 in_array( 'registered', $selectedExpLevels ) &&
1472 in_array( 'unregistered', $selectedExpLevels )
1473 ) {
1474 return;
1475 }
1476
1477 // 'registered' but not 'unregistered', experience levels, if any, are included in 'registered'
1478 if (
1479 in_array( 'registered', $selectedExpLevels ) &&
1480 !in_array( 'unregistered', $selectedExpLevels )
1481 ) {
1482 $conds[] = 'rc_user != 0';
1483 return;
1484 }
1485
1486 if ( $selectedExpLevels === [ 'unregistered' ] ) {
1487 $conds[] = 'rc_user = 0';
1488 return;
1489 }
1490
1491 $tables[] = 'user';
1492 $join_conds['user'] = [ 'LEFT JOIN', 'rc_user = user_id' ];
1493
1494 if ( $now === 0 ) {
1495 $now = time();
1496 }
1497 $secondsPerDay = 86400;
1498 $learnerCutoff = $now - $wgLearnerMemberSince * $secondsPerDay;
1499 $experiencedUserCutoff = $now - $wgExperiencedUserMemberSince * $secondsPerDay;
1500
1501 $aboveNewcomer = $dbr->makeList(
1502 [
1503 'user_editcount >= ' . intval( $wgLearnerEdits ),
1504 'user_registration <= ' . $dbr->addQuotes( $dbr->timestamp( $learnerCutoff ) ),
1505 ],
1506 IDatabase::LIST_AND
1507 );
1508
1509 $aboveLearner = $dbr->makeList(
1510 [
1511 'user_editcount >= ' . intval( $wgExperiencedUserEdits ),
1512 'user_registration <= ' .
1513 $dbr->addQuotes( $dbr->timestamp( $experiencedUserCutoff ) ),
1514 ],
1515 IDatabase::LIST_AND
1516 );
1517
1518 $conditions = [];
1519
1520 if ( in_array( 'unregistered', $selectedExpLevels ) ) {
1521 $selectedExpLevels = array_diff( $selectedExpLevels, [ 'unregistered' ] );
1522 $conditions[] = 'rc_user = 0';
1523 }
1524
1525 if ( $selectedExpLevels === [ 'newcomer' ] ) {
1526 $conditions[] = "NOT ( $aboveNewcomer )";
1527 } elseif ( $selectedExpLevels === [ 'learner' ] ) {
1528 $conditions[] = $dbr->makeList(
1529 [ $aboveNewcomer, "NOT ( $aboveLearner )" ],
1530 IDatabase::LIST_AND
1531 );
1532 } elseif ( $selectedExpLevels === [ 'experienced' ] ) {
1533 $conditions[] = $aboveLearner;
1534 } elseif ( $selectedExpLevels === [ 'learner', 'newcomer' ] ) {
1535 $conditions[] = "NOT ( $aboveLearner )";
1536 } elseif ( $selectedExpLevels === [ 'experienced', 'newcomer' ] ) {
1537 $conditions[] = $dbr->makeList(
1538 [ "NOT ( $aboveNewcomer )", $aboveLearner ],
1539 IDatabase::LIST_OR
1540 );
1541 } elseif ( $selectedExpLevels === [ 'experienced', 'learner' ] ) {
1542 $conditions[] = $aboveNewcomer;
1543 } elseif ( $selectedExpLevels === [ 'experienced', 'learner', 'newcomer' ] ) {
1544 $conditions[] = 'rc_user != 0';
1545 }
1546
1547 if ( count( $conditions ) > 1 ) {
1548 $conds[] = $dbr->makeList( $conditions, IDatabase::LIST_OR );
1549 } elseif ( count( $conditions ) === 1 ) {
1550 $conds[] = reset( $conditions );
1551 }
1552 }
1553
1554 /**
1555 * Check whether the structured filter UI is enabled
1556 *
1557 * @return bool
1558 */
1559 public function isStructuredFilterUiEnabled() {
1560 if ( $this->getRequest()->getBool( 'rcfilters' ) ) {
1561 return true;
1562 }
1563
1564 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1565 return !$this->getUser()->getOption( 'rcenhancedfilters-disable' );
1566 } else {
1567 return $this->getUser()->getOption( 'rcenhancedfilters' );
1568 }
1569 }
1570
1571 /**
1572 * Check whether the structured filter UI is enabled by default (regardless of
1573 * this particular user's setting)
1574 *
1575 * @return bool
1576 */
1577 public function isStructuredFilterUiEnabledByDefault() {
1578 if ( $this->getConfig()->get( 'StructuredChangeFiltersShowPreference' ) ) {
1579 return !$this->getUser()->getDefaultOption( 'rcenhancedfilters-disable' );
1580 } else {
1581 return $this->getUser()->getDefaultOption( 'rcenhancedfilters' );
1582 }
1583 }
1584
1585 abstract function getDefaultLimit();
1586
1587 abstract function getDefaultDays();
1588 }