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 wfRunHooks( '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 global $wgAllowCategorizedRecentChanges;
197 $dbr = $this->getDB();
198 $user = $this->getUser();
200 $tables = array( 'recentchanges' );
201 $fields = RecentChange
::selectFields();
202 $query_options = array();
203 $join_conds = array();
205 // JOIN on watchlist for users
206 if ( $user->getId() && $user->isAllowed( 'viewmywatchlist' ) ) {
207 $tables[] = 'watchlist';
208 $fields[] = 'wl_user';
209 $fields[] = 'wl_notificationtimestamp';
210 $join_conds['watchlist'] = array( 'LEFT JOIN', array(
211 'wl_user' => $user->getId(),
213 'wl_namespace=rc_namespace'
217 if ( $user->isAllowed( 'rollback' ) ) {
219 $fields[] = 'page_latest';
220 $join_conds['page'] = array( 'LEFT JOIN', 'rc_cur_id=page_id' );
223 ChangeTags
::modifyDisplayQuery(
232 if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
238 // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
239 // knowledge to use an index merge if it wants (it may use some other index though).
240 $rows = $dbr->select(
243 $conds +
array( 'rc_new' => array( 0, 1 ) ),
245 array( 'ORDER BY' => 'rc_timestamp DESC', 'LIMIT' => $opts['limit'] ) +
$query_options,
249 // Build the final data
250 if ( $wgAllowCategorizedRecentChanges ) {
251 $this->filterByCategories( $rows, $opts );
257 protected function runMainQueryHook( &$tables, &$fields, &$conds, &$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() {
277 $query = array_filter( $this->getOptions()->getAllValues(), function ( $value ) {
278 // API handles empty parameters in a different way
279 return $value !== '';
281 $query['action'] = 'feedrecentchanges';
282 if ( $query['limit'] > $wgFeedLimit ) {
283 $query['limit'] = $wgFeedLimit;
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 global $wgRCShowWatchingUsers, $wgShowUpdatedMarker;
298 $limit = $opts['limit'];
300 $showWatcherCount = $wgRCShowWatchingUsers
301 && $this->getUser()->getOption( 'shownumberswatching' );
302 $watcherCache = array();
304 $dbr = $this->getDB();
307 $list = ChangesList
::newFromContext( $this->getContext() );
308 $list->initChangesListRows( $rows );
310 $rclistOutput = $list->beginRecentChangesList();
311 foreach ( $rows as $obj ) {
315 $rc = RecentChange
::newFromRow( $obj );
316 $rc->counter
= $counter++
;
317 # Check if the page has been updated since the last visit
318 if ( $wgShowUpdatedMarker && !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 ) {
372 $this->setTopText( $opts );
374 $defaults = $opts->getAllValues();
375 $nondefaults = $opts->getChangedValues();
378 $panel[] = self
::makeLegend( $this->getContext() );
379 $panel[] = $this->optionsPanel( $defaults, $nondefaults, $numRows );
382 $extraOpts = $this->getExtraOptions( $opts );
383 $extraOptsCount = count( $extraOpts );
385 $submit = ' ' . Xml
::submitbutton( $this->msg( 'allpagessubmit' )->text() );
387 $out = Xml
::openElement( 'table', array( 'class' => 'mw-recentchanges-table' ) );
388 foreach ( $extraOpts as $name => $optionRow ) {
389 # Add submit button to the last row only
391 $addSubmit = ( $count === $extraOptsCount ) ?
$submit : '';
393 $out .= Xml
::openElement( 'tr' );
394 if ( is_array( $optionRow ) ) {
397 array( 'class' => 'mw-label mw-' . $name . '-label' ),
402 array( 'class' => 'mw-input' ),
403 $optionRow[1] . $addSubmit
408 array( 'class' => 'mw-input', 'colspan' => 2 ),
409 $optionRow . $addSubmit
412 $out .= Xml
::closeElement( 'tr' );
414 $out .= Xml
::closeElement( 'table' );
416 $unconsumed = $opts->getUnconsumedValues();
417 foreach ( $unconsumed as $key => $value ) {
418 $out .= Html
::hidden( $key, $value );
421 $t = $this->getPageTitle();
422 $out .= Html
::hidden( 'title', $t->getPrefixedText() );
423 $form = Xml
::tags( 'form', array( 'action' => $wgScript ), $out );
425 $panelString = implode( "\n", $panel );
427 $this->getOutput()->addHTML(
429 $this->msg( 'recentchanges-legend' )->text(),
431 array( 'class' => 'rcoptions' )
435 $this->setBottomText( $opts );
439 * Send the text to be displayed above the options
441 * @param FormOptions $opts Unused
443 function setTopText( FormOptions
$opts ) {
446 $message = $this->msg( 'recentchangestext' )->inContentLanguage();
447 if ( !$message->isDisabled() ) {
448 $this->getOutput()->addWikiText(
449 Html
::rawElement( 'p',
450 array( 'lang' => $wgContLang->getCode(), 'dir' => $wgContLang->getDir() ),
451 "\n" . $message->plain() . "\n"
453 /* $lineStart */ false,
454 /* $interface */ false
460 * Get options to be displayed in a form
462 * @param FormOptions $opts
465 function getExtraOptions( $opts ) {
466 $opts->consumeValues( array(
467 'namespace', 'invert', 'associated', 'tagfilter', 'categories', 'categories_any'
470 $extraOpts = array();
471 $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );
473 global $wgAllowCategorizedRecentChanges;
474 if ( $wgAllowCategorizedRecentChanges ) {
475 $extraOpts['category'] = $this->categoryFilterForm( $opts );
478 $tagFilter = ChangeTags
::buildTagFilterSelector( $opts['tagfilter'] );
479 if ( count( $tagFilter ) ) {
480 $extraOpts['tagfilter'] = $tagFilter;
483 // Don't fire the hook for subclasses. (Or should we?)
484 if ( $this->getName() === 'Recentchanges' ) {
485 wfRunHooks( 'SpecialRecentChangesPanel', array( &$extraOpts, $opts ) );
492 * Add page-specific modules.
494 protected function addModules() {
495 parent
::addModules();
496 $out = $this->getOutput();
497 $out->addModules( 'mediawiki.special.recentchanges' );
501 * Get last modified date, for client caching
502 * Don't use this if we are using the patrol feature, patrol changes don't
503 * update the timestamp
505 * @return string|bool
507 public function checkLastModified() {
508 $dbr = $this->getDB();
509 $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', false, __METHOD__
);
515 * Creates the choose namespace selection
517 * @param FormOptions $opts
520 protected function namespaceFilterForm( FormOptions
$opts ) {
521 $nsSelect = Html
::namespaceSelector(
522 array( 'selected' => $opts['namespace'], 'all' => '' ),
523 array( 'name' => 'namespace', 'id' => 'namespace' )
525 $nsLabel = Xml
::label( $this->msg( 'namespace' )->text(), 'namespace' );
526 $invert = Xml
::checkLabel(
527 $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
529 array( 'title' => $this->msg( 'tooltip-invert' )->text() )
531 $associated = Xml
::checkLabel(
532 $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
534 array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
537 return array( $nsLabel, "$nsSelect $invert $associated" );
541 * Create an input to filter changes by categories
543 * @param FormOptions $opts
546 protected function categoryFilterForm( FormOptions
$opts ) {
547 list( $label, $input ) = Xml
::inputLabelSep( $this->msg( 'rc_categories' )->text(),
548 'categories', 'mw-categories', false, $opts['categories'] );
550 $input .= ' ' . Xml
::checkLabel( $this->msg( 'rc_categories_any' )->text(),
551 'categories_any', 'mw-categories_any', $opts['categories_any'] );
553 return array( $label, $input );
557 * Filter $rows by categories set in $opts
559 * @param ResultWrapper $rows Database rows
560 * @param FormOptions $opts
562 function filterByCategories( &$rows, FormOptions
$opts ) {
563 $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );
565 if ( !count( $categories ) ) {
571 foreach ( $categories as $cat ) {
583 foreach ( $rows as $k => $r ) {
584 $nt = Title
::makeTitle( $r->rc_namespace
, $r->rc_title
);
585 $id = $nt->getArticleID();
587 continue; # Page might have been deleted...
589 if ( !in_array( $id, $articles ) ) {
592 if ( !isset( $a2r[$id] ) ) {
600 if ( !count( $articles ) ||
!count( $cats ) ) {
605 $c = new Categoryfinder
;
606 $c->seed( $articles, $cats, $opts['categories_any'] ?
'OR' : 'AND' );
611 foreach ( $match as $id ) {
612 foreach ( $a2r[$id] as $rev ) {
614 $newrows[$k] = $rowsarr[$k];
621 * Makes change an option link which carries all the other options
623 * @param string $title Title
624 * @param array $override Options to override
625 * @param array $options Current options
626 * @param bool $active Whether to show the link in bold
629 function makeOptionsLink( $title, $override, $options, $active = false ) {
630 $params = $override +
$options;
632 // Bug 36524: false values have be converted to "0" otherwise
633 // wfArrayToCgi() will omit it them.
634 foreach ( $params as &$value ) {
635 if ( $value === false ) {
641 $text = htmlspecialchars( $title );
643 $text = '<strong>' . $text . '</strong>';
646 return Linker
::linkKnown( $this->getPageTitle(), $text, array(), $params );
650 * Creates the options panel.
652 * @param array $defaults
653 * @param array $nondefaults
654 * @param int $numRows Number of rows in the result to show after this header
657 function optionsPanel( $defaults, $nondefaults, $numRows ) {
658 global $wgRCLinkLimits, $wgRCLinkDays;
660 $options = $nondefaults +
$defaults;
663 $msg = $this->msg( 'rclegend' );
664 if ( !$msg->isDisabled() ) {
665 $note .= '<div class="mw-rclegend">' . $msg->parse() . "</div>\n";
668 $lang = $this->getLanguage();
669 $user = $this->getUser();
670 if ( $options['from'] ) {
671 $note .= $this->msg( 'rcnotefrom' )
672 ->numParams( $options['limit'] )
674 $lang->userTimeAndDate( $options['from'], $user ),
675 $lang->userDate( $options['from'], $user ),
676 $lang->userTime( $options['from'], $user )
678 ->numParams( $numRows )
679 ->parse() . '<br />';
682 # Sort data for display and make sure it's unique after we've added user data.
683 $linkLimits = $wgRCLinkLimits;
684 $linkLimits[] = $options['limit'];
686 $linkLimits = array_unique( $linkLimits );
688 $linkDays = $wgRCLinkDays;
689 $linkDays[] = $options['days'];
691 $linkDays = array_unique( $linkDays );
695 foreach ( $linkLimits as $value ) {
696 $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
697 array( 'limit' => $value ), $nondefaults, $value == $options['limit'] );
699 $cl = $lang->pipeList( $cl );
701 // day links, reset 'from' to none
703 foreach ( $linkDays as $value ) {
704 $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
705 array( 'days' => $value, 'from' => '' ), $nondefaults, $value == $options['days'] );
707 $dl = $lang->pipeList( $dl );
711 'hideminor' => 'rcshowhideminor',
712 'hidebots' => 'rcshowhidebots',
713 'hideanons' => 'rcshowhideanons',
714 'hideliu' => 'rcshowhideliu',
715 'hidepatrolled' => 'rcshowhidepatr',
716 'hidemyself' => 'rcshowhidemine'
719 $showhide = array( 'show', 'hide' );
721 foreach ( $this->getCustomFilters() as $key => $params ) {
722 $filters[$key] = $params['msg'];
724 // Disable some if needed
725 if ( !$user->useRCPatrol() ) {
726 unset( $filters['hidepatrolled'] );
730 foreach ( $filters as $key => $msg ) {
731 // The following messages are used here:
732 // rcshowhideminor-show, rcshowhideminor-hide, rcshowhidebots-show, rcshowhidebots-hide,
733 // rcshowhideanons-show, rcshowhideanons-hide, rcshowhideliu-show, rcshowhideliu-hide,
734 // rcshowhidepatr-show, rcshowhidepatr-hide, rcshowhidemine-show, rcshowhidemine-hide.
735 $linkMessage = $this->msg( $msg . '-' . $showhide[1 - $options[$key]] );
736 // Extensions can define additional filters, but don't need to define the corresponding
737 // messages. If they don't exist, just fall back to 'show' and 'hide'.
738 if ( !$linkMessage->exists() ) {
739 $linkMessage = $this->msg( $showhide[1 - $options[$key]] );
742 $link = $this->makeOptionsLink( $linkMessage->text(),
743 array( $key => 1 - $options[$key] ), $nondefaults );
744 $links[] = $this->msg( $msg )->rawParams( $link )->escaped();
747 // show from this onward link
748 $timestamp = wfTimestampNow();
749 $now = $lang->userTimeAndDate( $timestamp, $user );
750 $timenow = $lang->userTime( $timestamp, $user );
751 $datenow = $lang->userDate( $timestamp, $user );
752 $rclinks = $this->msg( 'rclinks' )->rawParams( $cl, $dl, $lang->pipeList( $links ) )
754 $rclistfrom = $this->makeOptionsLink(
755 $this->msg( 'rclistfrom' )->rawParams( $now, $timenow, $datenow )->parse(),
756 array( 'from' => $timestamp ),
760 return "{$note}$rclinks<br />$rclistfrom";
763 public function isIncludable() {