8fb118cb8b
It is part of the component at https://phabricator.wikimedia.org/tag/mediawiki-recent-changes/ and https://www.mediawiki.org/wiki/Developers/Maintainers and since Ifac20da51f7e809f under the same "Recent changes" doc group. The Maintainers list oddly enough lists only rcfeed and completely forgets the majority of it under /includes/changes (or now, /includes/recentchanges). Bug: T364652 Change-Id: I94e6705672c1e2821bdc726aa7a383d9e7c1f7b5
346 lines
10 KiB
PHP
346 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Context\IContextSource;
|
|
use MediaWiki\Linker\Linker;
|
|
use MediaWiki\Linker\LinkRenderer;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\SpecialPage\SpecialPage;
|
|
use MediaWiki\Title\Title;
|
|
use MediaWiki\User\ExternalUserNames;
|
|
|
|
/**
|
|
* Create a RCCacheEntry from a RecentChange to use in EnhancedChangesList
|
|
*
|
|
* @ingroup RecentChanges
|
|
*/
|
|
class RCCacheEntryFactory {
|
|
|
|
/** @var IContextSource */
|
|
private $context;
|
|
|
|
/** @var string[] */
|
|
private $messages;
|
|
|
|
/**
|
|
* @var LinkRenderer
|
|
*/
|
|
private $linkRenderer;
|
|
|
|
/**
|
|
* @var MapCacheLRU
|
|
*/
|
|
private MapCacheLRU $userLinkCache;
|
|
|
|
/**
|
|
* @var MapCacheLRU
|
|
*/
|
|
private MapCacheLRU $toolLinkCache;
|
|
|
|
/**
|
|
* @param IContextSource $context
|
|
* @param string[] $messages
|
|
* @param LinkRenderer $linkRenderer
|
|
*/
|
|
public function __construct(
|
|
IContextSource $context, $messages, LinkRenderer $linkRenderer
|
|
) {
|
|
$this->context = $context;
|
|
$this->messages = $messages;
|
|
$this->linkRenderer = $linkRenderer;
|
|
$this->userLinkCache = new MapCacheLRU( 50 );
|
|
$this->toolLinkCache = new MapCacheLRU( 50 );
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $baseRC
|
|
* @param bool $watched
|
|
*
|
|
* @return RCCacheEntry
|
|
*/
|
|
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->watchlistExpiry = $baseRC->watchlistExpiry;
|
|
|
|
$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 = ChangesList::userCan( $cacheEntry, RevisionRecord::DELETED_TEXT, $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 ) ) {
|
|
/**
|
|
* userToolLinks requires a lot of parser work to process multiple links that are
|
|
* rendered there, like contrib page, user talk etc. Often, active
|
|
* users will appear multiple times on same run of RecentChanges, and therefore it is
|
|
* unnecessary to process it for each RC record separately.
|
|
*/
|
|
$cacheEntry->usertalklink = $this->toolLinkCache->getWithSetCallback(
|
|
$this->toolLinkCache->makeKey(
|
|
$cacheEntry->mAttribs['rc_user_text'],
|
|
$this->context->getUser()->getName(),
|
|
$this->context->getLanguage()->getCode()
|
|
),
|
|
static fn () => 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;
|
|
}
|
|
|
|
/**
|
|
* @param RCCacheEntry $cacheEntry
|
|
*
|
|
* @return string
|
|
*/
|
|
private function buildCLink( RCCacheEntry $cacheEntry ) {
|
|
$type = $cacheEntry->mAttribs['rc_type'];
|
|
|
|
// Log entries
|
|
if ( $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 and everything else
|
|
} 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;
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $cacheEntry
|
|
*
|
|
* @return string
|
|
*/
|
|
private function buildTimestamp( RecentChange $cacheEntry ) {
|
|
return $this->context->getLanguage()->userTime(
|
|
$cacheEntry->mAttribs['rc_timestamp'],
|
|
$this->context->getUser()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $recentChange
|
|
*
|
|
* @return array
|
|
*/
|
|
private function buildCurQueryParams( RecentChange $recentChange ) {
|
|
return [
|
|
'curid' => $recentChange->mAttribs['rc_cur_id'],
|
|
'diff' => 0,
|
|
'oldid' => $recentChange->mAttribs['rc_this_oldid']
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $cacheEntry
|
|
* @param bool $showDiffLinks
|
|
*
|
|
* @return string
|
|
*/
|
|
private function buildCurLink( RecentChange $cacheEntry, $showDiffLinks ) {
|
|
$curMessage = $this->getMessage( 'cur' );
|
|
$logTypes = [ RC_LOG ];
|
|
if ( $cacheEntry->mAttribs['rc_this_oldid'] == $cacheEntry->getAttribute( 'page_latest' ) ) {
|
|
$showDiffLinks = false;
|
|
}
|
|
|
|
if ( !$showDiffLinks || in_array( $cacheEntry->mAttribs['rc_type'], $logTypes ) ) {
|
|
$curLink = $curMessage;
|
|
} else {
|
|
$queryParams = $this->buildCurQueryParams( $cacheEntry );
|
|
$curUrl = htmlspecialchars( $cacheEntry->getTitle()->getLinkURL( $queryParams ) );
|
|
$curLink = "<a class=\"mw-changeslist-diff-cur\" href=\"$curUrl\">$curMessage</a>";
|
|
}
|
|
|
|
return $curLink;
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $recentChange
|
|
*
|
|
* @return array
|
|
*/
|
|
private function buildDiffQueryParams( RecentChange $recentChange ) {
|
|
return [
|
|
'curid' => $recentChange->mAttribs['rc_cur_id'],
|
|
'diff' => $recentChange->mAttribs['rc_this_oldid'],
|
|
'oldid' => $recentChange->mAttribs['rc_last_oldid']
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $cacheEntry
|
|
* @param bool $showDiffLinks
|
|
*
|
|
* @return string
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Builds the link to the previous version
|
|
*
|
|
* @param RecentChange $cacheEntry
|
|
* @param bool $showDiffLinks
|
|
*
|
|
* @return string
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* @param RecentChange $cacheEntry
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getUserLink( RecentChange $cacheEntry ) {
|
|
if ( ChangesList::isDeleted( $cacheEntry, RevisionRecord::DELETED_USER ) ) {
|
|
$deletedClass = 'history-deleted';
|
|
if ( ChangesList::isDeleted( $cacheEntry, RevisionRecord::DELETED_RESTRICTED ) ) {
|
|
$deletedClass .= ' mw-history-suppressed';
|
|
}
|
|
$userLink = ' <span class="' . $deletedClass . '">' .
|
|
$this->context->msg( 'rev-deleted-user' )->escaped() . '</span>';
|
|
} else {
|
|
/**
|
|
* UserLink requires parser to render which when run on thousands of records can add
|
|
* up to significant amount of processing time.
|
|
* @see RCCacheEntryFactory::newFromRecentChange
|
|
*/
|
|
$userLink = $this->userLinkCache->getWithSetCallback(
|
|
$this->userLinkCache->makeKey(
|
|
$cacheEntry->mAttribs['rc_user_text'],
|
|
$this->context->getUser()->getName(),
|
|
$this->context->getLanguage()->getCode()
|
|
),
|
|
static fn () => Linker::userLink(
|
|
$cacheEntry->mAttribs['rc_user'],
|
|
$cacheEntry->mAttribs['rc_user_text'],
|
|
ExternalUserNames::getLocal( $cacheEntry->mAttribs['rc_user_text'] )
|
|
)
|
|
);
|
|
}
|
|
|
|
return $userLink;
|
|
}
|
|
|
|
/**
|
|
* @param string $key
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getMessage( $key ) {
|
|
return $this->messages[$key];
|
|
}
|
|
|
|
}
|