ChangesList.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;

class ChangesList extends ContextSource {
    public $skin;

    protected $watchlist = false;
    protected $lastdate;
    protected $message;
    protected $rc_cache;
    protected $rcCacheIndex;
    protected $rclistOpen;
    protected $rcMoveIndex;

    protected $watchMsgCache;

    protected $linkRenderer;

    public function __construct( $obj ) {
        if ( $obj instanceof IContextSource ) {
            $this->setContext( $obj );
            $this->skin = $obj->getSkin();
        } else {
            $this->setContext( $obj->getContext() );
            $this->skin = $obj;
        }
        $this->preCacheMessages();
        $this->watchMsgCache = new HashBagOStuff( [ 'maxKeys' => 50 ] );
        $this->linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
    }

    public static function newFromContext( IContextSource $context ) {
        $user = $context->getUser();
        $sk = $context->getSkin();
        $list = null;
        if ( Hooks::run( 'FetchChangesList', [ $user, &$sk, &$list ] ) ) {
            $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );

            return $new ? new EnhancedChangesList( $context ) : new OldChangesList( $context );
        } else {
            return $list;
        }
    }

    public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
        throw new RuntimeException( 'recentChangesLine should be implemented' );
    }

    public function setWatchlistDivs( $value = true ) {
        $this->watchlist = $value;
    }

    public function isWatchlist() {
        return (bool)$this->watchlist;
    }

    private function preCacheMessages() {
        if ( !isset( $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 = '&#160;' ) {
        $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 = [];
        $logType = $rc->mAttribs['rc_log_type'];

        if ( $logType ) {
            $classes[] = Sanitizer::escapeClass( 'mw-changeslist-log-' . $logType );
        } else {
            $classes[] = Sanitizer::escapeClass( 'mw-changeslist-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
            ? 'mw-changeslist-line-watched'
            : 'mw-changeslist-line-not-watched';

        return $classes;
    }

    public static function flag( $flag, IContextSource $context = null ) {
        static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
        static $flagInfos = null;

        if ( is_null( $flagInfos ) ) {
            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'] = isset( $value['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.special.changeslist' );

        return '<div class="mw-changeslist">';
    }

    public function initChangesListRows( $rows ) {
        Hooks::run( 'ChangesListInitRows', [ $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';
        }

        $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();

        return Html::element( $tag,
            [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
            $context->msg( 'parentheses', $formattedSize )->plain() ) . $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 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 ) {
        $page = new LogPage( $logtype );
        $logname = $page->getName()->setContext( $this->getContext() )->text();
        $s .= $this->msg( 'parentheses' )->rawParams(
            $this->linkRenderer->makeKnownLink( $title, $logname )
        )->escaped();
    }

    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, Revision::DELETED_TEXT, $this->getUser() ) ) {
            $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'] ),
                [],
                $query
            );
        }
        if ( $rc->mAttribs['rc_type'] == RC_CATEGORIZE ) {
            $diffhist = $diffLink . $this->message['pipe-separator'] . $this->message['hist'];
        } else {
            $diffhist = $diffLink . $this->message['pipe-separator'];
            # History link
            $diffhist .= $this->linkRenderer->makeKnownLink(
                $rc->getTitle(),
                new HtmlArmor( $this->message['hist'] ),
                [],
                [
                    'curid' => $rc->mAttribs['rc_cur_id'],
                    'action' => 'history'
                ]
            );
        }

        // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
        $s .= $this->msg( 'parentheses' )->rawParams( $diffhist )->escaped() .
            ' <span class="mw-changeslist-separator">. .</span> ';
    }

    public function insertArticleLink( &$s, RecentChange $rc, $unpatrolled, $watched ) {
        $s .= $this->getArticleLink( $rc, $unpatrolled, $watched );
    }

    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, Revision::DELETED_TEXT ) ) {
            $articlelink = '<span class="history-deleted">' . $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 = '';
        Hooks::run( 'ChangesListInsertArticleLink',
            [ &$this, &$articlelink, &$s, &$rc, $unpatrolled, $watched ] );

        return "{$s} {$articlelink}";
    }

    public function getTimestamp( $rc ) {
        // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
        return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' .
            $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, Revision::DELETED_USER ) ) {
            $s .= ' <span class="history-deleted">' .
                $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'] );
        }
    }

    public function insertLogEntry( $rc ) {
        $formatter = LogFormatter::newFromRow( $rc->mAttribs );
        $formatter->setContext( $this->getContext() );
        $formatter->setShowUserToolLinks( true );
        $mark = $this->getLanguage()->getDirMark();

        return $formatter->getActionText() . " $mark" . $formatter->getComment();
    }

    public function insertComment( $rc ) {
        if ( $this->isDeleted( $rc, Revision::DELETED_COMMENT ) ) {
            return ' <span class="history-deleted">' .
                $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
        } else {
            return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
        }
    }

    protected function numberofWatchingusers( $count ) {
        if ( $count <= 0 ) {
            return '';
        }
        $cache = $this->watchMsgCache;
        return $cache->getWithSetCallback( $count, $cache::TTL_INDEFINITE,
            function () use ( $count ) {
                return $this->msg( 'number_of_watching_users_RCview' )
                    ->numParams( $count )->escaped();
            }
        );
    }

    public static function isDeleted( $rc, $field ) {
        return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
    }

    public static function userCan( $rc, $field, User $user = null ) {
        if ( $rc->mAttribs['rc_type'] == RC_LOG ) {
            return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
        } else {
            return Revision::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
        }
    }

    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']
        ) {
            $page = $rc->getTitle();
            if ( $this->getUser()->isAllowed( 'rollback' )
                && $rc->mAttribs['page_latest'] == $rc->mAttribs['rc_this_oldid']
            ) {
                $rev = new Revision( [
                    'title' => $page,
                    'id' => $rc->mAttribs['rc_this_oldid'],
                    'user' => $rc->mAttribs['rc_user'],
                    'user_text' => $rc->mAttribs['rc_user_text'],
                    'deleted' => $rc->mAttribs['rc_deleted']
                ] );
                $s .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
            }
        }
    }

    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;
    }

}