wiki.techinc.nl/includes/page/ImagePage.php

1215 lines
36 KiB
PHP
Raw Normal View History

<?php
/**
* Special handling for file description pages.
*
* 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\MediaWikiServices;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IResultWrapper;
/**
* Class for viewing MediaWiki file description pages
*
* @ingroup Media
*
* @method WikiFilePage getPage()
*/
class ImagePage extends Article {
use MediaFileTrait;
/** @var File|false Only temporary false, most code can assume this is a File */
private $displayImg;
/** @var FileRepo */
private $repo;
/** @var bool */
private $fileLoaded;
/** @var string|false Guaranteed to be HTML, {@see File::getDescriptionText} */
protected $mExtraDescription = false;
/**
* @param Title $title
* @return WikiFilePage
*/
protected function newPage( Title $title ) {
// Overload mPage with a file-specific page
return new WikiFilePage( $title );
}
/**
* @param File $file
* @return void
*/
public function setFile( $file ) {
$this->getPage()->setFile( $file );
$this->displayImg = $file;
$this->fileLoaded = true;
}
protected function loadFile() {
2010-03-20 22:58:48 +00:00
if ( $this->fileLoaded ) {
return;
}
$this->fileLoaded = true;
$this->displayImg = $img = false;
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onImagePageFindFile( $this, $img, $this->displayImg );
if ( !$img ) { // not set by hook?
$services = MediaWikiServices::getInstance();
$img = $services->getRepoGroup()->findFile( $this->getTitle() );
if ( !$img ) {
$img = $services->getRepoGroup()->getLocalRepo()->newFile( $this->getTitle() );
2008-05-21 22:20:07 +00:00
}
}
$this->getPage()->setFile( $img );
if ( !$this->displayImg ) { // not set by hook?
$this->displayImg = $img;
}
$this->repo = $img->getRepo();
}
public function view() {
$showEXIF = MediaWikiServices::getInstance()->getMainConfig()->get( 'ShowEXIF' );
// For action=render, include body text only; none of the image extras
if ( $this->viewIsRenderAction ) {
parent::view();
return;
}
$out = $this->getContext()->getOutput();
$request = $this->getContext()->getRequest();
$diff = $request->getVal( 'diff' );
$diffOnly = $request->getBool(
'diffonly',
$this->getContext()->getUser()->getOption( 'diffonly' )
);
if ( $this->getTitle()->getNamespace() !== NS_FILE || ( $diff !== null && $diffOnly ) ) {
parent::view();
return;
}
2011-06-30 01:24:54 +00:00
$this->loadFile();
2004-01-12 00:55:01 +00:00
if (
$this->getTitle()->getNamespace() === NS_FILE
&& $this->getFile()->getRedirected()
) {
if (
$this->getTitle()->getDBkey() == $this->getFile()->getName()
|| $diff !== null
) {
$request->setVal( 'diffonly', 'true' );
}
parent::view();
return;
}
if ( $showEXIF && $this->displayImg->exists() ) {
// @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
$formattedMetadata = $this->displayImg->formatMetadata( $this->getContext() );
} else {
$formattedMetadata = false;
}
if ( !$diff && $this->displayImg->exists() ) {
$out->addHTML( $this->showTOC( (bool)$formattedMetadata ) );
}
if ( !$diff ) {
$this->openShowImage();
}
2005-07-04 02:59:23 +00:00
# No need to display noarticletext, we use our own message, output in openShowImage()
if ( $this->getPage()->getId() ) {
# NS_FILE is in the user language, but this section (the actual wikitext)
# should be in page content language
$pageLang = $this->getTitle()->getPageViewLanguage();
$out->addHTML( Xml::openElement( 'div', [ 'id' => 'mw-imagepage-content',
'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
'class' => 'mw-content-' . $pageLang->getDir() ] ) );
2012-03-30 12:47:05 +00:00
2012-06-12 09:11:37 +00:00
parent::view();
2012-03-30 12:47:05 +00:00
2012-06-12 09:11:37 +00:00
$out->addHTML( Xml::closeElement( 'div' ) );
} else {
# Just need to set the right headers
$out->setArticleFlag( true );
$out->setPageTitle( $this->getTitle()->getPrefixedText() );
$this->getPage()->doViewUpdates(
$this->getContext()->getUser(),
$this->getOldID()
);
}
# Show shared description, if needed
2010-03-20 22:58:48 +00:00
if ( $this->mExtraDescription ) {
$fol = $this->getContext()->msg( 'shareddescriptionfollows' );
if ( !$fol->isDisabled() ) {
$out->addWikiTextAsInterface( $fol->plain() );
}
$out->addHTML(
Html::rawElement(
'div',
[ 'id' => 'shared-image-desc' ],
$this->mExtraDescription
) . "\n"
);
}
$this->closeShowImage();
$this->imageHistory();
// TODO: Cleanup the following
2010-03-20 22:58:48 +00:00
$out->addHTML( Xml::element( 'h2',
[ 'id' => 'filelinks' ],
$this->getContext()->msg( 'imagelinks' )->text() ) . "\n" );
$this->imageDupes();
# @todo FIXME: For some freaky reason, we can't redirect to foreign images.
# Yet we return metadata about the target. Definitely an issue in the FileRepo
$this->imageLinks();
2011-06-30 01:24:54 +00:00
# Allow extensions to add something after the image links
$html = '';
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onImagePageAfterImageLinks( $this, $html );
if ( $html ) {
$out->addHTML( $html );
}
if ( $formattedMetadata ) {
$out->addHTML( Xml::element(
'h2',
[ 'id' => 'metadata' ],
$this->getContext()->msg( 'metadata' )->text() ) . "\n" );
$out->wrapWikiTextAsInterface(
'mw-imagepage-section-metadata',
$this->makeMetadataTable( $formattedMetadata )
);
$out->addModules( [ 'mediawiki.action.view.metadata' ] );
}
// Add remote Filepage.css
if ( !$this->repo->isLocal() ) {
$css = $this->repo->getDescriptionStylesheetUrl();
if ( $css ) {
$out->addStyle( $css );
}
}
$out->addModuleStyles( [
'filepage', // always show the local local Filepage.css, T31277
'mediawiki.action.view.filepage', // Add MediaWiki styles for a file page
] );
}
2011-10-29 01:53:28 +00:00
/**
* @return File
*/
public function getDisplayedFile() {
$this->loadFile();
return $this->displayImg;
}
/**
* Create the TOC
*
* @param bool $metadata Whether or not to show the metadata link
* @return string
*/
protected function showTOC( $metadata ) {
$r = [
Html::rawElement(
'li',
[],
Html::rawElement(
'a',
[ 'href' => '#file' ],
$this->getContext()->msg( 'file-anchor-link' )->escaped()
)
),
Html::rawElement(
'li',
[],
Html::rawElement(
'a',
[ 'href' => '#filehistory' ],
$this->getContext()->msg( 'filehist' )->escaped()
)
),
Html::rawElement(
'li',
[],
Html::rawElement(
'a',
[ 'href' => '#filelinks' ],
$this->getContext()->msg( 'imagelinks' )->escaped()
)
),
];
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onImagePageShowTOC( $this, $r );
if ( $metadata ) {
$r[] = Html::rawElement(
'li',
[],
Html::rawElement(
'a',
[ 'href' => '#metadata' ],
$this->getContext()->msg( 'metadata' )->escaped()
)
);
}
2011-06-30 01:24:54 +00:00
return Html::rawElement( 'ul', [ 'id' => 'filetoc' ], implode( "\n", $r ) );
}
/**
* Make a table with metadata to be shown in the output page.
*
* @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
*
* @param array $metadata The array containing the Exif data
* @return string The metadata table. This is treated as Wikitext (!)
*/
protected function makeMetadataTable( $metadata ) {
$r = $this->getContext()->msg( 'metadata-help' )->plain();
// Initial state is collapsed
// see filepage.css and mediawiki.action.view.metadata module.
$r .= "<table id=\"mw_metadata\" class=\"mw_metadata collapsed\">\n";
foreach ( $metadata as $type => $stuff ) {
Static code analysis housekeeping time... things that could be double-checked are marked with "[Note: some-comment]" : if-if-else without curly braces [api/ApiQuerySiteinfo.php] --> adding Unused global declaration: $wgGroupPermissions --> removing Unused global declaration: $wgEmailConfirmToEdit (line 301) --> removing Variable $id appears only once (line 1021) --> removing Variable $m was used before it was defined (line 805) --> defining. Variable $retval was used before it was defined (line 2346) --> renaming to $result Variable $rcid appears only once (line 244 of RecentChange.php) --> using this instead of $change [Note: was left over from r24607 refactoring, revert if wrong please] Unused global declaration: $wgCommandLineMode (line 11) --> removing Variable $k appears only once (line 132 of ImagePage.php) --> removing. Variable $info appears only once (line 311 of ImagePage.php) --> removing. Unused global declaration: $wgTitle (line 569 of ImagePage.php) -> removing. Variable $handlerParams was used before it was defined (line 616 of Linker.php) --> resolved by Raymond in r24966 Variable $match was used before it was defined (line 1031 of Linker.php) --> defining. Unused global declaration: $wgEnotifWatchlist (line 253 of UserMailer.php) --> removing Unused global declaration: $wgShowUpdatedMarker (line 253 of UserMailer.php) --> removing Variable $img appears only once (line 446 of SpecialUpload.php) --> added definition, defined as null, flagged with @todo [Note: should $img be defined in this context, or is it intended to be null? And should the return value after the hook be checked in some way?] Unused global declaration: $wgEnableAPI (line 739 of SpecialUpload.php) --> removing. Unused global declaration: $wgNamespaceProtection (line 1030 of OutputPage.php) --> removing. Unused global declaration: $wgContLang (line 18 of SpecialWatchlist.php) --> removing. Unused global declaration: $wgRawHtml (line 269 of SpecialMovepage.php) --> removing. The value of variable $page was never used (line 331 of SpecialUndelete.php) --> removing line, as $page gets redefined a few lines down. Variable $synIndex appears only once (line 521 of MagicWord.php) --> commenting out. Variable $case appears only once (line 539 of MagicWord.php) --> removing from foreach index key usage. Variable $wgUser appears only once (line 1039 of Title.php) --> adding line to declare as a global, would be null otherwise. Variable $m was used before it was defined (line 285 of Title.php) --> defining. Variable $id appears only once (line 1150 of Title.php) --> removing from foreach index key usage. Variable $subpage appears only once (line 1297 of Title.php) --> commenting out. Variable $restrictions appears only once (line 1399 of Title.php) --> commenting out. Variable $mime appears only once (line 210 of filerepo/OldLocalFile.php) --> removing. Variable $deprefixedName appears only once (line 213 of filerepo/LocalFile.php) --> removing. Variable $m appears only once (line 541 of filerepo/LocalFile.php) --> removing. Variable $where appears only once (line 1245 of filerepo/LocalFile.php) --> removing. Variable $info appears only once (line 1427 of filerepo/LocalFile.php) --> removing. Variable $rel appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $zone appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $nbytes appears only once (line 208 of media/Generic.php) --> added a return line that uses $nbytes. [Note: I'm assuming that this was the intent] Variable $offset appears only once (line 201 of SpecialListusers.php) --> removing. Variable $limit appears only once (line 201 of SpecialListusers.php) --> removing. Variable $groupTarget appears only once (line 203 of SpecialListusers.php) --> removing. Unused global declaration: $wgLang (line 74 of SpecialWantedpages.php) --> removing. Variable $block appears only once (line 244 of SpecialProtectedpages.php) --> removing. Variable $offset appears only once (line 281 of SpecialProtectedpages.php) --> removing. Variable $limit appears only once (line 281 of SpecialProtectedpages.php) --> removing. Unused global declaration: $wgLang (line 30 of FileDeleteForm.php) --> removing. Unused global declaration: $wgServer (line 30 of FileDeleteForm.php) --> removing.
2007-08-21 03:57:54 +00:00
foreach ( $stuff as $v ) {
$class = str_replace( ' ', '_', $v['id'] );
2010-03-20 22:58:48 +00:00
if ( $type == 'collapsed' ) {
$class .= ' mw-metadata-collapsible';
}
$r .= Html::rawElement( 'tr',
[ 'class' => $class ],
Html::rawElement( 'th', [], $v['name'] )
. Html::rawElement( 'td', [], $v['value'] )
);
}
}
$r .= "</table>\n";
return $r;
}
2006-01-07 13:31:29 +00:00
/**
* Returns language code to be used for dispaying the image, based on request context and
* languages available in the file.
*
* @param WebRequest $request
* @param File $file
* @return string|null
*/
private function getLanguageForRendering( WebRequest $request, File $file ) {
$handler = $file->getHandler();
if ( !$handler ) {
return null;
}
$config = MediaWikiServices::getInstance()->getMainConfig();
$requestLanguage = $request->getVal( 'lang', $config->get( 'LanguageCode' ) );
if ( $handler->validateParam( 'lang', $requestLanguage ) ) {
return $file->getMatchedLanguage( $requestLanguage );
}
return $handler->getDefaultRenderLanguage( $file );
}
protected function openShowImage() {
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$enableUploads = $mainConfig->get( 'EnableUploads' );
$send404Code = $mainConfig->get( 'Send404Code' );
$svgMaxSize = $mainConfig->get( 'SVGMaxSize' );
$this->loadFile();
$out = $this->getContext()->getOutput();
$user = $this->getContext()->getUser();
$lang = $this->getContext()->getLanguage();
$dirmark = $lang->getDirMarkEntity();
$request = $this->getContext()->getRequest();
2010-03-20 22:58:48 +00:00
if ( $this->displayImg->exists() ) {
list( $maxWidth, $maxHeight ) = $this->getImageLimitsFromOption( $user, 'imagesize' );
2005-05-21 07:46:17 +00:00
# image
$page = $request->getIntOrNull( 'page' );
if ( $page === null ) {
$params = [];
$page = 1;
} else {
$params = [ 'page' => $page ];
}
$renderLang = $this->getLanguageForRendering( $request, $this->displayImg );
if ( $renderLang !== null ) {
$params['lang'] = $renderLang;
}
$width_orig = $this->displayImg->getWidth( $page );
$width = $width_orig;
$height_orig = $this->displayImg->getHeight( $page );
$height = $height_orig;
2010-10-14 20:53:04 +00:00
$filename = wfEscapeWikiText( $this->displayImg->getName() );
$linktext = $filename;
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onImageOpenShowImageInlineBefore( $this, $out );
2010-03-20 22:58:48 +00:00
if ( $this->displayImg->allowInlineDisplay() ) {
# image
# "Download high res version" link below the image
# $msgsize = $this->getContext()->msg( 'file-info-size', $width_orig, $height_orig,
# Language::formatSize( $this->displayImg->getSize() ), $mime )->escaped();
# We'll show a thumbnail of this image
if ( $width > $maxWidth ||
$height > $maxHeight ||
$this->displayImg->isVectorized()
) {
list( $width, $height ) = $this->displayImg->getDisplayWidthHeight(
$maxWidth, $maxHeight, $page
);
$linktext = $this->getContext()->msg( 'show-big-image' )->escaped();
$thumbSizes = $this->getThumbSizes( $width_orig, $height_orig );
# Generate thumbnails or thumbnail links as needed...
$otherSizes = [];
foreach ( $thumbSizes as $size ) {
// We include a thumbnail size in the list, if it is
// less than or equal to the original size of the image
// asset ($width_orig/$height_orig). We also exclude
// the current thumbnail's size ($width/$height)
// since that is added to the message separately, so
// it can be denoted as the current size being shown.
// Vectorized images are limited by $wgSVGMaxSize big,
// so all thumbs less than or equal that are shown.
if ( ( ( $size[0] <= $width_orig && $size[1] <= $height_orig )
|| ( $this->displayImg->isVectorized()
&& max( $size[0], $size[1] ) <= $svgMaxSize )
)
&& $size[0] != $width && $size[1] != $height
&& $size[0] != $maxWidth && $size[1] != $maxHeight
) {
$sizeLink = $this->makeSizeLink( $params, $size[0], $size[1] );
if ( $sizeLink ) {
$otherSizes[] = $sizeLink;
}
2011-10-15 21:40:30 +00:00
}
}
$otherSizes = array_unique( $otherSizes );
$sizeLinkBigImagePreview = $this->makeSizeLink( $params, $width, $height );
$msgsmall = $this->getThumbPrevText( $params, $sizeLinkBigImagePreview );
if ( count( $otherSizes ) ) {
$msgsmall .= ' ' .
Html::rawElement(
'span',
[ 'class' => 'mw-filepage-other-resolutions' ],
$this->getContext()->msg( 'show-big-image-other' )
->rawParams( $lang->pipeList( $otherSizes ) )
->params( count( $otherSizes ) )
->parse()
);
}
} elseif ( $width == 0 && $height == 0 ) {
# Some sort of audio file that doesn't have dimensions
# Don't output a no hi res message for such a file
$msgsmall = '';
} else {
# Image is small enough to show full size on image page
$msgsmall = $this->getContext()->msg( 'file-nohires' )->parse();
}
$params['width'] = $width;
$params['height'] = $height;
$params['isFilePageThumb'] = true;
// Allow the MediaHandler to handle query string parameters on the file page,
// e.g. start time for videos (T203994)
$params['imagePageParams'] = $request->getQueryValuesOnly();
$thumbnail = $this->displayImg->transform( $params );
Linker::processResponsiveImages( $this->displayImg, $thumbnail, $params );
$anchorclose = Html::rawElement(
'div',
[ 'class' => 'mw-filepage-resolutioninfo' ],
$msgsmall
);
$isMulti = $this->displayImg->isMultipage() && $this->displayImg->pageCount() > 1;
2010-03-20 22:58:48 +00:00
if ( $isMulti ) {
$out->addModules( 'mediawiki.page.image.pagination' );
$out->addHTML( '<table class="multipageimage"><tr><td>' );
}
2010-03-20 22:58:48 +00:00
if ( $thumbnail ) {
$options = [
'alt' => $this->displayImg->getTitle()->getPrefixedText(),
2011-10-15 21:40:30 +00:00
'file-link' => true,
];
$out->addHTML(
Html::rawElement(
'div',
[ 'class' => 'fullImageLink', 'id' => 'file' ],
$thumbnail->toHtml( $options ) . $anchorclose
) . "\n"
);
}
2010-03-20 22:58:48 +00:00
if ( $isMulti ) {
$count = $this->displayImg->pageCount();
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
2010-03-20 22:58:48 +00:00
if ( $page > 1 ) {
$label = $this->getContext()->msg( 'imgmultipageprev' )->text();
// on the client side, this link is generated in ajaxifyPageNavigation()
// in the mediawiki.page.image.pagination module
$link = $linkRenderer->makeKnownLink(
$this->getTitle(),
$label,
[],
[ 'page' => $page - 1 ]
);
// @phan-suppress-next-line SecurityCheck-DoubleEscaped link getting a key, false positive
$thumb1 = Linker::makeThumbLinkObj(
$this->getTitle(),
$this->displayImg,
$link,
$label,
'none',
[ 'page' => $page - 1, 'isFilePageThumb' => true ]
);
} else {
$thumb1 = '';
}
2010-03-20 22:58:48 +00:00
if ( $page < $count ) {
$label = $this->getContext()->msg( 'imgmultipagenext' )->text();
$link = $linkRenderer->makeKnownLink(
$this->getTitle(),
$label,
[],
[ 'page' => $page + 1 ]
);
// @phan-suppress-next-line SecurityCheck-DoubleEscaped link getting a key, false positive
$thumb2 = Linker::makeThumbLinkObj(
$this->getTitle(),
$this->displayImg,
$link,
$label,
'none',
[ 'page' => $page + 1, 'isFilePageThumb' => true ]
);
} else {
$thumb2 = '';
}
$script = MediaWikiServices::getInstance()->getMainConfig()->get( 'Script' );
2008-05-10 11:56:02 +00:00
$formParams = [
2008-05-10 11:56:02 +00:00
'name' => 'pageselector',
'action' => $script,
];
$options = [];
2010-03-20 22:58:48 +00:00
for ( $i = 1; $i <= $count; $i++ ) {
$options[] = Xml::option( $lang->formatNum( $i ), (string)$i, $i == $page );
}
2008-05-10 11:56:02 +00:00
$select = Xml::tags( 'select',
[ 'id' => 'pageselector', 'name' => 'page' ],
2008-05-10 11:56:02 +00:00
implode( "\n", $options ) );
$out->addHTML(
2008-05-10 11:56:02 +00:00
'</td><td><div class="multipageimagenavbox">' .
Xml::openElement( 'form', $formParams ) .
Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
$this->getContext()->msg( 'imgmultigoto' )->rawParams( $select )->parse() .
$this->getContext()->msg( 'word-separator' )->escaped() .
Xml::submitButton( $this->getContext()->msg( 'imgmultigo' )->text() ) .
2008-05-10 11:56:02 +00:00
Xml::closeElement( 'form' ) .
"<hr />$thumb1\n$thumb2<br style=\"clear: both\" /></div></td></tr></table>"
2008-05-10 11:56:02 +00:00
);
}
} elseif ( $this->displayImg->isSafeFile() ) {
2010-03-20 22:58:48 +00:00
# if direct link is allowed but it's not a renderable image, show an icon.
$icon = $this->displayImg->iconThumb();
2006-01-07 13:31:29 +00:00
$out->addHTML(
Html::rawElement(
'div',
[ 'class' => 'fullImageLink', 'id' => 'file' ],
$icon->toHtml( [ 'file-link' => true ] )
) . "\n"
);
}
$longDesc = $this->getContext()->msg( 'parentheses', $this->displayImg->getLongDesc() )->text();
$handler = $this->displayImg->getHandler();
// If this is a filetype with potential issues, warn the user.
if ( $handler ) {
$warningConfig = $handler->getWarningConfig( $this->displayImg );
if ( $warningConfig !== null ) {
// The warning will be displayed via CSS and JavaScript.
// We just need to tell the client side what message to use.
$output = $this->getContext()->getOutput();
$output->addJsConfigVars( 'wgFileWarning', $warningConfig );
$output->addModules( $warningConfig['module'] );
$output->addModules( 'mediawiki.filewarning' );
}
}
$medialink = "[[Media:$filename|$linktext]]";
if ( !$this->displayImg->isSafeFile() ) {
$warning = $this->getContext()->msg( 'mediawarning' )->plain();
// dirmark is needed here to separate the file name, which
// most likely ends in Latin characters, from the description,
// which may begin with the file type. In RTL environment
// this will get messy.
// The dirmark, however, must not be immediately adjacent
// to the filename, because it can get copied with it.
// See T27277.
// phpcs:disable Generic.Files.LineLength
$out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
<span class="dangerousLink">{$medialink}</span> $dirmark<span class="fileInfo">$longDesc</span>
EOT
);
// phpcs:enable
$out->wrapWikiTextAsInterface( 'mediaWarning', $warning );
} else {
$out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
{$medialink} {$dirmark}<span class="fileInfo">$longDesc</span>
EOT
);
2005-05-21 07:46:17 +00:00
}
$renderLangOptions = $this->displayImg->getAvailableLanguages();
if ( count( $renderLangOptions ) >= 1 ) {
$out->addHTML( $this->doRenderLangOpt( $renderLangOptions, $renderLang ) );
}
// Add cannot animate thumbnail warning
if ( !$this->displayImg->canAnimateThumbIfAppropriate() ) {
// Include the extension so wiki admins can
// customize it on a per file-type basis
// (aka say things like use format X instead).
// additionally have a specific message for
// file-no-thumb-animation-gif
$ext = $this->displayImg->getExtension();
$noAnimMesg = wfMessageFallback(
'file-no-thumb-animation-' . $ext,
'file-no-thumb-animation'
)->plain();
$out->wrapWikiTextAsInterface( 'mw-noanimatethumb', $noAnimMesg );
}
2010-03-20 22:58:48 +00:00
if ( !$this->displayImg->isLocal() ) {
$this->printSharedImageText();
}
} else {
# Image does not exist
if ( !$this->getPage()->getId() ) {
$dbr = wfGetDB( DB_REPLICA );
# No article exists either
# Show deletion log to be consistent with normal articles
LogEventsList::showLogExtract(
$out,
[ 'delete', 'move', 'protect' ],
$this->getTitle()->getPrefixedText(),
'',
[ 'lim' => 10,
'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
'showIfEmpty' => false,
'msgKey' => [ 'moveddeleted-notice' ]
]
);
}
if ( $enableUploads &&
$this->getContext()->getAuthority()->isAllowed( 'upload' )
) {
// Only show an upload link if the user can upload
$uploadTitle = SpecialPage::getTitleFor( 'Upload' );
$nofile = [
'filepage-nofile-link',
$uploadTitle->getFullURL( [
'wpDestFile' => $this->getFile()->getName()
] )
];
} else {
$nofile = 'filepage-nofile';
}
// Note, if there is an image description page, but
// no image, then this setRobotPolicy is overridden
// by Article::View().
$out->setRobotPolicy( 'noindex,nofollow' );
$out->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
if ( !$this->getPage()->getId() && $send404Code ) {
// If there is no image, no shared image, and no description page,
// output a 404, to be consistent with Article::showMissingArticle.
$request->response()->statusHeader( 404 );
}
2004-01-12 00:55:01 +00:00
}
$out->setFileVersion( $this->displayImg );
2004-01-12 00:55:01 +00:00
}
2011-06-30 01:24:54 +00:00
/**
* Make the text under the image to say what size preview
*
* @param array $params parameters for thumbnail
* @param string $sizeLinkBigImagePreview HTML for the current size
* @return string HTML output
*/
protected function getThumbPrevText( $params, $sizeLinkBigImagePreview ) {
if ( $sizeLinkBigImagePreview ) {
// Show a different message of preview is different format from original.
$previewTypeDiffers = false;
$origExt = $thumbExt = $this->displayImg->getExtension();
if ( $this->displayImg->getHandler() ) {
$origMime = $this->displayImg->getMimeType();
$typeParams = $params;
$this->displayImg->getHandler()->normaliseParams( $this->displayImg, $typeParams );
list( $thumbExt, $thumbMime ) = $this->displayImg->getHandler()->getThumbType(
$origExt, $origMime, $typeParams );
if ( $thumbMime !== $origMime ) {
$previewTypeDiffers = true;
}
}
if ( $previewTypeDiffers ) {
return $this->getContext()->msg( 'show-big-image-preview-differ' )->
rawParams( $sizeLinkBigImagePreview )->
params( strtoupper( $origExt ) )->
params( strtoupper( $thumbExt ) )->
parse();
} else {
return $this->getContext()->msg( 'show-big-image-preview' )->
rawParams( $sizeLinkBigImagePreview )->
parse();
}
} else {
return '';
}
}
/**
2011-06-30 01:24:54 +00:00
* Creates an thumbnail of specified size and returns an HTML link to it
* @param array $params Scaler parameters
* @param int $width
* @param int $height
2011-10-29 01:53:28 +00:00
* @return string
*/
protected function makeSizeLink( $params, $width, $height ) {
$params['width'] = $width;
$params['height'] = $height;
$thumbnail = $this->displayImg->transform( $params );
if ( $thumbnail && !$thumbnail->isError() ) {
return Html::rawElement( 'a', [
'href' => $thumbnail->getUrl(),
'class' => 'mw-thumbnail-link'
], $this->getContext()->msg( 'show-big-image-size' )->numParams(
2011-06-30 01:24:54 +00:00
$thumbnail->getWidth(), $thumbnail->getHeight()
)->parse() );
} else {
return '';
}
}
/**
* Show a notice that the file is from a shared repository
*/
protected function printSharedImageText() {
$out = $this->getContext()->getOutput();
$this->loadFile();
$descUrl = $this->getFile()->getDescriptionUrl();
$descText = $this->getFile()->getDescriptionText( $this->getContext()->getLanguage() );
/* Add canonical to head if there is no local page for this shared file */
if ( $descUrl && !$this->getPage()->getId() ) {
$out->setCanonicalUrl( $descUrl );
}
2009-03-28 16:41:00 +00:00
$wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
$repo = $this->getFile()->getRepo()->getDisplayName();
if ( $descUrl &&
$descText &&
$this->getContext()->msg( 'sharedupload-desc-here' )->plain() !== '-'
) {
$out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-here', $repo, $descUrl ] );
} elseif ( $descUrl &&
$this->getContext()->msg( 'sharedupload-desc-there' )->plain() !== '-'
) {
$out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-there', $repo, $descUrl ] );
} else {
$out->wrapWikiMsg( $wrap, [ 'sharedupload', $repo ], ''/*BACKCOMPAT*/ );
}
2010-03-20 22:58:48 +00:00
if ( $descText ) {
$this->mExtraDescription = $descText;
}
}
public function getUploadUrl() {
$this->loadFile();
$uploadTitle = SpecialPage::getTitleFor( 'Upload' );
return $uploadTitle->getFullURL( [
'wpDestFile' => $this->getFile()->getName(),
'wpForReUpload' => 1
] );
}
/**
* Add the re-upload link (or message about not being able to re-upload) to the output.
*/
protected function uploadLinksBox() {
if ( !$this->getContext()->getConfig()->get( 'EnableUploads' ) ) {
return;
}
$this->loadFile();
if ( !$this->getFile()->isLocal() ) {
return;
}
$canUpload = $this->getContext()->getAuthority()
->probablyCan( 'upload', $this->getTitle() );
if ( $canUpload && UploadBase::userCanReUpload(
$this->getContext()->getAuthority(),
$this->getFile() )
) {
// "Upload a new version of this file" link
$ulink = Linker::makeExternalLink(
$this->getUploadUrl(),
$this->getContext()->msg( 'uploadnewversion-linktext' )->text()
);
$attrs = [ 'class' => 'plainlinks', 'id' => 'mw-imagepage-reupload-link' ];
$linkPara = Html::rawElement( 'p', $attrs, $ulink );
} else {
// "You cannot overwrite this file." message
$attrs = [ 'id' => 'mw-imagepage-upload-disallowed' ];
$msg = $this->getContext()->msg( 'upload-disallowed-here' )->text();
$linkPara = Html::element( 'p', $attrs, $msg );
}
$uploadLinks = Html::rawElement( 'div', [ 'class' => 'mw-imagepage-upload-links' ], $linkPara );
$this->getContext()->getOutput()->addHTML( $uploadLinks );
}
/**
* For overloading
*/
protected function closeShowImage() {
}
2004-01-12 00:55:01 +00:00
/**
* If the page we've just displayed is in the "Image" namespace,
* we follow it with an upload history of the image and its usage.
*/
protected function imageHistory() {
$this->loadFile();
$out = $this->getContext()->getOutput();
$pager = new ImageHistoryPseudoPager(
$this,
MediaWikiServices::getInstance()->getLinkBatchFactory()
);
$out->addHTML( $pager->getBody() );
$out->setPreventClickjacking( $pager->getPreventClickjacking() );
$this->getFile()->resetHistory(); // free db resources
# Exist check because we don't want to show this on pages where an image
# doesn't exist along with the noimage message, that would suck. -ævar
if ( $this->getFile()->exists() ) {
$this->uploadLinksBox();
}
}
2011-10-29 01:53:28 +00:00
/**
* @param string|string[] $target
* @param int $limit
* @return IResultWrapper
2011-10-29 01:53:28 +00:00
*/
protected function queryImageLinks( $target, $limit ) {
$dbr = wfGetDB( DB_REPLICA );
return $dbr->select(
[ 'imagelinks', 'page' ],
[ 'page_namespace', 'page_title', 'il_to' ],
[ 'il_to' => $target, 'il_from = page_id' ],
__METHOD__,
[ 'LIMIT' => $limit + 1, 'ORDER BY' => 'il_from', ]
2011-06-30 01:24:54 +00:00
);
}
2011-06-30 01:24:54 +00:00
protected function imageLinks() {
$limit = 100;
2011-06-30 01:24:54 +00:00
$out = $this->getContext()->getOutput();
$rows = [];
$redirects = [];
foreach ( $this->getTitle()->getRedirectsHere( NS_FILE ) as $redir ) {
$redirects[$redir->getDBkey()] = [];
$rows[] = (object)[
'page_namespace' => NS_FILE,
'page_title' => $redir->getDBkey(),
];
}
$res = $this->queryImageLinks( $this->getTitle()->getDBkey(), $limit + 1 );
foreach ( $res as $row ) {
$rows[] = $row;
}
$count = count( $rows );
2011-06-30 01:24:54 +00:00
$hasMore = $count > $limit;
if ( !$hasMore && count( $redirects ) ) {
2011-06-30 01:24:54 +00:00
$res = $this->queryImageLinks( array_keys( $redirects ),
$limit - count( $rows ) + 1 );
foreach ( $res as $row ) {
$redirects[$row->il_to][] = $row;
$count++;
}
$hasMore = ( $res->numRows() + count( $rows ) ) > $limit;
}
2010-03-20 22:58:48 +00:00
if ( $count == 0 ) {
$out->wrapWikiMsg(
Html::rawElement( 'div',
[ 'id' => 'mw-imagepage-nolinkstoimage' ], "\n$1\n" ),
'nolinkstoimage'
);
return;
}
2011-06-30 01:24:54 +00:00
$out->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
if ( !$hasMore ) {
$out->addWikiMsg( 'linkstoimage', $count );
} else {
// More links than the limit. Add a link to [[Special:Whatlinkshere]]
$out->addWikiMsg( 'linkstoimage-more',
$this->getContext()->getLanguage()->formatNum( $limit ),
$this->getTitle()->getPrefixedDBkey()
);
}
$out->addHTML(
Html::openElement( 'ul',
[ 'class' => 'mw-imagepage-linkstoimage' ] ) . "\n"
);
// Sort the list by namespace:title
usort( $rows, [ $this, 'compare' ] );
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
// Create links for every element
$currentCount = 0;
foreach ( $rows as $element ) {
$currentCount++;
if ( $currentCount > $limit ) {
break;
}
2011-06-30 01:24:54 +00:00
$query = [];
# Add a redirect=no to make redirect pages reachable
if ( isset( $redirects[$element->page_title] ) ) {
$query['redirect'] = 'no';
}
$link = $linkRenderer->makeKnownLink(
Title::makeTitle( $element->page_namespace, $element->page_title ),
null, [], $query
);
if ( !isset( $redirects[$element->page_title] ) ) {
# No redirects
$liContents = $link;
} elseif ( count( $redirects[$element->page_title] ) === 0 ) {
# Redirect without usages
$liContents = $this->getContext()->msg( 'linkstoimage-redirect' )
->rawParams( $link, '' )
->parse();
} else {
# Redirect with usages
$li = '';
foreach ( $redirects[$element->page_title] as $row ) {
$currentCount++;
if ( $currentCount > $limit ) {
break;
}
2011-06-30 01:24:54 +00:00
$link2 = $linkRenderer->makeKnownLink(
Title::makeTitle( $row->page_namespace, $row->page_title ) );
$li .= Html::rawElement(
'li',
[ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace ],
$link2
) . "\n";
}
$ul = Html::rawElement(
'ul',
[ 'class' => 'mw-imagepage-redirectstofile' ],
$li
) . "\n";
$liContents = $this->getContext()->msg( 'linkstoimage-redirect' )->rawParams(
$link, $ul )->parse();
}
$out->addHTML( Html::rawElement(
'li',
[ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace ],
$liContents
) . "\n"
);
}
$out->addHTML( Html::closeElement( 'ul' ) . "\n" );
$res->free();
// Add a links to [[Special:Whatlinkshere]]
if ( $currentCount > $limit ) {
$out->addWikiMsg( 'morelinkstoimage', $this->getTitle()->getPrefixedDBkey() );
}
$out->addHTML( Html::closeElement( 'div' ) . "\n" );
}
protected function imageDupes() {
$this->loadFile();
$out = $this->getContext()->getOutput();
$dupes = $this->getPage()->getDuplicates();
if ( count( $dupes ) == 0 ) {
return;
}
$out->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
$out->addWikiMsg( 'duplicatesoffile',
$this->getContext()->getLanguage()->formatNum( count( $dupes ) ), $this->getTitle()->getDBkey()
);
$out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
2011-10-29 01:53:28 +00:00
/**
* @var File $file
2011-10-29 01:53:28 +00:00
*/
foreach ( $dupes as $file ) {
$fromSrc = '';
2010-03-20 22:58:48 +00:00
if ( $file->isLocal() ) {
$link = $linkRenderer->makeKnownLink( $file->getTitle() );
} else {
$link = Linker::makeExternalLink( $file->getDescriptionUrl(),
$file->getTitle()->getPrefixedText() );
$fromSrc = $this->getContext()->msg(
'shared-repo-from',
$file->getRepo()->getDisplayName()
)->escaped();
}
$out->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
}
$out->addHTML( "</ul></div>\n" );
}
/**
* Display an error with a wikitext description
*
* @param string $description
*/
public function showError( $description ) {
$out = $this->getContext()->getOutput();
$out->setPageTitle( $this->getContext()->msg( 'internalerror' ) );
$out->setRobotPolicy( 'noindex,nofollow' );
$out->setArticleRelated( false );
$out->disableClientCache();
$out->addWikiTextAsInterface( $description );
}
/**
* Callback for usort() to do link sorts by (namespace, title)
* Function copied from Title::compare()
2011-06-30 01:24:54 +00:00
*
* @param stdClass $a Object page to compare with
* @param stdClass $b Object page to compare with
* @return int Result of string comparison, or namespace comparison
*/
protected function compare( $a, $b ) {
return $a->page_namespace <=> $b->page_namespace
?: strcmp( $a->page_title, $b->page_title );
}
/**
* Returns the corresponding $wgImageLimits entry for the selected user option
*
* @param UserIdentity $user
* @param string $optionName Name of a option to check, typically imagesize or thumbsize
* @return int[]
* @since 1.21
* @deprecated Since 1.35 Use static function MediaFileTrait::getImageLimitsFromOption
*/
public function getImageLimitsFromOption( UserIdentity $user, $optionName ) {
return MediaFileTrait::getImageLimitsFromOption( $user, $optionName );
}
/**
* Output a drop-down box for language options for the file
*
* @param array $langChoices Array of string language codes
* @param string $renderLang Language code for the language we want the file to rendered in.
* @return string HTML to insert underneath image.
*/
protected function doRenderLangOpt( array $langChoices, $renderLang ) {
$script = MediaWikiServices::getInstance()->getMainConfig()->get( 'Script' );
$opts = '';
$matchedRenderLang = $this->displayImg->getMatchedLanguage( $renderLang );
foreach ( $langChoices as $lang ) {
$opts .= $this->createXmlOptionStringForLanguage(
$lang,
$matchedRenderLang === $lang
);
}
// Allow for the default case in an svg <switch> that is displayed if no
// systemLanguage attribute matches
$opts .= "\n" .
Xml::option(
$this->getContext()->msg( 'img-lang-default' )->text(),
'und',
$matchedRenderLang === null
);
$select = Html::rawElement(
'select',
[ 'id' => 'mw-imglangselector', 'name' => 'lang' ],
$opts
);
$submit = Xml::submitButton( $this->getContext()->msg( 'img-lang-go' )->text() );
$formContents = $this->getContext()->msg( 'img-lang-info' )
->rawParams( $select, $submit )
->parse();
$formContents .= Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() );
$langSelectLine = Html::rawElement( 'div', [ 'id' => 'mw-imglangselector-line' ],
Html::rawElement( 'form', [ 'action' => $script ], $formContents )
);
return $langSelectLine;
}
/**
* @param string $lang
* @param bool $selected
* @return string
*/
private function createXmlOptionStringForLanguage( $lang, $selected ) {
$code = LanguageCode::bcp47( $lang );
$name = MediaWikiServices::getInstance()
->getLanguageNameUtils()
->getLanguageName( $code, $this->getContext()->getLanguage()->getCode() );
if ( $name !== '' ) {
$display = $this->getContext()->msg( 'img-lang-opt', $code, $name )->text();
} else {
$display = $code;
}
return "\n" .
Xml::option(
$display,
$lang,
$selected
);
}
/**
* Get alternative thumbnail sizes.
*
* @note This will only list several alternatives if thumbnails are rendered on 404
* @param int $origWidth Actual width of image
* @param int $origHeight Actual height of image
* @return int[][] An array of [width, height] pairs.
* @phan-return array<int,array{0:int,1:int}>
*/
protected function getThumbSizes( $origWidth, $origHeight ) {
$imageLimits = MediaWikiServices::getInstance()->getMainConfig()->get( 'ImageLimits' );
if ( $this->displayImg->getRepo()->canTransformVia404() ) {
$thumbSizes = $imageLimits;
// Also include the full sized resolution in the list, so
// that users know they can get it. This will link to the
// original file asset if mustRender() === false. In the case
// that we mustRender, some users have indicated that they would
// find it useful to have the full size image in the rendered
// image format.
$thumbSizes[] = [ $origWidth, $origHeight ];
} else {
# Creating thumb links triggers thumbnail generation.
# Just generate the thumb for the current users prefs.
$thumbSizes = [
$this->getImageLimitsFromOption( $this->getContext()->getUser(), 'thumbsize' )
];
if ( !$this->displayImg->mustRender() ) {
// We can safely include a link to the "full-size" preview,
// without actually rendering.
$thumbSizes[] = [ $origWidth, $origHeight ];
}
}
return $thumbSizes;
}
/**
* @see WikiFilePage::getFile
* @return File
*/
public function getFile(): File {
return $this->getPage()->getFile();
}
/**
* @see WikiFilePage::isLocal
* @return bool
*/
public function isLocal() {
return $this->getPage()->isLocal();
}
/**
* @see WikiFilePage::getDuplicates
* @return File[]|null
*/
public function getDuplicates() {
return $this->getPage()->getDuplicates();
}
/**
* @see WikiFilePage::getForeignCategories
* @return TitleArray|Title[]
*/
public function getForeignCategories() {
return $this->getPage()->getForeignCategories();
}
}