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
24 * Class for viewing MediaWiki file description pages
28 class ImagePage
extends Article
{
39 protected $mExtraDescription = false;
43 * @return WikiFilePage
45 protected function newPage( Title
$title ) {
46 // Overload mPage with a file-specific page
47 return new WikiFilePage( $title );
51 * Constructor from a page id
52 * @param int $id Article ID to load
53 * @return ImagePage|null
55 public static function newFromID( $id ) {
56 $t = Title
::newFromID( $id );
57 # @todo FIXME: Doesn't inherit right
58 return $t == null ?
null : new self( $t );
59 # return $t == null ? null : new static( $t ); // PHP 5.3
66 public function setFile( $file ) {
67 $this->mPage
->setFile( $file );
68 $this->displayImg
= $file;
69 $this->fileLoaded
= true;
72 protected function loadFile() {
73 if ( $this->fileLoaded
) {
76 $this->fileLoaded
= true;
78 $this->displayImg
= $img = false;
79 wfRunHooks( 'ImagePageFindFile', array( $this, &$img, &$this->displayImg
) );
80 if ( !$img ) { // not set by hook?
81 $img = wfFindFile( $this->getTitle() );
83 $img = wfLocalFile( $this->getTitle() );
86 $this->mPage
->setFile( $img );
87 if ( !$this->displayImg
) { // not set by hook?
88 $this->displayImg
= $img;
90 $this->repo
= $img->getRepo();
94 * Handler for action=render
95 * Include body text only; none of the image extras
97 public function render() {
98 $this->getContext()->getOutput()->setArticleBodyOnly( true );
102 public function view() {
105 $out = $this->getContext()->getOutput();
106 $request = $this->getContext()->getRequest();
107 $diff = $request->getVal( 'diff' );
108 $diffOnly = $request->getBool(
110 $this->getContext()->getUser()->getOption( 'diffonly' )
113 if ( $this->getTitle()->getNamespace() != NS_FILE ||
( $diff !== null && $diffOnly ) ) {
120 if ( $this->getTitle()->getNamespace() == NS_FILE
&& $this->mPage
->getFile()->getRedirected() ) {
121 if ( $this->getTitle()->getDBkey() == $this->mPage
->getFile()->getName() ||
$diff !== null ) {
122 // mTitle is the same as the redirect target so ask Article
123 // to perform the redirect for us.
124 $request->setVal( 'diffonly', 'true' );
128 // mTitle is not the same as the redirect target so it is
129 // probably the redirect page itself. Fake the redirect symbol
130 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
131 $out->addHTML( $this->viewRedirect(
132 Title
::makeTitle( NS_FILE
, $this->mPage
->getFile()->getName() ),
133 /* $appendSubtitle */ true,
134 /* $forceKnown */ true )
136 $this->mPage
->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
141 if ( $wgShowEXIF && $this->displayImg
->exists() ) {
142 // @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
143 $formattedMetadata = $this->displayImg
->formatMetadata();
144 $showmeta = $formattedMetadata !== false;
149 if ( !$diff && $this->displayImg
->exists() ) {
150 $out->addHTML( $this->showTOC( $showmeta ) );
154 $this->openShowImage();
157 # No need to display noarticletext, we use our own message, output in openShowImage()
158 if ( $this->mPage
->getID() ) {
159 # NS_FILE is in the user language, but this section (the actual wikitext)
160 # should be in page content language
161 $pageLang = $this->getTitle()->getPageViewLanguage();
162 $out->addHTML( Xml
::openElement( 'div', array( 'id' => 'mw-imagepage-content',
163 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
164 'class' => 'mw-content-' . $pageLang->getDir() ) ) );
168 $out->addHTML( Xml
::closeElement( 'div' ) );
170 # Just need to set the right headers
171 $out->setArticleFlag( true );
172 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
173 $this->mPage
->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
176 # Show shared description, if needed
177 if ( $this->mExtraDescription
) {
178 $fol = wfMessage( 'shareddescriptionfollows' );
179 if ( !$fol->isDisabled() ) {
180 $out->addWikiText( $fol->plain() );
182 $out->addHTML( '<div id="shared-image-desc">' . $this->mExtraDescription
. "</div>\n" );
185 $this->closeShowImage();
186 $this->imageHistory();
187 // TODO: Cleanup the following
189 $out->addHTML( Xml
::element( 'h2',
190 array( 'id' => 'filelinks' ),
191 wfMessage( 'imagelinks' )->text() ) . "\n" );
193 # @todo FIXME: For some freaky reason, we can't redirect to foreign images.
194 # Yet we return metadata about the target. Definitely an issue in the FileRepo
197 # Allow extensions to add something after the image links
199 wfRunHooks( 'ImagePageAfterImageLinks', array( $this, &$html ) );
201 $out->addHTML( $html );
205 $out->addHTML( Xml
::element(
207 array( 'id' => 'metadata' ),
208 wfMessage( 'metadata' )->text() ) . "\n" );
209 $out->addWikiText( $this->makeMetadataTable( $formattedMetadata ) );
210 $out->addModules( array( 'mediawiki.action.view.metadata' ) );
213 // Add remote Filepage.css
214 if ( !$this->repo
->isLocal() ) {
215 $css = $this->repo
->getDescriptionStylesheetUrl();
217 $out->addStyle( $css );
220 // always show the local local Filepage.css, bug 29277
221 $out->addModuleStyles( 'filepage' );
227 public function getDisplayedFile() {
229 return $this->displayImg
;
235 * @param bool $metadata Whether or not to show the metadata link
238 protected function showTOC( $metadata ) {
240 '<li><a href="#file">' . wfMessage( 'file-anchor-link' )->escaped() . '</a></li>',
241 '<li><a href="#filehistory">' . wfMessage( 'filehist' )->escaped() . '</a></li>',
242 '<li><a href="#filelinks">' . wfMessage( 'imagelinks' )->escaped() . '</a></li>',
245 $r[] = '<li><a href="#metadata">' . wfMessage( 'metadata' )->escaped() . '</a></li>';
248 wfRunHooks( 'ImagePageShowTOC', array( $this, &$r ) );
250 return '<ul id="filetoc">' . implode( "\n", $r ) . '</ul>';
254 * Make a table with metadata to be shown in the output page.
256 * @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
258 * @param array $metadata The array containing the Exif data
259 * @return string The metadata table. This is treated as Wikitext (!)
261 protected function makeMetadataTable( $metadata ) {
262 $r = "<div class=\"mw-imagepage-section-metadata\">";
263 $r .= wfMessage( 'metadata-help' )->plain();
264 $r .= "<table id=\"mw_metadata\" class=\"mw_metadata\">\n";
265 foreach ( $metadata as $type => $stuff ) {
266 foreach ( $stuff as $v ) {
267 # @todo FIXME: Why is this using escapeId for a class?!
268 $class = Sanitizer
::escapeId( $v['id'] );
269 if ( $type == 'collapsed' ) {
270 // Handled by mediawiki.action.view.metadata module.
271 $class .= ' collapsable';
273 $r .= "<tr class=\"$class\">\n";
274 $r .= "<th>{$v['name']}</th>\n";
275 $r .= "<td>{$v['value']}</td>\n</tr>";
278 $r .= "</table>\n</div>\n";
283 * Overloading Article's getContentObject method.
285 * Omit noarticletext if sharedupload; text will be fetched from the
286 * shared upload server if possible.
289 public function getContentObject() {
291 if ( $this->mPage
->getFile() && !$this->mPage
->getFile()->isLocal() && 0 == $this->getID() ) {
294 return parent
::getContentObject();
297 protected function openShowImage() {
298 global $wgEnableUploads, $wgSend404Code;
301 $out = $this->getContext()->getOutput();
302 $user = $this->getContext()->getUser();
303 $lang = $this->getContext()->getLanguage();
304 $dirmark = $lang->getDirMarkEntity();
305 $request = $this->getContext()->getRequest();
307 $max = $this->getImageLimitsFromOption( $user, 'imagesize' );
309 $maxHeight = $max[1];
311 if ( $this->displayImg
->exists() ) {
313 $page = $request->getIntOrNull( 'page' );
314 if ( is_null( $page ) ) {
318 $params = array( 'page' => $page );
321 $renderLang = $request->getVal( 'lang' );
322 if ( !is_null( $renderLang ) ) {
323 $handler = $this->displayImg
->getHandler();
324 if ( $handler && $handler->validateParam( 'lang', $renderLang ) ) {
325 $params['lang'] = $renderLang;
331 $width_orig = $this->displayImg
->getWidth( $page );
332 $width = $width_orig;
333 $height_orig = $this->displayImg
->getHeight( $page );
334 $height = $height_orig;
336 $filename = wfEscapeWikiText( $this->displayImg
->getName() );
337 $linktext = $filename;
339 wfRunHooks( 'ImageOpenShowImageInlineBefore', array( &$this, &$out ) );
341 if ( $this->displayImg
->allowInlineDisplay() ) {
343 # "Download high res version" link below the image
344 # $msgsize = wfMessage( 'file-info-size', $width_orig, $height_orig,
345 # Linker::formatSize( $this->displayImg->getSize() ), $mime )->escaped();
346 # We'll show a thumbnail of this image
347 if ( $width > $maxWidth ||
$height > $maxHeight ||
$this->displayImg
->isVectorized() ) {
348 list( $width, $height ) = $this->getDisplayWidthHeight(
349 $maxWidth, $maxHeight, $width, $height
351 $linktext = wfMessage( 'show-big-image' )->escaped();
353 $thumbSizes = $this->getThumbSizes( $width, $height, $width_orig, $height_orig );
354 # Generate thumbnails or thumbnail links as needed...
355 $otherSizes = array();
356 foreach ( $thumbSizes as $size ) {
357 // We include a thumbnail size in the list, if it is
358 // less than or equal to the original size of the image
359 // asset ($width_orig/$height_orig). We also exclude
360 // the current thumbnail's size ($width/$height)
361 // since that is added to the message separately, so
362 // it can be denoted as the current size being shown.
363 // Vectorized images are "infinitely" big, so all thumb
365 if ( ( ( $size[0] <= $width_orig && $size[1] <= $height_orig )
366 ||
$this->displayImg
->isVectorized() )
367 && $size[0] != $width && $size[1] != $height
369 $sizeLink = $this->makeSizeLink( $params, $size[0], $size[1] );
371 $otherSizes[] = $sizeLink;
375 $otherSizes = array_unique( $otherSizes );
378 $sizeLinkBigImagePreview = $this->makeSizeLink( $params, $width, $height );
379 if ( $sizeLinkBigImagePreview ) {
380 $msgsmall .= wfMessage( 'show-big-image-preview' )->
381 rawParams( $sizeLinkBigImagePreview )->
384 if ( count( $otherSizes ) ) {
386 Html
::rawElement( 'span', array( 'class' => 'mw-filepage-other-resolutions' ),
387 wfMessage( 'show-big-image-other' )->rawParams( $lang->pipeList( $otherSizes ) )->
388 params( count( $otherSizes ) )->parse()
391 } elseif ( $width == 0 && $height == 0 ) {
392 # Some sort of audio file that doesn't have dimensions
393 # Don't output a no hi res message for such a file
396 # Image is small enough to show full size on image page
397 $msgsmall = wfMessage( 'file-nohires' )->parse();
400 $params['width'] = $width;
401 $params['height'] = $height;
402 $thumbnail = $this->displayImg
->transform( $params );
403 Linker
::processResponsiveImages( $this->displayImg
, $thumbnail, $params );
405 $anchorclose = Html
::rawElement(
407 array( 'class' => 'mw-filepage-resolutioninfo' ),
411 $isMulti = $this->displayImg
->isMultipage() && $this->displayImg
->pageCount() > 1;
413 $out->addModules( 'mediawiki.page.image.pagination' );
414 $out->addHTML( '<table class="multipageimage"><tr><td>' );
419 'alt' => $this->displayImg
->getTitle()->getPrefixedText(),
422 $out->addHTML( '<div class="fullImageLink" id="file">' .
423 $thumbnail->toHtml( $options ) .
424 $anchorclose . "</div>\n" );
428 $count = $this->displayImg
->pageCount();
431 $label = $out->parse( wfMessage( 'imgmultipageprev' )->text(), false );
432 // on the client side, this link is generated in ajaxifyPageNavigation()
433 // in the mediawiki.page.image.pagination module
434 $link = Linker
::linkKnown(
438 array( 'page' => $page - 1 )
440 $thumb1 = Linker
::makeThumbLinkObj(
446 array( 'page' => $page - 1 )
452 if ( $page < $count ) {
453 $label = wfMessage( 'imgmultipagenext' )->text();
454 $link = Linker
::linkKnown(
458 array( 'page' => $page +
1 )
460 $thumb2 = Linker
::makeThumbLinkObj(
466 array( 'page' => $page +
1 )
475 'name' => 'pageselector',
476 'action' => $wgScript,
479 for ( $i = 1; $i <= $count; $i++
) {
480 $options[] = Xml
::option( $lang->formatNum( $i ), $i, $i == $page );
482 $select = Xml
::tags( 'select',
483 array( 'id' => 'pageselector', 'name' => 'page' ),
484 implode( "\n", $options ) );
487 '</td><td><div class="multipageimagenavbox">' .
488 Xml
::openElement( 'form', $formParams ) .
489 Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
490 wfMessage( 'imgmultigoto' )->rawParams( $select )->parse() .
491 Xml
::submitButton( wfMessage( 'imgmultigo' )->text() ) .
492 Xml
::closeElement( 'form' ) .
493 "<hr />$thumb1\n$thumb2<br style=\"clear: both\" /></div></td></tr></table>"
496 } elseif ( $this->displayImg
->isSafeFile() ) {
497 # if direct link is allowed but it's not a renderable image, show an icon.
498 $icon = $this->displayImg
->iconThumb();
500 $out->addHTML( '<div class="fullImageLink" id="file">' .
501 $icon->toHtml( array( 'file-link' => true ) ) .
505 $longDesc = wfMessage( 'parentheses', $this->displayImg
->getLongDesc() )->text();
507 $medialink = "[[Media:$filename|$linktext]]";
509 if ( !$this->displayImg
->isSafeFile() ) {
510 $warning = wfMessage( 'mediawarning' )->plain();
511 // dirmark is needed here to separate the file name, which
512 // most likely ends in Latin characters, from the description,
513 // which may begin with the file type. In RTL environment
514 // this will get messy.
515 // The dirmark, however, must not be immediately adjacent
516 // to the filename, because it can get copied with it.
518 // @codingStandardsIgnoreStart Ignore long line
519 $out->addWikiText( <<<EOT
520 <div class="fullMedia"><span class="dangerousLink">{$medialink}</span> $dirmark<span class="fileInfo">$longDesc</span></div>
521 <div class="mediaWarning">$warning</div>
524 // @codingStandardsIgnoreEnd
526 $out->addWikiText( <<<EOT
527 <div class="fullMedia">{$medialink} {$dirmark}<span class="fileInfo">$longDesc</span>
533 $renderLangOptions = $this->displayImg
->getAvailableLanguages();
534 if ( count( $renderLangOptions ) >= 1 ) {
535 $currentLanguage = $renderLang;
536 $defaultLang = $this->displayImg
->getDefaultRenderLanguage();
537 if ( is_null( $currentLanguage ) ) {
538 $currentLanguage = $defaultLang;
540 $out->addHtml( $this->doRenderLangOpt( $renderLangOptions, $currentLanguage, $defaultLang ) );
543 // Add cannot animate thumbnail warning
544 if ( !$this->displayImg
->canAnimateThumbIfAppropriate() ) {
545 // Include the extension so wiki admins can
546 // customize it on a per file-type basis
547 // (aka say things like use format X instead).
548 // additionally have a specific message for
549 // file-no-thumb-animation-gif
550 $ext = $this->displayImg
->getExtension();
551 $noAnimMesg = wfMessageFallback(
552 'file-no-thumb-animation-' . $ext,
553 'file-no-thumb-animation'
556 $out->addWikiText( <<<EOT
557 <div class="mw-noanimatethumb">{$noAnimMesg}</div>
562 if ( !$this->displayImg
->isLocal() ) {
563 $this->printSharedImageText();
566 # Image does not exist
567 if ( !$this->getID() ) {
568 # No article exists either
569 # Show deletion log to be consistent with normal articles
570 LogEventsList
::showLogExtract(
572 array( 'delete', 'move' ),
573 $this->getTitle()->getPrefixedText(),
576 'conds' => array( "log_action != 'revision'" ),
577 'showIfEmpty' => false,
578 'msgKey' => array( 'moveddeleted-notice' )
583 if ( $wgEnableUploads && $user->isAllowed( 'upload' ) ) {
584 // Only show an upload link if the user can upload
585 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
587 'filepage-nofile-link',
588 $uploadTitle->getFullURL( array( 'wpDestFile' => $this->mPage
->getFile()->getName() ) )
591 $nofile = 'filepage-nofile';
593 // Note, if there is an image description page, but
594 // no image, then this setRobotPolicy is overridden
595 // by Article::View().
596 $out->setRobotPolicy( 'noindex,nofollow' );
597 $out->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
598 if ( !$this->getID() && $wgSend404Code ) {
599 // If there is no image, no shared image, and no description page,
600 // output a 404, to be consistent with articles.
601 $request->response()->header( 'HTTP/1.1 404 Not Found' );
604 $out->setFileVersion( $this->displayImg
);
608 * Creates an thumbnail of specified size and returns an HTML link to it
609 * @param array $params Scaler parameters
614 private function makeSizeLink( $params, $width, $height ) {
615 $params['width'] = $width;
616 $params['height'] = $height;
617 $thumbnail = $this->displayImg
->transform( $params );
618 if ( $thumbnail && !$thumbnail->isError() ) {
619 return Html
::rawElement( 'a', array(
620 'href' => $thumbnail->getUrl(),
621 'class' => 'mw-thumbnail-link'
622 ), wfMessage( 'show-big-image-size' )->numParams(
623 $thumbnail->getWidth(), $thumbnail->getHeight()
631 * Show a notice that the file is from a shared repository
633 protected function printSharedImageText() {
634 $out = $this->getContext()->getOutput();
637 $descUrl = $this->mPage
->getFile()->getDescriptionUrl();
638 $descText = $this->mPage
->getFile()->getDescriptionText( $this->getContext()->getLanguage() );
640 /* Add canonical to head if there is no local page for this shared file */
641 if ( $descUrl && $this->mPage
->getID() == 0 ) {
642 $out->setCanonicalUrl( $descUrl );
645 $wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
646 $repo = $this->mPage
->getFile()->getRepo()->getDisplayName();
648 if ( $descUrl && $descText && wfMessage( 'sharedupload-desc-here' )->plain() !== '-' ) {
649 $out->wrapWikiMsg( $wrap, array( 'sharedupload-desc-here', $repo, $descUrl ) );
650 } elseif ( $descUrl && wfMessage( 'sharedupload-desc-there' )->plain() !== '-' ) {
651 $out->wrapWikiMsg( $wrap, array( 'sharedupload-desc-there', $repo, $descUrl ) );
653 $out->wrapWikiMsg( $wrap, array( 'sharedupload', $repo ), ''/*BACKCOMPAT*/ );
657 $this->mExtraDescription
= $descText;
661 public function getUploadUrl() {
663 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
664 return $uploadTitle->getFullURL( array(
665 'wpDestFile' => $this->mPage
->getFile()->getName(),
671 * Print out the various links at the bottom of the image page, e.g. reupload,
672 * external editing (and instructions link) etc.
674 protected function uploadLinksBox() {
675 global $wgEnableUploads;
677 if ( !$wgEnableUploads ) {
682 if ( !$this->mPage
->getFile()->isLocal() ) {
686 $out = $this->getContext()->getOutput();
687 $out->addHTML( "<ul>\n" );
689 # "Upload a new version of this file" link
690 $canUpload = $this->getTitle()->userCan( 'upload', $this->getContext()->getUser() );
691 if ( $canUpload && UploadBase
::userCanReUpload(
692 $this->getContext()->getUser(),
693 $this->mPage
->getFile()->name
)
695 $ulink = Linker
::makeExternalLink(
696 $this->getUploadUrl(),
697 wfMessage( 'uploadnewversion-linktext' )->text()
699 $out->addHTML( "<li id=\"mw-imagepage-reupload-link\">"
700 . "<div class=\"plainlinks\">{$ulink}</div></li>\n" );
702 $out->addHTML( "<li id=\"mw-imagepage-upload-disallowed\">"
703 . $this->getContext()->msg( 'upload-disallowed-here' )->escaped() . "</li>\n" );
706 $out->addHTML( "</ul>\n" );
712 protected function closeShowImage() {
716 * If the page we've just displayed is in the "Image" namespace,
717 * we follow it with an upload history of the image and its usage.
719 protected function imageHistory() {
721 $out = $this->getContext()->getOutput();
722 $pager = new ImageHistoryPseudoPager( $this );
723 $out->addHTML( $pager->getBody() );
724 $out->preventClickjacking( $pager->getPreventClickjacking() );
726 $this->mPage
->getFile()->resetHistory(); // free db resources
728 # Exist check because we don't want to show this on pages where an image
729 # doesn't exist along with the noimage message, that would suck. -ævar
730 if ( $this->mPage
->getFile()->exists() ) {
731 $this->uploadLinksBox();
736 * @param string $target
738 * @return ResultWrapper
740 protected function queryImageLinks( $target, $limit ) {
741 $dbr = wfGetDB( DB_SLAVE
);
744 array( 'imagelinks', 'page' ),
745 array( 'page_namespace', 'page_title', 'il_to' ),
746 array( 'il_to' => $target, 'il_from = page_id' ),
748 array( 'LIMIT' => $limit +
1, 'ORDER BY' => 'il_from', )
752 protected function imageLinks() {
755 $out = $this->getContext()->getOutput();
758 $redirects = array();
759 foreach ( $this->getTitle()->getRedirectsHere( NS_FILE
) as $redir ) {
760 $redirects[$redir->getDBkey()] = array();
761 $rows[] = (object)array(
762 'page_namespace' => NS_FILE
,
763 'page_title' => $redir->getDBkey(),
767 $res = $this->queryImageLinks( $this->getTitle()->getDBkey(), $limit +
1 );
768 foreach ( $res as $row ) {
771 $count = count( $rows );
773 $hasMore = $count > $limit;
774 if ( !$hasMore && count( $redirects ) ) {
775 $res = $this->queryImageLinks( array_keys( $redirects ),
776 $limit - count( $rows ) +
1 );
777 foreach ( $res as $row ) {
778 $redirects[$row->il_to
][] = $row;
781 $hasMore = ( $res->numRows() +
count( $rows ) ) > $limit;
786 Html
::rawElement( 'div',
787 array( 'id' => 'mw-imagepage-nolinkstoimage' ), "\n$1\n" ),
793 $out->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
795 $out->addWikiMsg( 'linkstoimage', $count );
797 // More links than the limit. Add a link to [[Special:Whatlinkshere]]
798 $out->addWikiMsg( 'linkstoimage-more',
799 $this->getContext()->getLanguage()->formatNum( $limit ),
800 $this->getTitle()->getPrefixedDBkey()
805 Html
::openElement( 'ul',
806 array( 'class' => 'mw-imagepage-linkstoimage' ) ) . "\n"
810 // Sort the list by namespace:title
811 usort( $rows, array( $this, 'compare' ) );
813 // Create links for every element
815 foreach ( $rows as $element ) {
817 if ( $currentCount > $limit ) {
822 # Add a redirect=no to make redirect pages reachable
823 if ( isset( $redirects[$element->page_title
] ) ) {
824 $query['redirect'] = 'no';
826 $link = Linker
::linkKnown(
827 Title
::makeTitle( $element->page_namespace
, $element->page_title
),
828 null, array(), $query
830 if ( !isset( $redirects[$element->page_title
] ) ) {
833 } elseif ( count( $redirects[$element->page_title
] ) === 0 ) {
834 # Redirect without usages
835 $liContents = wfMessage( 'linkstoimage-redirect' )->rawParams( $link, '' )->parse();
837 # Redirect with usages
839 foreach ( $redirects[$element->page_title
] as $row ) {
841 if ( $currentCount > $limit ) {
845 $link2 = Linker
::linkKnown( Title
::makeTitle( $row->page_namespace
, $row->page_title
) );
846 $li .= Html
::rawElement(
848 array( 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
),
853 $ul = Html
::rawElement(
855 array( 'class' => 'mw-imagepage-redirectstofile' ),
858 $liContents = wfMessage( 'linkstoimage-redirect' )->rawParams(
859 $link, $ul )->parse();
861 $out->addHTML( Html
::rawElement(
863 array( 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
),
869 $out->addHTML( Html
::closeElement( 'ul' ) . "\n" );
872 // Add a links to [[Special:Whatlinkshere]]
873 if ( $count > $limit ) {
874 $out->addWikiMsg( 'morelinkstoimage', $this->getTitle()->getPrefixedDBkey() );
876 $out->addHTML( Html
::closeElement( 'div' ) . "\n" );
879 protected function imageDupes() {
881 $out = $this->getContext()->getOutput();
883 $dupes = $this->mPage
->getDuplicates();
884 if ( count( $dupes ) == 0 ) {
888 $out->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
889 $out->addWikiMsg( 'duplicatesoffile',
890 $this->getContext()->getLanguage()->formatNum( count( $dupes ) ), $this->getTitle()->getDBkey()
892 $out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
897 foreach ( $dupes as $file ) {
899 if ( $file->isLocal() ) {
900 $link = Linker
::linkKnown( $file->getTitle() );
902 $link = Linker
::makeExternalLink( $file->getDescriptionUrl(),
903 $file->getTitle()->getPrefixedText() );
904 $fromSrc = wfMessage( 'shared-repo-from', $file->getRepo()->getDisplayName() )->text();
906 $out->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
908 $out->addHTML( "</ul></div>\n" );
912 * Delete the file, or an earlier version of it
914 public function delete() {
915 $file = $this->mPage
->getFile();
916 if ( !$file->exists() ||
!$file->isLocal() ||
$file->getRedirected() ) {
917 // Standard article deletion
922 $deleter = new FileDeleteForm( $file );
927 * Display an error with a wikitext description
929 * @param string $description
931 function showError( $description ) {
932 $out = $this->getContext()->getOutput();
933 $out->setPageTitle( wfMessage( 'internalerror' ) );
934 $out->setRobotPolicy( 'noindex,nofollow' );
935 $out->setArticleRelated( false );
936 $out->enableClientCache( false );
937 $out->addWikiText( $description );
941 * Callback for usort() to do link sorts by (namespace, title)
942 * Function copied from Title::compare()
944 * @param object $a Object page to compare with
945 * @param object $b Object page to compare with
946 * @return int Result of string comparison, or namespace comparison
948 protected function compare( $a, $b ) {
949 if ( $a->page_namespace
== $b->page_namespace
) {
950 return strcmp( $a->page_title
, $b->page_title
);
952 return $a->page_namespace
- $b->page_namespace
;
957 * Returns the corresponding $wgImageLimits entry for the selected user option
960 * @param string $optionName Name of a option to check, typically imagesize or thumbsize
964 public function getImageLimitsFromOption( $user, $optionName ) {
965 global $wgImageLimits;
967 $option = $user->getIntOption( $optionName );
968 if ( !isset( $wgImageLimits[$option] ) ) {
969 $option = User
::getDefaultOption( $optionName );
972 // The user offset might still be incorrect, specially if
973 // $wgImageLimits got changed (see bug #8858).
974 if ( !isset( $wgImageLimits[$option] ) ) {
975 // Default to the first offset in $wgImageLimits
979 return isset( $wgImageLimits[$option] )
980 ?
$wgImageLimits[$option]
981 : array( 800, 600 ); // if nothing is set, fallback to a hardcoded default
985 * Output a drop-down box for language options for the file
987 * @param array $langChoices Array of string language codes
988 * @param string $curLang Language code file is being viewed in.
989 * @param string $defaultLang Language code that image is rendered in by default
990 * @return string HTML to insert underneath image.
992 protected function doRenderLangOpt( array $langChoices, $curLang, $defaultLang ) {
994 sort( $langChoices );
995 $curLang = wfBCP47( $curLang );
996 $defaultLang = wfBCP47( $defaultLang );
998 $haveCurrentLang = false;
999 $haveDefaultLang = false;
1001 // We make a list of all the language choices in the file.
1002 // Additionally if the default language to render this file
1003 // is not included as being in this file (for example, in svgs
1004 // usually the fallback content is the english content) also
1005 // include a choice for that. Last of all, if we're viewing
1006 // the file in a language not on the list, add it as a choice.
1007 foreach ( $langChoices as $lang ) {
1008 $code = wfBCP47( $lang );
1009 $name = Language
::fetchLanguageName( $code, $this->getContext()->getLanguage()->getCode() );
1010 if ( $name !== '' ) {
1011 $display = wfMessage( 'img-lang-opt', $code, $name )->text();
1015 $opts .= "\n" . Xml
::option( $display, $code, $curLang === $code );
1016 if ( $curLang === $code ) {
1017 $haveCurrentLang = true;
1019 if ( $defaultLang === $code ) {
1020 $haveDefaultLang = true;
1023 if ( !$haveDefaultLang ) {
1024 // Its hard to know if the content is really in the default language, or
1025 // if its just unmarked content that could be in any language.
1026 $opts = Xml
::option(
1027 wfMessage( 'img-lang-default' )->text(),
1029 $defaultLang === $curLang
1032 if ( !$haveCurrentLang && $defaultLang !== $curLang ) {
1033 $name = Language
::fetchLanguageName( $curLang, $this->getContext()->getLanguage()->getCode() );
1034 if ( $name !== '' ) {
1035 $display = wfMessage( 'img-lang-opt', $curLang, $name )->text();
1037 $display = $curLang;
1039 $opts = Xml
::option( $display, $curLang, true ) . $opts;
1042 $select = Html
::rawElement(
1044 array( 'id' => 'mw-imglangselector', 'name' => 'lang' ),
1047 $submit = Xml
::submitButton( wfMessage( 'img-lang-go' )->text() );
1049 $formContents = wfMessage( 'img-lang-info' )->rawParams( $select, $submit )->parse()
1050 . Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() );
1052 $langSelectLine = Html
::rawElement( 'div', array( 'id' => 'mw-imglangselector-line' ),
1053 Html
::rawElement( 'form', array( 'action' => $wgScript ), $formContents )
1055 return $langSelectLine;
1059 * Get the width and height to display image at.
1061 * @note This method assumes that it is only called if one
1062 * of the dimensions are bigger than the max, or if the
1063 * image is vectorized.
1065 * @param int $maxWidth Max width to display at
1066 * @param int $maxHeight Max height to display at
1067 * @param int $width Actual width of the image
1068 * @param int $height Actual height of the image
1069 * @throws MWException
1070 * @return array Array (width, height)
1072 protected function getDisplayWidthHeight( $maxWidth, $maxHeight, $width, $height ) {
1073 if ( !$maxWidth ||
!$maxHeight ) {
1074 // should never happen
1075 throw new MWException( 'Using a choice from $wgImageLimits that is 0x0' );
1078 if ( !$width ||
!$height ) {
1079 return array( 0, 0 );
1082 # Calculate the thumbnail size.
1083 if ( $width <= $maxWidth && $height <= $maxHeight ) {
1084 // Vectorized image, do nothing.
1085 } elseif ( $width / $height >= $maxWidth / $maxHeight ) {
1086 # The limiting factor is the width, not the height.
1087 $height = round( $height * $maxWidth / $width );
1089 # Note that $height <= $maxHeight now.
1091 $newwidth = floor( $width * $maxHeight / $height );
1092 $height = round( $height * $newwidth / $width );
1094 # Note that $height <= $maxHeight now, but might not be identical
1095 # because of rounding.
1097 return array( $width, $height );
1101 * Get alternative thumbnail sizes.
1103 * @note This will only list several alternatives if thumbnails are rendered on 404
1104 * @param int $origWidth Actual width of image
1105 * @param int $origHeight Actual height of image
1106 * @return array An array of [width, height] pairs.
1108 protected function getThumbSizes( $origWidth, $origHeight ) {
1109 global $wgImageLimits;
1110 if ( $this->displayImg
->getRepo()->canTransformVia404() ) {
1111 $thumbSizes = $wgImageLimits;
1112 // Also include the full sized resolution in the list, so
1113 // that users know they can get it. This will link to the
1114 // original file asset if mustRender() === false. In the case
1115 // that we mustRender, some users have indicated that they would
1116 // find it useful to have the full size image in the rendered
1118 $thumbSizes[] = array( $origWidth, $origHeight );
1120 # Creating thumb links triggers thumbnail generation.
1121 # Just generate the thumb for the current users prefs.
1122 $thumbSizes = array( $this->getImageLimitsFromOption( $this->getContext()->getUser(), 'thumbsize' ) );
1123 if ( !$this->displayImg
->mustRender() ) {
1124 // We can safely include a link to the "full-size" preview,
1125 // without actually rendering.
1126 $thumbSizes[] = array( $origWidth, $origHeight );
1135 * Builds the image revision log shown on image pages
1139 class ImageHistoryList
extends ContextSource
{
1154 protected $imagePage;
1161 protected $repo, $showThumb;
1162 protected $preventClickjacking = false;
1165 * @param ImagePage $imagePage
1167 public function __construct( $imagePage ) {
1168 global $wgShowArchiveThumbnails;
1169 $this->current
= $imagePage->getFile();
1170 $this->img
= $imagePage->getDisplayedFile();
1171 $this->title
= $imagePage->getTitle();
1172 $this->imagePage
= $imagePage;
1173 $this->showThumb
= $wgShowArchiveThumbnails && $this->img
->canRender();
1174 $this->setContext( $imagePage->getContext() );
1180 public function getImagePage() {
1181 return $this->imagePage
;
1187 public function getFile() {
1192 * @param string $navLinks
1195 public function beginImageHistoryList( $navLinks = '' ) {
1196 return Xml
::element( 'h2', array( 'id' => 'filehistory' ), $this->msg( 'filehist' )->text() )
1198 . "<div id=\"mw-imagepage-section-filehistory\">\n"
1199 . $this->msg( 'filehist-help' )->parseAsBlock()
1201 . Xml
::openElement( 'table', array( 'class' => 'wikitable filehistory' ) ) . "\n"
1203 . ( $this->current
->isLocal()
1204 && ( $this->getUser()->isAllowedAny( 'delete', 'deletedhistory' ) ) ?
'<td></td>' : '' )
1205 . '<th>' . $this->msg( 'filehist-datetime' )->escaped() . '</th>'
1206 . ( $this->showThumb ?
'<th>' . $this->msg( 'filehist-thumb' )->escaped() . '</th>' : '' )
1207 . '<th>' . $this->msg( 'filehist-dimensions' )->escaped() . '</th>'
1208 . '<th>' . $this->msg( 'filehist-user' )->escaped() . '</th>'
1209 . '<th>' . $this->msg( 'filehist-comment' )->escaped() . '</th>'
1214 * @param string $navLinks
1217 public function endImageHistoryList( $navLinks = '' ) {
1218 return "</table>\n$navLinks\n</div>\n";
1222 * @param bool $iscur
1226 public function imageHistoryLine( $iscur, $file ) {
1229 $user = $this->getUser();
1230 $lang = $this->getLanguage();
1231 $timestamp = wfTimestamp( TS_MW
, $file->getTimestamp() );
1232 $img = $iscur ?
$file->getName() : $file->getArchiveName();
1233 $userId = $file->getUser( 'id' );
1234 $userText = $file->getUser( 'text' );
1235 $description = $file->getDescription( File
::FOR_THIS_USER
, $user );
1237 $local = $this->current
->isLocal();
1238 $row = $selected = '';
1241 if ( $local && ( $user->isAllowedAny( 'delete', 'deletedhistory' ) ) ) {
1243 # Link to remove from history
1244 if ( $user->isAllowed( 'delete' ) ) {
1245 $q = array( 'action' => 'delete' );
1247 $q['oldimage'] = $img;
1249 $row .= Linker
::linkKnown(
1251 $this->msg( $iscur ?
'filehist-deleteall' : 'filehist-deleteone' )->escaped(),
1255 # Link to hide content. Don't show useless link to people who cannot hide revisions.
1256 $canHide = $user->isAllowed( 'deleterevision' );
1257 if ( $canHide ||
( $user->isAllowed( 'deletedhistory' ) && $file->getVisibility() ) ) {
1258 if ( $user->isAllowed( 'delete' ) ) {
1261 // If file is top revision or locked from this user, don't link
1262 if ( $iscur ||
!$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1263 $del = Linker
::revDeleteLinkDisabled( $canHide );
1265 list( $ts, ) = explode( '!', $img, 2 );
1267 'type' => 'oldimage',
1268 'target' => $this->title
->getPrefixedText(),
1271 $del = Linker
::revDeleteLink( $query,
1272 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1279 // Reversion link/current indicator
1282 $row .= $this->msg( 'filehist-current' )->escaped();
1283 } elseif ( $local && $this->title
->quickUserCan( 'edit', $user )
1284 && $this->title
->quickUserCan( 'upload', $user )
1286 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1287 $row .= $this->msg( 'filehist-revert' )->escaped();
1289 $row .= Linker
::linkKnown(
1291 $this->msg( 'filehist-revert' )->escaped(),
1294 'action' => 'revert',
1296 'wpEditToken' => $user->getEditToken( $img )
1303 // Date/time and image link
1304 if ( $file->getTimestamp() === $this->img
->getTimestamp() ) {
1305 $selected = "class='filehistory-selected'";
1307 $row .= "<td $selected style='white-space: nowrap;'>";
1308 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1309 # Don't link to unviewable files
1310 $row .= '<span class="history-deleted">'
1311 . $lang->userTimeAndDate( $timestamp, $user ) . '</span>';
1312 } elseif ( $file->isDeleted( File
::DELETED_FILE
) ) {
1314 $this->preventClickjacking();
1315 $revdel = SpecialPage
::getTitleFor( 'Revisiondelete' );
1316 # Make a link to review the image
1317 $url = Linker
::linkKnown(
1319 $lang->userTimeAndDate( $timestamp, $user ),
1322 'target' => $this->title
->getPrefixedText(),
1324 'token' => $user->getEditToken( $img )
1328 $url = $lang->userTimeAndDate( $timestamp, $user );
1330 $row .= '<span class="history-deleted">' . $url . '</span>';
1331 } elseif ( !$file->exists() ) {
1332 $row .= '<span class="mw-file-missing">'
1333 . $lang->userTimeAndDate( $timestamp, $user ) . '</span>';
1335 $url = $iscur ?
$this->current
->getUrl() : $this->current
->getArchiveUrl( $img );
1336 $row .= Xml
::element(
1338 array( 'href' => $url ),
1339 $lang->userTimeAndDate( $timestamp, $user )
1345 if ( $this->showThumb
) {
1346 $row .= '<td>' . $this->getThumbForLine( $file ) . '</td>';
1349 // Image dimensions + size
1351 $row .= htmlspecialchars( $file->getDimensionsString() );
1352 $row .= $this->msg( 'word-separator' )->escaped();
1353 $row .= '<span style="white-space: nowrap;">';
1354 $row .= $this->msg( 'parentheses' )->sizeParams( $file->getSize() )->escaped();
1360 // Hide deleted usernames
1361 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1362 $row .= '<span class="history-deleted">'
1363 . $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
1366 $row .= Linker
::userLink( $userId, $userText );
1367 $row .= $this->msg( 'word-separator' )->escaped();
1368 $row .= '<span style="white-space: nowrap;">';
1369 $row .= Linker
::userToolLinks( $userId, $userText );
1372 $row .= htmlspecialchars( $userText );
1377 // Don't show deleted descriptions
1378 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1379 $row .= '<td><span class="history-deleted">' .
1380 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></td>';
1382 $row .= '<td dir="' . $wgContLang->getDir() . '">' .
1383 Linker
::formatComment( $description, $this->title
) . '</td>';
1387 wfRunHooks( 'ImagePageFileHistoryLine', array( $this, $file, &$row, &$rowClass ) );
1388 $classAttr = $rowClass ?
" class='$rowClass'" : '';
1390 return "<tr{$classAttr}>{$row}</tr>\n";
1397 protected function getThumbForLine( $file ) {
1398 $lang = $this->getLanguage();
1399 $user = $this->getUser();
1400 if ( $file->allowInlineDisplay() && $file->userCan( File
::DELETED_FILE
, $user )
1401 && !$file->isDeleted( File
::DELETED_FILE
)
1407 $timestamp = wfTimestamp( TS_MW
, $file->getTimestamp() );
1409 $thumbnail = $file->transform( $params );
1411 'alt' => $this->msg( 'filehist-thumbtext',
1412 $lang->userTimeAndDate( $timestamp, $user ),
1413 $lang->userDate( $timestamp, $user ),
1414 $lang->userTime( $timestamp, $user ) )->text(),
1415 'file-link' => true,
1418 if ( !$thumbnail ) {
1419 return $this->msg( 'filehist-nothumb' )->escaped();
1422 return $thumbnail->toHtml( $options );
1424 return $this->msg( 'filehist-nothumb' )->escaped();
1429 * @param bool $enable
1431 protected function preventClickjacking( $enable = true ) {
1432 $this->preventClickjacking
= $enable;
1438 public function getPreventClickjacking() {
1439 return $this->preventClickjacking
;
1443 class ImageHistoryPseudoPager
extends ReverseChronologicalPager
{
1444 protected $preventClickjacking = false;
1457 * @param ImagePage $imagePage
1459 function __construct( $imagePage ) {
1460 parent
::__construct( $imagePage->getContext() );
1461 $this->mImagePage
= $imagePage;
1462 $this->mTitle
= clone ( $imagePage->getTitle() );
1463 $this->mTitle
->setFragment( '#filehistory' );
1465 $this->mHist
= array();
1466 $this->mRange
= array( 0, 0 ); // display range
1472 function getTitle() {
1473 return $this->mTitle
;
1476 function getQueryInfo() {
1483 function getIndexField() {
1488 * @param object $row
1491 function formatRow( $row ) {
1498 function getBody() {
1501 if ( count( $this->mHist
) ) {
1502 $list = new ImageHistoryList( $this->mImagePage
);
1503 # Generate prev/next links
1504 $navLink = $this->getNavigationBar();
1505 $s = $list->beginImageHistoryList( $navLink );
1506 // Skip rows there just for paging links
1507 for ( $i = $this->mRange
[0]; $i <= $this->mRange
[1]; $i++
) {
1508 $file = $this->mHist
[$i];
1509 $s .= $list->imageHistoryLine( !$file->isOld(), $file );
1511 $s .= $list->endImageHistoryList( $navLink );
1513 if ( $list->getPreventClickjacking() ) {
1514 $this->preventClickjacking();
1520 function doQuery() {
1521 if ( $this->mQueryDone
) {
1524 $this->mImg
= $this->mImagePage
->getFile(); // ensure loading
1525 if ( !$this->mImg
->exists() ) {
1528 $queryLimit = $this->mLimit +
1; // limit plus extra row
1529 if ( $this->mIsBackwards
) {
1530 // Fetch the file history
1531 $this->mHist
= $this->mImg
->getHistory( $queryLimit, null, $this->mOffset
, false );
1532 // The current rev may not meet the offset/limit
1533 $numRows = count( $this->mHist
);
1534 if ( $numRows <= $this->mLimit
&& $this->mImg
->getTimestamp() > $this->mOffset
) {
1535 $this->mHist
= array_merge( array( $this->mImg
), $this->mHist
);
1538 // The current rev may not meet the offset
1539 if ( !$this->mOffset ||
$this->mImg
->getTimestamp() < $this->mOffset
) {
1540 $this->mHist
[] = $this->mImg
;
1542 // Old image versions (fetch extra row for nav links)
1543 $oiLimit = count( $this->mHist
) ?
$this->mLimit
: $this->mLimit +
1;
1544 // Fetch the file history
1545 $this->mHist
= array_merge( $this->mHist
,
1546 $this->mImg
->getHistory( $oiLimit, $this->mOffset
, null, false ) );
1548 $numRows = count( $this->mHist
); // Total number of query results
1550 # Index value of top item in the list
1551 $firstIndex = $this->mIsBackwards ?
1552 $this->mHist
[$numRows - 1]->getTimestamp() : $this->mHist
[0]->getTimestamp();
1553 # Discard the extra result row if there is one
1554 if ( $numRows > $this->mLimit
&& $numRows > 1 ) {
1555 if ( $this->mIsBackwards
) {
1556 # Index value of item past the index
1557 $this->mPastTheEndIndex
= $this->mHist
[0]->getTimestamp();
1558 # Index value of bottom item in the list
1559 $lastIndex = $this->mHist
[1]->getTimestamp();
1561 $this->mRange
= array( 1, $numRows - 1 );
1563 # Index value of item past the index
1564 $this->mPastTheEndIndex
= $this->mHist
[$numRows - 1]->getTimestamp();
1565 # Index value of bottom item in the list
1566 $lastIndex = $this->mHist
[$numRows - 2]->getTimestamp();
1568 $this->mRange
= array( 0, $numRows - 2 );
1571 # Setting indexes to an empty string means that they will be
1572 # omitted if they would otherwise appear in URLs. It just so
1573 # happens that this is the right thing to do in the standard
1574 # UI, in all the relevant cases.
1575 $this->mPastTheEndIndex
= '';
1576 # Index value of bottom item in the list
1577 $lastIndex = $this->mIsBackwards ?
1578 $this->mHist
[0]->getTimestamp() : $this->mHist
[$numRows - 1]->getTimestamp();
1580 $this->mRange
= array( 0, $numRows - 1 );
1585 $this->mPastTheEndIndex
= '';
1587 if ( $this->mIsBackwards
) {
1588 $this->mIsFirst
= ( $numRows < $queryLimit );
1589 $this->mIsLast
= ( $this->mOffset
== '' );
1590 $this->mLastShown
= $firstIndex;
1591 $this->mFirstShown
= $lastIndex;
1593 $this->mIsFirst
= ( $this->mOffset
== '' );
1594 $this->mIsLast
= ( $numRows < $queryLimit );
1595 $this->mLastShown
= $lastIndex;
1596 $this->mFirstShown
= $firstIndex;
1598 $this->mQueryDone
= true;
1602 * @param bool $enable
1604 protected function preventClickjacking( $enable = true ) {
1605 $this->preventClickjacking
= $enable;
1611 public function getPreventClickjacking() {
1612 return $this->preventClickjacking
;