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