wiki.techinc.nl/includes/page/ImageHistoryList.php
AntiCompositeNumber e8e7f3f78a
Add timestamp to thumbnail URLs on file pages
When overwriting a file, the browser will sometimes display a cached old
version of the file instead of the new version. This is because the URLs
for the current version of a file (and thumbnails) are not versioned.

This patch adds the timestamp as a query parameter to the end of the
file URLs. Only the src and srcset URLs will have the timestamp, the
links to the original and thumbnails are not versioned. The current
version in the file history also gets the timestamp. Previous versions
already have a timestamp in the URL.

This timestamp is only used for client-side cache busting, it is not
interpreted server-side. On WMF sites it will be stripped out by the
caching layer anyway.

Bug: T38380
Change-Id: Ia63bd96a02d1aa36265742c4307f5af2e675b3ec
2022-01-25 15:41:37 -05:00

358 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\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
/**
* Builds the image revision log shown on image pages
*
* @ingroup Media
*/
class ImageHistoryList extends ContextSource {
use ProtectedHookAccessorTrait;
/**
* @var Title
*/
protected $title;
/**
* @var File
*/
protected $img;
/**
* @var ImagePage
*/
protected $imagePage;
/**
* @var File
*/
protected $current;
protected $repo, $showThumb;
protected $preventClickjacking = false;
/**
* @param ImagePage $imagePage
*/
public function __construct( $imagePage ) {
$context = $imagePage->getContext();
$this->current = $imagePage->getPage()->getFile();
$this->img = $imagePage->getDisplayedFile();
$this->title = $imagePage->getTitle();
$this->imagePage = $imagePage;
$this->showThumb = $context->getConfig()->get( 'ShowArchiveThumbnails' ) &&
$this->img->canRender();
$this->setContext( $context );
}
/**
* @return ImagePage
*/
public function getImagePage() {
return $this->imagePage;
}
/**
* @return File
*/
public function getFile() {
return $this->img;
}
/**
* @param string $navLinks
* @return string
*/
public function beginImageHistoryList( $navLinks = '' ) {
// Styles for class=history-deleted
$this->getOutput()->addModuleStyles( 'mediawiki.interface.helpers.styles' );
$html = '';
$canDelete = $this->current->isLocal() &&
$this->getAuthority()->isAllowedAny( 'delete', 'deletedhistory' );
foreach ( [
'',
$canDelete ? '' : null,
'filehist-datetime',
$this->showThumb ? 'filehist-thumb' : null,
'filehist-dimensions',
'filehist-user',
'filehist-comment',
] as $key ) {
if ( $key !== null ) {
$html .= Html::element( 'th', [], $key ? $this->msg( $key )->text() : '' );
}
}
return Html::element( 'h2', [ 'id' => 'filehistory' ], $this->msg( 'filehist' )->text() )
. "\n"
. Html::openElement( 'div', [ 'id' => 'mw-imagepage-section-filehistory' ] ) . "\n"
. $this->msg( 'filehist-help' )->parseAsBlock()
. $navLinks . "\n"
. Html::openElement( 'table', [ 'class' => 'wikitable filehistory' ] ) . "\n"
. Html::rawElement( 'tr', [], $html ) . "\n";
}
/**
* @param string $navLinks
* @return string
*/
public function endImageHistoryList( $navLinks = '' ) {
return Html::closeElement( 'table' ) . "\n" .
$navLinks . "\n" .
Html::closeElement( 'div' ) . "\n";
}
/**
* @internal
* @param bool $iscur
* @param File $file
* @param string $formattedComment
* @return string
*/
public function imageHistoryLine( $iscur, $file, $formattedComment ) {
$user = $this->getUser();
$lang = $this->getLanguage();
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
// @phan-suppress-next-line PhanUndeclaredMethod
$img = $iscur ? $file->getName() : $file->getArchiveName();
$uploader = $file->getUploader( File::FOR_THIS_USER, $user );
$local = $this->current->isLocal();
$row = '';
// Deletion link
if ( $local && ( $this->getAuthority()->isAllowedAny( 'delete', 'deletedhistory' ) ) ) {
$row .= Html::openElement( 'td' );
# Link to remove from history
if ( $this->getAuthority()->isAllowed( 'delete' ) ) {
$row .= $linkRenderer->makeKnownLink(
$this->title,
$this->msg( $iscur ? 'filehist-deleteall' : 'filehist-deleteone' )->text(),
[],
[ 'action' => 'delete', 'oldimage' => $iscur ? null : $img ]
);
}
# Link to hide content. Don't show useless link to people who cannot hide revisions.
$canHide = $this->getAuthority()->isAllowed( 'deleterevision' );
if ( $canHide || ( $this->getAuthority()->isAllowed( 'deletedhistory' )
&& $file->getVisibility() ) ) {
if ( $this->getAuthority()->isAllowed( 'delete' ) ) {
$row .= Html::element( 'br' );
}
// If file is top revision or locked from this user, don't link
if ( $iscur || !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
$row .= Linker::revDeleteLinkDisabled( $canHide );
} else {
$row .= Linker::revDeleteLink(
[
'type' => 'oldimage',
'target' => $this->title->getPrefixedText(),
'ids' => explode( '!', $img, 2 )[0],
],
$file->isDeleted( File::DELETED_RESTRICTED ),
$canHide
);
}
}
$row .= Html::closeElement( 'td' );
}
// Reversion link/current indicator
$row .= Html::openElement( 'td' );
if ( $iscur ) {
$row .= $this->msg( 'filehist-current' )->escaped();
} elseif ( $local && $this->getAuthority()->probablyCan( 'edit', $this->title )
&& $this->getAuthority()->probablyCan( 'upload', $this->title )
) {
if ( $file->isDeleted( File::DELETED_FILE ) ) {
$row .= $this->msg( 'filehist-revert' )->escaped();
} else {
$row .= $linkRenderer->makeKnownLink(
$this->title,
$this->msg( 'filehist-revert' )->text(),
[],
[
'action' => 'revert',
'oldimage' => $img,
]
);
}
}
$row .= Html::closeElement( 'td' );
// Date/time and image link
$selected = $file->getTimestamp() === $this->img->getTimestamp();
$row .= Html::openElement( 'td', [
'class' => $selected ? 'filehistory-selected' : null,
'style' => 'white-space: nowrap;'
] );
if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
# Don't link to unviewable files
$row .= Html::element( 'span', [ 'class' => 'history-deleted' ],
$lang->userTimeAndDate( $timestamp, $user )
);
} elseif ( $file->isDeleted( File::DELETED_FILE ) ) {
$timeAndDate = $lang->userTimeAndDate( $timestamp, $user );
if ( $local ) {
$this->setPreventClickjacking( true );
# Make a link to review the image
$url = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'Revisiondelete' ),
$timeAndDate,
[],
[
'target' => $this->title->getPrefixedText(),
'file' => $img,
'token' => $user->getEditToken( $img )
]
);
} else {
$url = htmlspecialchars( $timeAndDate );
}
$row .= Html::rawElement( 'span', [ 'class' => 'history-deleted' ], $url );
} elseif ( !$file->exists() ) {
$row .= Html::element( 'span', [ 'class' => 'mw-file-missing' ],
$lang->userTimeAndDate( $timestamp, $user )
);
} else {
$url = $iscur ? $this->current->getUrl() : $this->current->getArchiveUrl( $img );
$row .= Html::element( 'a', [ 'href' => $url ],
$lang->userTimeAndDate( $timestamp, $user )
);
}
$row .= Html::closeElement( 'td' );
// Thumbnail
if ( $this->showThumb ) {
$row .= Html::rawElement( 'td', [],
$this->getThumbForLine( $file, $iscur ) ?? $this->msg( 'filehist-nothumb' )->escaped()
);
}
// Image dimensions + size
$row .= Html::openElement( 'td' );
$row .= htmlspecialchars( $file->getDimensionsString() );
$row .= $this->msg( 'word-separator' )->escaped();
$row .= Html::element( 'span', [ 'style' => 'white-space: nowrap;' ],
$this->msg( 'parentheses' )->sizeParams( $file->getSize() )->text()
);
$row .= Html::closeElement( 'td' );
// Uploading user
$row .= Html::openElement( 'td' );
// Hide deleted usernames
if ( $uploader && $local ) {
$row .= Linker::userLink( $uploader->getId(), $uploader->getName() );
$row .= Html::rawElement( 'span', [ 'style' => 'white-space: nowrap;' ],
Linker::userToolLinks( $uploader->getId(), $uploader->getName() )
);
} elseif ( $uploader ) {
$row .= htmlspecialchars( $uploader->getName() );
} else {
$row .= Html::element( 'span', [ 'class' => 'history-deleted' ],
$this->msg( 'rev-deleted-user' )->text()
);
}
$row .= Html::closeElement( 'td' );
// Don't show deleted descriptions
if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
$row .= Html::rawElement( 'td', [],
Html::element( 'span', [ 'class' => 'history-deleted' ],
$this->msg( 'rev-deleted-comment' )->text()
)
);
} else {
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$row .= Html::rawElement( 'td', [ 'dir' => $contLang->getDir() ], $formattedComment );
}
$rowClass = null;
$this->getHookRunner()->onImagePageFileHistoryLine( $this, $file, $row, $rowClass );
return Html::rawElement( 'tr', [ 'class' => $rowClass ], $row ) . "\n";
}
/**
* @param File $file
* @param bool $iscur
* @return string|null
*/
protected function getThumbForLine( $file, $iscur ) {
$user = $this->getUser();
if ( !$file->allowInlineDisplay() ||
$file->isDeleted( File::DELETED_FILE ) ||
!$file->userCan( File::DELETED_FILE, $user )
) {
return null;
}
$thumbnail = $file->transform(
[
'width' => '120',
'height' => '120',
'isFilePageThumb' => $iscur // old revisions are already versioned
]
);
if ( !$thumbnail ) {
return null;
}
$lang = $this->getLanguage();
$timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
$alt = $this->msg(
'filehist-thumbtext',
$lang->userTimeAndDate( $timestamp, $user ),
$lang->userDate( $timestamp, $user ),
$lang->userTime( $timestamp, $user )
)->text();
return $thumbnail->toHtml( [ 'alt' => $alt, 'file-link' => true ] );
}
/**
* @param bool $enable
* @deprecated since 1.38, use ::setPreventClickjacking() instead
*/
protected function preventClickjacking( $enable = true ) {
$this->preventClickjacking = $enable;
}
/**
* @param bool $enable
* @since 1.38
*/
protected function setPreventClickjacking( bool $enable ) {
$this->preventClickjacking = $enable;
}
/**
* @return bool
*/
public function getPreventClickjacking() {
return $this->preventClickjacking;
}
}