3 * Special handling for file description pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use Wikimedia\Rdbms\ResultWrapper
;
27 * Class for viewing MediaWiki file description pages
31 * @property WikiFilePage $mPage Set by overwritten newPage() in this class
32 * @method WikiFilePage getPage()
34 class ImagePage
extends Article
{
35 /** @var File|false */
45 protected $mExtraDescription = false;
49 * @return WikiFilePage
51 protected function newPage( Title
$title ) {
52 // Overload mPage with a file-specific page
53 return new WikiFilePage( $title );
60 public function setFile( $file ) {
61 $this->mPage
->setFile( $file );
62 $this->displayImg
= $file;
63 $this->fileLoaded
= true;
66 protected function loadFile() {
67 if ( $this->fileLoaded
) {
70 $this->fileLoaded
= true;
72 $this->displayImg
= $img = false;
74 Hooks
::run( 'ImagePageFindFile', [ $this, &$img, &$this->displayImg
] );
75 if ( !$img ) { // not set by hook?
76 $services = MediaWikiServices
::getInstance();
77 $img = $services->getRepoGroup()->findFile( $this->getTitle() );
79 $img = $services->getRepoGroup()->getLocalRepo()->newFile( $this->getTitle() );
82 $this->mPage
->setFile( $img );
83 if ( !$this->displayImg
) { // not set by hook?
84 $this->displayImg
= $img;
86 $this->repo
= $img->getRepo();
89 public function view() {
92 // For action=render, include body text only; none of the image extras
93 if ( $this->viewIsRenderAction
) {
98 $out = $this->getContext()->getOutput();
99 $request = $this->getContext()->getRequest();
100 $diff = $request->getVal( 'diff' );
101 $diffOnly = $request->getBool(
103 $this->getContext()->getUser()->getOption( 'diffonly' )
106 if ( $this->getTitle()->getNamespace() != NS_FILE ||
( $diff !== null && $diffOnly ) ) {
113 if ( $this->getTitle()->getNamespace() == NS_FILE
&& $this->mPage
->getFile()->getRedirected() ) {
114 if ( $this->getTitle()->getDBkey() == $this->mPage
->getFile()->getName() ||
$diff !== null ) {
115 $request->setVal( 'diffonly', 'true' );
122 if ( $wgShowEXIF && $this->displayImg
->exists() ) {
123 // @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
124 $formattedMetadata = $this->displayImg
->formatMetadata( $this->getContext() );
125 $showmeta = $formattedMetadata !== false;
130 if ( !$diff && $this->displayImg
->exists() ) {
131 $out->addHTML( $this->showTOC( $showmeta ) );
135 $this->openShowImage();
138 # No need to display noarticletext, we use our own message, output in openShowImage()
139 if ( $this->mPage
->getId() ) {
140 # NS_FILE is in the user language, but this section (the actual wikitext)
141 # should be in page content language
142 $pageLang = $this->getTitle()->getPageViewLanguage();
143 $out->addHTML( Xml
::openElement( 'div', [ 'id' => 'mw-imagepage-content',
144 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
145 'class' => 'mw-content-' . $pageLang->getDir() ] ) );
149 $out->addHTML( Xml
::closeElement( 'div' ) );
151 # Just need to set the right headers
152 $out->setArticleFlag( true );
153 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
154 $this->mPage
->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
157 # Show shared description, if needed
158 if ( $this->mExtraDescription
) {
159 $fol = $this->getContext()->msg( 'shareddescriptionfollows' );
160 if ( !$fol->isDisabled() ) {
161 $out->addWikiTextAsInterface( $fol->plain() );
163 $out->addHTML( '<div id="shared-image-desc">' . $this->mExtraDescription
. "</div>\n" );
166 $this->closeShowImage();
167 $this->imageHistory();
168 // TODO: Cleanup the following
170 $out->addHTML( Xml
::element( 'h2',
171 [ 'id' => 'filelinks' ],
172 $this->getContext()->msg( 'imagelinks' )->text() ) . "\n" );
174 # @todo FIXME: For some freaky reason, we can't redirect to foreign images.
175 # Yet we return metadata about the target. Definitely an issue in the FileRepo
178 # Allow extensions to add something after the image links
180 Hooks
::run( 'ImagePageAfterImageLinks', [ $this, &$html ] );
182 $out->addHTML( $html );
186 $out->addHTML( Xml
::element(
188 [ 'id' => 'metadata' ],
189 $this->getContext()->msg( 'metadata' )->text() ) . "\n" );
190 $out->wrapWikiTextAsInterface(
191 'mw-imagepage-section-metadata',
192 $this->makeMetadataTable( $formattedMetadata )
194 $out->addModules( [ 'mediawiki.action.view.metadata' ] );
197 // Add remote Filepage.css
198 if ( !$this->repo
->isLocal() ) {
199 $css = $this->repo
->getDescriptionStylesheetUrl();
201 $out->addStyle( $css );
205 $out->addModuleStyles( [
206 'filepage', // always show the local local Filepage.css, T31277
207 'mediawiki.action.view.filepage', // Add MediaWiki styles for a file page
214 public function getDisplayedFile() {
216 return $this->displayImg
;
222 * @param bool $metadata Whether or not to show the metadata link
225 protected function showTOC( $metadata ) {
227 '<li><a href="#file">' . $this->getContext()->msg( 'file-anchor-link' )->escaped() . '</a></li>',
228 '<li><a href="#filehistory">' . $this->getContext()->msg( 'filehist' )->escaped() . '</a></li>',
229 '<li><a href="#filelinks">' . $this->getContext()->msg( 'imagelinks' )->escaped() . '</a></li>',
232 Hooks
::run( 'ImagePageShowTOC', [ $this, &$r ] );
235 $r[] = '<li><a href="#metadata">' .
236 $this->getContext()->msg( 'metadata' )->escaped() .
240 return '<ul id="filetoc">' . implode( "\n", $r ) . '</ul>';
244 * Make a table with metadata to be shown in the output page.
246 * @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
248 * @param array $metadata The array containing the Exif data
249 * @return string The metadata table. This is treated as Wikitext (!)
251 protected function makeMetadataTable( $metadata ) {
252 $r = $this->getContext()->msg( 'metadata-help' )->plain();
253 // Intial state is collapsed
254 // see filepage.css and mediawiki.action.view.metadata module.
255 $r .= "<table id=\"mw_metadata\" class=\"mw_metadata collapsed\">\n";
256 foreach ( $metadata as $type => $stuff ) {
257 foreach ( $stuff as $v ) {
258 $class = str_replace( ' ', '_', $v['id'] );
259 if ( $type == 'collapsed' ) {
260 $class .= ' mw-metadata-collapsible';
262 $r .= Html
::rawElement( 'tr',
263 [ 'class' => $class ],
264 Html
::rawElement( 'th', [], $v['name'] )
265 . Html
::rawElement( 'td', [], $v['value'] )
274 * Overloading Article's getEmptyPageParserOutput method.
276 * Omit noarticletext if sharedupload; text will be fetched from the
277 * shared upload server if possible.
279 * @param ParserOptions $options
280 * @return ParserOutput
282 public function getEmptyPageParserOutput( ParserOptions
$options ) {
284 if ( $this->mPage
->getFile() && !$this->mPage
->getFile()->isLocal() && $this->getId() == 0 ) {
285 return new ParserOutput();
287 return parent
::getEmptyPageParserOutput( $options );
291 * Returns language code to be used for dispaying the image, based on request context and
292 * languages available in the file.
294 * @param WebRequest $request
296 * @return string|null
298 private function getLanguageForRendering( WebRequest
$request, File
$file ) {
299 $handler = $file->getHandler();
304 $config = MediaWikiServices
::getInstance()->getMainConfig();
305 $requestLanguage = $request->getVal( 'lang', $config->get( 'LanguageCode' ) );
306 if ( $handler->validateParam( 'lang', $requestLanguage ) ) {
307 return $file->getMatchedLanguage( $requestLanguage );
310 return $handler->getDefaultRenderLanguage( $file );
313 protected function openShowImage() {
314 global $wgEnableUploads, $wgSend404Code, $wgSVGMaxSize;
317 $out = $this->getContext()->getOutput();
318 $user = $this->getContext()->getUser();
319 $lang = $this->getContext()->getLanguage();
320 $dirmark = $lang->getDirMarkEntity();
321 $request = $this->getContext()->getRequest();
323 list( $maxWidth, $maxHeight ) = $this->getImageLimitsFromOption( $user, 'imagesize' );
325 if ( $this->displayImg
->exists() ) {
327 $page = $request->getIntOrNull( 'page' );
328 if ( is_null( $page ) ) {
332 $params = [ 'page' => $page ];
335 $renderLang = $this->getLanguageForRendering( $request, $this->displayImg
);
336 if ( !is_null( $renderLang ) ) {
337 $params['lang'] = $renderLang;
340 $width_orig = $this->displayImg
->getWidth( $page );
341 $width = $width_orig;
342 $height_orig = $this->displayImg
->getHeight( $page );
343 $height = $height_orig;
345 $filename = wfEscapeWikiText( $this->displayImg
->getName() );
346 $linktext = $filename;
348 // Avoid PHP 7.1 warning from passing $this by reference
351 Hooks
::run( 'ImageOpenShowImageInlineBefore', [ &$imagePage, &$out ] );
353 if ( $this->displayImg
->allowInlineDisplay() ) {
355 # "Download high res version" link below the image
356 # $msgsize = $this->getContext()->msg( 'file-info-size', $width_orig, $height_orig,
357 # Language::formatSize( $this->displayImg->getSize() ), $mime )->escaped();
358 # We'll show a thumbnail of this image
359 if ( $width > $maxWidth ||
$height > $maxHeight ||
$this->displayImg
->isVectorized() ) {
360 list( $width, $height ) = $this->getDisplayWidthHeight(
361 $maxWidth, $maxHeight, $width, $height
363 $linktext = $this->getContext()->msg( 'show-big-image' )->escaped();
365 $thumbSizes = $this->getThumbSizes( $width_orig, $height_orig );
366 # Generate thumbnails or thumbnail links as needed...
368 foreach ( $thumbSizes as $size ) {
369 // We include a thumbnail size in the list, if it is
370 // less than or equal to the original size of the image
371 // asset ($width_orig/$height_orig). We also exclude
372 // the current thumbnail's size ($width/$height)
373 // since that is added to the message separately, so
374 // it can be denoted as the current size being shown.
375 // Vectorized images are limited by $wgSVGMaxSize big,
376 // so all thumbs less than or equal that are shown.
377 if ( ( ( $size[0] <= $width_orig && $size[1] <= $height_orig )
378 ||
( $this->displayImg
->isVectorized()
379 && max( $size[0], $size[1] ) <= $wgSVGMaxSize )
381 && $size[0] != $width && $size[1] != $height
383 $sizeLink = $this->makeSizeLink( $params, $size[0], $size[1] );
385 $otherSizes[] = $sizeLink;
389 $otherSizes = array_unique( $otherSizes );
391 $sizeLinkBigImagePreview = $this->makeSizeLink( $params, $width, $height );
392 $msgsmall = $this->getThumbPrevText( $params, $sizeLinkBigImagePreview );
393 if ( count( $otherSizes ) ) {
397 [ 'class' => 'mw-filepage-other-resolutions' ],
398 $this->getContext()->msg( 'show-big-image-other' )
399 ->rawParams( $lang->pipeList( $otherSizes ) )
400 ->params( count( $otherSizes ) )
404 } elseif ( $width == 0 && $height == 0 ) {
405 # Some sort of audio file that doesn't have dimensions
406 # Don't output a no hi res message for such a file
409 # Image is small enough to show full size on image page
410 $msgsmall = $this->getContext()->msg( 'file-nohires' )->parse();
413 $params['width'] = $width;
414 $params['height'] = $height;
415 $thumbnail = $this->displayImg
->transform( $params );
416 Linker
::processResponsiveImages( $this->displayImg
, $thumbnail, $params );
418 $anchorclose = Html
::rawElement(
420 [ 'class' => 'mw-filepage-resolutioninfo' ],
424 $isMulti = $this->displayImg
->isMultipage() && $this->displayImg
->pageCount() > 1;
426 $out->addModules( 'mediawiki.page.image.pagination' );
427 $out->addHTML( '<table class="multipageimage"><tr><td>' );
432 'alt' => $this->displayImg
->getTitle()->getPrefixedText(),
435 $out->addHTML( '<div class="fullImageLink" id="file">' .
436 $thumbnail->toHtml( $options ) .
437 $anchorclose . "</div>\n" );
441 $count = $this->displayImg
->pageCount();
444 $label = $this->getContext()->msg( 'imgmultipageprev' )->text();
445 // on the client side, this link is generated in ajaxifyPageNavigation()
446 // in the mediawiki.page.image.pagination module
447 $link = Linker
::linkKnown(
449 htmlspecialchars( $label ),
451 [ 'page' => $page - 1 ]
453 $thumb1 = Linker
::makeThumbLinkObj(
459 [ 'page' => $page - 1 ]
465 if ( $page < $count ) {
466 $label = $this->getContext()->msg( 'imgmultipagenext' )->text();
467 $link = Linker
::linkKnown(
469 htmlspecialchars( $label ),
471 [ 'page' => $page +
1 ]
473 $thumb2 = Linker
::makeThumbLinkObj(
479 [ 'page' => $page +
1 ]
488 'name' => 'pageselector',
489 'action' => $wgScript,
492 for ( $i = 1; $i <= $count; $i++
) {
493 $options[] = Xml
::option( $lang->formatNum( $i ), $i, $i == $page );
495 $select = Xml
::tags( 'select',
496 [ 'id' => 'pageselector', 'name' => 'page' ],
497 implode( "\n", $options ) );
500 '</td><td><div class="multipageimagenavbox">' .
501 Xml
::openElement( 'form', $formParams ) .
502 Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
503 $this->getContext()->msg( 'imgmultigoto' )->rawParams( $select )->parse() .
504 $this->getContext()->msg( 'word-separator' )->escaped() .
505 Xml
::submitButton( $this->getContext()->msg( 'imgmultigo' )->text() ) .
506 Xml
::closeElement( 'form' ) .
507 "<hr />$thumb1\n$thumb2<br style=\"clear: both\" /></div></td></tr></table>"
510 } elseif ( $this->displayImg
->isSafeFile() ) {
511 # if direct link is allowed but it's not a renderable image, show an icon.
512 $icon = $this->displayImg
->iconThumb();
514 $out->addHTML( '<div class="fullImageLink" id="file">' .
515 $icon->toHtml( [ 'file-link' => true ] ) .
519 $longDesc = $this->getContext()->msg( 'parentheses', $this->displayImg
->getLongDesc() )->text();
521 $handler = $this->displayImg
->getHandler();
523 // If this is a filetype with potential issues, warn the user.
525 $warningConfig = $handler->getWarningConfig( $this->displayImg
);
527 if ( $warningConfig !== null ) {
528 // The warning will be displayed via CSS and JavaScript.
529 // We just need to tell the client side what message to use.
530 $output = $this->getContext()->getOutput();
531 $output->addJsConfigVars( 'wgFileWarning', $warningConfig );
532 $output->addModules( $warningConfig['module'] );
533 $output->addModules( 'mediawiki.filewarning' );
537 $medialink = "[[Media:$filename|$linktext]]";
539 if ( !$this->displayImg
->isSafeFile() ) {
540 $warning = $this->getContext()->msg( 'mediawarning' )->plain();
541 // dirmark is needed here to separate the file name, which
542 // most likely ends in Latin characters, from the description,
543 // which may begin with the file type. In RTL environment
544 // this will get messy.
545 // The dirmark, however, must not be immediately adjacent
546 // to the filename, because it can get copied with it.
548 // phpcs:disable Generic.Files.LineLength
549 $out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
550 <span class="dangerousLink">{$medialink}</span> $dirmark<span class="fileInfo">$longDesc</span>
554 $out->wrapWikiTextAsInterface( 'mediaWarning', $warning );
556 $out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
557 {$medialink} {$dirmark}<span class="fileInfo">$longDesc</span>
562 $renderLangOptions = $this->displayImg
->getAvailableLanguages();
563 if ( count( $renderLangOptions ) >= 1 ) {
564 $out->addHTML( $this->doRenderLangOpt( $renderLangOptions, $renderLang ) );
567 // Add cannot animate thumbnail warning
568 if ( !$this->displayImg
->canAnimateThumbIfAppropriate() ) {
569 // Include the extension so wiki admins can
570 // customize it on a per file-type basis
571 // (aka say things like use format X instead).
572 // additionally have a specific message for
573 // file-no-thumb-animation-gif
574 $ext = $this->displayImg
->getExtension();
575 $noAnimMesg = wfMessageFallback(
576 'file-no-thumb-animation-' . $ext,
577 'file-no-thumb-animation'
580 $out->wrapWikiTextAsInterface( 'mw-noanimatethumb', $noAnimMesg );
583 if ( !$this->displayImg
->isLocal() ) {
584 $this->printSharedImageText();
587 # Image does not exist
588 if ( !$this->getId() ) {
589 $dbr = wfGetDB( DB_REPLICA
);
591 # No article exists either
592 # Show deletion log to be consistent with normal articles
593 LogEventsList
::showLogExtract(
595 [ 'delete', 'move', 'protect' ],
596 $this->getTitle()->getPrefixedText(),
599 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
600 'showIfEmpty' => false,
601 'msgKey' => [ 'moveddeleted-notice' ]
606 if ( $wgEnableUploads && MediaWikiServices
::getInstance()
607 ->getPermissionManager()
608 ->userHasRight( $user, 'upload' )
610 // Only show an upload link if the user can upload
611 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
613 'filepage-nofile-link',
614 $uploadTitle->getFullURL( [ 'wpDestFile' => $this->mPage
->getFile()->getName() ] )
617 $nofile = 'filepage-nofile';
619 // Note, if there is an image description page, but
620 // no image, then this setRobotPolicy is overridden
621 // by Article::View().
622 $out->setRobotPolicy( 'noindex,nofollow' );
623 $out->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
624 if ( !$this->getId() && $wgSend404Code ) {
625 // If there is no image, no shared image, and no description page,
626 // output a 404, to be consistent with Article::showMissingArticle.
627 $request->response()->statusHeader( 404 );
630 $out->setFileVersion( $this->displayImg
);
634 * Make the text under the image to say what size preview
636 * @param array $params parameters for thumbnail
637 * @param string $sizeLinkBigImagePreview HTML for the current size
638 * @return string HTML output
640 protected function getThumbPrevText( $params, $sizeLinkBigImagePreview ) {
641 if ( $sizeLinkBigImagePreview ) {
642 // Show a different message of preview is different format from original.
643 $previewTypeDiffers = false;
644 $origExt = $thumbExt = $this->displayImg
->getExtension();
645 if ( $this->displayImg
->getHandler() ) {
646 $origMime = $this->displayImg
->getMimeType();
647 $typeParams = $params;
648 $this->displayImg
->getHandler()->normaliseParams( $this->displayImg
, $typeParams );
649 list( $thumbExt, $thumbMime ) = $this->displayImg
->getHandler()->getThumbType(
650 $origExt, $origMime, $typeParams );
651 if ( $thumbMime !== $origMime ) {
652 $previewTypeDiffers = true;
655 if ( $previewTypeDiffers ) {
656 return $this->getContext()->msg( 'show-big-image-preview-differ' )->
657 rawParams( $sizeLinkBigImagePreview )->
658 params( strtoupper( $origExt ) )->
659 params( strtoupper( $thumbExt ) )->
662 return $this->getContext()->msg( 'show-big-image-preview' )->
663 rawParams( $sizeLinkBigImagePreview )->
672 * Creates an thumbnail of specified size and returns an HTML link to it
673 * @param array $params Scaler parameters
678 protected function makeSizeLink( $params, $width, $height ) {
679 $params['width'] = $width;
680 $params['height'] = $height;
681 $thumbnail = $this->displayImg
->transform( $params );
682 if ( $thumbnail && !$thumbnail->isError() ) {
683 return Html
::rawElement( 'a', [
684 'href' => $thumbnail->getUrl(),
685 'class' => 'mw-thumbnail-link'
686 ], $this->getContext()->msg( 'show-big-image-size' )->numParams(
687 $thumbnail->getWidth(), $thumbnail->getHeight()
695 * Show a notice that the file is from a shared repository
697 protected function printSharedImageText() {
698 $out = $this->getContext()->getOutput();
701 $descUrl = $this->mPage
->getFile()->getDescriptionUrl();
702 $descText = $this->mPage
->getFile()->getDescriptionText( $this->getContext()->getLanguage() );
704 /* Add canonical to head if there is no local page for this shared file */
705 if ( $descUrl && $this->mPage
->getId() == 0 ) {
706 $out->setCanonicalUrl( $descUrl );
709 $wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
710 $repo = $this->mPage
->getFile()->getRepo()->getDisplayName();
714 $this->getContext()->msg( 'sharedupload-desc-here' )->plain() !== '-'
716 $out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-here', $repo, $descUrl ] );
717 } elseif ( $descUrl &&
718 $this->getContext()->msg( 'sharedupload-desc-there' )->plain() !== '-'
720 $out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-there', $repo, $descUrl ] );
722 $out->wrapWikiMsg( $wrap, [ 'sharedupload', $repo ], ''/*BACKCOMPAT*/ );
726 $this->mExtraDescription
= $descText;
730 public function getUploadUrl() {
732 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
733 return $uploadTitle->getFullURL( [
734 'wpDestFile' => $this->mPage
->getFile()->getName(),
740 * Add the re-upload link (or message about not being able to re-upload) to the output.
742 protected function uploadLinksBox() {
743 if ( !$this->getContext()->getConfig()->get( 'EnableUploads' ) ) {
748 if ( !$this->mPage
->getFile()->isLocal() ) {
752 $canUpload = MediaWikiServices
::getInstance()->getPermissionManager()
753 ->quickUserCan( 'upload', $this->getContext()->getUser(), $this->getTitle() );
754 if ( $canUpload && UploadBase
::userCanReUpload(
755 $this->getContext()->getUser(),
756 $this->mPage
->getFile() )
758 // "Upload a new version of this file" link
759 $ulink = Linker
::makeExternalLink(
760 $this->getUploadUrl(),
761 $this->getContext()->msg( 'uploadnewversion-linktext' )->text()
763 $attrs = [ 'class' => 'plainlinks', 'id' => 'mw-imagepage-reupload-link' ];
764 $linkPara = Html
::rawElement( 'p', $attrs, $ulink );
766 // "You cannot overwrite this file." message
767 $attrs = [ 'id' => 'mw-imagepage-upload-disallowed' ];
768 $msg = $this->getContext()->msg( 'upload-disallowed-here' )->text();
769 $linkPara = Html
::element( 'p', $attrs, $msg );
772 $uploadLinks = Html
::rawElement( 'div', [ 'class' => 'mw-imagepage-upload-links' ], $linkPara );
773 $this->getContext()->getOutput()->addHTML( $uploadLinks );
779 protected function closeShowImage() {
783 * If the page we've just displayed is in the "Image" namespace,
784 * we follow it with an upload history of the image and its usage.
786 protected function imageHistory() {
788 $out = $this->getContext()->getOutput();
789 $pager = new ImageHistoryPseudoPager( $this );
790 $out->addHTML( $pager->getBody() );
791 $out->preventClickjacking( $pager->getPreventClickjacking() );
793 $this->mPage
->getFile()->resetHistory(); // free db resources
795 # Exist check because we don't want to show this on pages where an image
796 # doesn't exist along with the noimage message, that would suck. -ævar
797 if ( $this->mPage
->getFile()->exists() ) {
798 $this->uploadLinksBox();
803 * @param string|string[] $target
805 * @return ResultWrapper
807 protected function queryImageLinks( $target, $limit ) {
808 $dbr = wfGetDB( DB_REPLICA
);
811 [ 'imagelinks', 'page' ],
812 [ 'page_namespace', 'page_title', 'il_to' ],
813 [ 'il_to' => $target, 'il_from = page_id' ],
815 [ 'LIMIT' => $limit +
1, 'ORDER BY' => 'il_from', ]
819 protected function imageLinks() {
822 $out = $this->getContext()->getOutput();
826 foreach ( $this->getTitle()->getRedirectsHere( NS_FILE
) as $redir ) {
827 $redirects[$redir->getDBkey()] = [];
829 'page_namespace' => NS_FILE
,
830 'page_title' => $redir->getDBkey(),
834 $res = $this->queryImageLinks( $this->getTitle()->getDBkey(), $limit +
1 );
835 foreach ( $res as $row ) {
838 $count = count( $rows );
840 $hasMore = $count > $limit;
841 if ( !$hasMore && count( $redirects ) ) {
842 $res = $this->queryImageLinks( array_keys( $redirects ),
843 $limit - count( $rows ) +
1 );
844 foreach ( $res as $row ) {
845 $redirects[$row->il_to
][] = $row;
848 $hasMore = ( $res->numRows() +
count( $rows ) ) > $limit;
853 Html
::rawElement( 'div',
854 [ 'id' => 'mw-imagepage-nolinkstoimage' ], "\n$1\n" ),
860 $out->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
862 $out->addWikiMsg( 'linkstoimage', $count );
864 // More links than the limit. Add a link to [[Special:Whatlinkshere]]
865 $out->addWikiMsg( 'linkstoimage-more',
866 $this->getContext()->getLanguage()->formatNum( $limit ),
867 $this->getTitle()->getPrefixedDBkey()
872 Html
::openElement( 'ul',
873 [ 'class' => 'mw-imagepage-linkstoimage' ] ) . "\n"
877 // Sort the list by namespace:title
878 usort( $rows, [ $this, 'compare' ] );
880 // Create links for every element
882 foreach ( $rows as $element ) {
884 if ( $currentCount > $limit ) {
889 # Add a redirect=no to make redirect pages reachable
890 if ( isset( $redirects[$element->page_title
] ) ) {
891 $query['redirect'] = 'no';
893 $link = Linker
::linkKnown(
894 Title
::makeTitle( $element->page_namespace
, $element->page_title
),
897 if ( !isset( $redirects[$element->page_title
] ) ) {
900 } elseif ( count( $redirects[$element->page_title
] ) === 0 ) {
901 # Redirect without usages
902 $liContents = $this->getContext()->msg( 'linkstoimage-redirect' )
903 ->rawParams( $link, '' )
906 # Redirect with usages
908 foreach ( $redirects[$element->page_title
] as $row ) {
910 if ( $currentCount > $limit ) {
914 $link2 = Linker
::linkKnown( Title
::makeTitle( $row->page_namespace
, $row->page_title
) );
915 $li .= Html
::rawElement(
917 [ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
],
922 $ul = Html
::rawElement(
924 [ 'class' => 'mw-imagepage-redirectstofile' ],
927 $liContents = $this->getContext()->msg( 'linkstoimage-redirect' )->rawParams(
928 $link, $ul )->parse();
930 $out->addHTML( Html
::rawElement(
932 [ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
],
938 $out->addHTML( Html
::closeElement( 'ul' ) . "\n" );
941 // Add a links to [[Special:Whatlinkshere]]
942 if ( $count > $limit ) {
943 $out->addWikiMsg( 'morelinkstoimage', $this->getTitle()->getPrefixedDBkey() );
945 $out->addHTML( Html
::closeElement( 'div' ) . "\n" );
948 protected function imageDupes() {
950 $out = $this->getContext()->getOutput();
952 $dupes = $this->mPage
->getDuplicates();
953 if ( count( $dupes ) == 0 ) {
957 $out->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
958 $out->addWikiMsg( 'duplicatesoffile',
959 $this->getContext()->getLanguage()->formatNum( count( $dupes ) ), $this->getTitle()->getDBkey()
961 $out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
966 foreach ( $dupes as $file ) {
968 if ( $file->isLocal() ) {
969 $link = Linker
::linkKnown( $file->getTitle() );
971 $link = Linker
::makeExternalLink( $file->getDescriptionUrl(),
972 $file->getTitle()->getPrefixedText() );
973 $fromSrc = $this->getContext()->msg(
975 $file->getRepo()->getDisplayName()
978 $out->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
980 $out->addHTML( "</ul></div>\n" );
984 * Delete the file, or an earlier version of it
986 public function delete() {
987 $file = $this->mPage
->getFile();
988 if ( !$file->exists() ||
!$file->isLocal() ||
$file->getRedirected() ) {
989 // Standard article deletion
993 '@phan-var LocalFile $file';
995 $deleter = new FileDeleteForm( $file );
1000 * Display an error with a wikitext description
1002 * @param string $description
1004 function showError( $description ) {
1005 $out = $this->getContext()->getOutput();
1006 $out->setPageTitle( $this->getContext()->msg( 'internalerror' ) );
1007 $out->setRobotPolicy( 'noindex,nofollow' );
1008 $out->setArticleRelated( false );
1009 $out->enableClientCache( false );
1010 $out->addWikiTextAsInterface( $description );
1014 * Callback for usort() to do link sorts by (namespace, title)
1015 * Function copied from Title::compare()
1017 * @param object $a Object page to compare with
1018 * @param object $b Object page to compare with
1019 * @return int Result of string comparison, or namespace comparison
1021 protected function compare( $a, $b ) {
1022 return $a->page_namespace
<=> $b->page_namespace
1023 ?
: strcmp( $a->page_title
, $b->page_title
);
1027 * Returns the corresponding $wgImageLimits entry for the selected user option
1030 * @param string $optionName Name of a option to check, typically imagesize or thumbsize
1034 public function getImageLimitsFromOption( $user, $optionName ) {
1035 global $wgImageLimits;
1037 $option = $user->getIntOption( $optionName );
1038 if ( !isset( $wgImageLimits[$option] ) ) {
1039 $option = User
::getDefaultOption( $optionName );
1042 // The user offset might still be incorrect, specially if
1043 // $wgImageLimits got changed (see T10858).
1044 if ( !isset( $wgImageLimits[$option] ) ) {
1045 // Default to the first offset in $wgImageLimits
1049 // if nothing is set, fallback to a hardcoded default
1050 return $wgImageLimits[$option] ??
[ 800, 600 ];
1054 * Output a drop-down box for language options for the file
1056 * @param array $langChoices Array of string language codes
1057 * @param string $renderLang Language code for the language we want the file to rendered in.
1058 * @return string HTML to insert underneath image.
1060 protected function doRenderLangOpt( array $langChoices, $renderLang ) {
1064 $matchedRenderLang = $this->displayImg
->getMatchedLanguage( $renderLang );
1066 foreach ( $langChoices as $lang ) {
1067 $opts .= $this->createXmlOptionStringForLanguage(
1069 $matchedRenderLang === $lang
1073 // Allow for the default case in an svg <switch> that is displayed if no
1074 // systemLanguage attribute matches
1077 $this->getContext()->msg( 'img-lang-default' )->text(),
1079 is_null( $matchedRenderLang )
1082 $select = Html
::rawElement(
1084 [ 'id' => 'mw-imglangselector', 'name' => 'lang' ],
1087 $submit = Xml
::submitButton( $this->getContext()->msg( 'img-lang-go' )->text() );
1089 $formContents = $this->getContext()->msg( 'img-lang-info' )
1090 ->rawParams( $select, $submit )
1092 $formContents .= Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() );
1094 $langSelectLine = Html
::rawElement( 'div', [ 'id' => 'mw-imglangselector-line' ],
1095 Html
::rawElement( 'form', [ 'action' => $wgScript ], $formContents )
1097 return $langSelectLine;
1101 * @param string $lang
1102 * @param bool $selected
1105 private function createXmlOptionStringForLanguage( $lang, $selected ) {
1106 $code = LanguageCode
::bcp47( $lang );
1107 $name = Language
::fetchLanguageName( $code, $this->getContext()->getLanguage()->getCode() );
1108 if ( $name !== '' ) {
1109 $display = $this->getContext()->msg( 'img-lang-opt', $code, $name )->text();
1122 * Get the width and height to display image at.
1124 * @note This method assumes that it is only called if one
1125 * of the dimensions are bigger than the max, or if the
1126 * image is vectorized.
1128 * @param int $maxWidth Max width to display at
1129 * @param int $maxHeight Max height to display at
1130 * @param int $width Actual width of the image
1131 * @param int $height Actual height of the image
1132 * @throws MWException
1133 * @return array Array (width, height)
1135 protected function getDisplayWidthHeight( $maxWidth, $maxHeight, $width, $height ) {
1136 if ( !$maxWidth ||
!$maxHeight ) {
1137 // should never happen
1138 throw new MWException( 'Using a choice from $wgImageLimits that is 0x0' );
1141 if ( !$width ||
!$height ) {
1145 # Calculate the thumbnail size.
1146 if ( $width <= $maxWidth && $height <= $maxHeight ) {
1147 // Vectorized image, do nothing.
1148 } elseif ( $width / $height >= $maxWidth / $maxHeight ) {
1149 # The limiting factor is the width, not the height.
1150 $height = round( $height * $maxWidth / $width );
1152 # Note that $height <= $maxHeight now.
1154 $newwidth = floor( $width * $maxHeight / $height );
1155 $height = round( $height * $newwidth / $width );
1157 # Note that $height <= $maxHeight now, but might not be identical
1158 # because of rounding.
1160 return [ $width, $height ];
1164 * Get alternative thumbnail sizes.
1166 * @note This will only list several alternatives if thumbnails are rendered on 404
1167 * @param int $origWidth Actual width of image
1168 * @param int $origHeight Actual height of image
1169 * @return array An array of [width, height] pairs.
1171 protected function getThumbSizes( $origWidth, $origHeight ) {
1172 global $wgImageLimits;
1173 if ( $this->displayImg
->getRepo()->canTransformVia404() ) {
1174 $thumbSizes = $wgImageLimits;
1175 // Also include the full sized resolution in the list, so
1176 // that users know they can get it. This will link to the
1177 // original file asset if mustRender() === false. In the case
1178 // that we mustRender, some users have indicated that they would
1179 // find it useful to have the full size image in the rendered
1181 $thumbSizes[] = [ $origWidth, $origHeight ];
1183 # Creating thumb links triggers thumbnail generation.
1184 # Just generate the thumb for the current users prefs.
1186 $this->getImageLimitsFromOption( $this->getContext()->getUser(), 'thumbsize' )
1188 if ( !$this->displayImg
->mustRender() ) {
1189 // We can safely include a link to the "full-size" preview,
1190 // without actually rendering.
1191 $thumbSizes[] = [ $origWidth, $origHeight ];
1198 * @see WikiFilePage::getFile
1201 public function getFile() {
1202 return $this->mPage
->getFile();
1206 * @see WikiFilePage::isLocal
1209 public function isLocal() {
1210 return $this->mPage
->isLocal();
1214 * @see WikiFilePage::getDuplicates
1215 * @return array|null
1217 public function getDuplicates() {
1218 return $this->mPage
->getDuplicates();
1222 * @see WikiFilePage::getForeignCategories
1223 * @return TitleArray|Title[]
1225 public function getForeignCategories() {
1226 return $this->mPage
->getForeignCategories();