dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
RCFilters: Export config vars in the RL modules where possible
[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 'StructuredChangeFiltersDisplayConfig',
797 [
798 'maxDays' => (int)$this->getConfig()->get( 'RCMaxAge' ) / ( 24 * 3600 ), // Translate to days
799 'limitArray' => $this->getConfig()->get( 'RCLinkLimits' ),
800 'limitDefault' => $this->getDefaultLimit(),
801 'daysArray' => $this->getConfig()->get( 'RCLinkDays' ),
802 'daysDefault' => $this->getDefaultDays(),
803 ]
804 );
805
806 $out->addJsConfigVars(
807 'wgStructuredChangeFiltersSavedQueriesPreferenceName',
808 static::$savedQueriesPreferenceName
809 );
810 $out->addJsConfigVars(
811 'wgStructuredChangeFiltersLimitPreferenceName',
812 static::$limitPreferenceName
813 );
814 $out->addJsConfigVars(
815 'wgStructuredChangeFiltersDaysPreferenceName',
816 static::$daysPreferenceName
817 );
818 $out->addJsConfigVars(
819 'wgStructuredChangeFiltersCollapsedPreferenceName',
820 static::$collapsedPreferenceName
821 );
822 } else {
823 $out->addBodyClasses( 'mw-rcfilters-disabled' );
824 }
825 }
826
827 /**
828 * Get config vars to export with the mediawiki.rcfilters.filters.ui module.
829 *
830 * @param ResourceLoaderContext $context
831 * @return array
832 */
833 public static function getRcFiltersConfigVars( ResourceLoaderContext $context ) {
834 return [
835 'RCFiltersChangeTags' => self::getChangeTagList( $context ),
836 'StructuredChangeFiltersEditWatchlistUrl' =>
837 SpecialPage::getTitleFor( 'EditWatchlist' )->getLocalURL()
838 ];
839 }
840
841 /**
842 * Fetch the change tags list for the front end
843 *
844 * @param ResourceLoaderContext $context
845 * @return array Tag data
846 */
847 protected static function getChangeTagList( ResourceLoaderContext $context ) {
848 $cache = ObjectCache::getMainWANInstance();
849 return $cache->getWithSetCallback(
850 $cache->makeKey( 'changeslistspecialpage-changetags', $context->getLanguage() ),
851 $cache::TTL_MINUTE * 10,
852 function () use ( $context ) {
853 $explicitlyDefinedTags = array_fill_keys( ChangeTags::listExplicitlyDefinedTags(), 0 );
854 $softwareActivatedTags = array_fill_keys( ChangeTags::listSoftwareActivatedTags(), 0 );
855
856 // Hit counts disabled for perf reasons, see T169997
857 /*
858 $tagStats = ChangeTags::tagUsageStatistics();
859 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags, $tagStats );
860
861 // Sort by hits
862 arsort( $tagHitCounts );
863 */
864 $tagHitCounts = array_merge( $explicitlyDefinedTags, $softwareActivatedTags );
865
866 // HACK work around ChangeTags::truncateTagDescription() requiring a RequestContext
867 $fakeContext = new RequestContext;
868 $fakeContext->setLanguage( Language::factory( $context->getLanguage() ) );
869
870 // Build the list and data
871 $result = [];
872 foreach ( $tagHitCounts as $tagName => $hits ) {
873 if (
874 // Only get active tags
875 isset( $explicitlyDefinedTags[ $tagName ] ) ||
876 isset( $softwareActivatedTags[ $tagName ] )
877 ) {
878 $result[] = [
879 'name' => $tagName,
880 'label' => Sanitizer::stripAllTags(
881 ChangeTags::tagDescription( $tagName, $context )
882 ),
883 'description' =>
884 ChangeTags::truncateTagDescription(
885 $tagName,
886 self::TAG_DESC_CHARACTER_LIMIT,
887 $fakeContext
888 ),
889 'cssClass' => Sanitizer::escapeClass( 'mw-tag-' . $tagName ),
890 'hits' => $hits,
891 ];
892 }
893 }
894
895 // Instead of sorting by hit count (disabled, see above), sort by display name
896 usort( $result, function ( $a, $b ) {
897 return strcasecmp( $a['label'], $b['label'] );
898 } );
899
900 return $result;
901 },
902 [
903 'lockTSE' => 30
904 ]
905 );
906 }
907
908 /**
909 * Add the "no results" message to the output
910 */
911 protected function outputNoResults() {
912 $this->getOutput()->addHTML(
913 '<div class="mw-changeslist-empty">' .
914 $this->msg( 'recentchanges-noresult' )->parse() .
915 '</div>'
916 );
917 }
918
919 /**
920 * Add the "timeout" message to the output
921 */
922 protected function outputTimeout() {
923 $this->getOutput()->addHTML(
924 '<div class="mw-changeslist-empty mw-changeslist-timeout">' .
925 $this->msg( 'recentchanges-timeout' )->parse() .
926 '</div>'
927 );
928 }
929
930 /**
931 * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
932 *
933 * @return bool|IResultWrapper Result or false
934 */
935 public function getRows() {
936 $opts = $this->getOptions();
937
938 $tables = [];
939 $fields = [];
940 $conds = [];
941 $query_options = [];
942 $join_conds = [];
943 $this->buildQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
944
945 return $this->doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, $opts );
946 }
947
948 /**
949 * Get the current FormOptions for this request
950 *
951 * @return FormOptions
952 */
953 public function getOptions() {
954 if ( $this->rcOptions === null ) {
955 $this->rcOptions = $this->setup( $this->rcSubpage );
956 }
957
958 return $this->rcOptions;
959 }
960
961 /**
962 * Register all filters and their groups (including those from hooks), plus handle
963 * conflicts and defaults.
964 *
965 * You might want to customize these in the same method, in subclasses. You can
966 * call getFilterGroup to access a group, and (on the group) getFilter to access a
967 * filter, then make necessary modfications to the filter or group (e.g. with
968 * setDefault).
969 */
970 protected function registerFilters() {
971 $this->registerFiltersFromDefinitions( $this->filterGroupDefinitions );
972
973 // Make sure this is not being transcluded (we don't want to show this
974 // information to all users just because the user that saves the edit can
975 // patrol or is logged in)
976 if ( !$this->including() && $this->getUser()->useRCPatrol() ) {
977 $this->registerFiltersFromDefinitions( $this->legacyReviewStatusFilterGroupDefinition );
978 $this->registerFiltersFromDefinitions( $this->reviewStatusFilterGroupDefinition );
979 }
980
981 $changeTypeGroup = $this->getFilterGroup( 'changeType' );
982
983 if ( $this->getConfig()->get( 'RCWatchCategoryMembership' ) ) {
984 $transformedHideCategorizationDef = $this->transformFilterDefinition(
985 $this->hideCategorizationFilterDefinition
986 );
987
988 $transformedHideCategorizationDef['group'] = $changeTypeGroup;
989
990 $hideCategorization = new ChangesListBooleanFilter(
991 $transformedHideCategorizationDef
992 );
993 }
994
995 Hooks::run( 'ChangesListSpecialPageStructuredFilters', [ $this ] );
996
997 $this->registerFiltersFromDefinitions( [] );
998
999 $userExperienceLevel = $this->getFilterGroup( 'userExpLevel' );
1000 $registered = $userExperienceLevel->getFilter( 'registered' );
1001 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'newcomer' ) );
1002 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'learner' ) );
1003 $registered->setAsSupersetOf( $userExperienceLevel->getFilter( 'experienced' ) );
1004
1005 $categoryFilter = $changeTypeGroup->getFilter( 'hidecategorization' );
1006 $logactionsFilter = $changeTypeGroup->getFilter( 'hidelog' );
1007 $pagecreationFilter = $changeTypeGroup->getFilter( 'hidenewpages' );
1008
1009 $significanceTypeGroup = $this->getFilterGroup( 'significance' );
1010 $hideMinorFilter = $significanceTypeGroup->getFilter( 'hideminor' );
1011
1012 // categoryFilter is conditional; see registerFilters
1013 if ( $categoryFilter !== null ) {
1014 $hideMinorFilter->conflictsWith(
1015 $categoryFilter,
1016 'rcfilters-hideminor-conflicts-typeofchange-global',
1017 'rcfilters-hideminor-conflicts-typeofchange',
1018 'rcfilters-typeofchange-conflicts-hideminor'
1019 );
1020 }
1021 $hideMinorFilter->conflictsWith(
1022 $logactionsFilter,
1023 'rcfilters-hideminor-conflicts-typeofchange-global',
1024 'rcfilters-hideminor-conflicts-typeofchange',
1025 'rcfilters-typeofchange-conflicts-hideminor'
1026 );
1027 $hideMinorFilter->conflictsWith(
1028 $pagecreationFilter,
1029 'rcfilters-hideminor-conflicts-typeofchange-global',
1030 'rcfilters-hideminor-conflicts-typeofchange',
1031 'rcfilters-typeofchange-conflicts-hideminor'
1032 );
1033 }
1034
1035 /**
1036 * Transforms filter definition to prepare it for constructor.
1037 *
1038 * See overrides of this method as well.
1039 *
1040 * @param array $filterDefinition Original filter definition
1041 *
1042 * @return array Transformed definition
1043 */
1044 protected function transformFilterDefinition( array $filterDefinition ) {
1045 return $filterDefinition;
1046 }
1047
1048 /**
1049 * Register filters from a definition object
1050 *
1051 * Array specifying groups and their filters; see Filter and
1052 * ChangesListFilterGroup constructors.
1053 *
1054 * There is light processing to simplify core maintenance.
1055 * @param array $definition
1056 */
1057 protected function registerFiltersFromDefinitions( array $definition ) {
1058 $autoFillPriority = -1;
1059 foreach ( $definition as $groupDefinition ) {
1060 if ( !isset( $groupDefinition['priority'] ) ) {
1061 $groupDefinition['priority'] = $autoFillPriority;
1062 } else {
1063 // If it's explicitly specified, start over the auto-fill
1064 $autoFillPriority = $groupDefinition['priority'];
1065 }
1066
1067 $autoFillPriority--;
1068
1069 $className = $groupDefinition['class'];
1070 unset( $groupDefinition['class'] );
1071
1072 foreach ( $groupDefinition['filters'] as &$filterDefinition ) {
1073 $filterDefinition = $this->transformFilterDefinition( $filterDefinition );
1074 }
1075
1076 $this->registerFilterGroup( new $className( $groupDefinition ) );
1077 }
1078 }
1079
1080 /**
1081 * @return array The legacy show/hide toggle filters
1082 */
1083 protected function getLegacyShowHideFilters() {
1084 $filters = [];
1085 foreach ( $this->filterGroups as $group ) {
1086 if ( $group instanceof ChangesListBooleanFilterGroup ) {
1087 foreach ( $group->getFilters() as $key => $filter ) {
1088 if ( $filter->displaysOnUnstructuredUi( $this ) ) {
1089 $filters[ $key ] = $filter;
1090 }
1091 }
1092 }
1093 }
1094 return $filters;
1095 }
1096
1097 /**
1098 * Register all the filters, including legacy hook-driven ones.
1099 * Then create a FormOptions object with options as specified by the user
1100 *
1101 * @param array $parameters
1102 *
1103 * @return FormOptions
1104 */
1105 public function setup( $parameters ) {
1106 $this->registerFilters();
1107
1108 $opts = $this->getDefaultOptions();
1109
1110 $opts = $this->fetchOptionsFromRequest( $opts );
1111
1112 // Give precedence to subpage syntax
1113 if ( $parameters !== null ) {
1114 $this->parseParameters( $parameters, $opts );
1115 }
1116
1117 $this->validateOptions( $opts );
1118
1119 return $opts;
1120 }
1121
1122 /**
1123 * Get a FormOptions object containing the default options. By default, returns
1124 * some basic options. The filters listed explicitly here are overriden in this
1125 * method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters,
1126 * and more) are structured. Structured filters are overriden in registerFilters.
1127 * not here.
1128 *
1129 * @return FormOptions
1130 */
1131 public function getDefaultOptions() {
1132 $opts = new FormOptions();
1133 $structuredUI = $this->isStructuredFilterUiEnabled();
1134 // If urlversion=2 is set, ignore the filter defaults and set them all to false/empty
1135 $useDefaults = $this->getRequest()->getInt( 'urlversion' ) !== 2;
1136
1137 /** @var ChangesListFilterGroup $filterGroup */
1138 foreach ( $this->filterGroups as $filterGroup ) {
1139 $filterGroup->addOptions( $opts, $useDefaults, $structuredUI );
1140 }
1141
1142 $opts->add( 'namespace', '', FormOptions::STRING );
1143 $opts->add( 'invert', false );
1144 $opts->add( 'associated', false );
1145 $opts->add( 'urlversion', 1 );
1146 $opts->add( 'tagfilter', '' );
1147
1148 $opts->add( 'days', $this->getDefaultDays(), FormOptions::FLOAT );
1149 $opts->add( 'limit', $this->getDefaultLimit(), FormOptions::INT );
1150
1151 $opts->add( 'from', '' );
1152
1153 return $opts;
1154 }
1155
1156 /**
1157 * Register a structured changes list filter group
1158 *
1159 * @param ChangesListFilterGroup $group
1160 */
1161 public function registerFilterGroup( ChangesListFilterGroup $group ) {
1162 $groupName = $group->getName();
1163
1164 $this->filterGroups[$groupName] = $group;
1165 }
1166
1167 /**
1168 * Gets the currently registered filters groups
1169 *
1170 * @return array Associative array of ChangesListFilterGroup objects, with group name as key
1171 */
1172 protected function getFilterGroups() {
1173 return $this->filterGroups;
1174 }
1175
1176 /**
1177 * Gets a specified ChangesListFilterGroup by name
1178 *
1179 * @param string $groupName Name of group
1180 *
1181 * @return ChangesListFilterGroup|null Group, or null if not registered
1182 */
1183 public function getFilterGroup( $groupName ) {
1184 return $this->filterGroups[$groupName] ?? null;
1185 }
1186
1187 // Currently, this intentionally only includes filters that display
1188 // in the structured UI. This can be changed easily, though, if we want
1189 // to include data on filters that use the unstructured UI. messageKeys is a
1190 // special top-level value, with the value being an array of the message keys to
1191 // send to the client.
1192 /**
1193 * Gets structured filter information needed by JS
1194 *
1195 * @return array Associative array
1196 * * array $return['groups'] Group data
1197 * * array $return['messageKeys'] Array of message keys
1198 */
1199 public function getStructuredFilterJsData() {
1200 $output = [
1201 'groups' => [],
1202 'messageKeys' => [],
1203 ];
1204
1205 usort( $this->filterGroups, function ( $a, $b ) {
1206 return $b->getPriority() <=> $a->getPriority();
1207 } );
1208
1209 foreach ( $this->filterGroups as $groupName => $group ) {
1210 $groupOutput = $group->getJsData( $this );
1211 if ( $groupOutput !== null ) {
1212 $output['messageKeys'] = array_merge(
1213 $output['messageKeys'],
1214 $groupOutput['messageKeys']
1215 );
1216
1217 unset( $groupOutput['messageKeys'] );
1218 $output['groups'][] = $groupOutput;
1219 }
1220 }
1221
1222 return $output;
1223 }
1224
1225 /**
1226 * Fetch values for a FormOptions object from the WebRequest associated with this instance.
1227 *
1228 * Intended for subclassing, e.g. to add a backwards-compatibility layer.
1229 *
1230 * @param FormOptions $opts
1231 * @return FormOptions
1232 */
1233 protected function fetchOptionsFromRequest( $opts ) {
1234 $opts->fetchValuesFromRequest( $this->getRequest() );
1235
1236 return $opts;
1237 }
1238
1239 /**
1240 * Process $par and put options found in $opts. Used when including the page.
1241 *
1242 * @param string $par
1243 * @param FormOptions $opts
1244 */
1245 public function parseParameters( $par, FormOptions $opts ) {
1246 $stringParameterNameSet = [];
1247 $hideParameterNameSet = [];
1248
1249 // URL parameters can be per-group, like 'userExpLevel',
1250 // or per-filter, like 'hideminor'.
1251
1252 foreach ( $this->filterGroups as $filterGroup ) {
1253 if ( $filterGroup instanceof ChangesListStringOptionsFilterGroup ) {
1254 $stringParameterNameSet[$filterGroup->getName()] = true;
1255 } elseif ( $filterGroup instanceof ChangesListBooleanFilterGroup ) {
1256 foreach ( $filterGroup->getFilters() as $filter ) {
1257 $hideParameterNameSet[$filter->getName()] = true;
1258 }
1259 }
1260 }
1261
1262 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
1263 foreach ( $bits as $bit ) {
1264 $m = [];
1265 if ( isset( $hideParameterNameSet[$bit] ) ) {
1266 // hidefoo => hidefoo=true
1267 $opts[$bit] = true;
1268 } elseif ( isset( $hideParameterNameSet["hide$bit"] ) ) {
1269 // foo => hidefoo=false
1270 $opts["hide$bit"] = false;
1271 } elseif ( preg_match( '/^(.*)=(.*)$/', $bit, $m ) ) {
1272 if ( isset( $stringParameterNameSet[$m[1]] ) ) {
1273 $opts[$m[1]] = $m[2];
1274 }
1275 }
1276 }
1277 }
1278
1279 /**
1280 * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
1281 *
1282 * @param FormOptions $opts
1283 */
1284 public function validateOptions( FormOptions $opts ) {
1285 $isContradictory = $this->fixContradictoryOptions( $opts );
1286 $isReplaced = $this->replaceOldOptions( $opts );
1287
1288 if ( $isContradictory || $isReplaced ) {
1289 $query = wfArrayToCgi( $this->convertParamsForLink( $opts->getChangedValues() ) );
1290 $this->getOutput()->redirect( $this->getPageTitle()->getCanonicalURL( $query ) );
1291 }
1292
1293 $opts->validateIntBounds( 'limit', 0, 5000 );
1294 $opts->validateBounds( 'days', 0, $this->getConfig()->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
1295 }
1296
1297 /**
1298 * Fix invalid options by resetting pairs that should never appear together.
1299 *
1300 * @param FormOptions $opts
1301 * @return bool True if any option was reset
1302 */
1303 private function fixContradictoryOptions( FormOptions $opts ) {
1304 $fixed = $this->fixBackwardsCompatibilityOptions( $opts );
1305
1306 foreach ( $this->filterGroups as $filterGroup ) {
1307 if ( $filterGroup instanceof ChangesListBooleanFilterGroup ) {
1308 $filters = $filterGroup->getFilters();
1309
1310 if ( count( $filters ) === 1 ) {
1311 // legacy boolean filters should not be considered
1312 continue;
1313 }
1314
1315 $allInGroupEnabled = array_reduce(
1316 $filters,
1317 function ( $carry, $filter ) use ( $opts ) {
1318 return $carry && $opts[ $filter->getName() ];
1319 },
1320 /* initialValue */ count( $filters ) > 0
1321 );
1322
1323 if ( $allInGroupEnabled ) {
1324 foreach ( $filters as $filter ) {
1325 $opts[ $filter->getName() ] = false;
1326 }
1327
1328 $fixed = true;
1329 }
1330 }
1331 }
1332
1333 return $fixed;
1334 }
1335
1336 /**
1337 * Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards
1338 * compatibility.
1339 *
1340 * This is deprecated and may be removed.
1341 *
1342 * @param FormOptions $opts
1343 * @return bool True if this change was mode
1344 */
1345 private function fixBackwardsCompatibilityOptions( FormOptions $opts ) {
1346 if ( $opts['hideanons'] && $opts['hideliu'] ) {
1347 $opts->reset( 'hideanons' );
1348 if ( !$opts['hidebots'] ) {
1349 $opts->reset( 'hideliu' );
1350 $opts['hidehumans'] = 1;
1351 }
1352
1353 return true;
1354 }
1355
1356 return false;
1357 }
1358
1359 /**
1360 * Replace old options with their structured UI equivalents
1361 *
1362 * @param FormOptions $opts
1363 * @return bool True if the change was made
1364 */
1365 public function replaceOldOptions( FormOptions $opts ) {
1366 if ( !$this->isStructuredFilterUiEnabled() ) {
1367 return false;
1368 }
1369
1370 $changed = false;
1371
1372 // At this point 'hideanons' and 'hideliu' cannot be both true,
1373 // because fixBackwardsCompatibilityOptions resets (at least) 'hideanons' in such case
1374 if ( $opts[ 'hideanons' ] ) {
1375 $opts->reset( 'hideanons' );
1376 $opts[ 'userExpLevel' ] = 'registered';
1377 $changed = true;
1378 }
1379
1380 if ( $opts[ 'hideliu' ] ) {
1381 $opts->reset( 'hideliu' );
1382 $opts[ 'userExpLevel' ] = 'unregistered';
1383 $changed = true;
1384 }
1385
1386 if ( $this->getFilterGroup( 'legacyReviewStatus' ) ) {
1387 if ( $opts[ 'hidepatrolled' ] ) {
1388 $opts->reset( 'hidepatrolled' );
1389 $opts[ 'reviewStatus' ] = 'unpatrolled';
1390 $changed = true;
1391 }
1392
1393 if ( $opts[ 'hideunpatrolled' ] ) {
1394 $opts->reset( 'hideunpatrolled' );
1395 $opts[ 'reviewStatus' ] = implode(
1396 ChangesListStringOptionsFilterGroup::SEPARATOR,
1397 [ 'manual', 'auto' ]
1398 );
1399 $changed = true;
1400 }
1401 }
1402
1403 return $changed;
1404 }
1405
1406 /**
1407 * Convert parameters values from true/false to 1/0
1408 * so they are not omitted by wfArrayToCgi()
1409 * T38524
1410 *
1411 * @param array $params
1412 * @return array
1413 */
1414 protected function convertParamsForLink( $params ) {
1415 foreach ( $params as &$value ) {
1416 if ( $value === false ) {
1417 $value = '0';
1418 }
1419 }
1420 unset( $value );
1421 return $params;
1422 }
1423
1424 /**
1425 * Sets appropriate tables, fields, conditions, etc. depending on which filters
1426 * the user requested.
1427 *
1428 * @param array &$tables Array of tables; see IDatabase::select $table
1429 * @param array &$fields Array of fields; see IDatabase::select $vars
1430 * @param array &$conds Array of conditions; see IDatabase::select $conds
1431 * @param array &$query_options Array of query options; see IDatabase::select $options
1432 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1433 * @param FormOptions $opts
1434 */
1435 protected function buildQuery( &$tables, &$fields, &$conds, &$query_options,
1436 &$join_conds, FormOptions $opts
1437 ) {
1438 $dbr = $this->getDB();
1439 $isStructuredUI = $this->isStructuredFilterUiEnabled();
1440
1441 /** @var ChangesListFilterGroup $filterGroup */
1442 foreach ( $this->filterGroups as $filterGroup ) {
1443 $filterGroup->modifyQuery( $dbr, $this, $tables, $fields, $conds,
1444 $query_options, $join_conds, $opts, $isStructuredUI );
1445 }
1446
1447 // Namespace filtering
1448 if ( $opts[ 'namespace' ] !== '' ) {
1449 $namespaces = explode( ';', $opts[ 'namespace' ] );
1450
1451 if ( $opts[ 'associated' ] ) {
1452 $associatedNamespaces = array_map(
1453 function ( $ns ) {
1454 return MWNamespace::getAssociated( $ns );
1455 },
1456 $namespaces
1457 );
1458 $namespaces = array_unique( array_merge( $namespaces, $associatedNamespaces ) );
1459 }
1460
1461 if ( count( $namespaces ) === 1 ) {
1462 $operator = $opts[ 'invert' ] ? '!=' : '=';
1463 $value = $dbr->addQuotes( reset( $namespaces ) );
1464 } else {
1465 $operator = $opts[ 'invert' ] ? 'NOT IN' : 'IN';
1466 sort( $namespaces );
1467 $value = '(' . $dbr->makeList( $namespaces ) . ')';
1468 }
1469 $conds[] = "rc_namespace $operator $value";
1470 }
1471
1472 // Calculate cutoff
1473 $cutoff_unixtime = time() - $opts['days'] * 3600 * 24;
1474 $cutoff = $dbr->timestamp( $cutoff_unixtime );
1475
1476 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
1477 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW, $cutoff ) ) {
1478 $cutoff = $dbr->timestamp( $opts['from'] );
1479 } else {
1480 $opts->reset( 'from' );
1481 }
1482
1483 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
1484 }
1485
1486 /**
1487 * Process the query
1488 *
1489 * @param array $tables Array of tables; see IDatabase::select $table
1490 * @param array $fields Array of fields; see IDatabase::select $vars
1491 * @param array $conds Array of conditions; see IDatabase::select $conds
1492 * @param array $query_options Array of query options; see IDatabase::select $options
1493 * @param array $join_conds Array of join conditions; see IDatabase::select $join_conds
1494 * @param FormOptions $opts
1495 * @return bool|IResultWrapper Result or false
1496 */
1497 protected function doMainQuery( $tables, $fields, $conds,
1498 $query_options, $join_conds, FormOptions $opts
1499 ) {
1500 $rcQuery = RecentChange::getQueryInfo();
1501 $tables = array_merge( $tables, $rcQuery['tables'] );
1502 $fields = array_merge( $rcQuery['fields'], $fields );
1503 $join_conds = array_merge( $join_conds, $rcQuery['joins'] );
1504
1505 ChangeTags::modifyDisplayQuery(
1506 $tables,
1507 $fields,
1508 $conds,
1509 $join_conds,
1510 $query_options,
1511 ''
1512 );
1513
1514 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
1515 $opts )
1516 ) {
1517 return false;
1518 }
1519
1520 $dbr = $this->getDB();
1521
1522 return $dbr->select(
1523 $tables,
1524 $fields,
1525 $conds,
1526 __METHOD__,
1527 $query_options,
1528 $join_conds
1529 );
1530 }
1531
1532 protected function runMainQueryHook( &$tables, &$fields, &$conds,
1533 &$query_options, &$join_conds, $opts
1534 ) {
1535 return Hooks::run(
1536 'ChangesListSpecialPageQuery',
1537 [ $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ]
1538 );
1539 }
1540
1541 /**
1542 * Return a IDatabase object for reading
1543 *
1544 * @return IDatabase
1545 */
1546 protected function getDB() {
1547 return wfGetDB( DB_REPLICA );
1548 }
1549
1550 /**
1551 * Send header output to the OutputPage object, only called if not using feeds
1552 *
1553 * @param int $rowCount Number of database rows
1554 * @param FormOptions $opts
1555 */
1556 private function webOutputHeader( $rowCount, $opts ) {
1557 if ( !$this->including() ) {
1558 $this->outputFeedLinks();
1559 $this->doHeader( $opts, $rowCount );
1560 }
1561 }
1562
1563 /**
1564 * Send output to the OutputPage object, only called if not used feeds
1565 *
1566 * @param IResultWrapper $rows Database rows
1567 * @param FormOptions $opts
1568 */
1569 public function webOutput( $rows, $opts ) {
1570 $this->webOutputHeader( $rows->numRows(), $opts );
1571
1572 $this->outputChangesList( $rows, $opts );
1573 }
1574
1575 /**
1576 * Output feed links.
1577 */
1578 public function outputFeedLinks() {
1579 // nothing by default
1580 }
1581
1582 /**
1583 * Build and output the actual changes list.
1584 *
1585 * @param IResultWrapper $rows Database rows
1586 * @param FormOptions $opts
1587 */
1588 abstract public function outputChangesList( $rows, $opts );
1589
1590 /**
1591 * Set the text to be displayed above the changes
1592 *
1593 * @param FormOptions $opts
1594 * @param int $numRows Number of rows in the result to show after this header
1595 */
1596 public function doHeader( $opts, $numRows ) {
1597 $this->setTopText( $opts );
1598
1599 // @todo Lots of stuff should be done here.
1600
1601 $this->setBottomText( $opts );
1602 }
1603
1604 /**
1605 * Send the text to be displayed before the options.
1606 * Should use $this->getOutput()->addWikiTextAsInterface()
1607 * or similar methods to print the text.
1608 *
1609 * @param FormOptions $opts
1610 */
1611 public function setTopText( FormOptions $opts ) {
1612 // nothing by default
1613 }
1614
1615 /**
1616 * Send the text to be displayed after the options.
1617 * Should use $this->getOutput()->addWikiTextAsInterface()
1618 * or similar methods to print the text.
1619 *
1620 * @param FormOptions $opts
1621 */
1622 public function setBottomText( FormOptions $opts ) {
1623 // nothing by default
1624 }
1625
1626 /**
1627 * Get options to be displayed in a form
1628 * @todo This should handle options returned by getDefaultOptions().
1629 * @todo Not called by anything in this class (but is in subclasses), should be
1630 * called by something… doHeader() maybe?
1631 *
1632 * @param FormOptions $opts
1633 * @return array
1634 */
1635 public function getExtraOptions( $opts ) {
1636 return [];
1637 }
1638
1639 /**
1640 * Return the legend displayed within the fieldset
1641 *
1642 * @return string
1643 */
1644 public function makeLegend() {
1645 $context = $this->getContext();
1646 $user = $context->getUser();
1647 # The legend showing what the letters and stuff mean
1648 $legend = Html::openElement( 'dl' ) . "\n";
1649 # Iterates through them and gets the messages for both letter and tooltip
1650 $legendItems = $context->getConfig()->get( 'RecentChangesFlags' );
1651 if ( !( $user->useRCPatrol() || $user->useNPPatrol() ) ) {
1652 unset( $legendItems['unpatrolled'] );
1653 }
1654 foreach ( $legendItems as $key => $item ) { # generate items of the legend
1655 $label = $item['legend'] ?? $item['title'];
1656 $letter = $item['letter'];
1657 $cssClass = $item['class'] ?? $key;
1658
1659 $legend .= Html::element( 'dt',
1660 [ 'class' => $cssClass ], $context->msg( $letter )->text()
1661 ) . "\n" .
1662 Html::rawElement( 'dd',
1663 [ 'class' => Sanitizer::escapeClass( 'mw-changeslist-legend-' . $key ) ],
1664 $context->msg( $label )->parse()
1665 ) . "\n";
1666 }
1667 # (+-123)
1668 $legend .= Html::rawElement( 'dt',
1669 [ 'class' => 'mw-plusminus-pos' ],
1670 $context->msg( 'recentchanges-legend-plusminus' )->parse()
1671 ) . "\n";
1672 $legend .= Html::element(
1673 'dd',
1674 [ 'class' => 'mw-changeslist-legend-plusminus' ],
1675 $context->msg( 'recentchanges-label-plusminus' )->text()
1676 ) . "\n";
1677 $legend .= Html::closeElement( 'dl' ) . "\n";
1678
1679 $legendHeading = $this->isStructuredFilterUiEnabled() ?
1680 $context->msg( 'rcfilters-legend-heading' )->parse() :
1681 $context->msg( 'recentchanges-legend-heading' )->parse();
1682
1683 # Collapsible
1684 $collapsedState = $this->getRequest()->getCookie( 'changeslist-state' );
1685 $collapsedClass = $collapsedState === 'collapsed' ? ' mw-collapsed' : '';
1686
1687 $legend =
1688 '<div class="mw-changeslist-legend mw-collapsible' . $collapsedClass . '">' .
1689 $legendHeading .
1690 '<div class="mw-collapsible-content">' . $legend . '</div>' .
1691 '</div>';
1692
1693 return $legend;
1694 }
1695
1696 /**
1697 * Add page-specific modules.
1698 */
1699 protected function addModules() {
1700 $out = $this->getOutput();
1701 // Styles and behavior for the legend box (see makeLegend())
1702 $out->addModuleStyles( [
1703 'mediawiki.special.changeslist.legend',
1704 'mediawiki.special.changeslist',
1705 ] );
1706 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
1707
1708 if ( $this->isStructuredFilterUiEnabled() && !$this->including() ) {
1709 $out->addModules( 'mediawiki.rcfilters.filters.ui' );
1710 $out->addModuleStyles( 'mediawiki.rcfilters.filters.base.styles' );
1711 }
1712 }
1713
1714 protected function getGroupName() {
1715 return 'changes';
1716 }
1717
1718 /**
1719 * Filter on users' experience levels; this will not be called if nothing is
1720 * selected.
1721 *
1722 * @param string $specialPageClassName Class name of current special page
1723 * @param IContextSource $context Context, for e.g. user
1724 * @param IDatabase $dbr Database, for addQuotes, makeList, and similar
1725 * @param array &$tables Array of tables; see IDatabase::select $table
1726 * @param array &$fields Array of fields; see IDatabase::select $vars
1727 * @param array &$conds Array of conditions; see IDatabase::select $conds
1728 * @param array &$query_options Array of query options; see IDatabase::select $options
1729 * @param array &$join_conds Array of join conditions; see IDatabase::select $join_conds
1730 * @param array $selectedExpLevels The allowed active values, sorted
1731 * @param int $now Number of seconds since the UNIX epoch, or 0 if not given
1732 * (optional)
1733 */
1734 public function filterOnUserExperienceLevel( $specialPageClassName, $context, $dbr,
1735 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now = 0
1736 ) {
1737 global $wgLearnerEdits,
1738 $wgExperiencedUserEdits,
1739 $wgLearnerMemberSince,
1740 $wgExperiencedUserMemberSince;
1741
1742 $LEVEL_COUNT = 5;
1743
1744 // If all levels are selected, don't filter
1745 if ( count( $selectedExpLevels ) === $LEVEL_COUNT ) {
1746 return;
1747 }
1748
1749 // both 'registered' and 'unregistered', experience levels, if any, are included in 'registered'
1750 if (
1751 in_array( 'registered', $selectedExpLevels ) &&
1752 in_array( 'unregistered', $selectedExpLevels )
1753 ) {
1754 return;
1755 }
1756
1757 $actorMigration = ActorMigration::newMigration();
1758 $actorQuery = $actorMigration->getJoin( 'rc_user' );
1759 $tables += $actorQuery['tables'];
1760 $join_conds += $actorQuery['joins'];
1761
1762 // 'registered' but not 'unregistered', experience levels, if any, are included in 'registered'
1763 if (
1764 in_array( 'registered', $selectedExpLevels ) &&
1765 !in_array( 'unregistered', $selectedExpLevels )
1766 ) {
1767 $conds[] = $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] );
1768 return;
1769 }
1770
1771 if ( $selectedExpLevels === [ 'unregistered' ] ) {
1772 $conds[] = $actorMigration->isAnon( $actorQuery['fields']['rc_user'] );
1773 return;
1774 }
1775
1776 $tables[] = 'user';
1777 $join_conds['user'] = [ 'LEFT JOIN', $actorQuery['fields']['rc_user'] . ' = user_id' ];
1778
1779 if ( $now === 0 ) {
1780 $now = time();
1781 }
1782 $secondsPerDay = 86400;
1783 $learnerCutoff = $now - $wgLearnerMemberSince * $secondsPerDay;
1784 $experiencedUserCutoff = $now - $wgExperiencedUserMemberSince * $secondsPerDay;
1785
1786 $aboveNewcomer = $dbr->makeList(
1787 [
1788 'user_editcount >= ' . intval( $wgLearnerEdits ),
1789 'user_registration <= ' . $dbr->addQuotes( $dbr->timestamp( $learnerCutoff ) ),
1790 ],
1791 IDatabase::LIST_AND
1792 );
1793
1794 $aboveLearner = $dbr->makeList(
1795 [
1796 'user_editcount >= ' . intval( $wgExperiencedUserEdits ),
1797 'user_registration <= ' .
1798 $dbr->addQuotes( $dbr->timestamp( $experiencedUserCutoff ) ),
1799 ],
1800 IDatabase::LIST_AND
1801 );
1802
1803 $conditions = [];
1804
1805 if ( in_array( 'unregistered', $selectedExpLevels ) ) {
1806 $selectedExpLevels = array_diff( $selectedExpLevels, [ 'unregistered' ] );
1807 $conditions[] = $actorMigration->isAnon( $actorQuery['fields']['rc_user'] );
1808 }
1809
1810 if ( $selectedExpLevels === [ 'newcomer' ] ) {
1811 $conditions[] = "NOT ( $aboveNewcomer )";
1812 } elseif ( $selectedExpLevels === [ 'learner' ] ) {
1813 $conditions[] = $dbr->makeList(
1814 [ $aboveNewcomer, "NOT ( $aboveLearner )" ],
1815 IDatabase::LIST_AND
1816 );
1817 } elseif ( $selectedExpLevels === [ 'experienced' ] ) {
1818 $conditions[] = $aboveLearner;
1819 } elseif ( $selectedExpLevels === [ 'learner', 'newcomer' ] ) {
1820 $conditions[] = "NOT ( $aboveLearner )";
1821 } elseif ( $selectedExpLevels === [ 'experienced', 'newcomer' ] ) {
1822 $conditions[] = $dbr->makeList(
1823 [ "NOT ( $aboveNewcomer )", $aboveLearner ],
1824 IDatabase::LIST_OR
1825 );
1826 } elseif ( $selectedExpLevels === [ 'experienced', 'learner' ] ) {
1827 $conditions[] = $aboveNewcomer;
1828 } elseif ( $selectedExpLevels === [ 'experienced', 'learner', 'newcomer' ] ) {
1829 $conditions[] = $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] );
1830 }
1831
1832 if ( count( $conditions ) > 1 ) {
1833 $conds[] = $dbr->makeList( $conditions, IDatabase::LIST_OR );
1834 } elseif ( count( $conditions ) === 1 ) {
1835 $conds[] = reset( $conditions );
1836 }
1837 }
1838
1839 /**
1840 * Check whether the structured filter UI is enabled
1841 *
1842 * @return bool
1843 */
1844 public function isStructuredFilterUiEnabled() {
1845 if ( $this->getRequest()->getBool( 'rcfilters' ) ) {
1846 return true;
1847 }
1848
1849 return static::checkStructuredFilterUiEnabled(
1850 $this->getConfig(),
1851 $this->getUser()
1852 );
1853 }
1854
1855 /**
1856 * Static method to check whether StructuredFilter UI is enabled for the given user
1857 *
1858 * @since 1.31
1859 * @param Config $config
1860 * @param User $user
1861 * @return bool
1862 */
1863 public static function checkStructuredFilterUiEnabled( Config $config, User $user ) {
1864 return !$user->getOption( 'rcenhancedfilters-disable' );
1865 }
1866
1867 /**
1868 * Get the default value of the number of changes to display when loading
1869 * the result set.
1870 *
1871 * @since 1.30
1872 * @return int
1873 */
1874 public function getDefaultLimit() {
1875 return $this->getUser()->getIntOption( static::$limitPreferenceName );
1876 }
1877
1878 /**
1879 * Get the default value of the number of days to display when loading
1880 * the result set.
1881 * Supports fractional values, and should be cast to a float.
1882 *
1883 * @since 1.30
1884 * @return float
1885 */
1886 public function getDefaultDays() {
1887 return floatval( $this->getUser()->getOption( static::$daysPreferenceName ) );
1888 }
1889 }
Wiklou, le Wiki du Wiklou