RCCacheEntryFactory.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Revision\RevisionRecord;

class RCCacheEntryFactory {

    /* @var IContextSource */
    private $context;

    /* @var string[] */
    private $messages;

    private $linkRenderer;

    public function __construct(
        IContextSource $context, $messages, LinkRenderer $linkRenderer
    ) {
        $this->context = $context;
        $this->messages = $messages;
        $this->linkRenderer = $linkRenderer;
    }

    public function newFromRecentChange( RecentChange $baseRC, $watched ) {
        $user = $this->context->getUser();

        $cacheEntry = RCCacheEntry::newFromParent( $baseRC );

        // Should patrol-related stuff be shown?
        $cacheEntry->unpatrolled = ChangesList::isUnpatrolled( $baseRC, $user );

        $cacheEntry->watched = $cacheEntry->mAttribs['rc_type'] == RC_LOG ? false : $watched;
        $cacheEntry->numberofWatchingusers = $baseRC->numberofWatchingusers;

        $cacheEntry->link = $this->buildCLink( $cacheEntry );
        $cacheEntry->timestamp = $this->buildTimestamp( $cacheEntry );

        // Make "cur" and "diff" links.  Do not use link(), it is too slow if
        // called too many times (50% of CPU time on RecentChanges!).
        $showDiffLinks = $this->showDiffLinks( $cacheEntry, $user );

        $cacheEntry->difflink = $this->buildDiffLink( $cacheEntry, $showDiffLinks );
        $cacheEntry->curlink = $this->buildCurLink( $cacheEntry, $showDiffLinks );
        $cacheEntry->lastlink = $this->buildLastLink( $cacheEntry, $showDiffLinks );

        // Make user links
        $cacheEntry->userlink = $this->getUserLink( $cacheEntry );

        if ( !ChangesList::isDeleted( $cacheEntry, RevisionRecord::DELETED_USER ) ) {
            $cacheEntry->usertalklink = Linker::userToolLinks(
                $cacheEntry->mAttribs['rc_user'],
                $cacheEntry->mAttribs['rc_user_text'],
                // Should the contributions link be red if the user has no edits (using default)
                false,
                // Customisation flags (using default 0)
                0,
                // User edit count (using default )
                null,
                // do not wrap the message in parentheses
                false
            );
        }

        return $cacheEntry;
    }

    private function showDiffLinks( RecentChange $cacheEntry, User $user ) {
        return ChangesList::userCan( $cacheEntry, RevisionRecord::DELETED_TEXT, $user );
    }

    private function buildCLink( RCCacheEntry $cacheEntry ) {
        $type = $cacheEntry->mAttribs['rc_type'];

        // New unpatrolled pages
        if ( $cacheEntry->unpatrolled && $type == RC_NEW ) {
            $clink = $this->linkRenderer->makeKnownLink( $cacheEntry->getTitle() );
        // Log entries
        } elseif ( $type == RC_LOG ) {
            $logType = $cacheEntry->mAttribs['rc_log_type'];

            if ( $logType ) {
                $clink = $this->getLogLink( $logType );
            } else {
                wfDebugLog( 'recentchanges', 'Unexpected log entry with no log type in recent changes' );
                $clink = $this->linkRenderer->makeLink( $cacheEntry->getTitle() );
            }
        // Log entries (old format) and special pages
        } elseif ( $cacheEntry->mAttribs['rc_namespace'] == NS_SPECIAL ) {
            wfDebugLog( 'recentchanges', 'Unexpected special page in recentchanges' );
            $clink = '';
        // Edits
        } else {
            $clink = $this->linkRenderer->makeKnownLink( $cacheEntry->getTitle() );
        }

        return $clink;
    }

    private function getLogLink( $logType ) {
        $logtitle = SpecialPage::getTitleFor( 'Log', $logType );
        $logpage = new LogPage( $logType );
        $logname = $logpage->getName()->text();

        $logLink = $this->context->msg( 'parentheses' )
            ->rawParams(
                $this->linkRenderer->makeKnownLink( $logtitle, $logname )
            )->escaped();

        return $logLink;
    }

    private function buildTimestamp( RecentChange $cacheEntry ) {
        return $this->context->getLanguage()->userTime(
            $cacheEntry->mAttribs['rc_timestamp'],
            $this->context->getUser()
        );
    }

    private function buildCurQueryParams( RecentChange $recentChange ) {
        return [
            'curid' => $recentChange->mAttribs['rc_cur_id'],
            'diff' => 0,
            'oldid' => $recentChange->mAttribs['rc_this_oldid']
        ];
    }

    private function buildCurLink( RecentChange $cacheEntry, $showDiffLinks ) {
        $queryParams = $this->buildCurQueryParams( $cacheEntry );
        $curMessage = $this->getMessage( 'cur' );
        $logTypes = [ RC_LOG ];

        if ( !$showDiffLinks || in_array( $cacheEntry->mAttribs['rc_type'], $logTypes ) ) {
            $curLink = $curMessage;
        } else {
            $curUrl = htmlspecialchars( $cacheEntry->getTitle()->getLinkURL( $queryParams ) );
            $curLink = "<a class=\"mw-changeslist-diff-cur\" href=\"$curUrl\">$curMessage</a>";
        }

        return $curLink;
    }

    private function buildDiffQueryParams( RecentChange $recentChange ) {
        return [
            'curid' => $recentChange->mAttribs['rc_cur_id'],
            'diff' => $recentChange->mAttribs['rc_this_oldid'],
            'oldid' => $recentChange->mAttribs['rc_last_oldid']
        ];
    }

    private function buildDiffLink( RecentChange $cacheEntry, $showDiffLinks ) {
        $queryParams = $this->buildDiffQueryParams( $cacheEntry );
        $diffMessage = $this->getMessage( 'diff' );
        $logTypes = [ RC_NEW, RC_LOG ];

        if ( !$showDiffLinks ) {
            $diffLink = $diffMessage;
        } elseif ( in_array( $cacheEntry->mAttribs['rc_type'], $logTypes ) ) {
            $diffLink = $diffMessage;
        } elseif ( $cacheEntry->getAttribute( 'rc_type' ) == RC_CATEGORIZE ) {
            $rcCurId = $cacheEntry->getAttribute( 'rc_cur_id' );
            $pageTitle = Title::newFromID( $rcCurId );
            if ( $pageTitle === null ) {
                wfDebugLog( 'RCCacheEntryFactory', 'Could not get Title for rc_cur_id: ' . $rcCurId );
                return $diffMessage;
            }
            $diffUrl = htmlspecialchars( $pageTitle->getLinkURL( $queryParams ) );
            $diffLink = "<a class=\"mw-changeslist-diff\" href=\"$diffUrl\">$diffMessage</a>";
        } else {
            $diffUrl = htmlspecialchars( $cacheEntry->getTitle()->getLinkURL( $queryParams ) );
            $diffLink = "<a class=\"mw-changeslist-diff\" href=\"$diffUrl\">$diffMessage</a>";
        }

        return $diffLink;
    }

    private function buildLastLink( RecentChange $cacheEntry, $showDiffLinks ) {
        $lastOldid = $cacheEntry->mAttribs['rc_last_oldid'];
        $lastMessage = $this->getMessage( 'last' );
        $type = $cacheEntry->mAttribs['rc_type'];
        $logTypes = [ RC_LOG ];

        // Make "last" link
        if ( !$showDiffLinks || !$lastOldid || in_array( $type, $logTypes ) ) {
            $lastLink = $lastMessage;
        } else {
            $lastLink = $this->linkRenderer->makeKnownLink(
                $cacheEntry->getTitle(),
                new HtmlArmor( $lastMessage ),
                [ 'class' => 'mw-changeslist-diff' ],
                $this->buildDiffQueryParams( $cacheEntry )
            );
        }

        return $lastLink;
    }

    private function getUserLink( RecentChange $cacheEntry ) {
        if ( ChangesList::isDeleted( $cacheEntry, RevisionRecord::DELETED_USER ) ) {
            $userLink = ' <span class="history-deleted">' .
                $this->context->msg( 'rev-deleted-user' )->escaped() . '</span>';
        } else {
            $userLink = Linker::userLink(
                $cacheEntry->mAttribs['rc_user'],
                $cacheEntry->mAttribs['rc_user_text'],
                ExternalUserNames::getLocal( $cacheEntry->mAttribs['rc_user_text'] )
            );
        }

        return $userLink;
    }

    private function getMessage( $key ) {
        return $this->messages[$key];
    }

}