Use the WebRequest::getCheck() shortcut where possible
[lhc/web/wiklou.git] / includes / specials / SpecialRecentchanges.php
1 <?php
2 /**
3 * Implements Special:Recentchanges
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
24 use MediaWiki\MediaWikiServices;
25 use Wikimedia\Rdbms\IResultWrapper;
26 use Wikimedia\Rdbms\FakeResultWrapper;
27
28 /**
29 * A special page that lists last changes made to the wiki
30 *
31 * @ingroup SpecialPage
32 */
33 class SpecialRecentChanges extends ChangesListSpecialPage {
34
35 protected static $savedQueriesPreferenceName = 'rcfilters-saved-queries';
36 protected static $daysPreferenceName = 'rcdays'; // Use general RecentChanges preference
37 protected static $limitPreferenceName = 'rcfilters-limit'; // Use RCFilters-specific preference
38 protected static $collapsedPreferenceName = 'rcfilters-rc-collapsed';
39
40 private $watchlistFilterGroupDefinition;
41
42 public function __construct( $name = 'Recentchanges', $restriction = '' ) {
43 parent::__construct( $name, $restriction );
44
45 $this->watchlistFilterGroupDefinition = [
46 'name' => 'watchlist',
47 'title' => 'rcfilters-filtergroup-watchlist',
48 'class' => ChangesListStringOptionsFilterGroup::class,
49 'priority' => -9,
50 'isFullCoverage' => true,
51 'filters' => [
52 [
53 'name' => 'watched',
54 'label' => 'rcfilters-filter-watchlist-watched-label',
55 'description' => 'rcfilters-filter-watchlist-watched-description',
56 'cssClassSuffix' => 'watched',
57 'isRowApplicableCallable' => function ( $ctx, $rc ) {
58 return $rc->getAttribute( 'wl_user' );
59 }
60 ],
61 [
62 'name' => 'watchednew',
63 'label' => 'rcfilters-filter-watchlist-watchednew-label',
64 'description' => 'rcfilters-filter-watchlist-watchednew-description',
65 'cssClassSuffix' => 'watchednew',
66 'isRowApplicableCallable' => function ( $ctx, $rc ) {
67 return $rc->getAttribute( 'wl_user' ) &&
68 $rc->getAttribute( 'rc_timestamp' ) &&
69 $rc->getAttribute( 'wl_notificationtimestamp' ) &&
70 $rc->getAttribute( 'rc_timestamp' ) >= $rc->getAttribute( 'wl_notificationtimestamp' );
71 },
72 ],
73 [
74 'name' => 'notwatched',
75 'label' => 'rcfilters-filter-watchlist-notwatched-label',
76 'description' => 'rcfilters-filter-watchlist-notwatched-description',
77 'cssClassSuffix' => 'notwatched',
78 'isRowApplicableCallable' => function ( $ctx, $rc ) {
79 return $rc->getAttribute( 'wl_user' ) === null;
80 },
81 ]
82 ],
83 'default' => ChangesListStringOptionsFilterGroup::NONE,
84 'queryCallable' => function ( $specialPageClassName, $context, $dbr,
85 &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedValues ) {
86 sort( $selectedValues );
87 $notwatchedCond = 'wl_user IS NULL';
88 $watchedCond = 'wl_user IS NOT NULL';
89 $newCond = 'rc_timestamp >= wl_notificationtimestamp';
90
91 if ( $selectedValues === [ 'notwatched' ] ) {
92 $conds[] = $notwatchedCond;
93 return;
94 }
95
96 if ( $selectedValues === [ 'watched' ] ) {
97 $conds[] = $watchedCond;
98 return;
99 }
100
101 if ( $selectedValues === [ 'watchednew' ] ) {
102 $conds[] = $dbr->makeList( [
103 $watchedCond,
104 $newCond
105 ], LIST_AND );
106 return;
107 }
108
109 if ( $selectedValues === [ 'notwatched', 'watched' ] ) {
110 // no filters
111 return;
112 }
113
114 if ( $selectedValues === [ 'notwatched', 'watchednew' ] ) {
115 $conds[] = $dbr->makeList( [
116 $notwatchedCond,
117 $dbr->makeList( [
118 $watchedCond,
119 $newCond
120 ], LIST_AND )
121 ], LIST_OR );
122 return;
123 }
124
125 if ( $selectedValues === [ 'watched', 'watchednew' ] ) {
126 $conds[] = $watchedCond;
127 return;
128 }
129
130 if ( $selectedValues === [ 'notwatched', 'watched', 'watchednew' ] ) {
131 // no filters
132 return;
133 }
134 }
135 ];
136 }
137
138 /**
139 * Main execution point
140 *
141 * @param string $subpage
142 */
143 public function execute( $subpage ) {
144 // Backwards-compatibility: redirect to new feed URLs
145 $feedFormat = $this->getRequest()->getVal( 'feed' );
146 if ( !$this->including() && $feedFormat ) {
147 $query = $this->getFeedQuery();
148 $query['feedformat'] = $feedFormat === 'atom' ? 'atom' : 'rss';
149 $this->getOutput()->redirect( wfAppendQuery( wfScript( 'api' ), $query ) );
150
151 return;
152 }
153
154 // 10 seconds server-side caching max
155 $out = $this->getOutput();
156 $out->setCdnMaxage( 10 );
157 // Check if the client has a cached version
158 $lastmod = $this->checkLastModified();
159 if ( $lastmod === false ) {
160 return;
161 }
162
163 $this->addHelpLink(
164 '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Recent_changes',
165 true
166 );
167 parent::execute( $subpage );
168 }
169
170 /**
171 * @inheritDoc
172 */
173 protected function transformFilterDefinition( array $filterDefinition ) {
174 if ( isset( $filterDefinition['showHideSuffix'] ) ) {
175 $filterDefinition['showHide'] = 'rc' . $filterDefinition['showHideSuffix'];
176 }
177
178 return $filterDefinition;
179 }
180
181 /**
182 * @inheritDoc
183 */
184 protected function registerFilters() {
185 parent::registerFilters();
186
187 if (
188 !$this->including() &&
189 $this->getUser()->isLoggedIn() &&
190 $this->getUser()->isAllowed( 'viewmywatchlist' )
191 ) {
192 $this->registerFiltersFromDefinitions( [ $this->watchlistFilterGroupDefinition ] );
193 $watchlistGroup = $this->getFilterGroup( 'watchlist' );
194 $watchlistGroup->getFilter( 'watched' )->setAsSupersetOf(
195 $watchlistGroup->getFilter( 'watchednew' )
196 );
197 }
198
199 $user = $this->getUser();
200
201 $significance = $this->getFilterGroup( 'significance' );
202 $hideMinor = $significance->getFilter( 'hideminor' );
203 $hideMinor->setDefault( $user->getBoolOption( 'hideminor' ) );
204
205 $automated = $this->getFilterGroup( 'automated' );
206 $hideBots = $automated->getFilter( 'hidebots' );
207 $hideBots->setDefault( true );
208
209 $reviewStatus = $this->getFilterGroup( 'reviewStatus' );
210 if ( $reviewStatus !== null ) {
211 // Conditional on feature being available and rights
212 if ( $user->getBoolOption( 'hidepatrolled' ) ) {
213 $reviewStatus->setDefault( 'unpatrolled' );
214 $legacyReviewStatus = $this->getFilterGroup( 'legacyReviewStatus' );
215 $legacyHidePatrolled = $legacyReviewStatus->getFilter( 'hidepatrolled' );
216 $legacyHidePatrolled->setDefault( true );
217 }
218 }
219
220 $changeType = $this->getFilterGroup( 'changeType' );
221 $hideCategorization = $changeType->getFilter( 'hidecategorization' );
222 if ( $hideCategorization !== null ) {
223 // Conditional on feature being available
224 $hideCategorization->setDefault( $user->getBoolOption( 'hidecategorization' ) );
225 }
226 }
227
228 /**
229 * Process $par and put options found in $opts. Used when including the page.
230 *
231 * @param string $par
232 * @param FormOptions $opts
233 */
234 public function parseParameters( $par, FormOptions $opts ) {
235 parent::parseParameters( $par, $opts );
236
237 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
238 foreach ( $bits as $bit ) {
239 if ( is_numeric( $bit ) ) {
240 $opts['limit'] = $bit;
241 }
242
243 $m = [];
244 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
245 $opts['limit'] = $m[1];
246 }
247 if ( preg_match( '/^days=(\d+(?:\.\d+)?)$/', $bit, $m ) ) {
248 $opts['days'] = $m[1];
249 }
250 if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
251 $opts['namespace'] = $m[1];
252 }
253 if ( preg_match( '/^tagfilter=(.*)$/', $bit, $m ) ) {
254 $opts['tagfilter'] = $m[1];
255 }
256 }
257 }
258
259 /**
260 * @inheritDoc
261 */
262 protected function doMainQuery( $tables, $fields, $conds, $query_options,
263 $join_conds, FormOptions $opts
264 ) {
265 $dbr = $this->getDB();
266 $user = $this->getUser();
267
268 $rcQuery = RecentChange::getQueryInfo();
269 $tables = array_merge( $tables, $rcQuery['tables'] );
270 $fields = array_merge( $rcQuery['fields'], $fields );
271 $join_conds = array_merge( $join_conds, $rcQuery['joins'] );
272
273 // JOIN on watchlist for users
274 if ( $user->isLoggedIn() && $user->isAllowed( 'viewmywatchlist' ) ) {
275 $tables[] = 'watchlist';
276 $fields[] = 'wl_user';
277 $fields[] = 'wl_notificationtimestamp';
278 $join_conds['watchlist'] = [ 'LEFT JOIN', [
279 'wl_user' => $user->getId(),
280 'wl_title=rc_title',
281 'wl_namespace=rc_namespace'
282 ] ];
283 }
284
285 // JOIN on page, used for 'last revision' filter highlight
286 $tables[] = 'page';
287 $fields[] = 'page_latest';
288 $join_conds['page'] = [ 'LEFT JOIN', 'rc_cur_id=page_id' ];
289
290 $tagFilter = $opts['tagfilter'] ? explode( '|', $opts['tagfilter'] ) : [];
291 ChangeTags::modifyDisplayQuery(
292 $tables,
293 $fields,
294 $conds,
295 $join_conds,
296 $query_options,
297 $tagFilter
298 );
299
300 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
301 $opts )
302 ) {
303 return false;
304 }
305
306 if ( $this->areFiltersInConflict() ) {
307 return false;
308 }
309
310 $orderByAndLimit = [
311 'ORDER BY' => 'rc_timestamp DESC',
312 'LIMIT' => $opts['limit']
313 ];
314 if ( in_array( 'DISTINCT', $query_options ) ) {
315 // ChangeTags::modifyDisplayQuery() adds DISTINCT when filtering on multiple tags.
316 // In order to prevent DISTINCT from causing query performance problems,
317 // we have to GROUP BY the primary key. This in turn requires us to add
318 // the primary key to the end of the ORDER BY, and the old ORDER BY to the
319 // start of the GROUP BY
320 $orderByAndLimit['ORDER BY'] = 'rc_timestamp DESC, rc_id DESC';
321 $orderByAndLimit['GROUP BY'] = 'rc_timestamp, rc_id';
322 }
323 // array_merge() is used intentionally here so that hooks can, should
324 // they so desire, override the ORDER BY / LIMIT condition(s); prior to
325 // MediaWiki 1.26 this used to use the plus operator instead, which meant
326 // that extensions weren't able to change these conditions
327 $query_options = array_merge( $orderByAndLimit, $query_options );
328 $rows = $dbr->select(
329 $tables,
330 $fields,
331 // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
332 // knowledge to use an index merge if it wants (it may use some other index though).
333 $conds + [ 'rc_new' => [ 0, 1 ] ],
334 __METHOD__,
335 $query_options,
336 $join_conds
337 );
338
339 return $rows;
340 }
341
342 protected function getDB() {
343 return wfGetDB( DB_REPLICA, 'recentchanges' );
344 }
345
346 public function outputFeedLinks() {
347 $this->addFeedLinks( $this->getFeedQuery() );
348 }
349
350 /**
351 * Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.
352 *
353 * @return array
354 */
355 protected function getFeedQuery() {
356 $query = array_filter( $this->getOptions()->getAllValues(), function ( $value ) {
357 // API handles empty parameters in a different way
358 return $value !== '';
359 } );
360 $query['action'] = 'feedrecentchanges';
361 $feedLimit = $this->getConfig()->get( 'FeedLimit' );
362 if ( $query['limit'] > $feedLimit ) {
363 $query['limit'] = $feedLimit;
364 }
365
366 return $query;
367 }
368
369 /**
370 * Build and output the actual changes list.
371 *
372 * @param IResultWrapper $rows Database rows
373 * @param FormOptions $opts
374 */
375 public function outputChangesList( $rows, $opts ) {
376 $limit = $opts['limit'];
377
378 $showWatcherCount = $this->getConfig()->get( 'RCShowWatchingUsers' )
379 && $this->getUser()->getOption( 'shownumberswatching' );
380 $watcherCache = [];
381
382 $counter = 1;
383 $list = ChangesList::newFromContext( $this->getContext(), $this->filterGroups );
384 $list->initChangesListRows( $rows );
385
386 $userShowHiddenCats = $this->getUser()->getBoolOption( 'showhiddencats' );
387 $rclistOutput = $list->beginRecentChangesList();
388 if ( $this->isStructuredFilterUiEnabled() ) {
389 $rclistOutput .= $this->makeLegend();
390 }
391
392 foreach ( $rows as $obj ) {
393 if ( $limit == 0 ) {
394 break;
395 }
396 $rc = RecentChange::newFromRow( $obj );
397
398 # Skip CatWatch entries for hidden cats based on user preference
399 if (
400 $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE &&
401 !$userShowHiddenCats &&
402 $rc->getParam( 'hidden-cat' )
403 ) {
404 continue;
405 }
406
407 $rc->counter = $counter++;
408 # Check if the page has been updated since the last visit
409 if ( $this->getConfig()->get( 'ShowUpdatedMarker' )
410 && !empty( $obj->wl_notificationtimestamp )
411 ) {
412 $rc->notificationtimestamp = ( $obj->rc_timestamp >= $obj->wl_notificationtimestamp );
413 } else {
414 $rc->notificationtimestamp = false; // Default
415 }
416 # Check the number of users watching the page
417 $rc->numberofWatchingusers = 0; // Default
418 if ( $showWatcherCount && $obj->rc_namespace >= 0 ) {
419 if ( !isset( $watcherCache[$obj->rc_namespace][$obj->rc_title] ) ) {
420 $watcherCache[$obj->rc_namespace][$obj->rc_title] =
421 MediaWikiServices::getInstance()->getWatchedItemStore()->countWatchers(
422 new TitleValue( (int)$obj->rc_namespace, $obj->rc_title )
423 );
424 }
425 $rc->numberofWatchingusers = $watcherCache[$obj->rc_namespace][$obj->rc_title];
426 }
427
428 $changeLine = $list->recentChangesLine( $rc, !empty( $obj->wl_user ), $counter );
429 if ( $changeLine !== false ) {
430 $rclistOutput .= $changeLine;
431 --$limit;
432 }
433 }
434 $rclistOutput .= $list->endRecentChangesList();
435
436 if ( $rows->numRows() === 0 ) {
437 $this->outputNoResults();
438 if ( !$this->including() ) {
439 $this->getOutput()->setStatusCode( 404 );
440 }
441 } else {
442 $this->getOutput()->addHTML( $rclistOutput );
443 }
444 }
445
446 /**
447 * Set the text to be displayed above the changes
448 *
449 * @param FormOptions $opts
450 * @param int $numRows Number of rows in the result to show after this header
451 */
452 public function doHeader( $opts, $numRows ) {
453 $this->setTopText( $opts );
454
455 $defaults = $opts->getAllValues();
456 $nondefaults = $opts->getChangedValues();
457
458 $panel = [];
459 if ( !$this->isStructuredFilterUiEnabled() ) {
460 $panel[] = $this->makeLegend();
461 }
462 $panel[] = $this->optionsPanel( $defaults, $nondefaults, $numRows );
463 $panel[] = '<hr />';
464
465 $extraOpts = $this->getExtraOptions( $opts );
466 $extraOptsCount = count( $extraOpts );
467 $count = 0;
468 $submit = ' ' . Xml::submitButton( $this->msg( 'recentchanges-submit' )->text() );
469
470 $out = Xml::openElement( 'table', [ 'class' => 'mw-recentchanges-table' ] );
471 foreach ( $extraOpts as $name => $optionRow ) {
472 # Add submit button to the last row only
473 ++$count;
474 $addSubmit = ( $count === $extraOptsCount ) ? $submit : '';
475
476 $out .= Xml::openElement( 'tr', [ 'class' => $name . 'Form' ] );
477 if ( is_array( $optionRow ) ) {
478 $out .= Xml::tags(
479 'td',
480 [ 'class' => 'mw-label mw-' . $name . '-label' ],
481 $optionRow[0]
482 );
483 $out .= Xml::tags(
484 'td',
485 [ 'class' => 'mw-input' ],
486 $optionRow[1] . $addSubmit
487 );
488 } else {
489 $out .= Xml::tags(
490 'td',
491 [ 'class' => 'mw-input', 'colspan' => 2 ],
492 $optionRow . $addSubmit
493 );
494 }
495 $out .= Xml::closeElement( 'tr' );
496 }
497 $out .= Xml::closeElement( 'table' );
498
499 $unconsumed = $opts->getUnconsumedValues();
500 foreach ( $unconsumed as $key => $value ) {
501 $out .= Html::hidden( $key, $value );
502 }
503
504 $t = $this->getPageTitle();
505 $out .= Html::hidden( 'title', $t->getPrefixedText() );
506 $form = Xml::tags( 'form', [ 'action' => wfScript() ], $out );
507 $panel[] = $form;
508 $panelString = implode( "\n", $panel );
509
510 $rcoptions = Xml::fieldset(
511 $this->msg( 'recentchanges-legend' )->text(),
512 $panelString,
513 [ 'class' => 'rcoptions cloptions' ]
514 );
515
516 // Insert a placeholder for RCFilters
517 if ( $this->isStructuredFilterUiEnabled() ) {
518 $rcfilterContainer = Html::element(
519 'div',
520 [ 'class' => 'rcfilters-container' ]
521 );
522
523 $loadingContainer = Html::rawElement(
524 'div',
525 [ 'class' => 'rcfilters-spinner' ],
526 Html::element(
527 'div',
528 [ 'class' => 'rcfilters-spinner-bounce' ]
529 )
530 );
531
532 // Wrap both with rcfilters-head
533 $this->getOutput()->addHTML(
534 Html::rawElement(
535 'div',
536 [ 'class' => 'rcfilters-head' ],
537 $rcfilterContainer . $rcoptions
538 )
539 );
540
541 // Add spinner
542 $this->getOutput()->addHTML( $loadingContainer );
543 } else {
544 $this->getOutput()->addHTML( $rcoptions );
545 }
546
547 $this->setBottomText( $opts );
548 }
549
550 /**
551 * Send the text to be displayed above the options
552 *
553 * @param FormOptions $opts Unused
554 */
555 function setTopText( FormOptions $opts ) {
556 $message = $this->msg( 'recentchangestext' )->inContentLanguage();
557 if ( !$message->isDisabled() ) {
558 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
559 // Parse the message in this weird ugly way to preserve the ability to include interlanguage
560 // links in it (T172461). In the future when T66969 is resolved, perhaps we can just use
561 // $message->parse() instead. This code is copied from Message::parseText().
562 $parserOutput = MessageCache::singleton()->parse(
563 $message->plain(),
564 $this->getPageTitle(),
565 /*linestart*/true,
566 // Message class sets the interface flag to false when parsing in a language different than
567 // user language, and this is wiki content language
568 /*interface*/false,
569 $contLang
570 );
571 $content = $parserOutput->getText( [
572 'enableSectionEditLinks' => false,
573 ] );
574 // Add only metadata here (including the language links), text is added below
575 $this->getOutput()->addParserOutputMetadata( $parserOutput );
576
577 $langAttributes = [
578 'lang' => $contLang->getHtmlCode(),
579 'dir' => $contLang->getDir(),
580 ];
581
582 $topLinksAttributes = [ 'class' => 'mw-recentchanges-toplinks' ];
583
584 if ( $this->isStructuredFilterUiEnabled() ) {
585 // Check whether the widget is already collapsed or expanded
586 $collapsedState = $this->getRequest()->getCookie( 'rcfilters-toplinks-collapsed-state' );
587 // Note that an empty/unset cookie means collapsed, so check for !== 'expanded'
588 $topLinksAttributes[ 'class' ] .= $collapsedState !== 'expanded' ?
589 ' mw-recentchanges-toplinks-collapsed' : '';
590
591 $this->getOutput()->enableOOUI();
592 $contentTitle = new OOUI\ButtonWidget( [
593 'classes' => [ 'mw-recentchanges-toplinks-title' ],
594 'label' => new OOUI\HtmlSnippet( $this->msg( 'rcfilters-other-review-tools' )->parse() ),
595 'framed' => false,
596 'indicator' => $collapsedState !== 'expanded' ? 'down' : 'up',
597 'flags' => [ 'progressive' ],
598 ] );
599
600 $contentWrapper = Html::rawElement( 'div',
601 array_merge(
602 [ 'class' => 'mw-recentchanges-toplinks-content mw-collapsible-content' ],
603 $langAttributes
604 ),
605 $content
606 );
607 $content = $contentTitle . $contentWrapper;
608 } else {
609 // Language direction should be on the top div only
610 // if the title is not there. If it is there, it's
611 // interface direction, and the language/dir attributes
612 // should be on the content itself
613 $topLinksAttributes = array_merge( $topLinksAttributes, $langAttributes );
614 }
615
616 $this->getOutput()->addHTML(
617 Html::rawElement( 'div', $topLinksAttributes, $content )
618 );
619 }
620 }
621
622 /**
623 * Get options to be displayed in a form
624 *
625 * @param FormOptions $opts
626 * @return array
627 */
628 function getExtraOptions( $opts ) {
629 $opts->consumeValues( [
630 'namespace', 'invert', 'associated', 'tagfilter'
631 ] );
632
633 $extraOpts = [];
634 $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );
635
636 $tagFilter = ChangeTags::buildTagFilterSelector(
637 $opts['tagfilter'], false, $this->getContext() );
638 if ( count( $tagFilter ) ) {
639 $extraOpts['tagfilter'] = $tagFilter;
640 }
641
642 // Don't fire the hook for subclasses. (Or should we?)
643 if ( $this->getName() === 'Recentchanges' ) {
644 Hooks::run( 'SpecialRecentChangesPanel', [ &$extraOpts, $opts ] );
645 }
646
647 return $extraOpts;
648 }
649
650 /**
651 * Add page-specific modules.
652 */
653 protected function addModules() {
654 parent::addModules();
655 $out = $this->getOutput();
656 $out->addModules( 'mediawiki.special.recentchanges' );
657 }
658
659 /**
660 * Get last modified date, for client caching
661 * Don't use this if we are using the patrol feature, patrol changes don't
662 * update the timestamp
663 *
664 * @return string|bool
665 */
666 public function checkLastModified() {
667 $dbr = $this->getDB();
668 $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', '', __METHOD__ );
669
670 return $lastmod;
671 }
672
673 /**
674 * Creates the choose namespace selection
675 *
676 * @param FormOptions $opts
677 * @return string[]
678 */
679 protected function namespaceFilterForm( FormOptions $opts ) {
680 $nsSelect = Html::namespaceSelector(
681 [ 'selected' => $opts['namespace'], 'all' => '', 'in-user-lang' => true ],
682 [ 'name' => 'namespace', 'id' => 'namespace' ]
683 );
684 $nsLabel = Xml::label( $this->msg( 'namespace' )->text(), 'namespace' );
685 $attribs = [ 'class' => [ 'mw-input-with-label' ] ];
686 // Hide the checkboxes when the namespace filter is set to 'all'.
687 if ( $opts['namespace'] === '' ) {
688 $attribs['class'][] = 'mw-input-hidden';
689 }
690 $invert = Html::rawElement( 'span', $attribs, Xml::checkLabel(
691 $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
692 $opts['invert'],
693 [ 'title' => $this->msg( 'tooltip-invert' )->text() ]
694 ) );
695 $associated = Html::rawElement( 'span', $attribs, Xml::checkLabel(
696 $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
697 $opts['associated'],
698 [ 'title' => $this->msg( 'tooltip-namespace_association' )->text() ]
699 ) );
700
701 return [ $nsLabel, "$nsSelect $invert $associated" ];
702 }
703
704 /**
705 * Filter $rows by categories set in $opts
706 *
707 * @deprecated since 1.31
708 *
709 * @param IResultWrapper &$rows Database rows
710 * @param FormOptions $opts
711 */
712 function filterByCategories( &$rows, FormOptions $opts ) {
713 wfDeprecated( __METHOD__, '1.31' );
714
715 $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );
716
717 if ( $categories === [] ) {
718 return;
719 }
720
721 # Filter categories
722 $cats = [];
723 foreach ( $categories as $cat ) {
724 $cat = trim( $cat );
725 if ( $cat == '' ) {
726 continue;
727 }
728 $cats[] = $cat;
729 }
730
731 # Filter articles
732 $articles = [];
733 $a2r = [];
734 $rowsarr = [];
735 foreach ( $rows as $k => $r ) {
736 $nt = Title::makeTitle( $r->rc_namespace, $r->rc_title );
737 $id = $nt->getArticleID();
738 if ( $id == 0 ) {
739 continue; # Page might have been deleted...
740 }
741 if ( !in_array( $id, $articles ) ) {
742 $articles[] = $id;
743 }
744 if ( !isset( $a2r[$id] ) ) {
745 $a2r[$id] = [];
746 }
747 $a2r[$id][] = $k;
748 $rowsarr[$k] = $r;
749 }
750
751 # Shortcut?
752 if ( $articles === [] || $cats === [] ) {
753 return;
754 }
755
756 # Look up
757 $catFind = new CategoryFinder;
758 $catFind->seed( $articles, $cats, $opts['categories_any'] ? 'OR' : 'AND' );
759 $match = $catFind->run();
760
761 # Filter
762 $newrows = [];
763 foreach ( $match as $id ) {
764 foreach ( $a2r[$id] as $rev ) {
765 $k = $rev;
766 $newrows[$k] = $rowsarr[$k];
767 }
768 }
769 $rows = new FakeResultWrapper( array_values( $newrows ) );
770 }
771
772 /**
773 * Makes change an option link which carries all the other options
774 *
775 * @param string $title
776 * @param array $override Options to override
777 * @param array $options Current options
778 * @param bool $active Whether to show the link in bold
779 * @return string
780 */
781 function makeOptionsLink( $title, $override, $options, $active = false ) {
782 $params = $this->convertParamsForLink( $override + $options );
783
784 if ( $active ) {
785 $title = new HtmlArmor( '<strong>' . htmlspecialchars( $title ) . '</strong>' );
786 }
787
788 return $this->getLinkRenderer()->makeKnownLink( $this->getPageTitle(), $title, [
789 'data-params' => json_encode( $override ),
790 'data-keys' => implode( ',', array_keys( $override ) ),
791 ], $params );
792 }
793
794 /**
795 * Creates the options panel.
796 *
797 * @param array $defaults
798 * @param array $nondefaults
799 * @param int $numRows Number of rows in the result to show after this header
800 * @return string
801 */
802 function optionsPanel( $defaults, $nondefaults, $numRows ) {
803 $options = $nondefaults + $defaults;
804
805 $note = '';
806 $msg = $this->msg( 'rclegend' );
807 if ( !$msg->isDisabled() ) {
808 $note .= Html::rawElement(
809 'div',
810 [ 'class' => 'mw-rclegend' ],
811 $msg->parse()
812 );
813 }
814
815 $lang = $this->getLanguage();
816 $user = $this->getUser();
817 $config = $this->getConfig();
818 if ( $options['from'] ) {
819 $resetLink = $this->makeOptionsLink( $this->msg( 'rclistfromreset' ),
820 [ 'from' => '' ], $nondefaults );
821
822 $noteFromMsg = $this->msg( 'rcnotefrom' )
823 ->numParams( $options['limit'] )
824 ->params(
825 $lang->userTimeAndDate( $options['from'], $user ),
826 $lang->userDate( $options['from'], $user ),
827 $lang->userTime( $options['from'], $user )
828 )
829 ->numParams( $numRows );
830 $note .= Html::rawElement(
831 'span',
832 [ 'class' => 'rcnotefrom' ],
833 $noteFromMsg->parse()
834 ) .
835 ' ' .
836 Html::rawElement(
837 'span',
838 [ 'class' => 'rcoptions-listfromreset' ],
839 $this->msg( 'parentheses' )->rawParams( $resetLink )->parse()
840 ) .
841 '<br />';
842 }
843
844 # Sort data for display and make sure it's unique after we've added user data.
845 $linkLimits = $config->get( 'RCLinkLimits' );
846 $linkLimits[] = $options['limit'];
847 sort( $linkLimits );
848 $linkLimits = array_unique( $linkLimits );
849
850 $linkDays = $config->get( 'RCLinkDays' );
851 $linkDays[] = $options['days'];
852 sort( $linkDays );
853 $linkDays = array_unique( $linkDays );
854
855 // limit links
856 $cl = [];
857 foreach ( $linkLimits as $value ) {
858 $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
859 [ 'limit' => $value ], $nondefaults, $value == $options['limit'] );
860 }
861 $cl = $lang->pipeList( $cl );
862
863 // day links, reset 'from' to none
864 $dl = [];
865 foreach ( $linkDays as $value ) {
866 $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
867 [ 'days' => $value, 'from' => '' ], $nondefaults, $value == $options['days'] );
868 }
869 $dl = $lang->pipeList( $dl );
870
871 $showhide = [ 'show', 'hide' ];
872
873 $links = [];
874
875 foreach ( $this->getLegacyShowHideFilters() as $key => $filter ) {
876 $msg = $filter->getShowHide();
877 $linkMessage = $this->msg( $msg . '-' . $showhide[1 - $options[$key]] );
878 // Extensions can define additional filters, but don't need to define the corresponding
879 // messages. If they don't exist, just fall back to 'show' and 'hide'.
880 if ( !$linkMessage->exists() ) {
881 $linkMessage = $this->msg( $showhide[1 - $options[$key]] );
882 }
883
884 $link = $this->makeOptionsLink( $linkMessage->text(),
885 [ $key => 1 - $options[$key] ], $nondefaults );
886
887 $attribs = [
888 'class' => "$msg rcshowhideoption clshowhideoption",
889 'data-filter-name' => $filter->getName(),
890 ];
891
892 if ( $filter->isFeatureAvailableOnStructuredUi( $this ) ) {
893 $attribs['data-feature-in-structured-ui'] = true;
894 }
895
896 $links[] = Html::rawElement(
897 'span',
898 $attribs,
899 $this->msg( $msg )->rawParams( $link )->parse()
900 );
901 }
902
903 // show from this onward link
904 $timestamp = wfTimestampNow();
905 $now = $lang->userTimeAndDate( $timestamp, $user );
906 $timenow = $lang->userTime( $timestamp, $user );
907 $datenow = $lang->userDate( $timestamp, $user );
908 $pipedLinks = '<span class="rcshowhide">' . $lang->pipeList( $links ) . '</span>';
909
910 $rclinks = Html::rawElement(
911 'span',
912 [ 'class' => 'rclinks' ],
913 $this->msg( 'rclinks' )->rawParams( $cl, $dl, '' )->parse()
914 );
915
916 $rclistfrom = Html::rawElement(
917 'span',
918 [ 'class' => 'rclistfrom' ],
919 $this->makeOptionsLink(
920 $this->msg( 'rclistfrom' )->plaintextParams( $now, $timenow, $datenow )->parse(),
921 [ 'from' => $timestamp ],
922 $nondefaults
923 )
924 );
925
926 return "{$note}$rclinks<br />$pipedLinks<br />$rclistfrom";
927 }
928
929 public function isIncludable() {
930 return true;
931 }
932
933 protected function getCacheTTL() {
934 return 60 * 5;
935 }
936
937 public function getDefaultLimit() {
938 $systemPrefValue = $this->getUser()->getIntOption( 'rclimit' );
939 // Prefer the RCFilters-specific preference if RCFilters is enabled
940 if ( $this->isStructuredFilterUiEnabled() ) {
941 return $this->getUser()->getIntOption( static::$limitPreferenceName, $systemPrefValue );
942 }
943
944 // Otherwise, use the system rclimit preference value
945 return $systemPrefValue;
946 }
947 }