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