Merge "Preserve grapheme clusters in upper corner completion suggester highlighting"
[lhc/web/wiklou.git] / includes / page / ImagePage.php
1 <?php
2 /**
3 * Special handling for file description pages.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 */
22
23 use MediaWiki\MediaWikiServices;
24 use Wikimedia\Rdbms\ResultWrapper;
25
26 /**
27 * Class for viewing MediaWiki file description pages
28 *
29 * @ingroup Media
30 */
31 class ImagePage extends Article {
32 /** @var File|false */
33 private $displayImg;
34
35 /** @var FileRepo */
36 private $repo;
37
38 /** @var bool */
39 private $fileLoaded;
40
41 /** @var bool */
42 protected $mExtraDescription = false;
43
44 /**
45 * @var WikiFilePage
46 */
47 protected $mPage;
48
49 /**
50 * @param Title $title
51 * @return WikiFilePage
52 */
53 protected function newPage( Title $title ) {
54 // Overload mPage with a file-specific page
55 return new WikiFilePage( $title );
56 }
57
58 /**
59 * @param File $file
60 * @return void
61 */
62 public function setFile( $file ) {
63 $this->mPage->setFile( $file );
64 $this->displayImg = $file;
65 $this->fileLoaded = true;
66 }
67
68 protected function loadFile() {
69 if ( $this->fileLoaded ) {
70 return;
71 }
72 $this->fileLoaded = true;
73
74 $this->displayImg = $img = false;
75
76 Hooks::run( 'ImagePageFindFile', [ $this, &$img, &$this->displayImg ] );
77 if ( !$img ) { // not set by hook?
78 $services = MediaWikiServices::getInstance();
79 $img = $services->getRepoGroup()->findFile( $this->getTitle() );
80 if ( !$img ) {
81 $img = $services->getRepoGroup()->getLocalRepo()->newFile( $this->getTitle() );
82 }
83 }
84 $this->mPage->setFile( $img );
85 if ( !$this->displayImg ) { // not set by hook?
86 $this->displayImg = $img;
87 }
88 $this->repo = $img->getRepo();
89 }
90
91 public function view() {
92 global $wgShowEXIF;
93
94 // For action=render, include body text only; none of the image extras
95 if ( $this->viewIsRenderAction ) {
96 parent::view();
97 return;
98 }
99
100 $out = $this->getContext()->getOutput();
101 $request = $this->getContext()->getRequest();
102 $diff = $request->getVal( 'diff' );
103 $diffOnly = $request->getBool(
104 'diffonly',
105 $this->getContext()->getUser()->getOption( 'diffonly' )
106 );
107
108 if ( $this->getTitle()->getNamespace() != NS_FILE || ( $diff !== null && $diffOnly ) ) {
109 parent::view();
110 return;
111 }
112
113 $this->loadFile();
114
115 if ( $this->getTitle()->getNamespace() == NS_FILE && $this->mPage->getFile()->getRedirected() ) {
116 if ( $this->getTitle()->getDBkey() == $this->mPage->getFile()->getName() || $diff !== null ) {
117 $request->setVal( 'diffonly', 'true' );
118 }
119
120 parent::view();
121 return;
122 }
123
124 if ( $wgShowEXIF && $this->displayImg->exists() ) {
125 // @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
126 $formattedMetadata = $this->displayImg->formatMetadata( $this->getContext() );
127 $showmeta = $formattedMetadata !== false;
128 } else {
129 $showmeta = false;
130 }
131
132 if ( !$diff && $this->displayImg->exists() ) {
133 $out->addHTML( $this->showTOC( $showmeta ) );
134 }
135
136 if ( !$diff ) {
137 $this->openShowImage();
138 }
139
140 # No need to display noarticletext, we use our own message, output in openShowImage()
141 if ( $this->mPage->getId() ) {
142 # NS_FILE is in the user language, but this section (the actual wikitext)
143 # should be in page content language
144 $pageLang = $this->getTitle()->getPageViewLanguage();
145 $out->addHTML( Xml::openElement( 'div', [ 'id' => 'mw-imagepage-content',
146 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
147 'class' => 'mw-content-' . $pageLang->getDir() ] ) );
148
149 parent::view();
150
151 $out->addHTML( Xml::closeElement( 'div' ) );
152 } else {
153 # Just need to set the right headers
154 $out->setArticleFlag( true );
155 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
156 $this->mPage->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
157 }
158
159 # Show shared description, if needed
160 if ( $this->mExtraDescription ) {
161 $fol = $this->getContext()->msg( 'shareddescriptionfollows' );
162 if ( !$fol->isDisabled() ) {
163 $out->addWikiTextAsInterface( $fol->plain() );
164 }
165 $out->addHTML( '<div id="shared-image-desc">' . $this->mExtraDescription . "</div>\n" );
166 }
167
168 $this->closeShowImage();
169 $this->imageHistory();
170 // TODO: Cleanup the following
171
172 $out->addHTML( Xml::element( 'h2',
173 [ 'id' => 'filelinks' ],
174 $this->getContext()->msg( 'imagelinks' )->text() ) . "\n" );
175 $this->imageDupes();
176 # @todo FIXME: For some freaky reason, we can't redirect to foreign images.
177 # Yet we return metadata about the target. Definitely an issue in the FileRepo
178 $this->imageLinks();
179
180 # Allow extensions to add something after the image links
181 $html = '';
182 Hooks::run( 'ImagePageAfterImageLinks', [ $this, &$html ] );
183 if ( $html ) {
184 $out->addHTML( $html );
185 }
186
187 if ( $showmeta ) {
188 $out->addHTML( Xml::element(
189 'h2',
190 [ 'id' => 'metadata' ],
191 $this->getContext()->msg( 'metadata' )->text() ) . "\n" );
192 $out->wrapWikiTextAsInterface(
193 'mw-imagepage-section-metadata',
194 $this->makeMetadataTable( $formattedMetadata )
195 );
196 $out->addModules( [ 'mediawiki.action.view.metadata' ] );
197 }
198
199 // Add remote Filepage.css
200 if ( !$this->repo->isLocal() ) {
201 $css = $this->repo->getDescriptionStylesheetUrl();
202 if ( $css ) {
203 $out->addStyle( $css );
204 }
205 }
206
207 $out->addModuleStyles( [
208 'filepage', // always show the local local Filepage.css, T31277
209 'mediawiki.action.view.filepage', // Add MediaWiki styles for a file page
210 ] );
211 }
212
213 /**
214 * @return File
215 */
216 public function getDisplayedFile() {
217 $this->loadFile();
218 return $this->displayImg;
219 }
220
221 /**
222 * Create the TOC
223 *
224 * @param bool $metadata Whether or not to show the metadata link
225 * @return string
226 */
227 protected function showTOC( $metadata ) {
228 $r = [
229 '<li><a href="#file">' . $this->getContext()->msg( 'file-anchor-link' )->escaped() . '</a></li>',
230 '<li><a href="#filehistory">' . $this->getContext()->msg( 'filehist' )->escaped() . '</a></li>',
231 '<li><a href="#filelinks">' . $this->getContext()->msg( 'imagelinks' )->escaped() . '</a></li>',
232 ];
233
234 Hooks::run( 'ImagePageShowTOC', [ $this, &$r ] );
235
236 if ( $metadata ) {
237 $r[] = '<li><a href="#metadata">' .
238 $this->getContext()->msg( 'metadata' )->escaped() .
239 '</a></li>';
240 }
241
242 return '<ul id="filetoc">' . implode( "\n", $r ) . '</ul>';
243 }
244
245 /**
246 * Make a table with metadata to be shown in the output page.
247 *
248 * @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
249 *
250 * @param array $metadata The array containing the Exif data
251 * @return string The metadata table. This is treated as Wikitext (!)
252 */
253 protected function makeMetadataTable( $metadata ) {
254 $r = $this->getContext()->msg( 'metadata-help' )->plain();
255 // Intial state is collapsed
256 // see filepage.css and mediawiki.action.view.metadata module.
257 $r .= "<table id=\"mw_metadata\" class=\"mw_metadata collapsed\">\n";
258 foreach ( $metadata as $type => $stuff ) {
259 foreach ( $stuff as $v ) {
260 $class = str_replace( ' ', '_', $v['id'] );
261 if ( $type == 'collapsed' ) {
262 $class .= ' mw-metadata-collapsible';
263 }
264 $r .= Html::rawElement( 'tr',
265 [ 'class' => $class ],
266 Html::rawElement( 'th', [], $v['name'] )
267 . Html::rawElement( 'td', [], $v['value'] )
268 );
269 }
270 }
271 $r .= "</table>\n";
272 return $r;
273 }
274
275 /**
276 * Overloading Article's getEmptyPageParserOutput method.
277 *
278 * Omit noarticletext if sharedupload; text will be fetched from the
279 * shared upload server if possible.
280 *
281 * @param ParserOptions $options
282 * @return ParserOutput
283 */
284 public function getEmptyPageParserOutput( ParserOptions $options ) {
285 $this->loadFile();
286 if ( $this->mPage->getFile() && !$this->mPage->getFile()->isLocal() && $this->getId() == 0 ) {
287 return new ParserOutput();
288 }
289 return parent::getEmptyPageParserOutput( $options );
290 }
291
292 /**
293 * Returns language code to be used for dispaying the image, based on request context and
294 * languages available in the file.
295 *
296 * @param WebRequest $request
297 * @param File $file
298 * @return string|null
299 */
300 private function getLanguageForRendering( WebRequest $request, File $file ) {
301 $handler = $file->getHandler();
302 if ( !$handler ) {
303 return null;
304 }
305
306 $config = MediaWikiServices::getInstance()->getMainConfig();
307 $requestLanguage = $request->getVal( 'lang', $config->get( 'LanguageCode' ) );
308 if ( $handler->validateParam( 'lang', $requestLanguage ) ) {
309 return $file->getMatchedLanguage( $requestLanguage );
310 }
311
312 return $handler->getDefaultRenderLanguage( $file );
313 }
314
315 protected function openShowImage() {
316 global $wgEnableUploads, $wgSend404Code, $wgSVGMaxSize;
317
318 $this->loadFile();
319 $out = $this->getContext()->getOutput();
320 $user = $this->getContext()->getUser();
321 $lang = $this->getContext()->getLanguage();
322 $dirmark = $lang->getDirMarkEntity();
323 $request = $this->getContext()->getRequest();
324
325 list( $maxWidth, $maxHeight ) = $this->getImageLimitsFromOption( $user, 'imagesize' );
326
327 if ( $this->displayImg->exists() ) {
328 # image
329 $page = $request->getIntOrNull( 'page' );
330 if ( is_null( $page ) ) {
331 $params = [];
332 $page = 1;
333 } else {
334 $params = [ 'page' => $page ];
335 }
336
337 $renderLang = $this->getLanguageForRendering( $request, $this->displayImg );
338 if ( !is_null( $renderLang ) ) {
339 $params['lang'] = $renderLang;
340 }
341
342 $width_orig = $this->displayImg->getWidth( $page );
343 $width = $width_orig;
344 $height_orig = $this->displayImg->getHeight( $page );
345 $height = $height_orig;
346
347 $filename = wfEscapeWikiText( $this->displayImg->getName() );
348 $linktext = $filename;
349
350 // Avoid PHP 7.1 warning from passing $this by reference
351 $imagePage = $this;
352
353 Hooks::run( 'ImageOpenShowImageInlineBefore', [ &$imagePage, &$out ] );
354
355 if ( $this->displayImg->allowInlineDisplay() ) {
356 # image
357 # "Download high res version" link below the image
358 # $msgsize = $this->getContext()->msg( 'file-info-size', $width_orig, $height_orig,
359 # Language::formatSize( $this->displayImg->getSize() ), $mime )->escaped();
360 # We'll show a thumbnail of this image
361 if ( $width > $maxWidth || $height > $maxHeight || $this->displayImg->isVectorized() ) {
362 list( $width, $height ) = $this->getDisplayWidthHeight(
363 $maxWidth, $maxHeight, $width, $height
364 );
365 $linktext = $this->getContext()->msg( 'show-big-image' )->escaped();
366
367 $thumbSizes = $this->getThumbSizes( $width_orig, $height_orig );
368 # Generate thumbnails or thumbnail links as needed...
369 $otherSizes = [];
370 foreach ( $thumbSizes as $size ) {
371 // We include a thumbnail size in the list, if it is
372 // less than or equal to the original size of the image
373 // asset ($width_orig/$height_orig). We also exclude
374 // the current thumbnail's size ($width/$height)
375 // since that is added to the message separately, so
376 // it can be denoted as the current size being shown.
377 // Vectorized images are limited by $wgSVGMaxSize big,
378 // so all thumbs less than or equal that are shown.
379 if ( ( ( $size[0] <= $width_orig && $size[1] <= $height_orig )
380 || ( $this->displayImg->isVectorized()
381 && max( $size[0], $size[1] ) <= $wgSVGMaxSize )
382 )
383 && $size[0] != $width && $size[1] != $height
384 ) {
385 $sizeLink = $this->makeSizeLink( $params, $size[0], $size[1] );
386 if ( $sizeLink ) {
387 $otherSizes[] = $sizeLink;
388 }
389 }
390 }
391 $otherSizes = array_unique( $otherSizes );
392
393 $sizeLinkBigImagePreview = $this->makeSizeLink( $params, $width, $height );
394 $msgsmall = $this->getThumbPrevText( $params, $sizeLinkBigImagePreview );
395 if ( count( $otherSizes ) ) {
396 $msgsmall .= ' ' .
397 Html::rawElement(
398 'span',
399 [ 'class' => 'mw-filepage-other-resolutions' ],
400 $this->getContext()->msg( 'show-big-image-other' )
401 ->rawParams( $lang->pipeList( $otherSizes ) )
402 ->params( count( $otherSizes ) )
403 ->parse()
404 );
405 }
406 } elseif ( $width == 0 && $height == 0 ) {
407 # Some sort of audio file that doesn't have dimensions
408 # Don't output a no hi res message for such a file
409 $msgsmall = '';
410 } else {
411 # Image is small enough to show full size on image page
412 $msgsmall = $this->getContext()->msg( 'file-nohires' )->parse();
413 }
414
415 $params['width'] = $width;
416 $params['height'] = $height;
417 $thumbnail = $this->displayImg->transform( $params );
418 Linker::processResponsiveImages( $this->displayImg, $thumbnail, $params );
419
420 $anchorclose = Html::rawElement(
421 'div',
422 [ 'class' => 'mw-filepage-resolutioninfo' ],
423 $msgsmall
424 );
425
426 $isMulti = $this->displayImg->isMultipage() && $this->displayImg->pageCount() > 1;
427 if ( $isMulti ) {
428 $out->addModules( 'mediawiki.page.image.pagination' );
429 $out->addHTML( '<table class="multipageimage"><tr><td>' );
430 }
431
432 if ( $thumbnail ) {
433 $options = [
434 'alt' => $this->displayImg->getTitle()->getPrefixedText(),
435 'file-link' => true,
436 ];
437 $out->addHTML( '<div class="fullImageLink" id="file">' .
438 $thumbnail->toHtml( $options ) .
439 $anchorclose . "</div>\n" );
440 }
441
442 if ( $isMulti ) {
443 $count = $this->displayImg->pageCount();
444
445 if ( $page > 1 ) {
446 $label = $this->getContext()->msg( 'imgmultipageprev' )->text();
447 // on the client side, this link is generated in ajaxifyPageNavigation()
448 // in the mediawiki.page.image.pagination module
449 $link = Linker::linkKnown(
450 $this->getTitle(),
451 htmlspecialchars( $label ),
452 [],
453 [ 'page' => $page - 1 ]
454 );
455 $thumb1 = Linker::makeThumbLinkObj(
456 $this->getTitle(),
457 $this->displayImg,
458 $link,
459 $label,
460 'none',
461 [ 'page' => $page - 1 ]
462 );
463 } else {
464 $thumb1 = '';
465 }
466
467 if ( $page < $count ) {
468 $label = $this->getContext()->msg( 'imgmultipagenext' )->text();
469 $link = Linker::linkKnown(
470 $this->getTitle(),
471 htmlspecialchars( $label ),
472 [],
473 [ 'page' => $page + 1 ]
474 );
475 $thumb2 = Linker::makeThumbLinkObj(
476 $this->getTitle(),
477 $this->displayImg,
478 $link,
479 $label,
480 'none',
481 [ 'page' => $page + 1 ]
482 );
483 } else {
484 $thumb2 = '';
485 }
486
487 global $wgScript;
488
489 $formParams = [
490 'name' => 'pageselector',
491 'action' => $wgScript,
492 ];
493 $options = [];
494 for ( $i = 1; $i <= $count; $i++ ) {
495 $options[] = Xml::option( $lang->formatNum( $i ), $i, $i == $page );
496 }
497 $select = Xml::tags( 'select',
498 [ 'id' => 'pageselector', 'name' => 'page' ],
499 implode( "\n", $options ) );
500
501 $out->addHTML(
502 '</td><td><div class="multipageimagenavbox">' .
503 Xml::openElement( 'form', $formParams ) .
504 Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
505 $this->getContext()->msg( 'imgmultigoto' )->rawParams( $select )->parse() .
506 $this->getContext()->msg( 'word-separator' )->escaped() .
507 Xml::submitButton( $this->getContext()->msg( 'imgmultigo' )->text() ) .
508 Xml::closeElement( 'form' ) .
509 "<hr />$thumb1\n$thumb2<br style=\"clear: both\" /></div></td></tr></table>"
510 );
511 }
512 } elseif ( $this->displayImg->isSafeFile() ) {
513 # if direct link is allowed but it's not a renderable image, show an icon.
514 $icon = $this->displayImg->iconThumb();
515
516 $out->addHTML( '<div class="fullImageLink" id="file">' .
517 $icon->toHtml( [ 'file-link' => true ] ) .
518 "</div>\n" );
519 }
520
521 $longDesc = $this->getContext()->msg( 'parentheses', $this->displayImg->getLongDesc() )->text();
522
523 $handler = $this->displayImg->getHandler();
524
525 // If this is a filetype with potential issues, warn the user.
526 if ( $handler ) {
527 $warningConfig = $handler->getWarningConfig( $this->displayImg );
528
529 if ( $warningConfig !== null ) {
530 // The warning will be displayed via CSS and JavaScript.
531 // We just need to tell the client side what message to use.
532 $output = $this->getContext()->getOutput();
533 $output->addJsConfigVars( 'wgFileWarning', $warningConfig );
534 $output->addModules( $warningConfig['module'] );
535 $output->addModules( 'mediawiki.filewarning' );
536 }
537 }
538
539 $medialink = "[[Media:$filename|$linktext]]";
540
541 if ( !$this->displayImg->isSafeFile() ) {
542 $warning = $this->getContext()->msg( 'mediawarning' )->plain();
543 // dirmark is needed here to separate the file name, which
544 // most likely ends in Latin characters, from the description,
545 // which may begin with the file type. In RTL environment
546 // this will get messy.
547 // The dirmark, however, must not be immediately adjacent
548 // to the filename, because it can get copied with it.
549 // See T27277.
550 // phpcs:disable Generic.Files.LineLength
551 $out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
552 <span class="dangerousLink">{$medialink}</span> $dirmark<span class="fileInfo">$longDesc</span>
553 EOT
554 );
555 // phpcs:enable
556 $out->wrapWikiTextAsInterface( 'mediaWarning', $warning );
557 } else {
558 $out->wrapWikiTextAsInterface( 'fullMedia', <<<EOT
559 {$medialink} {$dirmark}<span class="fileInfo">$longDesc</span>
560 EOT
561 );
562 }
563
564 $renderLangOptions = $this->displayImg->getAvailableLanguages();
565 if ( count( $renderLangOptions ) >= 1 ) {
566 $out->addHTML( $this->doRenderLangOpt( $renderLangOptions, $renderLang ) );
567 }
568
569 // Add cannot animate thumbnail warning
570 if ( !$this->displayImg->canAnimateThumbIfAppropriate() ) {
571 // Include the extension so wiki admins can
572 // customize it on a per file-type basis
573 // (aka say things like use format X instead).
574 // additionally have a specific message for
575 // file-no-thumb-animation-gif
576 $ext = $this->displayImg->getExtension();
577 $noAnimMesg = wfMessageFallback(
578 'file-no-thumb-animation-' . $ext,
579 'file-no-thumb-animation'
580 )->plain();
581
582 $out->wrapWikiTextAsInterface( 'mw-noanimatethumb', $noAnimMesg );
583 }
584
585 if ( !$this->displayImg->isLocal() ) {
586 $this->printSharedImageText();
587 }
588 } else {
589 # Image does not exist
590 if ( !$this->getId() ) {
591 $dbr = wfGetDB( DB_REPLICA );
592
593 # No article exists either
594 # Show deletion log to be consistent with normal articles
595 LogEventsList::showLogExtract(
596 $out,
597 [ 'delete', 'move', 'protect' ],
598 $this->getTitle()->getPrefixedText(),
599 '',
600 [ 'lim' => 10,
601 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
602 'showIfEmpty' => false,
603 'msgKey' => [ 'moveddeleted-notice' ]
604 ]
605 );
606 }
607
608 if ( $wgEnableUploads && $user->isAllowed( 'upload' ) ) {
609 // Only show an upload link if the user can upload
610 $uploadTitle = SpecialPage::getTitleFor( 'Upload' );
611 $nofile = [
612 'filepage-nofile-link',
613 $uploadTitle->getFullURL( [ 'wpDestFile' => $this->mPage->getFile()->getName() ] )
614 ];
615 } else {
616 $nofile = 'filepage-nofile';
617 }
618 // Note, if there is an image description page, but
619 // no image, then this setRobotPolicy is overridden
620 // by Article::View().
621 $out->setRobotPolicy( 'noindex,nofollow' );
622 $out->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
623 if ( !$this->getId() && $wgSend404Code ) {
624 // If there is no image, no shared image, and no description page,
625 // output a 404, to be consistent with Article::showMissingArticle.
626 $request->response()->statusHeader( 404 );
627 }
628 }
629 $out->setFileVersion( $this->displayImg );
630 }
631
632 /**
633 * Make the text under the image to say what size preview
634 *
635 * @param array $params parameters for thumbnail
636 * @param string $sizeLinkBigImagePreview HTML for the current size
637 * @return string HTML output
638 */
639 protected function getThumbPrevText( $params, $sizeLinkBigImagePreview ) {
640 if ( $sizeLinkBigImagePreview ) {
641 // Show a different message of preview is different format from original.
642 $previewTypeDiffers = false;
643 $origExt = $thumbExt = $this->displayImg->getExtension();
644 if ( $this->displayImg->getHandler() ) {
645 $origMime = $this->displayImg->getMimeType();
646 $typeParams = $params;
647 $this->displayImg->getHandler()->normaliseParams( $this->displayImg, $typeParams );
648 list( $thumbExt, $thumbMime ) = $this->displayImg->getHandler()->getThumbType(
649 $origExt, $origMime, $typeParams );
650 if ( $thumbMime !== $origMime ) {
651 $previewTypeDiffers = true;
652 }
653 }
654 if ( $previewTypeDiffers ) {
655 return $this->getContext()->msg( 'show-big-image-preview-differ' )->
656 rawParams( $sizeLinkBigImagePreview )->
657 params( strtoupper( $origExt ) )->
658 params( strtoupper( $thumbExt ) )->
659 parse();
660 } else {
661 return $this->getContext()->msg( 'show-big-image-preview' )->
662 rawParams( $sizeLinkBigImagePreview )->
663 parse();
664 }
665 } else {
666 return '';
667 }
668 }
669
670 /**
671 * Creates an thumbnail of specified size and returns an HTML link to it
672 * @param array $params Scaler parameters
673 * @param int $width
674 * @param int $height
675 * @return string
676 */
677 protected function makeSizeLink( $params, $width, $height ) {
678 $params['width'] = $width;
679 $params['height'] = $height;
680 $thumbnail = $this->displayImg->transform( $params );
681 if ( $thumbnail && !$thumbnail->isError() ) {
682 return Html::rawElement( 'a', [
683 'href' => $thumbnail->getUrl(),
684 'class' => 'mw-thumbnail-link'
685 ], $this->getContext()->msg( 'show-big-image-size' )->numParams(
686 $thumbnail->getWidth(), $thumbnail->getHeight()
687 )->parse() );
688 } else {
689 return '';
690 }
691 }
692
693 /**
694 * Show a notice that the file is from a shared repository
695 */
696 protected function printSharedImageText() {
697 $out = $this->getContext()->getOutput();
698 $this->loadFile();
699
700 $descUrl = $this->mPage->getFile()->getDescriptionUrl();
701 $descText = $this->mPage->getFile()->getDescriptionText( $this->getContext()->getLanguage() );
702
703 /* Add canonical to head if there is no local page for this shared file */
704 if ( $descUrl && $this->mPage->getId() == 0 ) {
705 $out->setCanonicalUrl( $descUrl );
706 }
707
708 $wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
709 $repo = $this->mPage->getFile()->getRepo()->getDisplayName();
710
711 if ( $descUrl &&
712 $descText &&
713 $this->getContext()->msg( 'sharedupload-desc-here' )->plain() !== '-'
714 ) {
715 $out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-here', $repo, $descUrl ] );
716 } elseif ( $descUrl &&
717 $this->getContext()->msg( 'sharedupload-desc-there' )->plain() !== '-'
718 ) {
719 $out->wrapWikiMsg( $wrap, [ 'sharedupload-desc-there', $repo, $descUrl ] );
720 } else {
721 $out->wrapWikiMsg( $wrap, [ 'sharedupload', $repo ], ''/*BACKCOMPAT*/ );
722 }
723
724 if ( $descText ) {
725 $this->mExtraDescription = $descText;
726 }
727 }
728
729 public function getUploadUrl() {
730 $this->loadFile();
731 $uploadTitle = SpecialPage::getTitleFor( 'Upload' );
732 return $uploadTitle->getFullURL( [
733 'wpDestFile' => $this->mPage->getFile()->getName(),
734 'wpForReUpload' => 1
735 ] );
736 }
737
738 /**
739 * Add the re-upload link (or message about not being able to re-upload) to the output.
740 */
741 protected function uploadLinksBox() {
742 if ( !$this->getContext()->getConfig()->get( 'EnableUploads' ) ) {
743 return;
744 }
745
746 $this->loadFile();
747 if ( !$this->mPage->getFile()->isLocal() ) {
748 return;
749 }
750
751 $canUpload = MediaWikiServices::getInstance()->getPermissionManager()
752 ->quickUserCan( 'upload', $this->getContext()->getUser(), $this->getTitle() );
753 if ( $canUpload && UploadBase::userCanReUpload(
754 $this->getContext()->getUser(),
755 $this->mPage->getFile() )
756 ) {
757 // "Upload a new version of this file" link
758 $ulink = Linker::makeExternalLink(
759 $this->getUploadUrl(),
760 $this->getContext()->msg( 'uploadnewversion-linktext' )->text()
761 );
762 $attrs = [ 'class' => 'plainlinks', 'id' => 'mw-imagepage-reupload-link' ];
763 $linkPara = Html::rawElement( 'p', $attrs, $ulink );
764 } else {
765 // "You cannot overwrite this file." message
766 $attrs = [ 'id' => 'mw-imagepage-upload-disallowed' ];
767 $msg = $this->getContext()->msg( 'upload-disallowed-here' )->text();
768 $linkPara = Html::element( 'p', $attrs, $msg );
769 }
770
771 $uploadLinks = Html::rawElement( 'div', [ 'class' => 'mw-imagepage-upload-links' ], $linkPara );
772 $this->getContext()->getOutput()->addHTML( $uploadLinks );
773 }
774
775 /**
776 * For overloading
777 */
778 protected function closeShowImage() {
779 }
780
781 /**
782 * If the page we've just displayed is in the "Image" namespace,
783 * we follow it with an upload history of the image and its usage.
784 */
785 protected function imageHistory() {
786 $this->loadFile();
787 $out = $this->getContext()->getOutput();
788 $pager = new ImageHistoryPseudoPager( $this );
789 $out->addHTML( $pager->getBody() );
790 $out->preventClickjacking( $pager->getPreventClickjacking() );
791
792 $this->mPage->getFile()->resetHistory(); // free db resources
793
794 # Exist check because we don't want to show this on pages where an image
795 # doesn't exist along with the noimage message, that would suck. -ævar
796 if ( $this->mPage->getFile()->exists() ) {
797 $this->uploadLinksBox();
798 }
799 }
800
801 /**
802 * @param string|string[] $target
803 * @param int $limit
804 * @return ResultWrapper
805 */
806 protected function queryImageLinks( $target, $limit ) {
807 $dbr = wfGetDB( DB_REPLICA );
808
809 return $dbr->select(
810 [ 'imagelinks', 'page' ],
811 [ 'page_namespace', 'page_title', 'il_to' ],
812 [ 'il_to' => $target, 'il_from = page_id' ],
813 __METHOD__,
814 [ 'LIMIT' => $limit + 1, 'ORDER BY' => 'il_from', ]
815 );
816 }
817
818 protected function imageLinks() {
819 $limit = 100;
820
821 $out = $this->getContext()->getOutput();
822
823 $rows = [];
824 $redirects = [];
825 foreach ( $this->getTitle()->getRedirectsHere( NS_FILE ) as $redir ) {
826 $redirects[$redir->getDBkey()] = [];
827 $rows[] = (object)[
828 'page_namespace' => NS_FILE,
829 'page_title' => $redir->getDBkey(),
830 ];
831 }
832
833 $res = $this->queryImageLinks( $this->getTitle()->getDBkey(), $limit + 1 );
834 foreach ( $res as $row ) {
835 $rows[] = $row;
836 }
837 $count = count( $rows );
838
839 $hasMore = $count > $limit;
840 if ( !$hasMore && count( $redirects ) ) {
841 $res = $this->queryImageLinks( array_keys( $redirects ),
842 $limit - count( $rows ) + 1 );
843 foreach ( $res as $row ) {
844 $redirects[$row->il_to][] = $row;
845 $count++;
846 }
847 $hasMore = ( $res->numRows() + count( $rows ) ) > $limit;
848 }
849
850 if ( $count == 0 ) {
851 $out->wrapWikiMsg(
852 Html::rawElement( 'div',
853 [ 'id' => 'mw-imagepage-nolinkstoimage' ], "\n$1\n" ),
854 'nolinkstoimage'
855 );
856 return;
857 }
858
859 $out->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
860 if ( !$hasMore ) {
861 $out->addWikiMsg( 'linkstoimage', $count );
862 } else {
863 // More links than the limit. Add a link to [[Special:Whatlinkshere]]
864 $out->addWikiMsg( 'linkstoimage-more',
865 $this->getContext()->getLanguage()->formatNum( $limit ),
866 $this->getTitle()->getPrefixedDBkey()
867 );
868 }
869
870 $out->addHTML(
871 Html::openElement( 'ul',
872 [ 'class' => 'mw-imagepage-linkstoimage' ] ) . "\n"
873 );
874 $count = 0;
875
876 // Sort the list by namespace:title
877 usort( $rows, [ $this, 'compare' ] );
878
879 // Create links for every element
880 $currentCount = 0;
881 foreach ( $rows as $element ) {
882 $currentCount++;
883 if ( $currentCount > $limit ) {
884 break;
885 }
886
887 $query = [];
888 # Add a redirect=no to make redirect pages reachable
889 if ( isset( $redirects[$element->page_title] ) ) {
890 $query['redirect'] = 'no';
891 }
892 $link = Linker::linkKnown(
893 Title::makeTitle( $element->page_namespace, $element->page_title ),
894 null, [], $query
895 );
896 if ( !isset( $redirects[$element->page_title] ) ) {
897 # No redirects
898 $liContents = $link;
899 } elseif ( count( $redirects[$element->page_title] ) === 0 ) {
900 # Redirect without usages
901 $liContents = $this->getContext()->msg( 'linkstoimage-redirect' )
902 ->rawParams( $link, '' )
903 ->parse();
904 } else {
905 # Redirect with usages
906 $li = '';
907 foreach ( $redirects[$element->page_title] as $row ) {
908 $currentCount++;
909 if ( $currentCount > $limit ) {
910 break;
911 }
912
913 $link2 = Linker::linkKnown( Title::makeTitle( $row->page_namespace, $row->page_title ) );
914 $li .= Html::rawElement(
915 'li',
916 [ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace ],
917 $link2
918 ) . "\n";
919 }
920
921 $ul = Html::rawElement(
922 'ul',
923 [ 'class' => 'mw-imagepage-redirectstofile' ],
924 $li
925 ) . "\n";
926 $liContents = $this->getContext()->msg( 'linkstoimage-redirect' )->rawParams(
927 $link, $ul )->parse();
928 }
929 $out->addHTML( Html::rawElement(
930 'li',
931 [ 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace ],
932 $liContents
933 ) . "\n"
934 );
935
936 }
937 $out->addHTML( Html::closeElement( 'ul' ) . "\n" );
938 $res->free();
939
940 // Add a links to [[Special:Whatlinkshere]]
941 if ( $count > $limit ) {
942 $out->addWikiMsg( 'morelinkstoimage', $this->getTitle()->getPrefixedDBkey() );
943 }
944 $out->addHTML( Html::closeElement( 'div' ) . "\n" );
945 }
946
947 protected function imageDupes() {
948 $this->loadFile();
949 $out = $this->getContext()->getOutput();
950
951 $dupes = $this->mPage->getDuplicates();
952 if ( count( $dupes ) == 0 ) {
953 return;
954 }
955
956 $out->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
957 $out->addWikiMsg( 'duplicatesoffile',
958 $this->getContext()->getLanguage()->formatNum( count( $dupes ) ), $this->getTitle()->getDBkey()
959 );
960 $out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
961
962 /**
963 * @var File $file
964 */
965 foreach ( $dupes as $file ) {
966 $fromSrc = '';
967 if ( $file->isLocal() ) {
968 $link = Linker::linkKnown( $file->getTitle() );
969 } else {
970 $link = Linker::makeExternalLink( $file->getDescriptionUrl(),
971 $file->getTitle()->getPrefixedText() );
972 $fromSrc = $this->getContext()->msg(
973 'shared-repo-from',
974 $file->getRepo()->getDisplayName()
975 )->escaped();
976 }
977 $out->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
978 }
979 $out->addHTML( "</ul></div>\n" );
980 }
981
982 /**
983 * Delete the file, or an earlier version of it
984 */
985 public function delete() {
986 $file = $this->mPage->getFile();
987 if ( !$file->exists() || !$file->isLocal() || $file->getRedirected() ) {
988 // Standard article deletion
989 parent::delete();
990 return;
991 }
992
993 $deleter = new FileDeleteForm( $file );
994 $deleter->execute();
995 }
996
997 /**
998 * Display an error with a wikitext description
999 *
1000 * @param string $description
1001 */
1002 function showError( $description ) {
1003 $out = $this->getContext()->getOutput();
1004 $out->setPageTitle( $this->getContext()->msg( 'internalerror' ) );
1005 $out->setRobotPolicy( 'noindex,nofollow' );
1006 $out->setArticleRelated( false );
1007 $out->enableClientCache( false );
1008 $out->addWikiTextAsInterface( $description );
1009 }
1010
1011 /**
1012 * Callback for usort() to do link sorts by (namespace, title)
1013 * Function copied from Title::compare()
1014 *
1015 * @param object $a Object page to compare with
1016 * @param object $b Object page to compare with
1017 * @return int Result of string comparison, or namespace comparison
1018 */
1019 protected function compare( $a, $b ) {
1020 return $a->page_namespace <=> $b->page_namespace
1021 ?: strcmp( $a->page_title, $b->page_title );
1022 }
1023
1024 /**
1025 * Returns the corresponding $wgImageLimits entry for the selected user option
1026 *
1027 * @param User $user
1028 * @param string $optionName Name of a option to check, typically imagesize or thumbsize
1029 * @return int[]
1030 * @since 1.21
1031 */
1032 public function getImageLimitsFromOption( $user, $optionName ) {
1033 global $wgImageLimits;
1034
1035 $option = $user->getIntOption( $optionName );
1036 if ( !isset( $wgImageLimits[$option] ) ) {
1037 $option = User::getDefaultOption( $optionName );
1038 }
1039
1040 // The user offset might still be incorrect, specially if
1041 // $wgImageLimits got changed (see T10858).
1042 if ( !isset( $wgImageLimits[$option] ) ) {
1043 // Default to the first offset in $wgImageLimits
1044 $option = 0;
1045 }
1046
1047 // if nothing is set, fallback to a hardcoded default
1048 return $wgImageLimits[$option] ?? [ 800, 600 ];
1049 }
1050
1051 /**
1052 * Output a drop-down box for language options for the file
1053 *
1054 * @param array $langChoices Array of string language codes
1055 * @param string $renderLang Language code for the language we want the file to rendered in.
1056 * @return string HTML to insert underneath image.
1057 */
1058 protected function doRenderLangOpt( array $langChoices, $renderLang ) {
1059 global $wgScript;
1060 $opts = '';
1061
1062 $matchedRenderLang = $this->displayImg->getMatchedLanguage( $renderLang );
1063
1064 foreach ( $langChoices as $lang ) {
1065 $opts .= $this->createXmlOptionStringForLanguage(
1066 $lang,
1067 $matchedRenderLang === $lang
1068 );
1069 }
1070
1071 // Allow for the default case in an svg <switch> that is displayed if no
1072 // systemLanguage attribute matches
1073 $opts .= "\n" .
1074 Xml::option(
1075 $this->getContext()->msg( 'img-lang-default' )->text(),
1076 'und',
1077 is_null( $matchedRenderLang )
1078 );
1079
1080 $select = Html::rawElement(
1081 'select',
1082 [ 'id' => 'mw-imglangselector', 'name' => 'lang' ],
1083 $opts
1084 );
1085 $submit = Xml::submitButton( $this->getContext()->msg( 'img-lang-go' )->text() );
1086
1087 $formContents = $this->getContext()->msg( 'img-lang-info' )
1088 ->rawParams( $select, $submit )
1089 ->parse();
1090 $formContents .= Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() );
1091
1092 $langSelectLine = Html::rawElement( 'div', [ 'id' => 'mw-imglangselector-line' ],
1093 Html::rawElement( 'form', [ 'action' => $wgScript ], $formContents )
1094 );
1095 return $langSelectLine;
1096 }
1097
1098 /**
1099 * @param string $lang
1100 * @param bool $selected
1101 * @return string
1102 */
1103 private function createXmlOptionStringForLanguage( $lang, $selected ) {
1104 $code = LanguageCode::bcp47( $lang );
1105 $name = Language::fetchLanguageName( $code, $this->getContext()->getLanguage()->getCode() );
1106 if ( $name !== '' ) {
1107 $display = $this->getContext()->msg( 'img-lang-opt', $code, $name )->text();
1108 } else {
1109 $display = $code;
1110 }
1111 return "\n" .
1112 Xml::option(
1113 $display,
1114 $lang,
1115 $selected
1116 );
1117 }
1118
1119 /**
1120 * Get the width and height to display image at.
1121 *
1122 * @note This method assumes that it is only called if one
1123 * of the dimensions are bigger than the max, or if the
1124 * image is vectorized.
1125 *
1126 * @param int $maxWidth Max width to display at
1127 * @param int $maxHeight Max height to display at
1128 * @param int $width Actual width of the image
1129 * @param int $height Actual height of the image
1130 * @throws MWException
1131 * @return array Array (width, height)
1132 */
1133 protected function getDisplayWidthHeight( $maxWidth, $maxHeight, $width, $height ) {
1134 if ( !$maxWidth || !$maxHeight ) {
1135 // should never happen
1136 throw new MWException( 'Using a choice from $wgImageLimits that is 0x0' );
1137 }
1138
1139 if ( !$width || !$height ) {
1140 return [ 0, 0 ];
1141 }
1142
1143 # Calculate the thumbnail size.
1144 if ( $width <= $maxWidth && $height <= $maxHeight ) {
1145 // Vectorized image, do nothing.
1146 } elseif ( $width / $height >= $maxWidth / $maxHeight ) {
1147 # The limiting factor is the width, not the height.
1148 $height = round( $height * $maxWidth / $width );
1149 $width = $maxWidth;
1150 # Note that $height <= $maxHeight now.
1151 } else {
1152 $newwidth = floor( $width * $maxHeight / $height );
1153 $height = round( $height * $newwidth / $width );
1154 $width = $newwidth;
1155 # Note that $height <= $maxHeight now, but might not be identical
1156 # because of rounding.
1157 }
1158 return [ $width, $height ];
1159 }
1160
1161 /**
1162 * Get alternative thumbnail sizes.
1163 *
1164 * @note This will only list several alternatives if thumbnails are rendered on 404
1165 * @param int $origWidth Actual width of image
1166 * @param int $origHeight Actual height of image
1167 * @return array An array of [width, height] pairs.
1168 */
1169 protected function getThumbSizes( $origWidth, $origHeight ) {
1170 global $wgImageLimits;
1171 if ( $this->displayImg->getRepo()->canTransformVia404() ) {
1172 $thumbSizes = $wgImageLimits;
1173 // Also include the full sized resolution in the list, so
1174 // that users know they can get it. This will link to the
1175 // original file asset if mustRender() === false. In the case
1176 // that we mustRender, some users have indicated that they would
1177 // find it useful to have the full size image in the rendered
1178 // image format.
1179 $thumbSizes[] = [ $origWidth, $origHeight ];
1180 } else {
1181 # Creating thumb links triggers thumbnail generation.
1182 # Just generate the thumb for the current users prefs.
1183 $thumbSizes = [
1184 $this->getImageLimitsFromOption( $this->getContext()->getUser(), 'thumbsize' )
1185 ];
1186 if ( !$this->displayImg->mustRender() ) {
1187 // We can safely include a link to the "full-size" preview,
1188 // without actually rendering.
1189 $thumbSizes[] = [ $origWidth, $origHeight ];
1190 }
1191 }
1192 return $thumbSizes;
1193 }
1194
1195 /**
1196 * @see WikiFilePage::getFile
1197 * @return bool|File
1198 */
1199 public function getFile() {
1200 return $this->mPage->getFile();
1201 }
1202
1203 /**
1204 * @see WikiFilePage::isLocal
1205 * @return bool
1206 */
1207 public function isLocal() {
1208 return $this->mPage->isLocal();
1209 }
1210
1211 /**
1212 * @see WikiFilePage::getDuplicates
1213 * @return array|null
1214 */
1215 public function getDuplicates() {
1216 return $this->mPage->getDuplicates();
1217 }
1218
1219 /**
1220 * @see WikiFilePage::getForeignCategories
1221 * @return TitleArray|Title[]
1222 */
1223 public function getForeignCategories() {
1224 return $this->mPage->getForeignCategories();
1225 }
1226
1227 }