3 * Implements Special:Recentchanges
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.
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.
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
21 * @ingroup SpecialPage
25 * A special page that lists last changes made to the wiki
27 * @ingroup SpecialPage
29 class SpecialRecentChanges
extends ChangesListSpecialPage
{
30 // @codingStandardsIgnoreStart Needed "useless" override to change parameters.
31 public function __construct( $name = 'Recentchanges', $restriction = '' ) {
32 parent
::__construct( $name, $restriction );
34 // @codingStandardsIgnoreEnd
37 * Main execution point
39 * @param string $subpage
41 public function execute( $subpage ) {
42 // Backwards-compatibility: redirect to new feed URLs
43 $feedFormat = $this->getRequest()->getVal( 'feed' );
44 if ( !$this->including() && $feedFormat ) {
45 $query = $this->getFeedQuery();
46 $query['feedformat'] = $feedFormat === 'atom' ?
'atom' : 'rss';
47 $this->getOutput()->redirect( wfAppendQuery( wfScript( 'api' ), $query ) );
52 // 10 seconds server-side caching max
53 $this->getOutput()->setSquidMaxage( 10 );
54 // Check if the client has a cached version
55 $lastmod = $this->checkLastModified();
56 if ( $lastmod === false ) {
60 parent
::execute( $subpage );
64 * Get a FormOptions object containing the default options
68 public function getDefaultOptions() {
69 $opts = parent
::getDefaultOptions();
70 $user = $this->getUser();
72 $opts->add( 'days', $user->getIntOption( 'rcdays' ) );
73 $opts->add( 'limit', $user->getIntOption( 'rclimit' ) );
74 $opts->add( 'from', '' );
76 $opts->add( 'hideminor', $user->getBoolOption( 'hideminor' ) );
77 $opts->add( 'hidebots', true );
78 $opts->add( 'hideanons', false );
79 $opts->add( 'hideliu', false );
80 $opts->add( 'hidepatrolled', $user->getBoolOption( 'hidepatrolled' ) );
81 $opts->add( 'hidemyself', false );
83 $opts->add( 'categories', '' );
84 $opts->add( 'categories_any', false );
85 $opts->add( 'tagfilter', '' );
91 * Get custom show/hide filters
93 * @return array Map of filter URL param names to properties (msg/default)
95 protected function getCustomFilters() {
96 if ( $this->customFilters
=== null ) {
97 $this->customFilters
= parent
::getCustomFilters();
98 Hooks
::run( 'SpecialRecentChangesFilters', array( $this, &$this->customFilters
), '1.23' );
101 return $this->customFilters
;
105 * Process $par and put options found in $opts. Used when including the page.
108 * @param FormOptions $opts
110 public function parseParameters( $par, FormOptions
$opts ) {
111 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
112 foreach ( $bits as $bit ) {
113 if ( 'hidebots' === $bit ) {
114 $opts['hidebots'] = true;
116 if ( 'bots' === $bit ) {
117 $opts['hidebots'] = false;
119 if ( 'hideminor' === $bit ) {
120 $opts['hideminor'] = true;
122 if ( 'minor' === $bit ) {
123 $opts['hideminor'] = false;
125 if ( 'hideliu' === $bit ) {
126 $opts['hideliu'] = true;
128 if ( 'hidepatrolled' === $bit ) {
129 $opts['hidepatrolled'] = true;
131 if ( 'hideanons' === $bit ) {
132 $opts['hideanons'] = true;
134 if ( 'hidemyself' === $bit ) {
135 $opts['hidemyself'] = true;
138 if ( is_numeric( $bit ) ) {
139 $opts['limit'] = $bit;
143 if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
144 $opts['limit'] = $m[1];
146 if ( preg_match( '/^days=(\d+)$/', $bit, $m ) ) {
147 $opts['days'] = $m[1];
149 if ( preg_match( '/^namespace=(\d+)$/', $bit, $m ) ) {
150 $opts['namespace'] = $m[1];
155 public function validateOptions( FormOptions
$opts ) {
156 $opts->validateIntBounds( 'limit', 0, 5000 );
157 parent
::validateOptions( $opts );
161 * Return an array of conditions depending of options set in $opts
163 * @param FormOptions $opts
166 public function buildMainQueryConds( FormOptions
$opts ) {
167 $dbr = $this->getDB();
168 $conds = parent
::buildMainQueryConds( $opts );
171 $cutoff_unixtime = time() - ( $opts['days'] * 86400 );
172 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime %
86400 );
173 $cutoff = $dbr->timestamp( $cutoff_unixtime );
175 $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
176 if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW
, $cutoff ) ) {
177 $cutoff = $dbr->timestamp( $opts['from'] );
179 $opts->reset( 'from' );
182 $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );
190 * @param array $conds
191 * @param FormOptions $opts
192 * @return bool|ResultWrapper Result or false (for Recentchangeslinked only)
194 public function doMainQuery( $conds, $opts ) {
195 $dbr = $this->getDB();
196 $user = $this->getUser();
198 $tables = array( 'recentchanges' );
199 $fields = RecentChange
::selectFields();
200 $query_options = array();
201 $join_conds = array();
203 // JOIN on watchlist for users
204 if ( $user->getId() && $user->isAllowed( 'viewmywatchlist' ) ) {
205 $tables[] = 'watchlist';
206 $fields[] = 'wl_user';
207 $fields[] = 'wl_notificationtimestamp';
208 $join_conds['watchlist'] = array( 'LEFT JOIN', array(
209 'wl_user' => $user->getId(),
211 'wl_namespace=rc_namespace'
215 if ( $user->isAllowed( 'rollback' ) ) {
217 $fields[] = 'page_latest';
218 $join_conds['page'] = array( 'LEFT JOIN', 'rc_cur_id=page_id' );
221 ChangeTags
::modifyDisplayQuery(
230 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
236 // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
237 // knowledge to use an index merge if it wants (it may use some other index though).
238 $rows = $dbr->select(
241 $conds +
array( 'rc_new' => array( 0, 1 ) ),
243 array( 'ORDER BY' => 'rc_timestamp DESC', 'LIMIT' => $opts['limit'] ) +
$query_options,
247 // Build the final data
248 if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
249 $this->filterByCategories( $rows, $opts );
255 protected function runMainQueryHook( &$tables, &$fields, &$conds,
256 &$query_options, &$join_conds, $opts
258 return parent
::runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds, $opts )
260 'SpecialRecentChangesQuery',
261 array( &$conds, &$tables, &$join_conds, $opts, &$query_options, &$fields ),
266 public function outputFeedLinks() {
267 $this->addFeedLinks( $this->getFeedQuery() );
271 * Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.
275 private function getFeedQuery() {
276 $query = array_filter( $this->getOptions()->getAllValues(), function ( $value ) {
277 // API handles empty parameters in a different way
278 return $value !== '';
280 $query['action'] = 'feedrecentchanges';
281 $feedLimit = $this->getConfig()->get( 'FeedLimit' );
282 if ( $query['limit'] > $feedLimit ) {
283 $query['limit'] = $feedLimit;
290 * Build and output the actual changes list.
292 * @param array $rows Database rows
293 * @param FormOptions $opts
295 public function outputChangesList( $rows, $opts ) {
296 $limit = $opts['limit'];
298 $showWatcherCount = $this->getConfig()->get( 'RCShowWatchingUsers' )
299 && $this->getUser()->getOption( 'shownumberswatching' );
300 $watcherCache = array();
302 $dbr = $this->getDB();
305 $list = ChangesList
::newFromContext( $this->getContext() );
306 $list->initChangesListRows( $rows );
308 $rclistOutput = $list->beginRecentChangesList();
309 foreach ( $rows as $obj ) {
313 $rc = RecentChange
::newFromRow( $obj );
314 $rc->counter
= $counter++
;
315 # Check if the page has been updated since the last visit
316 if ( $this->getConfig()->get( 'ShowUpdatedMarker' )
317 && !empty( $obj->wl_notificationtimestamp
)
319 $rc->notificationtimestamp
= ( $obj->rc_timestamp
>= $obj->wl_notificationtimestamp
);
321 $rc->notificationtimestamp
= false; // Default
323 # Check the number of users watching the page
324 $rc->numberofWatchingusers
= 0; // Default
325 if ( $showWatcherCount && $obj->rc_namespace
>= 0 ) {
326 if ( !isset( $watcherCache[$obj->rc_namespace
][$obj->rc_title
] ) ) {
327 $watcherCache[$obj->rc_namespace
][$obj->rc_title
] =
332 'wl_namespace' => $obj->rc_namespace
,
333 'wl_title' => $obj->rc_title
,
335 __METHOD__
. '-watchers'
338 $rc->numberofWatchingusers
= $watcherCache[$obj->rc_namespace
][$obj->rc_title
];
341 $changeLine = $list->recentChangesLine( $rc, !empty( $obj->wl_user
), $counter );
342 if ( $changeLine !== false ) {
343 $rclistOutput .= $changeLine;
347 $rclistOutput .= $list->endRecentChangesList();
349 if ( $rows->numRows() === 0 ) {
350 $this->getOutput()->addHtml(
351 '<div class="mw-changeslist-empty">' .
352 $this->msg( 'recentchanges-noresult' )->parse() .
355 if ( !$this->including() ) {
356 $this->getOutput()->setStatusCode( 404 );
359 $this->getOutput()->addHTML( $rclistOutput );
364 * Set the text to be displayed above the changes
366 * @param FormOptions $opts
367 * @param int $numRows Number of rows in the result to show after this header
369 public function doHeader( $opts, $numRows ) {
370 $this->setTopText( $opts );
372 $defaults = $opts->getAllValues();
373 $nondefaults = $opts->getChangedValues();
376 $panel[] = self
::makeLegend( $this->getContext() );
377 $panel[] = $this->optionsPanel( $defaults, $nondefaults, $numRows );
380 $extraOpts = $this->getExtraOptions( $opts );
381 $extraOptsCount = count( $extraOpts );
383 $submit = ' ' . Xml
::submitbutton( $this->msg( 'allpagessubmit' )->text() );
385 $out = Xml
::openElement( 'table', array( 'class' => 'mw-recentchanges-table' ) );
386 foreach ( $extraOpts as $name => $optionRow ) {
387 # Add submit button to the last row only
389 $addSubmit = ( $count === $extraOptsCount ) ?
$submit : '';
391 $out .= Xml
::openElement( 'tr' );
392 if ( is_array( $optionRow ) ) {
395 array( 'class' => 'mw-label mw-' . $name . '-label' ),
400 array( 'class' => 'mw-input' ),
401 $optionRow[1] . $addSubmit
406 array( 'class' => 'mw-input', 'colspan' => 2 ),
407 $optionRow . $addSubmit
410 $out .= Xml
::closeElement( 'tr' );
412 $out .= Xml
::closeElement( 'table' );
414 $unconsumed = $opts->getUnconsumedValues();
415 foreach ( $unconsumed as $key => $value ) {
416 $out .= Html
::hidden( $key, $value );
419 $t = $this->getPageTitle();
420 $out .= Html
::hidden( 'title', $t->getPrefixedText() );
421 $form = Xml
::tags( 'form', array( 'action' => wfScript() ), $out );
423 $panelString = implode( "\n", $panel );
425 $this->getOutput()->addHTML(
427 $this->msg( 'recentchanges-legend' )->text(),
429 array( 'class' => 'rcoptions' )
433 $this->setBottomText( $opts );
437 * Send the text to be displayed above the options
439 * @param FormOptions $opts Unused
441 function setTopText( FormOptions
$opts ) {
444 $message = $this->msg( 'recentchangestext' )->inContentLanguage();
445 if ( !$message->isDisabled() ) {
446 $this->getOutput()->addWikiText(
447 Html
::rawElement( 'div',
448 array( 'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ),
449 "\n" . $message->plain() . "\n"
451 /* $lineStart */ true,
452 /* $interface */ false
458 * Get options to be displayed in a form
460 * @param FormOptions $opts
463 function getExtraOptions( $opts ) {
464 $opts->consumeValues( array(
465 'namespace', 'invert', 'associated', 'tagfilter', 'categories', 'categories_any'
468 $extraOpts = array();
469 $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );
471 if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
472 $extraOpts['category'] = $this->categoryFilterForm( $opts );
475 $tagFilter = ChangeTags
::buildTagFilterSelector( $opts['tagfilter'] );
476 if ( count( $tagFilter ) ) {
477 $extraOpts['tagfilter'] = $tagFilter;
480 // Don't fire the hook for subclasses. (Or should we?)
481 if ( $this->getName() === 'Recentchanges' ) {
482 Hooks
::run( 'SpecialRecentChangesPanel', array( &$extraOpts, $opts ) );
489 * Add page-specific modules.
491 protected function addModules() {
492 parent
::addModules();
493 $out = $this->getOutput();
494 $out->addModules( 'mediawiki.special.recentchanges' );
498 * Get last modified date, for client caching
499 * Don't use this if we are using the patrol feature, patrol changes don't
500 * update the timestamp
502 * @return string|bool
504 public function checkLastModified() {
505 $dbr = $this->getDB();
506 $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', false, __METHOD__
);
512 * Creates the choose namespace selection
514 * @param FormOptions $opts
517 protected function namespaceFilterForm( FormOptions
$opts ) {
518 $nsSelect = Html
::namespaceSelector(
519 array( 'selected' => $opts['namespace'], 'all' => '' ),
520 array( 'name' => 'namespace', 'id' => 'namespace' )
522 $nsLabel = Xml
::label( $this->msg( 'namespace' )->text(), 'namespace' );
523 $invert = Xml
::checkLabel(
524 $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
526 array( 'title' => $this->msg( 'tooltip-invert' )->text() )
528 $associated = Xml
::checkLabel(
529 $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
531 array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
534 return array( $nsLabel, "$nsSelect $invert $associated" );
538 * Create an input to filter changes by categories
540 * @param FormOptions $opts
543 protected function categoryFilterForm( FormOptions
$opts ) {
544 list( $label, $input ) = Xml
::inputLabelSep( $this->msg( 'rc_categories' )->text(),
545 'categories', 'mw-categories', false, $opts['categories'] );
547 $input .= ' ' . Xml
::checkLabel( $this->msg( 'rc_categories_any' )->text(),
548 'categories_any', 'mw-categories_any', $opts['categories_any'] );
550 return array( $label, $input );
554 * Filter $rows by categories set in $opts
556 * @param ResultWrapper $rows Database rows
557 * @param FormOptions $opts
559 function filterByCategories( &$rows, FormOptions
$opts ) {
560 $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );
562 if ( !count( $categories ) ) {
568 foreach ( $categories as $cat ) {
580 foreach ( $rows as $k => $r ) {
581 $nt = Title
::makeTitle( $r->rc_namespace
, $r->rc_title
);
582 $id = $nt->getArticleID();
584 continue; # Page might have been deleted...
586 if ( !in_array( $id, $articles ) ) {
589 if ( !isset( $a2r[$id] ) ) {
597 if ( !count( $articles ) ||
!count( $cats ) ) {
602 $catFind = new CategoryFinder
;
603 $catFind->seed( $articles, $cats, $opts['categories_any'] ?
'OR' : 'AND' );
604 $match = $catFind->run();
608 foreach ( $match as $id ) {
609 foreach ( $a2r[$id] as $rev ) {
611 $newrows[$k] = $rowsarr[$k];
618 * Makes change an option link which carries all the other options
620 * @param string $title Title
621 * @param array $override Options to override
622 * @param array $options Current options
623 * @param bool $active Whether to show the link in bold
626 function makeOptionsLink( $title, $override, $options, $active = false ) {
627 $params = $override +
$options;
629 // Bug 36524: false values have be converted to "0" otherwise
630 // wfArrayToCgi() will omit it them.
631 foreach ( $params as &$value ) {
632 if ( $value === false ) {
638 $text = htmlspecialchars( $title );
640 $text = '<strong>' . $text . '</strong>';
643 return Linker
::linkKnown( $this->getPageTitle(), $text, array(), $params );
647 * Creates the options panel.
649 * @param array $defaults
650 * @param array $nondefaults
651 * @param int $numRows Number of rows in the result to show after this header
654 function optionsPanel( $defaults, $nondefaults, $numRows ) {
655 $options = $nondefaults +
$defaults;
658 $msg = $this->msg( 'rclegend' );
659 if ( !$msg->isDisabled() ) {
660 $note .= '<div class="mw-rclegend">' . $msg->parse() . "</div>\n";
663 $lang = $this->getLanguage();
664 $user = $this->getUser();
665 if ( $options['from'] ) {
666 $note .= $this->msg( 'rcnotefrom' )
667 ->numParams( $options['limit'] )
669 $lang->userTimeAndDate( $options['from'], $user ),
670 $lang->userDate( $options['from'], $user ),
671 $lang->userTime( $options['from'], $user )
673 ->numParams( $numRows )
674 ->parse() . '<br />';
677 # Sort data for display and make sure it's unique after we've added user data.
678 $linkLimits = $this->getConfig()->get( 'RCLinkLimits' );
679 $linkLimits[] = $options['limit'];
681 $linkLimits = array_unique( $linkLimits );
683 $linkDays = $this->getConfig()->get( 'RCLinkDays' );
684 $linkDays[] = $options['days'];
686 $linkDays = array_unique( $linkDays );
690 foreach ( $linkLimits as $value ) {
691 $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
692 array( 'limit' => $value ), $nondefaults, $value == $options['limit'] );
694 $cl = $lang->pipeList( $cl );
696 // day links, reset 'from' to none
698 foreach ( $linkDays as $value ) {
699 $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
700 array( 'days' => $value, 'from' => '' ), $nondefaults, $value == $options['days'] );
702 $dl = $lang->pipeList( $dl );
706 'hideminor' => 'rcshowhideminor',
707 'hidebots' => 'rcshowhidebots',
708 'hideanons' => 'rcshowhideanons',
709 'hideliu' => 'rcshowhideliu',
710 'hidepatrolled' => 'rcshowhidepatr',
711 'hidemyself' => 'rcshowhidemine'
714 $showhide = array( 'show', 'hide' );
716 foreach ( $this->getCustomFilters() as $key => $params ) {
717 $filters[$key] = $params['msg'];
719 // Disable some if needed
720 if ( !$user->useRCPatrol() ) {
721 unset( $filters['hidepatrolled'] );
725 foreach ( $filters as $key => $msg ) {
726 // The following messages are used here:
727 // rcshowhideminor-show, rcshowhideminor-hide, rcshowhidebots-show, rcshowhidebots-hide,
728 // rcshowhideanons-show, rcshowhideanons-hide, rcshowhideliu-show, rcshowhideliu-hide,
729 // rcshowhidepatr-show, rcshowhidepatr-hide, rcshowhidemine-show, rcshowhidemine-hide.
730 $linkMessage = $this->msg( $msg . '-' . $showhide[1 - $options[$key]] );
731 // Extensions can define additional filters, but don't need to define the corresponding
732 // messages. If they don't exist, just fall back to 'show' and 'hide'.
733 if ( !$linkMessage->exists() ) {
734 $linkMessage = $this->msg( $showhide[1 - $options[$key]] );
737 $link = $this->makeOptionsLink( $linkMessage->text(),
738 array( $key => 1 - $options[$key] ), $nondefaults );
739 $links[] = "<span class=\"$msg rcshowhideoption\">"
740 . $this->msg( $msg )->rawParams( $link )->escaped() . '</span>';
743 // show from this onward link
744 $timestamp = wfTimestampNow();
745 $now = $lang->userTimeAndDate( $timestamp, $user );
746 $timenow = $lang->userTime( $timestamp, $user );
747 $datenow = $lang->userDate( $timestamp, $user );
748 $pipedLinks = '<span class="rcshowhide">' . $lang->pipeList( $links ) . '</span>';
750 $rclinks = '<span class="rclinks">' . $this->msg( 'rclinks' )->rawParams( $cl, $dl, $pipedLinks )
751 ->parse() . '</span>';
753 $rclistfrom = '<span class="rclistfrom">' . $this->makeOptionsLink(
754 $this->msg( 'rclistfrom' )->rawParams( $now, $timenow, $datenow )->parse(),
755 array( 'from' => $timestamp ),
759 return "{$note}$rclinks<br />$rclistfrom";
762 public function isIncludable() {