Add a few bits of parameter documentation
[lhc/web/wiklou.git] / includes / ImagePage.php
1 <?php
2
3 if ( !defined( 'MEDIAWIKI' ) )
4 die( 1 );
5
6 /**
7 * Special handling for image description pages
8 *
9 * @ingroup Media
10 */
11 class ImagePage extends Article {
12
13 /* private */ var $img; // Image object
14 /* private */ var $displayImg;
15 /* private */ var $repo;
16 /* private */ var $fileLoaded;
17 var $mExtraDescription = false;
18 var $dupes;
19
20 function __construct( $title ) {
21 parent::__construct( $title );
22 $this->dupes = null;
23 $this->repo = null;
24 }
25
26 /**
27 * @param $file File:
28 * @return void
29 */
30 public function setFile( $file ) {
31 $this->displayImg = $file;
32 $this->img = $file;
33 $this->fileLoaded = true;
34 }
35
36 protected function loadFile() {
37 if ( $this->fileLoaded ) {
38 return true;
39 }
40 $this->fileLoaded = true;
41
42 $this->displayImg = $this->img = false;
43 wfRunHooks( 'ImagePageFindFile', array( $this, &$this->img, &$this->displayImg ) );
44 if ( !$this->img ) {
45 $this->img = wfFindFile( $this->mTitle );
46 if ( !$this->img ) {
47 $this->img = wfLocalFile( $this->mTitle );
48 }
49 }
50 if ( !$this->displayImg ) {
51 $this->displayImg = $this->img;
52 }
53 $this->repo = $this->img->getRepo();
54 }
55
56 /**
57 * Handler for action=render
58 * Include body text only; none of the image extras
59 */
60 public function render() {
61 global $wgOut;
62 $wgOut->setArticleBodyOnly( true );
63 parent::view();
64 }
65
66 public function view() {
67 global $wgOut, $wgShowEXIF, $wgRequest, $wgUser;
68
69 $diff = $wgRequest->getVal( 'diff' );
70 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
71
72 if ( $this->mTitle->getNamespace() != NS_FILE || ( isset( $diff ) && $diffOnly ) ) {
73 return parent::view();
74 }
75
76 $this->loadFile();
77
78 if ( $this->mTitle->getNamespace() == NS_FILE && $this->img->getRedirected() ) {
79 if ( $this->mTitle->getDBkey() == $this->img->getName() || isset( $diff ) ) {
80 // mTitle is the same as the redirect target so ask Article
81 // to perform the redirect for us.
82 $wgRequest->setVal( 'diffonly', 'true' );
83 return parent::view();
84 } else {
85 // mTitle is not the same as the redirect target so it is
86 // probably the redirect page itself. Fake the redirect symbol
87 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
88 $wgOut->addHTML( $this->viewRedirect( Title::makeTitle( NS_FILE, $this->img->getName() ),
89 /* $appendSubtitle */ true, /* $forceKnown */ true ) );
90 $this->viewUpdates();
91 return;
92 }
93 }
94
95 $this->showRedirectedFromHeader();
96
97 if ( $wgShowEXIF && $this->displayImg->exists() ) {
98 // FIXME: bad interface, see note on MediaHandler::formatMetadata().
99 $formattedMetadata = $this->displayImg->formatMetadata();
100 $showmeta = $formattedMetadata !== false;
101 } else {
102 $showmeta = false;
103 }
104
105 if ( !$diff && $this->displayImg->exists() )
106 $wgOut->addHTML( $this->showTOC( $showmeta ) );
107
108 if ( !$diff )
109 $this->openShowImage();
110
111 # No need to display noarticletext, we use our own message, output in openShowImage()
112 if ( $this->getID() ) {
113 parent::view();
114 } else {
115 # Just need to set the right headers
116 $wgOut->setArticleFlag( true );
117 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
118 $this->viewUpdates();
119 }
120
121 # Show shared description, if needed
122 if ( $this->mExtraDescription ) {
123 $fol = wfMsgNoTrans( 'shareddescriptionfollows' );
124 if ( $fol != '-' && !wfEmptyMsg( 'shareddescriptionfollows', $fol ) ) {
125 $wgOut->addWikiText( $fol );
126 }
127 $wgOut->addHTML( '<div id="shared-image-desc">' . $this->mExtraDescription . "</div>\n" );
128 }
129
130 $this->closeShowImage();
131 $this->imageHistory();
132 // TODO: Cleanup the following
133
134 $wgOut->addHTML( Xml::element( 'h2',
135 array( 'id' => 'filelinks' ),
136 wfMsg( 'imagelinks' ) ) . "\n" );
137 $this->imageDupes();
138 # TODO! FIXME! For some freaky reason, we can't redirect to foreign images.
139 # Yet we return metadata about the target. Definitely an issue in the FileRepo
140 $this->imageRedirects();
141 $this->imageLinks();
142
143 # Allow extensions to add something after the image links
144 $html = '';
145 wfRunHooks( 'ImagePageAfterImageLinks', array( $this, &$html ) );
146 if ( $html )
147 $wgOut->addHTML( $html );
148
149 if ( $showmeta ) {
150 $wgOut->addHTML( Xml::element( 'h2', array( 'id' => 'metadata' ), wfMsg( 'metadata' ) ) . "\n" );
151 $wgOut->addWikiText( $this->makeMetadataTable( $formattedMetadata ) );
152 $wgOut->addModules( array( 'mediawiki.legacy.metadata' ) );
153 }
154
155 $css = $this->repo->getDescriptionStylesheetUrl();
156 if ( $css ) {
157 $wgOut->addStyle( $css );
158 }
159 }
160
161 public function getRedirectTarget() {
162 $this->loadFile();
163 if ( $this->img->isLocal() ) {
164 return parent::getRedirectTarget();
165 }
166 // Foreign image page
167 $from = $this->img->getRedirected();
168 $to = $this->img->getName();
169 if ( $from == $to ) {
170 return null;
171 }
172 return $this->mRedirectTarget = Title::makeTitle( NS_FILE, $to );
173 }
174 public function followRedirect() {
175 $this->loadFile();
176 if ( $this->img->isLocal() ) {
177 return parent::followRedirect();
178 }
179 $from = $this->img->getRedirected();
180 $to = $this->img->getName();
181 if ( $from == $to ) {
182 return false;
183 }
184 return Title::makeTitle( NS_FILE, $to );
185 }
186 public function isRedirect( $text = false ) {
187 $this->loadFile();
188 if ( $this->img->isLocal() )
189 return parent::isRedirect( $text );
190
191 return (bool)$this->img->getRedirected();
192 }
193
194 public function isLocal() {
195 $this->loadFile();
196 return $this->img->isLocal();
197 }
198
199 public function getFile() {
200 $this->loadFile();
201 return $this->img;
202 }
203
204 public function getDisplayedFile() {
205 $this->loadFile();
206 return $this->displayImg;
207 }
208
209 public function getDuplicates() {
210 $this->loadFile();
211 if ( !is_null( $this->dupes ) ) {
212 return $this->dupes;
213 }
214 if ( !( $hash = $this->img->getSha1() ) ) {
215 return $this->dupes = array();
216 }
217 $dupes = RepoGroup::singleton()->findBySha1( $hash );
218 // Remove duplicates with self and non matching file sizes
219 $self = $this->img->getRepoName() . ':' . $this->img->getName();
220 $size = $this->img->getSize();
221 foreach ( $dupes as $index => $file ) {
222 $key = $file->getRepoName() . ':' . $file->getName();
223 if ( $key == $self )
224 unset( $dupes[$index] );
225 if ( $file->getSize() != $size )
226 unset( $dupes[$index] );
227 }
228 return $this->dupes = $dupes;
229
230 }
231
232
233 /**
234 * Create the TOC
235 *
236 * @param $metadata Boolean: whether or not to show the metadata link
237 * @return String
238 */
239 protected function showTOC( $metadata ) {
240 $r = array(
241 '<li><a href="#file">' . wfMsgHtml( 'file-anchor-link' ) . '</a></li>',
242 '<li><a href="#filehistory">' . wfMsgHtml( 'filehist' ) . '</a></li>',
243 '<li><a href="#filelinks">' . wfMsgHtml( 'imagelinks' ) . '</a></li>',
244 );
245 if ( $metadata ) {
246 $r[] = '<li><a href="#metadata">' . wfMsgHtml( 'metadata' ) . '</a></li>';
247 }
248
249 wfRunHooks( 'ImagePageShowTOC', array( $this, &$r ) );
250
251 return '<ul id="filetoc">' . implode( "\n", $r ) . '</ul>';
252 }
253
254 /**
255 * Make a table with metadata to be shown in the output page.
256 *
257 * FIXME: bad interface, see note on MediaHandler::formatMetadata().
258 *
259 * @param $metadata Array: the array containing the EXIF data
260 * @return String
261 */
262 protected function makeMetadataTable( $metadata ) {
263 $r = "<div class=\"mw-imagepage-section-metadata\">";
264 $r .= wfMsgNoTrans( 'metadata-help' );
265 $r .= "<table id=\"mw_metadata\" class=\"mw_metadata\">\n";
266 foreach ( $metadata as $type => $stuff ) {
267 foreach ( $stuff as $v ) {
268 # FIXME, why is this using escapeId for a class?!
269 $class = Sanitizer::escapeId( $v['id'] );
270 if ( $type == 'collapsed' ) {
271 $class .= ' collapsable';
272 }
273 $r .= "<tr class=\"$class\">\n";
274 $r .= "<th>{$v['name']}</th>\n";
275 $r .= "<td>{$v['value']}</td>\n</tr>";
276 }
277 }
278 $r .= "</table>\n</div>\n";
279 return $r;
280 }
281
282 /**
283 * Overloading Article's getContent method.
284 *
285 * Omit noarticletext if sharedupload; text will be fetched from the
286 * shared upload server if possible.
287 */
288 public function getContent() {
289 $this->loadFile();
290 if ( $this->img && !$this->img->isLocal() && 0 == $this->getID() ) {
291 return '';
292 }
293 return Article::getContent();
294 }
295
296 protected function openShowImage() {
297 global $wgOut, $wgUser, $wgImageLimits, $wgRequest,
298 $wgLang, $wgContLang, $wgEnableUploads;
299
300 $this->loadFile();
301
302 $full_url = $this->displayImg->getURL();
303 $sizeSel = intval( $wgUser->getOption( 'imagesize' ) );
304 if ( !isset( $wgImageLimits[$sizeSel] ) ) {
305 $sizeSel = User::getDefaultOption( 'imagesize' );
306
307 // The user offset might still be incorrect, specially if
308 // $wgImageLimits got changed (see bug #8858).
309 if ( !isset( $wgImageLimits[$sizeSel] ) ) {
310 // Default to the first offset in $wgImageLimits
311 $sizeSel = 0;
312 }
313 }
314 $max = $wgImageLimits[$sizeSel];
315 $maxWidth = $max[0];
316 $maxHeight = $max[1];
317 $sk = $wgUser->getSkin();
318 $dirmark = $wgContLang->getDirMark();
319
320 if ( $this->displayImg->exists() ) {
321 # image
322 $page = $wgRequest->getIntOrNull( 'page' );
323 if ( is_null( $page ) ) {
324 $params = array();
325 $page = 1;
326 } else {
327 $params = array( 'page' => $page );
328 }
329 $width_orig = $this->displayImg->getWidth( $page );
330 $width = $width_orig;
331 $height_orig = $this->displayImg->getHeight( $page );
332 $height = $height_orig;
333
334 $longDesc = $this->displayImg->getLongDesc();
335
336 wfRunHooks( 'ImageOpenShowImageInlineBefore', array( &$this, &$wgOut ) );
337
338 if ( $this->displayImg->allowInlineDisplay() ) {
339 # image
340
341 # "Download high res version" link below the image
342 # $msgsize = wfMsgHtml('file-info-size', $width_orig, $height_orig, $sk->formatSize( $this->displayImg->getSize() ), $mime );
343 # We'll show a thumbnail of this image
344 if ( $width > $maxWidth || $height > $maxHeight ) {
345 # Calculate the thumbnail size.
346 # First case, the limiting factor is the width, not the height.
347 if ( $width / $height >= $maxWidth / $maxHeight ) {
348 $height = round( $height * $maxWidth / $width );
349 $width = $maxWidth;
350 # Note that $height <= $maxHeight now.
351 } else {
352 $newwidth = floor( $width * $maxHeight / $height );
353 $height = round( $height * $newwidth / $width );
354 $width = $newwidth;
355 # Note that $height <= $maxHeight now, but might not be identical
356 # because of rounding.
357 }
358 $msgbig = wfMsgHtml( 'show-big-image' );
359 $msgsmall = wfMsgExt( 'show-big-image-thumb', 'parseinline',
360 $wgLang->formatNum( $width ),
361 $wgLang->formatNum( $height )
362 );
363 } else {
364 # Image is small enough to show full size on image page
365 $msgsmall = wfMsgExt( 'file-nohires', array( 'parseinline' ) );
366 }
367
368 $params['width'] = $width;
369 $thumbnail = $this->displayImg->transform( $params );
370
371 $showLink = true;
372 $anchorclose = '';
373 if ( !$this->displayImg->mustRender() ) {
374 $anchorclose = "<br />" . $msgsmall;
375 }
376
377 $isMulti = $this->displayImg->isMultipage() && $this->displayImg->pageCount() > 1;
378 if ( $isMulti ) {
379 $wgOut->addHTML( '<table class="multipageimage"><tr><td>' );
380 }
381
382 if ( $thumbnail ) {
383 $options = array(
384 'alt' => $this->displayImg->getTitle()->getPrefixedText(),
385 'file-link' => true,
386 );
387 $wgOut->addHTML( '<div class="fullImageLink" id="file">' .
388 $thumbnail->toHtml( $options ) .
389 $anchorclose . "</div>\n" );
390 }
391
392 if ( $isMulti ) {
393 $count = $this->displayImg->pageCount();
394
395 if ( $page > 1 ) {
396 $label = $wgOut->parse( wfMsg( 'imgmultipageprev' ), false );
397 $link = $sk->link(
398 $this->mTitle,
399 $label,
400 array(),
401 array( 'page' => $page - 1 ),
402 array( 'known', 'noclasses' )
403 );
404 $thumb1 = $sk->makeThumbLinkObj( $this->mTitle, $this->displayImg, $link, $label, 'none',
405 array( 'page' => $page - 1 ) );
406 } else {
407 $thumb1 = '';
408 }
409
410 if ( $page < $count ) {
411 $label = wfMsg( 'imgmultipagenext' );
412 $link = $sk->link(
413 $this->mTitle,
414 $label,
415 array(),
416 array( 'page' => $page + 1 ),
417 array( 'known', 'noclasses' )
418 );
419 $thumb2 = $sk->makeThumbLinkObj( $this->mTitle, $this->displayImg, $link, $label, 'none',
420 array( 'page' => $page + 1 ) );
421 } else {
422 $thumb2 = '';
423 }
424
425 global $wgScript;
426
427 $formParams = array(
428 'name' => 'pageselector',
429 'action' => $wgScript,
430 'onchange' => 'document.pageselector.submit();',
431 );
432
433 for ( $i = 1; $i <= $count; $i++ ) {
434 $options[] = Xml::option( $wgLang->formatNum( $i ), $i, $i == $page );
435 }
436 $select = Xml::tags( 'select',
437 array( 'id' => 'pageselector', 'name' => 'page' ),
438 implode( "\n", $options ) );
439
440 $wgOut->addHTML(
441 '</td><td><div class="multipageimagenavbox">' .
442 Xml::openElement( 'form', $formParams ) .
443 Html::hidden( 'title', $this->getTitle()->getPrefixedDbKey() ) .
444 wfMsgExt( 'imgmultigoto', array( 'parseinline', 'replaceafter' ), $select ) .
445 Xml::submitButton( wfMsg( 'imgmultigo' ) ) .
446 Xml::closeElement( 'form' ) .
447 "<hr />$thumb1\n$thumb2<br clear=\"all\" /></div></td></tr></table>"
448 );
449 }
450 } else {
451 # if direct link is allowed but it's not a renderable image, show an icon.
452 if ( $this->displayImg->isSafeFile() ) {
453 $icon = $this->displayImg->iconThumb();
454
455 $wgOut->addHTML( '<div class="fullImageLink" id="file">' .
456 $icon->toHtml( array( 'file-link' => true ) ) .
457 "</div>\n" );
458 }
459
460 $showLink = true;
461 }
462
463
464 if ( $showLink ) {
465 $filename = wfEscapeWikiText( $this->displayImg->getName() );
466 $linktext = $filename;
467 if ( isset( $msgbig ) ) {
468 $linktext = wfEscapeWikiText( $msgbig );
469 }
470 $medialink = "[[Media:$filename|$linktext]]";
471
472 if ( !$this->displayImg->isSafeFile() ) {
473 $warning = wfMsgNoTrans( 'mediawarning' );
474 $wgOut->addWikiText( <<<EOT
475 <div class="fullMedia"><span class="dangerousLink">{$medialink}</span>$dirmark <span class="fileInfo">$longDesc</span></div>
476 <div class="mediaWarning">$warning</div>
477 EOT
478 );
479 } else {
480 $wgOut->addWikiText( <<<EOT
481 <div class="fullMedia">{$medialink}{$dirmark} <span class="fileInfo">$longDesc</span>
482 </div>
483 EOT
484 );
485 }
486 }
487
488 if ( !$this->displayImg->isLocal() ) {
489 $this->printSharedImageText();
490 }
491 } else {
492 # Image does not exist
493 if ( $wgEnableUploads && $wgUser->isAllowed( 'upload' ) ) {
494 // Only show an upload link if the user can upload
495 $uploadTitle = SpecialPage::getTitleFor( 'Upload' );
496 $nofile = array(
497 'filepage-nofile-link',
498 $uploadTitle->getFullUrl( array( 'wpDestFile' => $this->img->getName() ) )
499 );
500 }
501 else
502 {
503 $nofile = 'filepage-nofile';
504 }
505 $wgOut->setRobotPolicy( 'noindex,nofollow' );
506 $wgOut->wrapWikiMsg( "<div id='mw-imagepage-nofile' class='plainlinks'>\n$1\n</div>", $nofile );
507 }
508 }
509
510 /**
511 * Show a notice that the file is from a shared repository
512 */
513 protected function printSharedImageText() {
514 global $wgOut;
515
516 $this->loadFile();
517
518 $descUrl = $this->img->getDescriptionUrl();
519 $descText = $this->img->getDescriptionText();
520
521 $wrap = "<div class=\"sharedUploadNotice\">\n$1\n</div>\n";
522 $repo = $this->img->getRepo()->getDisplayName();
523
524 if ( $descUrl && $descText && wfMsgNoTrans( 'sharedupload-desc-here' ) !== '-' ) {
525 $wgOut->wrapWikiMsg( $wrap, array( 'sharedupload-desc-here', $repo, $descUrl ) );
526 } elseif ( $descUrl && wfMsgNoTrans( 'sharedupload-desc-there' ) !== '-' ) {
527 $wgOut->wrapWikiMsg( $wrap, array( 'sharedupload-desc-there', $repo, $descUrl ) );
528 } else {
529 $wgOut->wrapWikiMsg( $wrap, array( 'sharedupload', $repo ), ''/*BACKCOMPAT*/ );
530 }
531
532 if ( $descText ) {
533 $this->mExtraDescription = $descText;
534 }
535 }
536
537 public function getUploadUrl() {
538 $this->loadFile();
539 $uploadTitle = SpecialPage::getTitleFor( 'Upload' );
540 return $uploadTitle->getFullUrl( array(
541 'wpDestFile' => $this->img->getName(),
542 'wpForReUpload' => 1
543 ) );
544 }
545
546 /**
547 * Print out the various links at the bottom of the image page, e.g. reupload,
548 * external editing (and instructions link) etc.
549 */
550 protected function uploadLinksBox() {
551 global $wgUser, $wgOut, $wgEnableUploads, $wgUseExternalEditor;
552
553 if ( !$wgEnableUploads ) { return; }
554
555 $this->loadFile();
556 if ( !$this->img->isLocal() )
557 return;
558
559 $sk = $wgUser->getSkin();
560
561 $wgOut->addHTML( "<br /><ul>\n" );
562
563 # "Upload a new version of this file" link
564 if ( UploadBase::userCanReUpload( $wgUser, $this->img->name ) ) {
565 $ulink = $sk->makeExternalLink( $this->getUploadUrl(), wfMsg( 'uploadnewversion-linktext' ) );
566 $wgOut->addHTML( "<li id=\"mw-imagepage-reupload-link\"><div class=\"plainlinks\">{$ulink}</div></li>\n" );
567 }
568
569 # External editing link
570 if ( $wgUseExternalEditor ) {
571 $elink = $sk->link(
572 $this->mTitle,
573 wfMsgHtml( 'edit-externally' ),
574 array(),
575 array(
576 'action' => 'edit',
577 'externaledit' => 'true',
578 'mode' => 'file'
579 ),
580 array( 'known', 'noclasses' )
581 );
582 $wgOut->addHTML( '<li id="mw-imagepage-edit-external">' . $elink . ' <small>' . wfMsgExt( 'edit-externally-help', array( 'parseinline' ) ) . "</small></li>\n" );
583 }
584
585 $wgOut->addHTML( "</ul>\n" );
586 }
587
588 protected function closeShowImage() { } # For overloading
589
590 /**
591 * If the page we've just displayed is in the "Image" namespace,
592 * we follow it with an upload history of the image and its usage.
593 */
594 protected function imageHistory() {
595 global $wgOut;
596
597 $this->loadFile();
598 $pager = new ImageHistoryPseudoPager( $this );
599 $wgOut->addHTML( $pager->getBody() );
600
601 $this->img->resetHistory(); // free db resources
602
603 # Exist check because we don't want to show this on pages where an image
604 # doesn't exist along with the noimage message, that would suck. -ævar
605 if ( $this->img->exists() ) {
606 $this->uploadLinksBox();
607 }
608 }
609
610 protected function imageLinks() {
611 global $wgUser, $wgOut, $wgLang;
612
613 $limit = 100;
614
615 $dbr = wfGetDB( DB_SLAVE );
616
617 $res = $dbr->select(
618 array( 'imagelinks', 'page' ),
619 array( 'page_namespace', 'page_title' ),
620 array( 'il_to' => $this->mTitle->getDBkey(), 'il_from = page_id' ),
621 __METHOD__,
622 array( 'LIMIT' => $limit + 1 )
623 );
624 $count = $dbr->numRows( $res );
625 if ( $count == 0 ) {
626 $wgOut->wrapWikiMsg( Html::rawElement( 'div', array ( 'id' => 'mw-imagepage-nolinkstoimage' ), "\n$1\n" ), 'nolinkstoimage' );
627 return;
628 }
629
630 $wgOut->addHTML( "<div id='mw-imagepage-section-linkstoimage'>\n" );
631 if ( $count <= $limit - 1 ) {
632 $wgOut->addWikiMsg( 'linkstoimage', $count );
633 } else {
634 // More links than the limit. Add a link to [[Special:Whatlinkshere]]
635 $wgOut->addWikiMsg( 'linkstoimage-more',
636 $wgLang->formatNum( $limit ),
637 $this->mTitle->getPrefixedDBkey()
638 );
639 }
640
641 $wgOut->addHTML( Html::openElement( 'ul', array( 'class' => 'mw-imagepage-linkstoimage' ) ) . "\n" );
642 $sk = $wgUser->getSkin();
643 $count = 0;
644 $elements = array();
645 foreach ( $res as $s ) {
646 $count++;
647 if ( $count <= $limit ) {
648 // We have not yet reached the extra one that tells us there is more to fetch
649 $elements[] = $s;
650 }
651 }
652
653 // Sort the list by namespace:title
654 usort ( $elements, array( $this, 'compare' ) );
655
656 // Create links for every element
657 foreach( $elements as $element ) {
658 $link = $sk->linkKnown( Title::makeTitle( $element->page_namespace, $element->page_title ) );
659 $wgOut->addHTML( Html::rawElement(
660 'li',
661 array( 'id' => 'mw-imagepage-linkstoimage-ns' . $element->page_namespace ),
662 $link
663 ) . "\n"
664 );
665
666 };
667 $wgOut->addHTML( Html::closeElement( 'ul' ) . "\n" );
668 $res->free();
669
670 // Add a links to [[Special:Whatlinkshere]]
671 if ( $count > $limit ) {
672 $wgOut->addWikiMsg( 'morelinkstoimage', $this->mTitle->getPrefixedDBkey() );
673 }
674 $wgOut->addHTML( Html::closeElement( 'div' ) . "\n" );
675 }
676
677 protected function imageRedirects() {
678 global $wgUser, $wgOut, $wgLang;
679
680 $redirects = $this->getTitle()->getRedirectsHere( NS_FILE );
681 if ( count( $redirects ) == 0 ) return;
682
683 $wgOut->addHTML( "<div id='mw-imagepage-section-redirectstofile'>\n" );
684 $wgOut->addWikiMsg( 'redirectstofile',
685 $wgLang->formatNum( count( $redirects ) )
686 );
687 $wgOut->addHTML( "<ul class='mw-imagepage-redirectstofile'>\n" );
688
689 $sk = $wgUser->getSkin();
690 foreach ( $redirects as $title ) {
691 $link = $sk->link(
692 $title,
693 null,
694 array(),
695 array( 'redirect' => 'no' ),
696 array( 'known', 'noclasses' )
697 );
698 $wgOut->addHTML( "<li>{$link}</li>\n" );
699 }
700 $wgOut->addHTML( "</ul></div>\n" );
701
702 }
703
704 protected function imageDupes() {
705 global $wgOut, $wgUser, $wgLang;
706
707 $this->loadFile();
708
709 $dupes = $this->getDuplicates();
710 if ( count( $dupes ) == 0 ) return;
711
712 $wgOut->addHTML( "<div id='mw-imagepage-section-duplicates'>\n" );
713 $wgOut->addWikiMsg( 'duplicatesoffile',
714 $wgLang->formatNum( count( $dupes ) ), $this->mTitle->getDBkey()
715 );
716 $wgOut->addHTML( "<ul class='mw-imagepage-duplicates'>\n" );
717
718 $sk = $wgUser->getSkin();
719 foreach ( $dupes as $file ) {
720 $fromSrc = '';
721 if ( $file->isLocal() ) {
722 $link = $sk->link(
723 $file->getTitle(),
724 null,
725 array(),
726 array(),
727 array( 'known', 'noclasses' )
728 );
729 } else {
730 $link = $sk->makeExternalLink( $file->getDescriptionUrl(),
731 $file->getTitle()->getPrefixedText() );
732 $fromSrc = wfMsg( 'shared-repo-from', $file->getRepo()->getDisplayName() );
733 }
734 $wgOut->addHTML( "<li>{$link} {$fromSrc}</li>\n" );
735 }
736 $wgOut->addHTML( "</ul></div>\n" );
737 }
738
739 /**
740 * Delete the file, or an earlier version of it
741 */
742 public function delete() {
743 global $wgUploadMaintenance;
744 if ( $wgUploadMaintenance && $this->mTitle && $this->mTitle->getNamespace() == NS_FILE ) {
745 global $wgOut;
746 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n", array( 'filedelete-maintenance' ) );
747 return;
748 }
749
750 $this->loadFile();
751 if ( !$this->img->exists() || !$this->img->isLocal() || $this->img->getRedirected() ) {
752 // Standard article deletion
753 parent::delete();
754 return;
755 }
756 $deleter = new FileDeleteForm( $this->img );
757 $deleter->execute();
758 }
759
760 /**
761 * Revert the file to an earlier version
762 */
763 public function revert() {
764 $this->loadFile();
765 $reverter = new FileRevertForm( $this->img );
766 $reverter->execute();
767 }
768
769 /**
770 * Override handling of action=purge
771 */
772 public function doPurge() {
773 $this->loadFile();
774 if ( $this->img->exists() ) {
775 wfDebug( "ImagePage::doPurge purging " . $this->img->getName() . "\n" );
776 $update = new HTMLCacheUpdate( $this->mTitle, 'imagelinks' );
777 $update->doUpdate();
778 $this->img->upgradeRow();
779 $this->img->purgeCache();
780 } else {
781 wfDebug( "ImagePage::doPurge no image for " . $this->img->getName() . "; limiting purge to cache only\n" );
782 // even if the file supposedly doesn't exist, force any cached information
783 // to be updated (in case the cached information is wrong)
784 $this->img->purgeCache();
785 }
786 parent::doPurge();
787 }
788
789 /**
790 * Display an error with a wikitext description
791 */
792 function showError( $description ) {
793 global $wgOut;
794 $wgOut->setPageTitle( wfMsg( "internalerror" ) );
795 $wgOut->setRobotPolicy( "noindex,nofollow" );
796 $wgOut->setArticleRelated( false );
797 $wgOut->enableClientCache( false );
798 $wgOut->addWikiText( $description );
799 }
800
801
802 /**
803 * Callback for usort() to do link sorts by (namespace, title)
804 * Function copied from Title::compare()
805 *
806 * @param $a object page to compare with
807 * @param $b object page to compare with
808 * @return Integer: result of string comparison, or namespace comparison
809 */
810 protected function compare( $a, $b ) {
811 if ( $a->page_namespace == $b->page_namespace ) {
812 return strcmp( $a->page_title, $b->page_title );
813 } else {
814 return $a->page_namespace - $b->page_namespace;
815 }
816 }
817 }
818
819 /**
820 * Builds the image revision log shown on image pages
821 *
822 * @ingroup Media
823 */
824 class ImageHistoryList {
825
826 protected $imagePage, $img, $skin, $title, $repo, $showThumb;
827
828 public function __construct( $imagePage ) {
829 global $wgUser, $wgShowArchiveThumbnails;
830 $this->skin = $wgUser->getSkin();
831 $this->current = $imagePage->getFile();
832 $this->img = $imagePage->getDisplayedFile();
833 $this->title = $imagePage->getTitle();
834 $this->imagePage = $imagePage;
835 $this->showThumb = $wgShowArchiveThumbnails && $this->img->canRender();
836 }
837
838 public function getImagePage() {
839 return $this->imagePage;
840 }
841
842 public function getSkin() {
843 return $this->skin;
844 }
845
846 public function getFile() {
847 return $this->img;
848 }
849
850 public function beginImageHistoryList( $navLinks = '' ) {
851 global $wgOut, $wgUser;
852 return Xml::element( 'h2', array( 'id' => 'filehistory' ), wfMsg( 'filehist' ) ) . "\n"
853 . "<div id=\"mw-imagepage-section-filehistory\">\n"
854 . $wgOut->parse( wfMsgNoTrans( 'filehist-help' ) )
855 . $navLinks . "\n"
856 . Xml::openElement( 'table', array( 'class' => 'wikitable filehistory' ) ) . "\n"
857 . '<tr><td></td>'
858 . ( $this->current->isLocal() && ( $wgUser->isAllowed( 'delete' ) || $wgUser->isAllowed( 'deletedhistory' ) ) ? '<td></td>' : '' )
859 . '<th>' . wfMsgHtml( 'filehist-datetime' ) . '</th>'
860 . ( $this->showThumb ? '<th>' . wfMsgHtml( 'filehist-thumb' ) . '</th>' : '' )
861 . '<th>' . wfMsgHtml( 'filehist-dimensions' ) . '</th>'
862 . '<th>' . wfMsgHtml( 'filehist-user' ) . '</th>'
863 . '<th>' . wfMsgHtml( 'filehist-comment' ) . '</th>'
864 . "</tr>\n";
865 }
866
867 public function endImageHistoryList( $navLinks = '' ) {
868 return "</table>\n$navLinks\n</div>\n";
869 }
870
871 public function imageHistoryLine( $iscur, $file ) {
872 global $wgUser, $wgLang;
873
874 $timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
875 $img = $iscur ? $file->getName() : $file->getArchiveName();
876 $user = $file->getUser( 'id' );
877 $usertext = $file->getUser( 'text' );
878 $description = $file->getDescription();
879
880 $local = $this->current->isLocal();
881 $row = $selected = '';
882
883 // Deletion link
884 if ( $local && ( $wgUser->isAllowed( 'delete' ) || $wgUser->isAllowed( 'deletedhistory' ) ) ) {
885 $row .= '<td>';
886 # Link to remove from history
887 if ( $wgUser->isAllowed( 'delete' ) ) {
888 $q = array( 'action' => 'delete' );
889 if ( !$iscur )
890 $q['oldimage'] = $img;
891 $row .= $this->skin->link(
892 $this->title,
893 wfMsgHtml( $iscur ? 'filehist-deleteall' : 'filehist-deleteone' ),
894 array(), $q, array( 'known' )
895 );
896 }
897 # Link to hide content. Don't show useless link to people who cannot hide revisions.
898 $canHide = $wgUser->isAllowed( 'deleterevision' );
899 if ( $canHide || ( $wgUser->isAllowed( 'deletedhistory' ) && $file->getVisibility() ) ) {
900 if ( $wgUser->isAllowed( 'delete' ) ) {
901 $row .= '<br />';
902 }
903 // If file is top revision or locked from this user, don't link
904 if ( $iscur || !$file->userCan( File::DELETED_RESTRICTED ) ) {
905 $del = $this->skin->revDeleteLinkDisabled( $canHide );
906 } else {
907 list( $ts, $name ) = explode( '!', $img, 2 );
908 $query = array(
909 'type' => 'oldimage',
910 'target' => $this->title->getPrefixedText(),
911 'ids' => $ts,
912 );
913 $del = $this->skin->revDeleteLink( $query,
914 $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
915 }
916 $row .= $del;
917 }
918 $row .= '</td>';
919 }
920
921 // Reversion link/current indicator
922 $row .= '<td>';
923 if ( $iscur ) {
924 $row .= wfMsgHtml( 'filehist-current' );
925 } elseif ( $local && $wgUser->isLoggedIn() && $this->title->userCan( 'edit' ) ) {
926 if ( $file->isDeleted( File::DELETED_FILE ) ) {
927 $row .= wfMsgHtml( 'filehist-revert' );
928 } else {
929 $row .= $this->skin->link(
930 $this->title,
931 wfMsgHtml( 'filehist-revert' ),
932 array(),
933 array(
934 'action' => 'revert',
935 'oldimage' => $img,
936 'wpEditToken' => $wgUser->editToken( $img )
937 ),
938 array( 'known', 'noclasses' )
939 );
940 }
941 }
942 $row .= '</td>';
943
944 // Date/time and image link
945 if ( $file->getTimestamp() === $this->img->getTimestamp() ) {
946 $selected = "class='filehistory-selected'";
947 }
948 $row .= "<td $selected style='white-space: nowrap;'>";
949 if ( !$file->userCan( File::DELETED_FILE ) ) {
950 # Don't link to unviewable files
951 $row .= '<span class="history-deleted">' . $wgLang->timeAndDate( $timestamp, true ) . '</span>';
952 } elseif ( $file->isDeleted( File::DELETED_FILE ) ) {
953 $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
954 # Make a link to review the image
955 $url = $this->skin->link(
956 $revdel,
957 $wgLang->timeAndDate( $timestamp, true ),
958 array(),
959 array(
960 'target' => $this->title->getPrefixedText(),
961 'file' => $img,
962 'token' => $wgUser->editToken( $img )
963 ),
964 array( 'known', 'noclasses' )
965 );
966 $row .= '<span class="history-deleted">' . $url . '</span>';
967 } else {
968 $url = $iscur ? $this->current->getUrl() : $this->current->getArchiveUrl( $img );
969 $row .= Xml::element( 'a', array( 'href' => $url ), $wgLang->timeAndDate( $timestamp, true ) );
970 }
971 $row .= "</td>";
972
973 // Thumbnail
974 if ( $this->showThumb ) {
975 $row .= '<td>' . $this->getThumbForLine( $file ) . '</td>';
976 }
977
978 // Image dimensions + size
979 $row .= '<td>';
980 $row .= htmlspecialchars( $file->getDimensionsString() );
981 $row .= " <span style='white-space: nowrap;'>(" . $this->skin->formatSize( $file->getSize() ) . ')</span>';
982 $row .= '</td>';
983
984 // Uploading user
985 $row .= '<td>';
986 if ( $local ) {
987 // Hide deleted usernames
988 if ( $file->isDeleted( File::DELETED_USER ) ) {
989 $row .= '<span class="history-deleted">' . wfMsgHtml( 'rev-deleted-user' ) . '</span>';
990 } else {
991 $row .= $this->skin->userLink( $user, $usertext ) . " <span style='white-space: nowrap;'>" .
992 $this->skin->userToolLinks( $user, $usertext ) . "</span>";
993 }
994 } else {
995 $row .= htmlspecialchars( $usertext );
996 }
997 $row .= '</td><td>';
998
999 // Don't show deleted descriptions
1000 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1001 $row .= '<span class="history-deleted">' . wfMsgHtml( 'rev-deleted-comment' ) . '</span>';
1002 } else {
1003 $row .= $this->skin->commentBlock( $description, $this->title );
1004 }
1005 $row .= '</td>';
1006
1007 $rowClass = null;
1008 wfRunHooks( 'ImagePageFileHistoryLine', array( $this, $file, &$row, &$rowClass ) );
1009 $classAttr = $rowClass ? " class='$rowClass'" : "";
1010
1011 return "<tr{$classAttr}>{$row}</tr>\n";
1012 }
1013
1014 protected function getThumbForLine( $file ) {
1015 global $wgLang;
1016
1017 if ( $file->allowInlineDisplay() && $file->userCan( File::DELETED_FILE ) && !$file->isDeleted( File::DELETED_FILE ) ) {
1018 $params = array(
1019 'width' => '120',
1020 'height' => '120',
1021 );
1022 $timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
1023
1024 $thumbnail = $file->transform( $params );
1025 $options = array(
1026 'alt' => wfMsg( 'filehist-thumbtext',
1027 $wgLang->timeAndDate( $timestamp, true ),
1028 $wgLang->date( $timestamp, true ),
1029 $wgLang->time( $timestamp, true ) ),
1030 'file-link' => true,
1031 );
1032
1033 if ( !$thumbnail ) return wfMsgHtml( 'filehist-nothumb' );
1034
1035 return $thumbnail->toHtml( $options );
1036 } else {
1037 return wfMsgHtml( 'filehist-nothumb' );
1038 }
1039 }
1040 }
1041
1042 class ImageHistoryPseudoPager extends ReverseChronologicalPager {
1043 function __construct( $imagePage ) {
1044 parent::__construct();
1045 $this->mImagePage = $imagePage;
1046 $this->mTitle = clone ( $imagePage->getTitle() );
1047 $this->mTitle->setFragment( '#filehistory' );
1048 $this->mImg = null;
1049 $this->mHist = array();
1050 $this->mRange = array( 0, 0 ); // display range
1051 }
1052
1053 function getTitle() {
1054 return $this->mTitle;
1055 }
1056
1057 function getQueryInfo() {
1058 return false;
1059 }
1060
1061 function getIndexField() {
1062 return '';
1063 }
1064
1065 function formatRow( $row ) {
1066 return '';
1067 }
1068
1069 function getBody() {
1070 $s = '';
1071 $this->doQuery();
1072 if ( count( $this->mHist ) ) {
1073 $list = new ImageHistoryList( $this->mImagePage );
1074 # Generate prev/next links
1075 $navLink = $this->getNavigationBar();
1076 $s = $list->beginImageHistoryList( $navLink );
1077 // Skip rows there just for paging links
1078 for ( $i = $this->mRange[0]; $i <= $this->mRange[1]; $i++ ) {
1079 $file = $this->mHist[$i];
1080 $s .= $list->imageHistoryLine( !$file->isOld(), $file );
1081 }
1082 $s .= $list->endImageHistoryList( $navLink );
1083 }
1084 return $s;
1085 }
1086
1087 function doQuery() {
1088 if ( $this->mQueryDone ) return;
1089 $this->mImg = $this->mImagePage->getFile(); // ensure loading
1090 if ( !$this->mImg->exists() ) {
1091 return;
1092 }
1093 $queryLimit = $this->mLimit + 1; // limit plus extra row
1094 if ( $this->mIsBackwards ) {
1095 // Fetch the file history
1096 $this->mHist = $this->mImg->getHistory( $queryLimit, null, $this->mOffset, false );
1097 // The current rev may not meet the offset/limit
1098 $numRows = count( $this->mHist );
1099 if ( $numRows <= $this->mLimit && $this->mImg->getTimestamp() > $this->mOffset ) {
1100 $this->mHist = array_merge( array( $this->mImg ), $this->mHist );
1101 }
1102 } else {
1103 // The current rev may not meet the offset
1104 if ( !$this->mOffset || $this->mImg->getTimestamp() < $this->mOffset ) {
1105 $this->mHist[] = $this->mImg;
1106 }
1107 // Old image versions (fetch extra row for nav links)
1108 $oiLimit = count( $this->mHist ) ? $this->mLimit : $this->mLimit + 1;
1109 // Fetch the file history
1110 $this->mHist = array_merge( $this->mHist,
1111 $this->mImg->getHistory( $oiLimit, $this->mOffset, null, false ) );
1112 }
1113 $numRows = count( $this->mHist ); // Total number of query results
1114 if ( $numRows ) {
1115 # Index value of top item in the list
1116 $firstIndex = $this->mIsBackwards ?
1117 $this->mHist[$numRows - 1]->getTimestamp() : $this->mHist[0]->getTimestamp();
1118 # Discard the extra result row if there is one
1119 if ( $numRows > $this->mLimit && $numRows > 1 ) {
1120 if ( $this->mIsBackwards ) {
1121 # Index value of item past the index
1122 $this->mPastTheEndIndex = $this->mHist[0]->getTimestamp();
1123 # Index value of bottom item in the list
1124 $lastIndex = $this->mHist[1]->getTimestamp();
1125 # Display range
1126 $this->mRange = array( 1, $numRows - 1 );
1127 } else {
1128 # Index value of item past the index
1129 $this->mPastTheEndIndex = $this->mHist[$numRows - 1]->getTimestamp();
1130 # Index value of bottom item in the list
1131 $lastIndex = $this->mHist[$numRows - 2]->getTimestamp();
1132 # Display range
1133 $this->mRange = array( 0, $numRows - 2 );
1134 }
1135 } else {
1136 # Setting indexes to an empty string means that they will be
1137 # omitted if they would otherwise appear in URLs. It just so
1138 # happens that this is the right thing to do in the standard
1139 # UI, in all the relevant cases.
1140 $this->mPastTheEndIndex = '';
1141 # Index value of bottom item in the list
1142 $lastIndex = $this->mIsBackwards ?
1143 $this->mHist[0]->getTimestamp() : $this->mHist[$numRows - 1]->getTimestamp();
1144 # Display range
1145 $this->mRange = array( 0, $numRows - 1 );
1146 }
1147 } else {
1148 $firstIndex = '';
1149 $lastIndex = '';
1150 $this->mPastTheEndIndex = '';
1151 }
1152 if ( $this->mIsBackwards ) {
1153 $this->mIsFirst = ( $numRows < $queryLimit );
1154 $this->mIsLast = ( $this->mOffset == '' );
1155 $this->mLastShown = $firstIndex;
1156 $this->mFirstShown = $lastIndex;
1157 } else {
1158 $this->mIsFirst = ( $this->mOffset == '' );
1159 $this->mIsLast = ( $numRows < $queryLimit );
1160 $this->mLastShown = $lastIndex;
1161 $this->mFirstShown = $firstIndex;
1162 }
1163 $this->mQueryDone = true;
1164 }
1165 }