SpecialRecentchanges.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class SpecialRecentChanges extends ChangesListSpecialPage {
    // @codingStandardsIgnoreStart Needed "useless" override to change parameters.
    public function __construct( $name = 'Recentchanges', $restriction = '' ) {
        parent::__construct( $name, $restriction );
    }
    // @codingStandardsIgnoreEnd

    public function execute( $subpage ) {
        // Backwards-compatibility: redirect to new feed URLs
        $feedFormat = $this->getRequest()->getVal( 'feed' );
        if ( !$this->including() && $feedFormat ) {
            $query = $this->getFeedQuery();
            $query['feedformat'] = $feedFormat === 'atom' ? 'atom' : 'rss';
            $this->getOutput()->redirect( wfAppendQuery( wfScript( 'api' ), $query ) );

            return;
        }

        // 10 seconds server-side caching max
        $this->getOutput()->setCdnMaxage( 10 );
        // Check if the client has a cached version
        $lastmod = $this->checkLastModified();
        if ( $lastmod === false ) {
            return;
        }

        $this->addHelpLink(
            '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Recent_changes',
            true
        );
        parent::execute( $subpage );
    }

    public function getDefaultOptions() {
        $opts = parent::getDefaultOptions();
        $user = $this->getUser();

        $opts->add( 'days', $user->getIntOption( 'rcdays' ) );
        $opts->add( 'limit', $user->getIntOption( 'rclimit' ) );
        $opts->add( 'from', '' );

        $opts->add( 'hideminor', $user->getBoolOption( 'hideminor' ) );
        $opts->add( 'hidebots', true );
        $opts->add( 'hideanons', false );
        $opts->add( 'hideliu', false );
        $opts->add( 'hidepatrolled', $user->getBoolOption( 'hidepatrolled' ) );
        $opts->add( 'hidemyself', false );
        $opts->add( 'hidecategorization', $user->getBoolOption( 'hidecategorization' ) );

        $opts->add( 'categories', '' );
        $opts->add( 'categories_any', false );
        $opts->add( 'tagfilter', '' );

        return $opts;
    }

    protected function getCustomFilters() {
        if ( $this->customFilters === null ) {
            $this->customFilters = parent::getCustomFilters();
            Hooks::run( 'SpecialRecentChangesFilters', [ $this, &$this->customFilters ], '1.23' );
        }

        return $this->customFilters;
    }

    public function parseParameters( $par, FormOptions $opts ) {
        $bits = preg_split( '/\s*,\s*/', trim( $par ) );
        foreach ( $bits as $bit ) {
            if ( 'hidebots' === $bit ) {
                $opts['hidebots'] = true;
            }
            if ( 'bots' === $bit ) {
                $opts['hidebots'] = false;
            }
            if ( 'hideminor' === $bit ) {
                $opts['hideminor'] = true;
            }
            if ( 'minor' === $bit ) {
                $opts['hideminor'] = false;
            }
            if ( 'hideliu' === $bit ) {
                $opts['hideliu'] = true;
            }
            if ( 'hidepatrolled' === $bit ) {
                $opts['hidepatrolled'] = true;
            }
            if ( 'hideanons' === $bit ) {
                $opts['hideanons'] = true;
            }
            if ( 'hidemyself' === $bit ) {
                $opts['hidemyself'] = true;
            }
            if ( 'hidecategorization' === $bit ) {
                $opts['hidecategorization'] = true;
            }

            if ( is_numeric( $bit ) ) {
                $opts['limit'] = $bit;
            }

            $m = [];
            if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
                $opts['limit'] = $m[1];
            }
            if ( preg_match( '/^days=(\d+)$/', $bit, $m ) ) {
                $opts['days'] = $m[1];
            }
            if ( preg_match( '/^namespace=(\d+)$/', $bit, $m ) ) {
                $opts['namespace'] = $m[1];
            }
            if ( preg_match( '/^tagfilter=(.*)$/', $bit, $m ) ) {
                $opts['tagfilter'] = $m[1];
            }
        }
    }

    public function validateOptions( FormOptions $opts ) {
        $opts->validateIntBounds( 'limit', 0, 5000 );
        parent::validateOptions( $opts );
    }

    public function buildMainQueryConds( FormOptions $opts ) {
        $dbr = $this->getDB();
        $conds = parent::buildMainQueryConds( $opts );

        // Calculate cutoff
        $cutoff_unixtime = time() - ( $opts['days'] * 86400 );
        $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime % 86400 );
        $cutoff = $dbr->timestamp( $cutoff_unixtime );

        $fromValid = preg_match( '/^[0-9]{14}$/', $opts['from'] );
        if ( $fromValid && $opts['from'] > wfTimestamp( TS_MW, $cutoff ) ) {
            $cutoff = $dbr->timestamp( $opts['from'] );
        } else {
            $opts->reset( 'from' );
        }

        $conds[] = 'rc_timestamp >= ' . $dbr->addQuotes( $cutoff );

        return $conds;
    }

    public function doMainQuery( $conds, $opts ) {
        $dbr = $this->getDB();
        $user = $this->getUser();

        $tables = [ 'recentchanges' ];
        $fields = RecentChange::selectFields();
        $query_options = [];
        $join_conds = [];

        // JOIN on watchlist for users
        if ( $user->getId() && $user->isAllowed( 'viewmywatchlist' ) ) {
            $tables[] = 'watchlist';
            $fields[] = 'wl_user';
            $fields[] = 'wl_notificationtimestamp';
            $join_conds['watchlist'] = [ 'LEFT JOIN', [
                'wl_user' => $user->getId(),
                'wl_title=rc_title',
                'wl_namespace=rc_namespace'
            ] ];
        }

        if ( $user->isAllowed( 'rollback' ) ) {
            $tables[] = 'page';
            $fields[] = 'page_latest';
            $join_conds['page'] = [ 'LEFT JOIN', 'rc_cur_id=page_id' ];
        }

        ChangeTags::modifyDisplayQuery(
            $tables,
            $fields,
            $conds,
            $join_conds,
            $query_options,
            $opts['tagfilter']
        );

        if ( !$this->runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds,
            $opts )
        ) {
            return false;
        }

        // array_merge() is used intentionally here so that hooks can, should
        // they so desire, override the ORDER BY / LIMIT condition(s); prior to
        // MediaWiki 1.26 this used to use the plus operator instead, which meant
        // that extensions weren't able to change these conditions
        $query_options = array_merge( [
            'ORDER BY' => 'rc_timestamp DESC',
            'LIMIT' => $opts['limit'] ], $query_options );
        $rows = $dbr->select(
            $tables,
            $fields,
            // rc_new is not an ENUM, but adding a redundant rc_new IN (0,1) gives mysql enough
            // knowledge to use an index merge if it wants (it may use some other index though).
            $conds + [ 'rc_new' => [ 0, 1 ] ],
            __METHOD__,
            $query_options,
            $join_conds
        );

        // Build the final data
        if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
            $this->filterByCategories( $rows, $opts );
        }

        return $rows;
    }

    protected function runMainQueryHook( &$tables, &$fields, &$conds,
        &$query_options, &$join_conds, $opts
    ) {
        return parent::runMainQueryHook( $tables, $fields, $conds, $query_options, $join_conds, $opts )
            && Hooks::run(
                'SpecialRecentChangesQuery',
                [ &$conds, &$tables, &$join_conds, $opts, &$query_options, &$fields ],
                '1.23'
            );
    }

    protected function getDB() {
        return wfGetDB( DB_REPLICA, 'recentchanges' );
    }

    public function outputFeedLinks() {
        $this->addFeedLinks( $this->getFeedQuery() );
    }

    protected function getFeedQuery() {
        $query = array_filter( $this->getOptions()->getAllValues(), function ( $value ) {
            // API handles empty parameters in a different way
            return $value !== '';
        } );
        $query['action'] = 'feedrecentchanges';
        $feedLimit = $this->getConfig()->get( 'FeedLimit' );
        if ( $query['limit'] > $feedLimit ) {
            $query['limit'] = $feedLimit;
        }

        return $query;
    }

    public function outputChangesList( $rows, $opts ) {
        $limit = $opts['limit'];

        $showWatcherCount = $this->getConfig()->get( 'RCShowWatchingUsers' )
            && $this->getUser()->getOption( 'shownumberswatching' );
        $watcherCache = [];

        $dbr = $this->getDB();

        $counter = 1;
        $list = ChangesList::newFromContext( $this->getContext() );
        $list->initChangesListRows( $rows );

        $userShowHiddenCats = $this->getUser()->getBoolOption( 'showhiddencats' );
        $rclistOutput = $list->beginRecentChangesList();
        foreach ( $rows as $obj ) {
            if ( $limit == 0 ) {
                break;
            }
            $rc = RecentChange::newFromRow( $obj );

            # Skip CatWatch entries for hidden cats based on user preference
            if (
                $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE &&
                !$userShowHiddenCats &&
                $rc->getParam( 'hidden-cat' )
            ) {
                continue;
            }

            $rc->counter = $counter++;
            # Check if the page has been updated since the last visit
            if ( $this->getConfig()->get( 'ShowUpdatedMarker' )
                && !empty( $obj->wl_notificationtimestamp )
            ) {
                $rc->notificationtimestamp = ( $obj->rc_timestamp >= $obj->wl_notificationtimestamp );
            } else {
                $rc->notificationtimestamp = false; // Default
            }
            # Check the number of users watching the page
            $rc->numberofWatchingusers = 0; // Default
            if ( $showWatcherCount && $obj->rc_namespace >= 0 ) {
                if ( !isset( $watcherCache[$obj->rc_namespace][$obj->rc_title] ) ) {
                    $watcherCache[$obj->rc_namespace][$obj->rc_title] =
                        MediaWikiServices::getInstance()->getWatchedItemStore()->countWatchers(
                            new TitleValue( (int)$obj->rc_namespace, $obj->rc_title )
                        );
                }
                $rc->numberofWatchingusers = $watcherCache[$obj->rc_namespace][$obj->rc_title];
            }

            $changeLine = $list->recentChangesLine( $rc, !empty( $obj->wl_user ), $counter );
            if ( $changeLine !== false ) {
                $rclistOutput .= $changeLine;
                --$limit;
            }
        }
        $rclistOutput .= $list->endRecentChangesList();

        if ( $rows->numRows() === 0 ) {
            $this->getOutput()->addHTML(
                '<div class="mw-changeslist-empty">' .
                $this->msg( 'recentchanges-noresult' )->parse() .
                '</div>'
            );
            if ( !$this->including() ) {
                $this->getOutput()->setStatusCode( 404 );
            }
        } else {
            $this->getOutput()->addHTML( $rclistOutput );
        }
    }

    public function doHeader( $opts, $numRows ) {
        $this->setTopText( $opts );

        $defaults = $opts->getAllValues();
        $nondefaults = $opts->getChangedValues();

        $panel = [];
        $panel[] = $this->makeLegend();
        $panel[] = $this->optionsPanel( $defaults, $nondefaults, $numRows );
        $panel[] = '<hr />';

        $extraOpts = $this->getExtraOptions( $opts );
        $extraOptsCount = count( $extraOpts );
        $count = 0;
        $submit = ' ' . Xml::submitButton( $this->msg( 'recentchanges-submit' )->text() );

        $out = Xml::openElement( 'table', [ 'class' => 'mw-recentchanges-table' ] );
        foreach ( $extraOpts as $name => $optionRow ) {
            # Add submit button to the last row only
            ++$count;
            $addSubmit = ( $count === $extraOptsCount ) ? $submit : '';

            $out .= Xml::openElement( 'tr' );
            if ( is_array( $optionRow ) ) {
                $out .= Xml::tags(
                    'td',
                    [ 'class' => 'mw-label mw-' . $name . '-label' ],
                    $optionRow[0]
                );
                $out .= Xml::tags(
                    'td',
                    [ 'class' => 'mw-input' ],
                    $optionRow[1] . $addSubmit
                );
            } else {
                $out .= Xml::tags(
                    'td',
                    [ 'class' => 'mw-input', 'colspan' => 2 ],
                    $optionRow . $addSubmit
                );
            }
            $out .= Xml::closeElement( 'tr' );
        }
        $out .= Xml::closeElement( 'table' );

        $unconsumed = $opts->getUnconsumedValues();
        foreach ( $unconsumed as $key => $value ) {
            $out .= Html::hidden( $key, $value );
        }

        $t = $this->getPageTitle();
        $out .= Html::hidden( 'title', $t->getPrefixedText() );
        $form = Xml::tags( 'form', [ 'action' => wfScript() ], $out );
        $panel[] = $form;
        $panelString = implode( "\n", $panel );

        $this->getOutput()->addHTML(
            Xml::fieldset(
                $this->msg( 'recentchanges-legend' )->text(),
                $panelString,
                [ 'class' => 'rcoptions' ]
            )
        );

        $this->setBottomText( $opts );
    }

    function setTopText( FormOptions $opts ) {
        global $wgContLang;

        $message = $this->msg( 'recentchangestext' )->inContentLanguage();
        if ( !$message->isDisabled() ) {
            $this->getOutput()->addWikiText(
                Html::rawElement( 'div',
                    [ 'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ],
                    "\n" . $message->plain() . "\n"
                ),
                /* $lineStart */ true,
                /* $interface */ false
            );
        }
    }

    function getExtraOptions( $opts ) {
        $opts->consumeValues( [
            'namespace', 'invert', 'associated', 'tagfilter', 'categories', 'categories_any'
        ] );

        $extraOpts = [];
        $extraOpts['namespace'] = $this->namespaceFilterForm( $opts );

        if ( $this->getConfig()->get( 'AllowCategorizedRecentChanges' ) ) {
            $extraOpts['category'] = $this->categoryFilterForm( $opts );
        }

        $tagFilter = ChangeTags::buildTagFilterSelector( $opts['tagfilter'] );
        if ( count( $tagFilter ) ) {
            $extraOpts['tagfilter'] = $tagFilter;
        }

        // Don't fire the hook for subclasses. (Or should we?)
        if ( $this->getName() === 'Recentchanges' ) {
            Hooks::run( 'SpecialRecentChangesPanel', [ &$extraOpts, $opts ] );
        }

        return $extraOpts;
    }

    protected function addModules() {
        parent::addModules();
        $out = $this->getOutput();
        $out->addModules( 'mediawiki.special.recentchanges' );
    }

    public function checkLastModified() {
        $dbr = $this->getDB();
        $lastmod = $dbr->selectField( 'recentchanges', 'MAX(rc_timestamp)', false, __METHOD__ );

        return $lastmod;
    }

    protected function namespaceFilterForm( FormOptions $opts ) {
        $nsSelect = Html::namespaceSelector(
            [ 'selected' => $opts['namespace'], 'all' => '' ],
            [ 'name' => 'namespace', 'id' => 'namespace' ]
        );
        $nsLabel = Xml::label( $this->msg( 'namespace' )->text(), 'namespace' );
        $invert = Xml::checkLabel(
            $this->msg( 'invert' )->text(), 'invert', 'nsinvert',
            $opts['invert'],
            [ 'title' => $this->msg( 'tooltip-invert' )->text() ]
        );
        $associated = Xml::checkLabel(
            $this->msg( 'namespace_association' )->text(), 'associated', 'nsassociated',
            $opts['associated'],
            [ 'title' => $this->msg( 'tooltip-namespace_association' )->text() ]
        );

        return [ $nsLabel, "$nsSelect $invert $associated" ];
    }

    protected function categoryFilterForm( FormOptions $opts ) {
        list( $label, $input ) = Xml::inputLabelSep( $this->msg( 'rc_categories' )->text(),
            'categories', 'mw-categories', false, $opts['categories'] );

        $input .= ' ' . Xml::checkLabel( $this->msg( 'rc_categories_any' )->text(),
            'categories_any', 'mw-categories_any', $opts['categories_any'] );

        return [ $label, $input ];
    }

    function filterByCategories( &$rows, FormOptions $opts ) {
        $categories = array_map( 'trim', explode( '|', $opts['categories'] ) );

        if ( !count( $categories ) ) {
            return;
        }

        # Filter categories
        $cats = [];
        foreach ( $categories as $cat ) {
            $cat = trim( $cat );
            if ( $cat == '' ) {
                continue;
            }
            $cats[] = $cat;
        }

        # Filter articles
        $articles = [];
        $a2r = [];
        $rowsarr = [];
        foreach ( $rows as $k => $r ) {
            $nt = Title::makeTitle( $r->rc_namespace, $r->rc_title );
            $id = $nt->getArticleID();
            if ( $id == 0 ) {
                continue; # Page might have been deleted...
            }
            if ( !in_array( $id, $articles ) ) {
                $articles[] = $id;
            }
            if ( !isset( $a2r[$id] ) ) {
                $a2r[$id] = [];
            }
            $a2r[$id][] = $k;
            $rowsarr[$k] = $r;
        }

        # Shortcut?
        if ( !count( $articles ) || !count( $cats ) ) {
            return;
        }

        # Look up
        $catFind = new CategoryFinder;
        $catFind->seed( $articles, $cats, $opts['categories_any'] ? 'OR' : 'AND' );
        $match = $catFind->run();

        # Filter
        $newrows = [];
        foreach ( $match as $id ) {
            foreach ( $a2r[$id] as $rev ) {
                $k = $rev;
                $newrows[$k] = $rowsarr[$k];
            }
        }
        $rows = $newrows;
    }

    function makeOptionsLink( $title, $override, $options, $active = false ) {
        $params = $override + $options;

        // Bug 36524: false values have be converted to "0" otherwise
        // wfArrayToCgi() will omit it them.
        foreach ( $params as &$value ) {
            if ( $value === false ) {
                $value = '0';
            }
        }
        unset( $value );

        $text = htmlspecialchars( $title );
        if ( $active ) {
            $text = '<strong>' . $text . '</strong>';
        }

        return Linker::linkKnown( $this->getPageTitle(), $text, [], $params );
    }

    function optionsPanel( $defaults, $nondefaults, $numRows ) {
        $options = $nondefaults + $defaults;

        $note = '';
        $msg = $this->msg( 'rclegend' );
        if ( !$msg->isDisabled() ) {
            $note .= '<div class="mw-rclegend">' . $msg->parse() . "</div>\n";
        }

        $lang = $this->getLanguage();
        $user = $this->getUser();
        $config = $this->getConfig();
        if ( $options['from'] ) {
            $note .= $this->msg( 'rcnotefrom' )
                ->numParams( $options['limit'] )
                ->params(
                    $lang->userTimeAndDate( $options['from'], $user ),
                    $lang->userDate( $options['from'], $user ),
                    $lang->userTime( $options['from'], $user )
                )
                ->numParams( $numRows )
                ->parse() . '<br />';
        }

        # Sort data for display and make sure it's unique after we've added user data.
        $linkLimits = $config->get( 'RCLinkLimits' );
        $linkLimits[] = $options['limit'];
        sort( $linkLimits );
        $linkLimits = array_unique( $linkLimits );

        $linkDays = $config->get( 'RCLinkDays' );
        $linkDays[] = $options['days'];
        sort( $linkDays );
        $linkDays = array_unique( $linkDays );

        // limit links
        $cl = [];
        foreach ( $linkLimits as $value ) {
            $cl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
                [ 'limit' => $value ], $nondefaults, $value == $options['limit'] );
        }
        $cl = $lang->pipeList( $cl );

        // day links, reset 'from' to none
        $dl = [];
        foreach ( $linkDays as $value ) {
            $dl[] = $this->makeOptionsLink( $lang->formatNum( $value ),
                [ 'days' => $value, 'from' => '' ], $nondefaults, $value == $options['days'] );
        }
        $dl = $lang->pipeList( $dl );

        // show/hide links
        $filters = [
            'hideminor' => 'rcshowhideminor',
            'hidebots' => 'rcshowhidebots',
            'hideanons' => 'rcshowhideanons',
            'hideliu' => 'rcshowhideliu',
            'hidepatrolled' => 'rcshowhidepatr',
            'hidemyself' => 'rcshowhidemine'
        ];

        if ( $config->get( 'RCWatchCategoryMembership' ) ) {
            $filters['hidecategorization'] = 'rcshowhidecategorization';
        }

        $showhide = [ 'show', 'hide' ];

        foreach ( $this->getCustomFilters() as $key => $params ) {
            $filters[$key] = $params['msg'];
        }
        // Disable some if needed
        if ( !$user->useRCPatrol() ) {
            unset( $filters['hidepatrolled'] );
        }

        $links = [];
        foreach ( $filters as $key => $msg ) {
            // The following messages are used here:
            // rcshowhideminor-show, rcshowhideminor-hide, rcshowhidebots-show, rcshowhidebots-hide,
            // rcshowhideanons-show, rcshowhideanons-hide, rcshowhideliu-show, rcshowhideliu-hide,
            // rcshowhidepatr-show, rcshowhidepatr-hide, rcshowhidemine-show, rcshowhidemine-hide,
            // rcshowhidecategorization-show, rcshowhidecategorization-hide.
            $linkMessage = $this->msg( $msg . '-' . $showhide[1 - $options[$key]] );
            // Extensions can define additional filters, but don't need to define the corresponding
            // messages. If they don't exist, just fall back to 'show' and 'hide'.
            if ( !$linkMessage->exists() ) {
                $linkMessage = $this->msg( $showhide[1 - $options[$key]] );
            }

            $link = $this->makeOptionsLink( $linkMessage->text(),
                [ $key => 1 - $options[$key] ], $nondefaults );
            $links[] = "<span class=\"$msg rcshowhideoption\">"
                . $this->msg( $msg )->rawParams( $link )->escaped() . '</span>';
        }

        // show from this onward link
        $timestamp = wfTimestampNow();
        $now = $lang->userTimeAndDate( $timestamp, $user );
        $timenow = $lang->userTime( $timestamp, $user );
        $datenow = $lang->userDate( $timestamp, $user );
        $pipedLinks = '<span class="rcshowhide">' . $lang->pipeList( $links ) . '</span>';

        $rclinks = '<span class="rclinks">' . $this->msg( 'rclinks' )->rawParams( $cl, $dl, $pipedLinks )
            ->parse() . '</span>';

        $rclistfrom = '<span class="rclistfrom">' . $this->makeOptionsLink(
            $this->msg( 'rclistfrom' )->rawParams( $now, $timenow, $datenow )->parse(),
            [ 'from' => $timestamp ],
            $nondefaults
        ) . '</span>';

        return "{$note}$rclinks<br />$rclistfrom";
    }

    public function isIncludable() {
        return true;
    }

    protected function getCacheTTL() {
        return 60 * 5;
    }

}