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
{
40 var $mExtraDescription = false;
44 * @return WikiFilePage
46 protected function newPage( Title
$title ) {
47 // Overload mPage with a file-specific page
48 return new WikiFilePage( $title );
52 * Constructor from a page id
53 * @param int $id article ID to load
54 * @return ImagePage|null
56 public static function newFromID( $id ) {
57 $t = Title
::newFromID( $id );
58 # @todo FIXME: Doesn't inherit right
59 return $t == null ?
null : new self( $t );
60 # return $t == null ? null : new static( $t ); // PHP 5.3
67 public function setFile( $file ) {
68 $this->mPage
->setFile( $file );
69 $this->displayImg
= $file;
70 $this->fileLoaded
= true;
73 protected function loadFile() {
74 if ( $this->fileLoaded
) {
77 $this->fileLoaded
= true;
79 $this->displayImg
= $img = false;
80 wfRunHooks( 'ImagePageFindFile', array( $this, &$img, &$this->displayImg
) );
81 if ( !$img ) { // not set by hook?
82 $img = wfFindFile( $this->getTitle() );
84 $img = wfLocalFile( $this->getTitle() );
87 $this->mPage
->setFile( $img );
88 if ( !$this->displayImg
) { // not set by hook?
89 $this->displayImg
= $img;
91 $this->repo
= $img->getRepo();
95 * Handler for action=render
96 * Include body text only; none of the image extras
98 public function render() {
99 $this->getContext()->getOutput()->setArticleBodyOnly( true );
103 public function view() {
106 $out = $this->getContext()->getOutput();
107 $request = $this->getContext()->getRequest();
108 $diff = $request->getVal( 'diff' );
109 $diffOnly = $request->getBool( 'diffonly', $this->getContext()->getUser()->getOption( 'diffonly' ) );
111 if ( $this->getTitle()->getNamespace() != NS_FILE ||
( $diff !== null && $diffOnly ) ) {
118 if ( $this->getTitle()->getNamespace() == NS_FILE
&& $this->mPage
->getFile()->getRedirected() ) {
119 if ( $this->getTitle()->getDBkey() == $this->mPage
->getFile()->getName() ||
$diff !== null ) {
120 // mTitle is the same as the redirect target so ask Article
121 // to perform the redirect for us.
122 $request->setVal( 'diffonly', 'true' );
126 // mTitle is not the same as the redirect target so it is
127 // probably the redirect page itself. Fake the redirect symbol
128 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
129 $out->addHTML( $this->viewRedirect( Title
::makeTitle( NS_FILE
, $this->mPage
->getFile()->getName() ),
130 /* $appendSubtitle */ true, /* $forceKnown */ true ) );
131 $this->mPage
->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
136 if ( $wgShowEXIF && $this->displayImg
->exists() ) {
137 // @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
138 $formattedMetadata = $this->displayImg
->formatMetadata();
139 $showmeta = $formattedMetadata !== false;
144 if ( !$diff && $this->displayImg
->exists() ) {
145 $out->addHTML( $this->showTOC( $showmeta ) );
149 $this->openShowImage();
152 # No need to display noarticletext, we use our own message, output in openShowImage()
153 if ( $this->mPage
->getID() ) {
154 # NS_FILE is in the user language, but this section (the actual wikitext)
155 # should be in page content language
156 $pageLang = $this->getTitle()->getPageViewLanguage();
157 $out->addHTML( Xml
::openElement( 'div', array( 'id' => 'mw-imagepage-content',
158 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
159 'class' => 'mw-content-' . $pageLang->getDir() ) ) );
163 $out->addHTML( Xml
::closeElement( 'div' ) );
165 # Just need to set the right headers
166 $out->setArticleFlag( true );
167 $out->setPageTitle( $this->getTitle()->getPrefixedText() );
168 $this->mPage
->doViewUpdates( $this->getContext()->getUser(), $this->getOldID() );
171 # Show shared description, if needed
172 if ( $this->mExtraDescription
) {
173 $fol = wfMessage( 'shareddescriptionfollows' );
174 if ( !$fol->isDisabled() ) {
175 $out->addWikiText( $fol->plain() );
177 $out->addHTML( '<div id="shared-image-desc">' . $this->mExtraDescription
. "</div>\n" );
180 $this->closeShowImage();
181 $this->imageHistory();
182 // TODO: Cleanup the following
184 $out->addHTML( Xml
::element( 'h2',
185 array( 'id' => 'filelinks' ),
186 wfMessage( 'imagelinks' )->text() ) . "\n" );
188 # @todo FIXME: For some freaky reason, we can't redirect to foreign images.
189 # Yet we return metadata about the target. Definitely an issue in the FileRepo
192 # Allow extensions to add something after the image links
194 wfRunHooks( 'ImagePageAfterImageLinks', array( $this, &$html ) );
196 $out->addHTML( $html );
200 $out->addHTML( Xml
::element(
202 array( 'id' => 'metadata' ),
203 wfMessage( 'metadata' )->text() ) . "\n" );
204 $out->addWikiText( $this->makeMetadataTable( $formattedMetadata ) );
205 $out->addModules( array( 'mediawiki.action.view.metadata' ) );
208 // Add remote Filepage.css
209 if ( !$this->repo
->isLocal() ) {
210 $css = $this->repo
->getDescriptionStylesheetUrl();
212 $out->addStyle( $css );
215 // always show the local local Filepage.css, bug 29277
216 $out->addModuleStyles( 'filepage' );
222 public function getDisplayedFile() {
224 return $this->displayImg
;
230 * @param $metadata Boolean: whether or not to show the metadata link
233 protected function showTOC( $metadata ) {
235 '<li><a href="#file">' . wfMessage( 'file-anchor-link' )->escaped() . '</a></li>',
236 '<li><a href="#filehistory">' . wfMessage( 'filehist' )->escaped() . '</a></li>',
237 '<li><a href="#filelinks">' . wfMessage( 'imagelinks' )->escaped() . '</a></li>',
240 $r[] = '<li><a href="#metadata">' . wfMessage( 'metadata' )->escaped() . '</a></li>';
243 wfRunHooks( 'ImagePageShowTOC', array( $this, &$r ) );
245 return '<ul id="filetoc">' . implode( "\n", $r ) . '</ul>';
249 * Make a table with metadata to be shown in the output page.
251 * @todo FIXME: Bad interface, see note on MediaHandler::formatMetadata().
253 * @param array $metadata the array containing the Exif data
254 * @return String The metadata table. This is treated as Wikitext (!)
256 protected function makeMetadataTable( $metadata ) {
257 $r = "<div class=\"mw-imagepage-section-metadata\">";
258 $r .= wfMessage( 'metadata-help' )->plain();
259 $r .= "<table id=\"mw_metadata\" class=\"mw_metadata\">\n";
260 foreach ( $metadata as $type => $stuff ) {
261 foreach ( $stuff as $v ) {
262 # @todo FIXME: Why is this using escapeId for a class?!
263 $class = Sanitizer
::escapeId( $v['id'] );
264 if ( $type == 'collapsed' ) {
265 $class .= ' collapsable'; // sic
267 $r .= "<tr class=\"$class\">\n";
268 $r .= "<th>{$v['name']}</th>\n";
269 $r .= "<td>{$v['value']}</td>\n</tr>";
272 $r .= "</table>\n</div>\n";
277 * Overloading Article's getContentObject method.
279 * Omit noarticletext if sharedupload; text will be fetched from the
280 * shared upload server if possible.
283 public function getContentObject() {
285 if ( $this->mPage
->getFile() && !$this->mPage
->getFile()->isLocal() && 0 == $this->getID() ) {
288 return parent
::getContentObject();
291 protected function openShowImage() {
292 global $wgImageLimits, $wgEnableUploads, $wgSend404Code;
295 $out = $this->getContext()->getOutput();
296 $user = $this->getContext()->getUser();
297 $lang = $this->getContext()->getLanguage();
298 $dirmark = $lang->getDirMarkEntity();
299 $request = $this->getContext()->getRequest();
301 $max = $this->getImageLimitsFromOption( $user, 'imagesize' );
303 $maxHeight = $max[1];
305 if ( $this->displayImg
->exists() ) {
307 $page = $request->getIntOrNull( 'page' );
308 if ( is_null( $page ) ) {
312 $params = array( 'page' => $page );
315 $renderLang = $request->getVal( 'lang' );
316 if ( !is_null( $renderLang ) ) {
317 $params['lang'] = $renderLang;
320 $width_orig = $this->displayImg
->getWidth( $page );
321 $width = $width_orig;
322 $height_orig = $this->displayImg
->getHeight( $page );
323 $height = $height_orig;
325 $filename = wfEscapeWikiText( $this->displayImg
->getName() );
326 $linktext = $filename;
328 wfRunHooks( 'ImageOpenShowImageInlineBefore', array( &$this, &$out ) );
330 if ( $this->displayImg
->allowInlineDisplay() ) {
333 # "Download high res version" link below the image
334 # $msgsize = wfMessage( 'file-info-size', $width_orig, $height_orig, Linker::formatSize( $this->displayImg->getSize() ), $mime )->escaped();
335 # We'll show a thumbnail of this image
336 if ( $width > $maxWidth ||
$height > $maxHeight ) {
337 # Calculate the thumbnail size.
338 # First case, the limiting factor is the width, not the height.
339 if ( $width / $height >= $maxWidth / $maxHeight ) { // FIXME: Possible division by 0. bug 36911
340 $height = round( $height * $maxWidth / $width ); // FIXME: Possible division by 0. bug 36911
342 # Note that $height <= $maxHeight now.
344 $newwidth = floor( $width * $maxHeight / $height ); // FIXME: Possible division by 0. bug 36911
345 $height = round( $height * $newwidth / $width ); // FIXME: Possible division by 0. bug 36911
347 # Note that $height <= $maxHeight now, but might not be identical
348 # because of rounding.
350 $linktext = wfMessage( 'show-big-image' )->escaped();
351 if ( $this->displayImg
->getRepo()->canTransformVia404() ) {
352 $thumbSizes = $wgImageLimits;
353 // Also include the full sized resolution in the list, so
354 // that users know they can get it. This will link to the
355 // original file asset if mustRender() === false. In the case
356 // that we mustRender, some users have indicated that they would
357 // find it useful to have the full size image in the rendered
359 $thumbSizes[] = array( $width_orig, $height_orig );
361 # Creating thumb links triggers thumbnail generation.
362 # Just generate the thumb for the current users prefs.
363 $thumbSizes = array( $this->getImageLimitsFromOption( $user, 'thumbsize' ) );
364 if ( !$this->displayImg
->mustRender() ) {
365 // We can safely include a link to the "full-size" preview,
366 // without actually rendering.
367 $thumbSizes[] = array( $width_orig, $height_orig );
370 # Generate thumbnails or thumbnail links as needed...
371 $otherSizes = array();
372 foreach ( $thumbSizes as $size ) {
373 // We include a thumbnail size in the list, if it is
374 // less than or equal to the original size of the image
375 // asset ($width_orig/$height_orig). We also exclude
376 // the current thumbnail's size ($width/$height)
377 // since that is added to the message separately, so
378 // it can be denoted as the current size being shown.
379 if ( $size[0] <= $width_orig && $size[1] <= $height_orig
380 && $size[0] != $width && $size[1] != $height )
382 $sizeLink = $this->makeSizeLink( $params, $size[0], $size[1] );
384 $otherSizes[] = $sizeLink;
388 $otherSizes = array_unique( $otherSizes );
390 $sizeLinkBigImagePreview = $this->makeSizeLink( $params, $width, $height );
391 if ( $sizeLinkBigImagePreview ) {
392 $msgsmall .= wfMessage( 'show-big-image-preview' )->
393 rawParams( $sizeLinkBigImagePreview )->
396 if ( count( $otherSizes ) ) {
398 Html
::rawElement( 'span', array( 'class' => 'mw-filepage-other-resolutions' ),
399 wfMessage( 'show-big-image-other' )->rawParams( $lang->pipeList( $otherSizes ) )->
400 params( count( $otherSizes ) )->parse()
403 } elseif ( $width == 0 && $height == 0 ) {
404 # Some sort of audio file that doesn't have dimensions
405 # Don't output a no hi res message for such a file
407 } elseif ( $this->displayImg
->isVectorized() ) {
408 # For vectorized images, full size is just the frame size
411 # Image is small enough to show full size on image page
412 $msgsmall = wfMessage( 'file-nohires' )->parse();
415 $params['width'] = $width;
416 $params['height'] = $height;
417 $thumbnail = $this->displayImg
->transform( $params );
419 $anchorclose = Html
::rawElement( 'div', array( 'class' => 'mw-filepage-resolutioninfo' ), $msgsmall );
421 $isMulti = $this->displayImg
->isMultipage() && $this->displayImg
->pageCount() > 1;
423 $out->addModules( 'mediawiki.page.image.pagination' );
424 $out->addHTML( '<table class="multipageimage"><tr><td>' );
429 'alt' => $this->displayImg
->getTitle()->getPrefixedText(),
432 $out->addHTML( '<div class="fullImageLink" id="file">' .
433 $thumbnail->toHtml( $options ) .
434 $anchorclose . "</div>\n" );
438 $count = $this->displayImg
->pageCount();
441 $label = $out->parse( wfMessage( 'imgmultipageprev' )->text(), false );
442 $link = Linker
::linkKnown(
446 array( 'page' => $page - 1 )
448 $thumb1 = Linker
::makeThumbLinkObj( $this->getTitle(), $this->displayImg
, $link, $label, 'none',
449 array( 'page' => $page - 1 ) );
454 if ( $page < $count ) {
455 $label = wfMessage( 'imgmultipagenext' )->text();
456 $link = Linker
::linkKnown(
460 array( 'page' => $page +
1 )
462 $thumb2 = Linker
::makeThumbLinkObj( $this->getTitle(), $this->displayImg
, $link, $label, 'none',
463 array( 'page' => $page +
1 ) );
471 'name' => 'pageselector',
472 'action' => $wgScript,
475 for ( $i = 1; $i <= $count; $i++
) {
476 $options[] = Xml
::option( $lang->formatNum( $i ), $i, $i == $page );
478 $select = Xml
::tags( 'select',
479 array( 'id' => 'pageselector', 'name' => 'page' ),
480 implode( "\n", $options ) );
483 '</td><td><div class="multipageimagenavbox">' .
484 Xml
::openElement( 'form', $formParams ) .
485 Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
486 wfMessage( 'imgmultigoto' )->rawParams( $select )->parse() .
487 Xml
::submitButton( wfMessage( 'imgmultigo' )->text() ) .
488 Xml
::closeElement( 'form' ) .
489 "<hr />$thumb1\n$thumb2<br style=\"clear: both\" /></div></td></tr></table>"
492 } elseif ( $this->displayImg
->isSafeFile() ) {
493 # if direct link is allowed but it's not a renderable image, show an icon.
494 $icon = $this->displayImg
->iconThumb();
496 $out->addHTML( '<div class="fullImageLink" id="file">' .
497 $icon->toHtml( array( 'file-link' => true ) ) .
501 $longDesc = wfMessage( 'parentheses', $this->displayImg
->getLongDesc() )->text();
503 $medialink = "[[Media:$filename|$linktext]]";
505 if ( !$this->displayImg
->isSafeFile() ) {
506 $warning = wfMessage( 'mediawarning' )->plain();
507 // dirmark is needed here to separate the file name, which
508 // most likely ends in Latin characters, from the description,
509 // which may begin with the file type. In RTL environment
510 // this will get messy.
511 // The dirmark, however, must not be immediately adjacent
512 // to the filename, because it can get copied with it.
514 $out->addWikiText( <<<EOT
515 <div class="fullMedia"><span class="dangerousLink">{$medialink}</span> $dirmark<span class="fileInfo">$longDesc</span></div>
516 <div class="mediaWarning">$warning</div>
520 $out->addWikiText( <<<EOT
521 <div class="fullMedia">{$medialink} {$dirmark}<span class="fileInfo">$longDesc</span>
527 // Add cannot animate thumbnail warning
528 if ( !$this->displayImg
->canAnimateThumbIfAppropriate() ) {
529 // Include the extension so wiki admins can
530 // customize it on a per file-type basis
531 // (aka say things like use format X instead).
532 // additionally have a specific message for
533 // file-no-thumb-animation-gif
534 $ext = $this->displayImg
->getExtension();
535 $noAnimMesg = wfMessageFallback(
536 'file-no-thumb-animation-' . $ext,
537 'file-no-thumb-animation'
540 $out->addWikiText( <<<EOT
541 <div class="mw-noanimatethumb">{$noAnimMesg}</div>
546 if ( !$this->displayImg
->isLocal() ) {
547 $this->printSharedImageText();
550 # Image does not exist
551 if ( !$this->getID() ) {
552 # No article exists either
553 # Show deletion log to be consistent with normal articles
554 LogEventsList
::showLogExtract(
556 array( 'delete', 'move' ),
557 $this->getTitle()->getPrefixedText(),
560 'conds' => array( "log_action != 'revision'" ),
561 'showIfEmpty' => false,
562 'msgKey' => array( 'moveddeleted-notice' )
567 if ( $wgEnableUploads && $user->isAllowed( 'upload' ) ) {
568 // Only show an upload link if the user can upload
569 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
571 'filepage-nofile-link',
572 $uploadTitle->getFullURL( array( 'wpDestFile' => $this->mPage
->getFile()->getName() ) )
575 $nofile = 'filepage-nofile';
577 // Note, if there is an image description page, but
578 // no image, then this setRobotPolicy is overridden
579 // by Article::View().
580 $out->setRobotPolicy( 'noindex,nofollow' );
581 $out->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
582 if ( !$this->getID() && $wgSend404Code ) {
583 // If there is no image, no shared image, and no description page,
584 // output a 404, to be consistent with articles.
585 $request->response()->header( 'HTTP/1.1 404 Not Found' );
588 $out->setFileVersion( $this->displayImg
);
592 * Creates an thumbnail of specified size and returns an HTML link to it
593 * @param array $params Scaler parameters
598 private function makeSizeLink( $params, $width, $height ) {
599 $params['width'] = $width;
600 $params['height'] = $height;
601 $thumbnail = $this->displayImg
->transform( $params );
602 if ( $thumbnail && !$thumbnail->isError() ) {
603 return Html
::rawElement( 'a', array(
604 'href' => $thumbnail->getUrl(),
605 'class' => 'mw-thumbnail-link'
606 ), wfMessage( 'show-big-image-size' )->numParams(
607 $thumbnail->getWidth(), $thumbnail->getHeight()
615 * Show a notice that the file is from a shared repository
617 protected function printSharedImageText() {
618 $out = $this->getContext()->getOutput();
621 $descUrl = $this->mPage
->getFile()->getDescriptionUrl();
622 $descText = $this->mPage
->getFile()->getDescriptionText( $this->getContext()->getLanguage() );
624 /* Add canonical to head if there is no local page for this shared file */
625 if ( $descUrl && $this->mPage
->getID() == 0 ) {
626 $out->setCanonicalUrl( $descUrl );
629 $wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
630 $repo = $this->mPage
->getFile()->getRepo()->getDisplayName();
632 if ( $descUrl && $descText && wfMessage( 'sharedupload-desc-here' )->plain() !== '-' ) {
633 $out->wrapWikiMsg( $wrap, array( 'sharedupload-desc-here', $repo, $descUrl ) );
634 } elseif ( $descUrl && wfMessage( 'sharedupload-desc-there' )->plain() !== '-' ) {
635 $out->wrapWikiMsg( $wrap, array( 'sharedupload-desc-there', $repo, $descUrl ) );
637 $out->wrapWikiMsg( $wrap, array( 'sharedupload', $repo ), ''/*BACKCOMPAT*/ );
641 $this->mExtraDescription
= $descText;
645 public function getUploadUrl() {
647 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
648 return $uploadTitle->getFullURL( array(
649 'wpDestFile' => $this->mPage
->getFile()->getName(),
655 * Print out the various links at the bottom of the image page, e.g. reupload,
656 * external editing (and instructions link) etc.
658 protected function uploadLinksBox() {
659 global $wgEnableUploads;
661 if ( !$wgEnableUploads ) {
666 if ( !$this->mPage
->getFile()->isLocal() ) {
670 $out = $this->getContext()->getOutput();
671 $out->addHTML( "<ul>\n" );
673 # "Upload a new version of this file" link
674 $canUpload = $this->getTitle()->userCan( 'upload', $this->getContext()->getUser() );
675 if ( $canUpload && UploadBase
::userCanReUpload( $this->getContext()->getUser(), $this->mPage
->getFile()->name
) ) {
676 $ulink = Linker
::makeExternalLink( $this->getUploadUrl(), wfMessage( 'uploadnewversion-linktext' )->text() );
677 $out->addHTML( "<li id=\"mw-imagepage-reupload-link\"><div class=\"plainlinks\">{$ulink}</div></li>\n" );
679 $out->addHTML( "<li id=\"mw-imagepage-upload-disallowed\">" . $this->getContext()->msg( 'upload-disallowed-here' )->escaped() . "</li>\n" );
682 $out->addHTML( "</ul>\n" );
685 protected function closeShowImage() { } # For overloading
688 * If the page we've just displayed is in the "Image" namespace,
689 * we follow it with an upload history of the image and its usage.
691 protected function imageHistory() {
693 $out = $this->getContext()->getOutput();
694 $pager = new ImageHistoryPseudoPager( $this );
695 $out->addHTML( $pager->getBody() );
696 $out->preventClickjacking( $pager->getPreventClickjacking() );
698 $this->mPage
->getFile()->resetHistory(); // free db resources
700 # Exist check because we don't want to show this on pages where an image
701 # doesn't exist along with the noimage message, that would suck. -ævar
702 if ( $this->mPage
->getFile()->exists() ) {
703 $this->uploadLinksBox();
710 * @return ResultWrapper
712 protected function queryImageLinks( $target, $limit ) {
713 $dbr = wfGetDB( DB_SLAVE
);
716 array( 'imagelinks', 'page' ),
717 array( 'page_namespace', 'page_title', 'page_is_redirect', 'il_to' ),
718 array( 'il_to' => $target, 'il_from = page_id' ),
720 array( 'LIMIT' => $limit +
1, 'ORDER BY' => 'il_from', )
724 protected function imageLinks() {
727 $out = $this->getContext()->getOutput();
728 $res = $this->queryImageLinks( $this->getTitle()->getDBkey(), $limit +
1 );
730 $redirects = array();
731 foreach ( $res as $row ) {
732 if ( $row->page_is_redirect
) {
733 $redirects[$row->page_title
] = array();
737 $count = count( $rows );
739 $hasMore = $count > $limit;
740 if ( !$hasMore && count( $redirects ) ) {
741 $res = $this->queryImageLinks( array_keys( $redirects ),
742 $limit - count( $rows ) +
1 );
743 foreach ( $res as $row ) {
744 $redirects[$row->il_to
][] = $row;
747 $hasMore = ( $res->numRows() +
count( $rows ) ) > $limit;
752 Html
::rawElement( 'div',
753 array( 'id' => 'mw-imagepage-nolinkstoimage' ), "\n$1\n" ),
759 $out->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
761 $out->addWikiMsg( 'linkstoimage', $count );
763 // More links than the limit. Add a link to [[Special:Whatlinkshere]]
764 $out->addWikiMsg( 'linkstoimage-more',
765 $this->getContext()->getLanguage()->formatNum( $limit ),
766 $this->getTitle()->getPrefixedDBkey()
771 Html
::openElement( 'ul',
772 array( 'class' => 'mw-imagepage-linkstoimage' ) ) . "\n"
776 // Sort the list by namespace:title
777 usort( $rows, array( $this, 'compare' ) );
779 // Create links for every element
781 foreach ( $rows as $element ) {
783 if ( $currentCount > $limit ) {
788 # Add a redirect=no to make redirect pages reachable
789 if ( isset( $redirects[$element->page_title
] ) ) {
790 $query['redirect'] = 'no';
792 $link = Linker
::linkKnown(
793 Title
::makeTitle( $element->page_namespace
, $element->page_title
),
794 null, array(), $query
796 if ( !isset( $redirects[$element->page_title
] ) ) {
799 } elseif ( count( $redirects[$element->page_title
] ) === 0 ) {
800 # Redirect without usages
801 $liContents = wfMessage( 'linkstoimage-redirect' )->rawParams( $link, '' )->parse();
803 # Redirect with usages
805 foreach ( $redirects[$element->page_title
] as $row ) {
807 if ( $currentCount > $limit ) {
811 $link2 = Linker
::linkKnown( Title
::makeTitle( $row->page_namespace
, $row->page_title
) );
812 $li .= Html
::rawElement(
814 array( 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
),
819 $ul = Html
::rawElement(
821 array( 'class' => 'mw-imagepage-redirectstofile' ),
824 $liContents = wfMessage( 'linkstoimage-redirect' )->rawParams(
825 $link, $ul )->parse();
827 $out->addHTML( Html
::rawElement(
829 array( 'class' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace
),
835 $out->addHTML( Html
::closeElement( 'ul' ) . "\n" );
838 // Add a links to [[Special:Whatlinkshere]]
839 if ( $count > $limit ) {
840 $out->addWikiMsg( 'morelinkstoimage', $this->getTitle()->getPrefixedDBkey() );
842 $out->addHTML( Html
::closeElement( 'div' ) . "\n" );
845 protected function imageDupes() {
847 $out = $this->getContext()->getOutput();
849 $dupes = $this->mPage
->getDuplicates();
850 if ( count( $dupes ) == 0 ) {
854 $out->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
855 $out->addWikiMsg( 'duplicatesoffile',
856 $this->getContext()->getLanguage()->formatNum( count( $dupes ) ), $this->getTitle()->getDBkey()
858 $out->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
863 foreach ( $dupes as $file ) {
865 if ( $file->isLocal() ) {
866 $link = Linker
::linkKnown( $file->getTitle() );
868 $link = Linker
::makeExternalLink( $file->getDescriptionUrl(),
869 $file->getTitle()->getPrefixedText() );
870 $fromSrc = wfMessage( 'shared-repo-from', $file->getRepo()->getDisplayName() )->text();
872 $out->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
874 $out->addHTML( "</ul></div>\n" );
878 * Delete the file, or an earlier version of it
880 public function delete() {
881 $file = $this->mPage
->getFile();
882 if ( !$file->exists() ||
!$file->isLocal() ||
$file->getRedirected() ) {
883 // Standard article deletion
888 $deleter = new FileDeleteForm( $file );
893 * Display an error with a wikitext description
895 * @param $description String
897 function showError( $description ) {
898 $out = $this->getContext()->getOutput();
899 $out->setPageTitle( wfMessage( 'internalerror' ) );
900 $out->setRobotPolicy( 'noindex,nofollow' );
901 $out->setArticleRelated( false );
902 $out->enableClientCache( false );
903 $out->addWikiText( $description );
907 * Callback for usort() to do link sorts by (namespace, title)
908 * Function copied from Title::compare()
910 * @param $a object page to compare with
911 * @param $b object page to compare with
912 * @return Integer: result of string comparison, or namespace comparison
914 protected function compare( $a, $b ) {
915 if ( $a->page_namespace
== $b->page_namespace
) {
916 return strcmp( $a->page_title
, $b->page_title
);
918 return $a->page_namespace
- $b->page_namespace
;
923 * Returns the corresponding $wgImageLimits entry for the selected user option
926 * @param string $optionName Name of a option to check, typically imagesize or thumbsize
930 public function getImageLimitsFromOption( $user, $optionName ) {
931 global $wgImageLimits;
933 $option = $user->getIntOption( $optionName );
934 if ( !isset( $wgImageLimits[$option] ) ) {
935 $option = User
::getDefaultOption( $optionName );
938 // The user offset might still be incorrect, specially if
939 // $wgImageLimits got changed (see bug #8858).
940 if ( !isset( $wgImageLimits[$option] ) ) {
941 // Default to the first offset in $wgImageLimits
945 return isset( $wgImageLimits[$option] )
946 ?
$wgImageLimits[$option]
947 : array( 800, 600 ); // if nothing is set, fallback to a hardcoded default
952 * Builds the image revision log shown on image pages
956 class ImageHistoryList
extends ContextSource
{
971 protected $imagePage;
978 protected $repo, $showThumb;
979 protected $preventClickjacking = false;
982 * @param ImagePage $imagePage
984 public function __construct( $imagePage ) {
985 global $wgShowArchiveThumbnails;
986 $this->current
= $imagePage->getFile();
987 $this->img
= $imagePage->getDisplayedFile();
988 $this->title
= $imagePage->getTitle();
989 $this->imagePage
= $imagePage;
990 $this->showThumb
= $wgShowArchiveThumbnails && $this->img
->canRender();
991 $this->setContext( $imagePage->getContext() );
997 public function getImagePage() {
998 return $this->imagePage
;
1004 public function getFile() {
1009 * @param $navLinks string
1012 public function beginImageHistoryList( $navLinks = '' ) {
1013 return Xml
::element( 'h2', array( 'id' => 'filehistory' ), $this->msg( 'filehist' )->text() ) . "\n"
1014 . "<div id=\"mw-imagepage-section-filehistory\">\n"
1015 . $this->msg( 'filehist-help' )->parseAsBlock()
1017 . Xml
::openElement( 'table', array( 'class' => 'wikitable filehistory' ) ) . "\n"
1019 . ( $this->current
->isLocal() && ( $this->getUser()->isAllowedAny( 'delete', 'deletedhistory' ) ) ?
'<td></td>' : '' )
1020 . '<th>' . $this->msg( 'filehist-datetime' )->escaped() . '</th>'
1021 . ( $this->showThumb ?
'<th>' . $this->msg( 'filehist-thumb' )->escaped() . '</th>' : '' )
1022 . '<th>' . $this->msg( 'filehist-dimensions' )->escaped() . '</th>'
1023 . '<th>' . $this->msg( 'filehist-user' )->escaped() . '</th>'
1024 . '<th>' . $this->msg( 'filehist-comment' )->escaped() . '</th>'
1029 * @param $navLinks string
1032 public function endImageHistoryList( $navLinks = '' ) {
1033 return "</table>\n$navLinks\n</div>\n";
1041 public function imageHistoryLine( $iscur, $file ) {
1044 $user = $this->getUser();
1045 $lang = $this->getLanguage();
1046 $timestamp = wfTimestamp( TS_MW
, $file->getTimestamp() );
1047 $img = $iscur ?
$file->getName() : $file->getArchiveName();
1048 $userId = $file->getUser( 'id' );
1049 $userText = $file->getUser( 'text' );
1050 $description = $file->getDescription( File
::FOR_THIS_USER
, $user );
1052 $local = $this->current
->isLocal();
1053 $row = $selected = '';
1056 if ( $local && ( $user->isAllowedAny( 'delete', 'deletedhistory' ) ) ) {
1058 # Link to remove from history
1059 if ( $user->isAllowed( 'delete' ) ) {
1060 $q = array( 'action' => 'delete' );
1062 $q['oldimage'] = $img;
1064 $row .= Linker
::linkKnown(
1066 $this->msg( $iscur ?
'filehist-deleteall' : 'filehist-deleteone' )->escaped(),
1070 # Link to hide content. Don't show useless link to people who cannot hide revisions.
1071 $canHide = $user->isAllowed( 'deleterevision' );
1072 if ( $canHide ||
( $user->isAllowed( 'deletedhistory' ) && $file->getVisibility() ) ) {
1073 if ( $user->isAllowed( 'delete' ) ) {
1076 // If file is top revision or locked from this user, don't link
1077 if ( $iscur ||
!$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1078 $del = Linker
::revDeleteLinkDisabled( $canHide );
1080 list( $ts, ) = explode( '!', $img, 2 );
1082 'type' => 'oldimage',
1083 'target' => $this->title
->getPrefixedText(),
1086 $del = Linker
::revDeleteLink( $query,
1087 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1094 // Reversion link/current indicator
1097 $row .= $this->msg( 'filehist-current' )->escaped();
1098 } elseif ( $local && $this->title
->quickUserCan( 'edit', $user )
1099 && $this->title
->quickUserCan( 'upload', $user )
1101 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1102 $row .= $this->msg( 'filehist-revert' )->escaped();
1104 $row .= Linker
::linkKnown(
1106 $this->msg( 'filehist-revert' )->escaped(),
1109 'action' => 'revert',
1111 'wpEditToken' => $user->getEditToken( $img )
1118 // Date/time and image link
1119 if ( $file->getTimestamp() === $this->img
->getTimestamp() ) {
1120 $selected = "class='filehistory-selected'";
1122 $row .= "<td $selected style='white-space: nowrap;'>";
1123 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1124 # Don't link to unviewable files
1125 $row .= '<span class="history-deleted">' . $lang->userTimeAndDate( $timestamp, $user ) . '</span>';
1126 } elseif ( $file->isDeleted( File
::DELETED_FILE
) ) {
1128 $this->preventClickjacking();
1129 $revdel = SpecialPage
::getTitleFor( 'Revisiondelete' );
1130 # Make a link to review the image
1131 $url = Linker
::linkKnown(
1133 $lang->userTimeAndDate( $timestamp, $user ),
1136 'target' => $this->title
->getPrefixedText(),
1138 'token' => $user->getEditToken( $img )
1142 $url = $lang->userTimeAndDate( $timestamp, $user );
1144 $row .= '<span class="history-deleted">' . $url . '</span>';
1146 $url = $iscur ?
$this->current
->getUrl() : $this->current
->getArchiveUrl( $img );
1147 $row .= Xml
::element( 'a', array( 'href' => $url ), $lang->userTimeAndDate( $timestamp, $user ) );
1152 if ( $this->showThumb
) {
1153 $row .= '<td>' . $this->getThumbForLine( $file ) . '</td>';
1156 // Image dimensions + size
1158 $row .= htmlspecialchars( $file->getDimensionsString() );
1159 $row .= $this->msg( 'word-separator' )->plain();
1160 $row .= '<span style="white-space: nowrap;">';
1161 $row .= $this->msg( 'parentheses' )->rawParams( Linker
::formatSize( $file->getSize() ) )->plain();
1167 // Hide deleted usernames
1168 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1169 $row .= '<span class="history-deleted">' . $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
1172 $row .= Linker
::userLink( $userId, $userText );
1173 $row .= $this->msg( 'word-separator' )->plain();
1174 $row .= '<span style="white-space: nowrap;">';
1175 $row .= Linker
::userToolLinks( $userId, $userText );
1178 $row .= htmlspecialchars( $userText );
1183 // Don't show deleted descriptions
1184 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1185 $row .= '<td><span class="history-deleted">' . $this->msg( 'rev-deleted-comment' )->escaped() . '</span></td>';
1187 $row .= '<td dir="' . $wgContLang->getDir() . '">' . Linker
::formatComment( $description, $this->title
) . '</td>';
1191 wfRunHooks( 'ImagePageFileHistoryLine', array( $this, $file, &$row, &$rowClass ) );
1192 $classAttr = $rowClass ?
" class='$rowClass'" : '';
1194 return "<tr{$classAttr}>{$row}</tr>\n";
1201 protected function getThumbForLine( $file ) {
1202 $lang = $this->getLanguage();
1203 $user = $this->getUser();
1204 if ( $file->allowInlineDisplay() && $file->userCan( File
::DELETED_FILE
, $user )
1205 && !$file->isDeleted( File
::DELETED_FILE
) )
1211 $timestamp = wfTimestamp( TS_MW
, $file->getTimestamp() );
1213 $thumbnail = $file->transform( $params );
1215 'alt' => $this->msg( 'filehist-thumbtext',
1216 $lang->userTimeAndDate( $timestamp, $user ),
1217 $lang->userDate( $timestamp, $user ),
1218 $lang->userTime( $timestamp, $user ) )->text(),
1219 'file-link' => true,
1222 if ( !$thumbnail ) {
1223 return $this->msg( 'filehist-nothumb' )->escaped();
1226 return $thumbnail->toHtml( $options );
1228 return $this->msg( 'filehist-nothumb' )->escaped();
1233 * @param $enable bool
1235 protected function preventClickjacking( $enable = true ) {
1236 $this->preventClickjacking
= $enable;
1242 public function getPreventClickjacking() {
1243 return $this->preventClickjacking
;
1247 class ImageHistoryPseudoPager
extends ReverseChronologicalPager
{
1248 protected $preventClickjacking = false;
1261 * @param ImagePage $imagePage
1263 function __construct( $imagePage ) {
1264 parent
::__construct( $imagePage->getContext() );
1265 $this->mImagePage
= $imagePage;
1266 $this->mTitle
= clone ( $imagePage->getTitle() );
1267 $this->mTitle
->setFragment( '#filehistory' );
1269 $this->mHist
= array();
1270 $this->mRange
= array( 0, 0 ); // display range
1276 function getTitle() {
1277 return $this->mTitle
;
1280 function getQueryInfo() {
1287 function getIndexField() {
1292 * @param $row object
1295 function formatRow( $row ) {
1302 function getBody() {
1305 if ( count( $this->mHist
) ) {
1306 $list = new ImageHistoryList( $this->mImagePage
);
1307 # Generate prev/next links
1308 $navLink = $this->getNavigationBar();
1309 $s = $list->beginImageHistoryList( $navLink );
1310 // Skip rows there just for paging links
1311 for ( $i = $this->mRange
[0]; $i <= $this->mRange
[1]; $i++
) {
1312 $file = $this->mHist
[$i];
1313 $s .= $list->imageHistoryLine( !$file->isOld(), $file );
1315 $s .= $list->endImageHistoryList( $navLink );
1317 if ( $list->getPreventClickjacking() ) {
1318 $this->preventClickjacking();
1324 function doQuery() {
1325 if ( $this->mQueryDone
) {
1328 $this->mImg
= $this->mImagePage
->getFile(); // ensure loading
1329 if ( !$this->mImg
->exists() ) {
1332 $queryLimit = $this->mLimit +
1; // limit plus extra row
1333 if ( $this->mIsBackwards
) {
1334 // Fetch the file history
1335 $this->mHist
= $this->mImg
->getHistory( $queryLimit, null, $this->mOffset
, false );
1336 // The current rev may not meet the offset/limit
1337 $numRows = count( $this->mHist
);
1338 if ( $numRows <= $this->mLimit
&& $this->mImg
->getTimestamp() > $this->mOffset
) {
1339 $this->mHist
= array_merge( array( $this->mImg
), $this->mHist
);
1342 // The current rev may not meet the offset
1343 if ( !$this->mOffset ||
$this->mImg
->getTimestamp() < $this->mOffset
) {
1344 $this->mHist
[] = $this->mImg
;
1346 // Old image versions (fetch extra row for nav links)
1347 $oiLimit = count( $this->mHist
) ?
$this->mLimit
: $this->mLimit +
1;
1348 // Fetch the file history
1349 $this->mHist
= array_merge( $this->mHist
,
1350 $this->mImg
->getHistory( $oiLimit, $this->mOffset
, null, false ) );
1352 $numRows = count( $this->mHist
); // Total number of query results
1354 # Index value of top item in the list
1355 $firstIndex = $this->mIsBackwards ?
1356 $this->mHist
[$numRows - 1]->getTimestamp() : $this->mHist
[0]->getTimestamp();
1357 # Discard the extra result row if there is one
1358 if ( $numRows > $this->mLimit
&& $numRows > 1 ) {
1359 if ( $this->mIsBackwards
) {
1360 # Index value of item past the index
1361 $this->mPastTheEndIndex
= $this->mHist
[0]->getTimestamp();
1362 # Index value of bottom item in the list
1363 $lastIndex = $this->mHist
[1]->getTimestamp();
1365 $this->mRange
= array( 1, $numRows - 1 );
1367 # Index value of item past the index
1368 $this->mPastTheEndIndex
= $this->mHist
[$numRows - 1]->getTimestamp();
1369 # Index value of bottom item in the list
1370 $lastIndex = $this->mHist
[$numRows - 2]->getTimestamp();
1372 $this->mRange
= array( 0, $numRows - 2 );
1375 # Setting indexes to an empty string means that they will be
1376 # omitted if they would otherwise appear in URLs. It just so
1377 # happens that this is the right thing to do in the standard
1378 # UI, in all the relevant cases.
1379 $this->mPastTheEndIndex
= '';
1380 # Index value of bottom item in the list
1381 $lastIndex = $this->mIsBackwards ?
1382 $this->mHist
[0]->getTimestamp() : $this->mHist
[$numRows - 1]->getTimestamp();
1384 $this->mRange
= array( 0, $numRows - 1 );
1389 $this->mPastTheEndIndex
= '';
1391 if ( $this->mIsBackwards
) {
1392 $this->mIsFirst
= ( $numRows < $queryLimit );
1393 $this->mIsLast
= ( $this->mOffset
== '' );
1394 $this->mLastShown
= $firstIndex;
1395 $this->mFirstShown
= $lastIndex;
1397 $this->mIsFirst
= ( $this->mOffset
== '' );
1398 $this->mIsLast
= ( $numRows < $queryLimit );
1399 $this->mLastShown
= $lastIndex;
1400 $this->mFirstShown
= $firstIndex;
1402 $this->mQueryDone
= true;
1406 * @param $enable bool
1408 protected function preventClickjacking( $enable = true ) {
1409 $this->preventClickjacking
= $enable;
1415 public function getPreventClickjacking() {
1416 return $this->preventClickjacking
;