ChangesList.php

Go to the documentation of this file.

<?php
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\User\UserIdentityValue;
use OOUI\IconWidget;
use Wikimedia\Rdbms\IResultWrapper;
 
class ChangesList extends ContextSource {
    use ProtectedHookAccessorTrait;
 
    public const CSS_CLASS_PREFIX = 'mw-changeslist-';
 
    protected $watchlist = false;
    protected $lastdate;
    protected $message;
    protected $rc_cache;
    protected $rcCacheIndex;
    protected $rclistOpen;
    protected $rcMoveIndex;
 
    protected $changeLinePrefixer;
 
    protected $watchMsgCache;
 
    protected $linkRenderer;
 
    protected $filterGroups;
 
    public function __construct( $context, array $filterGroups = [] ) {
        $this->setContext( $context );
        $this->preCacheMessages();
        $this->watchMsgCache = new MapCacheLRU( 50 );
        $this->linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        $this->filterGroups = $filterGroups;
    }
 
    public static function newFromContext( IContextSource $context, array $groups = [] ) {
        $user = $context->getUser();
        $sk = $context->getSkin();
        $list = null;
        if ( Hooks::runner()->onFetchChangesList( $user, $sk, $list, $groups ) ) {
            $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
 
            return $new ?
                new EnhancedChangesList( $context, $groups ) :
                new OldChangesList( $context, $groups );
        } else {
            return $list;
        }
    }
 
    public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
        throw new RuntimeException( 'recentChangesLine should be implemented' );
    }
 
    protected function getHighlightsContainerDiv() {
        $highlightColorDivs = '';
        foreach ( [ 'none', 'c1', 'c2', 'c3', 'c4', 'c5' ] as $color ) {
            $highlightColorDivs .= Html::rawElement(
                'div',
                [
                    'class' => 'mw-rcfilters-ui-highlights-color-' . $color,
                    'data-color' => $color
                ]
            );
        }
 
        return Html::rawElement(
            'div',
            [ 'class' => 'mw-rcfilters-ui-highlights' ],
            $highlightColorDivs
        );
    }
 
    public function setWatchlistDivs( $value = true ) {
        $this->watchlist = $value;
    }
 
    public function isWatchlist() {
        return (bool)$this->watchlist;
    }
 
    private function preCacheMessages() {
        if ( !isset( $this->message ) ) {
            $this->message = [];
            foreach ( [
                'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
                'semicolon-separator', 'pipe-separator' ] as $msg
            ) {
                $this->message[$msg] = $this->msg( $msg )->escaped();
            }
        }
    }
 
    public function recentChangesFlags( $flags, $nothing = "\u{00A0}" ) {
        $f = '';
        foreach ( array_keys( $this->getConfig()->get( 'RecentChangesFlags' ) ) as $flag ) {
            $f .= isset( $flags[$flag] ) && $flags[$flag]
                ? self::flag( $flag, $this->getContext() )
                : $nothing;
        }
 
        return $f;
    }
 
    protected function getHTMLClasses( $rc, $watched ) {
        $classes = [ self::CSS_CLASS_PREFIX . 'line' ];
        $logType = $rc->mAttribs['rc_log_type'];
 
        if ( $logType ) {
            $classes[] = self::CSS_CLASS_PREFIX . 'log';
            $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'log-' . $logType );
        } else {
            $classes[] = self::CSS_CLASS_PREFIX . 'edit';
            $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns' .
                $rc->mAttribs['rc_namespace'] . '-' . $rc->mAttribs['rc_title'] );
        }
 
        // Indicate watched status on the line to allow for more
        // comprehensive styling.
        $classes[] = $watched && $rc->mAttribs['rc_timestamp'] >= $watched
            ? self::CSS_CLASS_PREFIX . 'line-watched'
            : self::CSS_CLASS_PREFIX . 'line-not-watched';
 
        $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rc ) );
 
        return $classes;
    }
 
    protected function getHTMLClassesForFilters( $rc ) {
        $classes = [];
 
        $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns-' .
            $rc->mAttribs['rc_namespace'] );
 
        $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
        $classes[] = Sanitizer::escapeClass(
            self::CSS_CLASS_PREFIX .
            'ns-' .
            ( $nsInfo->isTalk( $rc->mAttribs['rc_namespace'] ) ? 'talk' : 'subject' )
        );
 
        foreach ( $this->filterGroups as $filterGroup ) {
            foreach ( $filterGroup->getFilters() as $filter ) {
                $filter->applyCssClassIfNeeded( $this, $rc, $classes );
            }
        }
 
        return $classes;
    }
 
    public static function flag( $flag, IContextSource $context = null ) {
        static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
        static $flagInfos = null;
 
        if ( $flagInfos === null ) {
            global $wgRecentChangesFlags;
            $flagInfos = [];
            foreach ( $wgRecentChangesFlags as $key => $value ) {
                $flagInfos[$key]['letter'] = $value['letter'];
                $flagInfos[$key]['title'] = $value['title'];
                // Allow customized class name, fall back to flag name
                $flagInfos[$key]['class'] = $value['class'] ?? $key;
            }
        }
 
        $context = $context ?: RequestContext::getMain();
 
        // Inconsistent naming, kepted for b/c
        if ( isset( $map[$flag] ) ) {
            $flag = $map[$flag];
        }
 
        $info = $flagInfos[$flag];
        return Html::element( 'abbr', [
            'class' => $info['class'],
            'title' => wfMessage( $info['title'] )->setContext( $context )->text(),
        ], wfMessage( $info['letter'] )->setContext( $context )->text() );
    }
 
    public function beginRecentChangesList() {
        $this->rc_cache = [];
        $this->rcMoveIndex = 0;
        $this->rcCacheIndex = 0;
        $this->lastdate = '';
        $this->rclistOpen = false;
        $this->getOutput()->addModuleStyles( [
            'mediawiki.interface.helpers.styles',
            'mediawiki.special.changeslist'
        ] );
 
        return '<div class="mw-changeslist">';
    }
 
    public function initChangesListRows( $rows ) {
        $this->getHookRunner()->onChangesListInitRows( $this, $rows );
    }
 
    public static function showCharacterDifference( $old, $new, IContextSource $context = null ) {
        if ( !$context ) {
            $context = RequestContext::getMain();
        }
 
        $new = (int)$new;
        $old = (int)$old;
        $szdiff = $new - $old;
 
        $lang = $context->getLanguage();
        $config = $context->getConfig();
        $code = $lang->getCode();
        static $fastCharDiff = [];
        if ( !isset( $fastCharDiff[$code] ) ) {
            $fastCharDiff[$code] = $config->get( 'MiserMode' )
                || $context->msg( 'rc-change-size' )->plain() === '$1';
        }
 
        $formattedSize = $lang->formatNum( $szdiff );
 
        if ( !$fastCharDiff[$code] ) {
            $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
        }
 
        if ( abs( $szdiff ) > abs( $config->get( 'RCChangedSizeThreshold' ) ) ) {
            $tag = 'strong';
        } else {
            $tag = 'span';
        }
 
        if ( $szdiff === 0 ) {
            $formattedSizeClass = 'mw-plusminus-null';
        } elseif ( $szdiff > 0 ) {
            $formattedSize = '+' . $formattedSize;
            $formattedSizeClass = 'mw-plusminus-pos';
        } else {
            $formattedSizeClass = 'mw-plusminus-neg';
        }
        $formattedSizeClass .= ' mw-diff-bytes';
 
        $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
 
        return Html::element( $tag,
            [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
            $formattedSize ) . $lang->getDirMark();
    }
 
    public function formatCharacterDifference( RecentChange $old, RecentChange $new = null ) {
        $oldlen = $old->mAttribs['rc_old_len'];
 
        if ( $new ) {
            $newlen = $new->mAttribs['rc_new_len'];
        } else {
            $newlen = $old->mAttribs['rc_new_len'];
        }
 
        if ( $oldlen === null || $newlen === null ) {
            return '';
        }
 
        return self::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
    }
 
    public function endRecentChangesList() {
        $out = $this->rclistOpen ? "</ul>\n" : '';
        $out .= '</div>';
 
        return $out;
    }
 
    public static function revDateLink(
        RevisionRecord $rev,
        Authority $performer,
        Language $lang,
        $title = null
    ) {
        $ts = $rev->getTimestamp();
        $date = $lang->userTimeAndDate( $ts, $performer->getUser() );
        if ( $rev->userCan( RevisionRecord::DELETED_TEXT, $performer ) ) {
            $link = MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
                $title ?? $rev->getPageAsLinkTarget(),
                $date,
                [ 'class' => 'mw-changeslist-date' ],
                [ 'oldid' => $rev->getId() ]
            );
        } else {
            $link = htmlspecialchars( $date );
        }
        if ( $rev->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
            $deletedClass = Linker::getRevisionDeletedClass( $rev );
            $link = "<span class=\"$deletedClass mw-changeslist-date\">$link</span>";
        }
        return $link;
    }
 
    public function insertDateHeader( &$s, $rc_timestamp ) {
        # Make date header if necessary
        $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
        if ( $date != $this->lastdate ) {
            if ( $this->lastdate != '' ) {
                $s .= "</ul>\n";
            }
            $s .= Xml::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
            $this->lastdate = $date;
            $this->rclistOpen = true;
        }
    }
 
    public function insertLog( &$s, $title, $logtype, $useParentheses = true ) {
        $page = new LogPage( $logtype );
        $logname = $page->getName()->setContext( $this->getContext() )->text();
        $link = $this->linkRenderer->makeKnownLink( $title, $logname, [
            'class' => $useParentheses ? '' : 'mw-changeslist-links'
        ] );
        if ( $useParentheses ) {
            $s .= $this->msg( 'parentheses' )->rawParams(
                $link
            )->escaped();
        } else {
            $s .= $link;
        }
    }
 
    public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
        # Diff link
        if (
            $rc->mAttribs['rc_type'] == RC_NEW ||
            $rc->mAttribs['rc_type'] == RC_LOG ||
            $rc->mAttribs['rc_type'] == RC_CATEGORIZE
        ) {
            $diffLink = $this->message['diff'];
        } elseif ( !self::userCan( $rc, RevisionRecord::DELETED_TEXT, $this->getAuthority() ) ) {
            $diffLink = $this->message['diff'];
        } else {
            $query = [
                'curid' => $rc->mAttribs['rc_cur_id'],
                'diff' => $rc->mAttribs['rc_this_oldid'],
                'oldid' => $rc->mAttribs['rc_last_oldid']
            ];
 
            $diffLink = $this->linkRenderer->makeKnownLink(
                $rc->getTitle(),
                new HtmlArmor( $this->message['diff'] ),
                [ 'class' => 'mw-changeslist-diff' ],
                $query
            );
        }
        if ( $rc->mAttribs['rc_type'] == RC_CATEGORIZE ) {
            $histLink = $this->message['hist'];
        } else {
            $histLink = $this->linkRenderer->makeKnownLink(
                $rc->getTitle(),
                new HtmlArmor( $this->message['hist'] ),
                [ 'class' => 'mw-changeslist-history' ],
                [
                    'curid' => $rc->mAttribs['rc_cur_id'],
                    'action' => 'history'
                ]
            );
        }
 
        $s .= Html::rawElement( 'div', [ 'class' => 'mw-changeslist-links' ],
                Html::rawElement( 'span', [], $diffLink ) .
                Html::rawElement( 'span', [], $histLink )
            ) .
            ' <span class="mw-changeslist-separator"></span> ';
    }
 
    public function getArticleLink( &$rc, $unpatrolled, $watched ) {
        $params = [];
        if ( $rc->getTitle()->isRedirect() ) {
            $params = [ 'redirect' => 'no' ];
        }
 
        $articlelink = $this->linkRenderer->makeLink(
            $rc->getTitle(),
            null,
            [ 'class' => 'mw-changeslist-title' ],
            $params
        );
        if ( $this->isDeleted( $rc, RevisionRecord::DELETED_TEXT ) ) {
            $class = 'history-deleted';
            if ( $this->isDeleted( $rc, RevisionRecord::DELETED_RESTRICTED ) ) {
                $class .= ' mw-history-suppressed';
            }
            $articlelink = '<span class="' . $class . '">' . $articlelink . '</span>';
        }
        # To allow for boldening pages watched by this user
        $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
        # RTL/LTR marker
        $articlelink .= $this->getLanguage()->getDirMark();
 
        # TODO: Deprecate the $s argument, it seems happily unused.
        $s = '';
        $this->getHookRunner()->onChangesListInsertArticleLink( $this, $articlelink,
            $s, $rc, $unpatrolled, $watched );
 
        // Watchlist expiry icon.
        $watchlistExpiry = '';
        if ( isset( $rc->watchlistExpiry ) && $rc->watchlistExpiry ) {
            $watchlistExpiry = $this->getWatchlistExpiry( $rc );
        }
 
        return "{$s} {$articlelink}{$watchlistExpiry}";
    }
 
    public function getWatchlistExpiry( RecentChange $recentChange ): string {
        $item = WatchedItem::newFromRecentChange( $recentChange, $this->getUser() );
        // Guard against expired items, even though they shouldn't come here.
        if ( $item->isExpired() ) {
            return '';
        }
        $daysLeftText = $item->getExpiryInDaysText( $this->getContext() );
        // Matching widget is also created in ChangesListSpecialPage, for the legend.
        $widget = new IconWidget( [
            'icon' => 'clock',
            'title' => $daysLeftText,
            'classes' => [ 'mw-changesList-watchlistExpiry' ],
        ] );
        $widget->setAttributes( [
            // Add labels for assistive technologies.
            'role' => 'img',
            'aria-label' => $this->msg( 'watchlist-expires-in-aria-label' )->text(),
            // Days-left is used in resources/src/mediawiki.special.changeslist.watchlistexpiry/watchlistexpiry.js
            'data-days-left' => $item->getExpiryInDays(),
        ] );
        // Add spaces around the widget (the page title is to one side,
        // and a semicolon or opening-parenthesis to the other).
        return " $widget ";
    }
 
    public function getTimestamp( $rc ) {
        // This uses the semi-colon separator unless there's a watchlist expiry date for the entry,
        // because in that case the timestamp is preceeded by a clock icon.
        // A space is important after mw-changeslist-separator--semicolon to make sure
        // that whatever comes before it is distinguishable.
        // (Otherwise your have the text of titles pushing up against the timestamp)
        // A specific element is used for this purpose as `mw-changeslist-date` is used in a variety
        // of other places with a different position and the information proceeding getTimestamp can vary.
        $separatorClass = $rc->watchlistExpiry ? 'mw-changeslist-separator' : 'mw-changeslist-separator--semicolon';
        return Html::element( 'span', [ 'class' => $separatorClass ] ) . ' ' .
            '<span class="mw-changeslist-date">' .
            htmlspecialchars( $this->getLanguage()->userTime(
                $rc->mAttribs['rc_timestamp'],
                $this->getUser()
            ) ) . '</span> <span class="mw-changeslist-separator"></span> ';
    }
 
    public function insertTimestamp( &$s, $rc ) {
        $s .= $this->getTimestamp( $rc );
    }
 
    public function insertUserRelatedLinks( &$s, &$rc ) {
        if ( $this->isDeleted( $rc, RevisionRecord::DELETED_USER ) ) {
            $deletedClass = 'history-deleted';
            if ( $this->isDeleted( $rc, RevisionRecord::DELETED_RESTRICTED ) ) {
                $deletedClass = ' mw-history-suppressed';
            }
            $s .= ' <span class="' . $deletedClass . '">' .
                $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
        } else {
            $s .= $this->getLanguage()->getDirMark() . Linker::userLink( $rc->mAttribs['rc_user'],
                $rc->mAttribs['rc_user_text'] );
            $s .= Linker::userToolLinks(
                $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'],
                false, 0, null,
                // The text content of tools is not wrapped with parenthesises or "piped".
                // This will be handled in CSS (T205581).
                false
            );
        }
    }
 
    public function insertLogEntry( $rc ) {
        $formatter = LogFormatter::newFromRow( $rc->mAttribs );
        $formatter->setContext( $this->getContext() );
        $formatter->setShowUserToolLinks( true );
        $mark = $this->getLanguage()->getDirMark();
 
        return Html::openElement( 'span', [ 'class' => 'mw-changeslist-log-entry' ] )
            . $formatter->getActionText() . " $mark" . $formatter->getComment()
            . Html::closeElement( 'span' );
    }
 
    public function insertComment( $rc ) {
        if ( $this->isDeleted( $rc, RevisionRecord::DELETED_COMMENT ) ) {
            $deletedClass = 'history-deleted';
            if ( $this->isDeleted( $rc, RevisionRecord::DELETED_RESTRICTED ) ) {
                $deletedClass .= ' mw-history-suppressed';
            }
            return ' <span class="' . $deletedClass . ' comment">' .
                $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
        } else {
            return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle(),
                // Whether section links should refer to local page (using default false)
                false,
                // wikid to generate links for (using default null) */
                null,
                // whether parentheses should be rendered as part of the message
                false );
        }
    }
 
    protected function numberofWatchingusers( $count ) {
        if ( $count <= 0 ) {
            return '';
        }
 
        return $this->watchMsgCache->getWithSetCallback(
            "watching-users-msg:$count",
            function () use ( $count ) {
                return $this->msg( 'number-of-watching-users-for-recent-changes' )
                    ->numParams( $count )->escaped();
            }
        );
    }
 
    public static function isDeleted( $rc, $field ) {
        return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
    }
 
    public static function userCan( $rc, $field, Authority $performer = null ) {
        if ( $performer === null ) {
            $performer = RequestContext::getMain()->getAuthority();
        }
 
        if ( $rc->mAttribs['rc_type'] == RC_LOG ) {
            return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $performer );
        }
 
        return RevisionRecord::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $performer );
    }
 
    protected function maybeWatchedLink( $link, $watched = false ) {
        if ( $watched ) {
            return '<strong class="mw-watched">' . $link . '</strong>';
        } else {
            return '<span class="mw-rc-unwatched">' . $link . '</span>';
        }
    }
 
    public function insertRollback( &$s, &$rc ) {
        if ( $rc->mAttribs['rc_type'] == RC_EDIT
            && $rc->mAttribs['rc_this_oldid']
            && $rc->mAttribs['rc_cur_id']
            && $rc->getAttribute( 'page_latest' ) == $rc->mAttribs['rc_this_oldid']
        ) {
            $title = $rc->getTitle();
            if ( $this->getAuthority()->probablyCan( 'rollback', $title ) ) {
                $revRecord = new MutableRevisionRecord( $title );
                $revRecord->setId( (int)$rc->mAttribs['rc_this_oldid'] );
                $revRecord->setVisibility( (int)$rc->mAttribs['rc_deleted'] );
                $user = new UserIdentityValue(
                    (int)$rc->mAttribs['rc_user'],
                    $rc->mAttribs['rc_user_text']
                );
                $revRecord->setUser( $user );
 
                $s .= ' ';
                $s .= Linker::generateRollback(
                    $revRecord,
                    $this->getContext(),
                    [ 'noBrackets' ]
                );
            }
        }
    }
 
    public function getRollback( RecentChange $rc ) {
        $s = '';
        $this->insertRollback( $s, $rc );
        return $s;
    }
 
    public function insertTags( &$s, &$rc, &$classes ) {
        if ( empty( $rc->mAttribs['ts_tags'] ) ) {
            return;
        }
 
        list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
            $rc->mAttribs['ts_tags'],
            'changeslist',
            $this->getContext()
        );
        $classes = array_merge( $classes, $newClasses );
        $s .= ' ' . $tagSummary;
    }
 
    public function getTags( RecentChange $rc, array &$classes ) {
        $s = '';
        $this->insertTags( $s, $rc, $classes );
        return $s;
    }
 
    public function insertExtra( &$s, &$rc, &$classes ) {
        // Empty, used for subclasses to add anything special.
    }
 
    protected function showAsUnpatrolled( RecentChange $rc ) {
        return self::isUnpatrolled( $rc, $this->getUser() );
    }
 
    public static function isUnpatrolled( $rc, User $user ) {
        if ( $rc instanceof RecentChange ) {
            $isPatrolled = $rc->mAttribs['rc_patrolled'];
            $rcType = $rc->mAttribs['rc_type'];
            $rcLogType = $rc->mAttribs['rc_log_type'];
        } else {
            $isPatrolled = $rc->rc_patrolled;
            $rcType = $rc->rc_type;
            $rcLogType = $rc->rc_log_type;
        }
 
        if ( !$isPatrolled ) {
            if ( $user->useRCPatrol() ) {
                return true;
            }
            if ( $user->useNPPatrol() && $rcType == RC_NEW ) {
                return true;
            }
            if ( $user->useFilePatrol() && $rcLogType == 'upload' ) {
                return true;
            }
        }
 
        return false;
    }
 
    protected function isCategorizationWithoutRevision( $rcObj ) {
        return intval( $rcObj->getAttribute( 'rc_type' ) ) === RC_CATEGORIZE
            && intval( $rcObj->getAttribute( 'rc_this_oldid' ) ) === 0;
    }
 
    protected function getDataAttributes( RecentChange $rc ) {
        $attrs = [];
 
        $type = $rc->getAttribute( 'rc_source' );
        switch ( $type ) {
            case RecentChange::SRC_EDIT:
            case RecentChange::SRC_NEW:
                $attrs['data-mw-revid'] = $rc->mAttribs['rc_this_oldid'];
                break;
            case RecentChange::SRC_LOG:
                $attrs['data-mw-logid'] = $rc->mAttribs['rc_logid'];
                $attrs['data-mw-logaction'] =
                    $rc->mAttribs['rc_log_type'] . '/' . $rc->mAttribs['rc_log_action'];
                break;
        }
 
        $attrs[ 'data-mw-ts' ] = $rc->getAttribute( 'rc_timestamp' );
 
        return $attrs;
    }
 
    public function setChangeLinePrefixer( callable $prefixer ) {
        $this->changeLinePrefixer = $prefixer;
    }
}