<?php
-/**
- * @package MediaWiki
- */
-
-/**
- * This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
- */
-if( defined( 'MEDIAWIKI' ) ) {
-
+if ( ! defined( 'MEDIAWIKI' ) )
+ die( 1 );
/**
* Image gallery
- *
+ *
* Add images to the gallery using add(), then render that list to HTML using toHTML().
*
- * @package MediaWiki
+ * @ingroup Media
*/
class ImageGallery
{
var $mImages, $mShowBytes, $mShowFilename;
+ var $mCaption = false;
+ var $mSkin = false;
+ var $mRevisionId = 0;
- /**
+ /**
+ * Hide blacklisted images?
+ */
+ var $mHideBadImages;
+
+ /**
+ * Registered parser object for output callbacks
+ */
+ var $mParser;
+
+ /**
+ * Contextual title, used when images are being screened
+ * against the bad image list
+ */
+ private $contextTitle = false;
+
+ private $mAttribs = array();
+
+ /**
* Create a new image gallery object.
*/
- function ImageGallery( ) {
+ function __construct( ) {
+ global $wgGalleryOptions;
$this->mImages = array();
- $this->mShowBytes = true;
+ $this->mShowBytes = $wgGalleryOptions['showBytes'];
$this->mShowFilename = true;
+ $this->mParser = false;
+ $this->mHideBadImages = false;
+ $this->mPerRow = $wgGalleryOptions['imagesPerRow'];
+ $this->mWidths = $wgGalleryOptions['imageWidth'];
+ $this->mHeights = $wgGalleryOptions['imageHeight'];
+ $this->mCaptionLength = $wgGalleryOptions['captionLength'];
+ }
+
+ /**
+ * Register a parser object
+ */
+ function setParser( $parser ) {
+ $this->mParser = $parser;
+ }
+
+ /**
+ * Set bad image flag
+ */
+ function setHideBadImages( $flag = true ) {
+ $this->mHideBadImages = $flag;
+ }
+
+ /**
+ * Set the caption (as plain text)
+ *
+ * @param $caption Caption
+ */
+ function setCaption( $caption ) {
+ $this->mCaption = htmlspecialchars( $caption );
+ }
+
+ /**
+ * Set the caption (as HTML)
+ *
+ * @param $caption String: Caption
+ */
+ public function setCaptionHtml( $caption ) {
+ $this->mCaption = $caption;
+ }
+
+ /**
+ * Set how many images will be displayed per row.
+ *
+ * @param $num Integer >= 0; If perrow=0 the gallery layout will adapt to screensize
+ * invalid numbers will be rejected
+ */
+ public function setPerRow( $num ) {
+ if ($num >= 0) {
+ $this->mPerRow = (int)$num;
+ }
+ }
+
+ /**
+ * Set how wide each image will be, in pixels.
+ *
+ * @param $num Integer > 0; invalid numbers will be ignored
+ */
+ public function setWidths( $num ) {
+ if ($num > 0) {
+ $this->mWidths = (int)$num;
+ }
+ }
+
+ /**
+ * Set how high each image will be, in pixels.
+ *
+ * @param $num Integer > 0; invalid numbers will be ignored
+ */
+ public function setHeights( $num ) {
+ if ($num > 0) {
+ $this->mHeights = (int)$num;
+ }
+ }
+
+ /**
+ * Instruct the class to use a specific skin for rendering
+ *
+ * @param $skin Skin object
+ */
+ function useSkin( $skin ) {
+ $this->mSkin = $skin;
+ }
+
+ /**
+ * Return the skin that should be used
+ *
+ * @return Skin object
+ */
+ function getSkin() {
+ if( !$this->mSkin ) {
+ global $wgUser;
+ $skin = $wgUser->getSkin();
+ } else {
+ $skin = $this->mSkin;
+ }
+ return $skin;
}
/**
* Add an image to the gallery.
*
- * @param Image $image Image object that is added to the gallery
- * @param string $html Additional HTML text to be shown. The name and size of the image are always shown.
+ * @param $title Title object of the image that is added to the gallery
+ * @param $html String: additional HTML text to be shown. The name and size of the image are always shown.
*/
- function add( $image, $html='' ) {
- $this->mImages[] = array( &$image, $html );
+ function add( $title, $html='' ) {
+ if ( $title instanceof File ) {
+ // Old calling convention
+ $title = $title->getTitle();
+ }
+ $this->mImages[] = array( $title, $html );
+ wfDebug( "ImageGallery::add " . $title->getText() . "\n" );
}
/**
* Add an image at the beginning of the gallery.
*
- * @param Image $image Image object that is added to the gallery
- * @param string $html Additional HTML text to be shown. The name and size of the image are always shown.
+ * @param $title Title object of the image that is added to the gallery
+ * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown.
*/
- function insert( $image, $html='' ) {
- array_unshift( $this->mImages, array( &$image, $html ) );
+ function insert( $title, $html='' ) {
+ if ( $title instanceof File ) {
+ // Old calling convention
+ $title = $title->getTitle();
+ }
+ array_unshift( $this->mImages, array( &$title, $html ) );
}
/**
- * isEmpty() returns false iff the gallery doesn't contain any images
+ * isEmpty() returns true if the gallery contains no images
*/
function isEmpty() {
return empty( $this->mImages );
/**
* Enable/Disable showing of the file size of an image in the gallery.
* Enabled by default.
- *
- * @param boolean $f set to false to disable
+ *
+ * @param $f Boolean: set to false to disable.
*/
function setShowBytes( $f ) {
- $this->mShowBytes = ( $f == true);
+ $this->mShowBytes = (bool)$f;
}
/**
* Enable/Disable showing of the filename of an image in the gallery.
* Enabled by default.
- *
- * @param boolean $f set to false to disable
+ *
+ * @param $f Boolean: set to false to disable.
*/
function setShowFilename( $f ) {
- $this->mShowFilename = ( $f == true);
+ $this->mShowFilename = (bool)$f;
+ }
+
+ /**
+ * Set arbitrary attributes to go on the HTML gallery output element.
+ * Should be suitable for a <ul> element.
+ *
+ * Note -- if taking from user input, you should probably run through
+ * Sanitizer::validateAttributes() first.
+ *
+ * @param $attribs Array of HTML attribute pairs
+ */
+ function setAttributes( $attribs ) {
+ $this->mAttribs = $attribs;
}
/**
* Return a HTML representation of the image gallery
- *
+ *
* For each image in the gallery, display
* - a thumbnail
* - the image name
*
*/
function toHTML() {
- global $wgLang, $wgContLang, $wgUser;
+ global $wgLang;
+
+ $sk = $this->getSkin();
- $sk = $wgUser->getSkin();
+ if ( $this->mPerRow > 0 ) {
+ $maxwidth = $this->mPerRow * ( $this->mWidths + 50 );
+ $this->mAttribs['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;";
+ }
+
+ $attribs = Sanitizer::mergeAttributes(
+ array(
+ 'class' => 'gallery'),
+ $this->mAttribs );
+ $s = Xml::openElement( 'ul', $attribs );
+ if ( $this->mCaption ) {
+ $s .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
+ }
- $s = '<table class="gallery" cellspacing="0" cellpadding="0">';
+ $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights );
$i = 0;
foreach ( $this->mImages as $pair ) {
- $img =& $pair[0];
- $text = $pair[1];
+ $nt = $pair[0];
+ $text = $pair[1]; # "text" means "caption" here
- $name = $img->getName();
- $nt = $img->getTitle();
+ # Give extensions a chance to select the file revision for us
+ $time = $descQuery = false;
+ wfRunHooks( 'BeforeGalleryFindFile', array( &$this, &$nt, &$time, &$descQuery ) );
- // Not an image. Just print the name and skip.
- if ( $nt->getNamespace() != NS_IMAGE ) {
- $s .= '<td><div class="gallerybox" style="height: 152px;">' .
- htmlspecialchars( $nt->getText() ) . '</div></td>' . (($i%4==3) ? "</tr>\n" : '');
- $i++;
+ if ( $nt->getNamespace() == NS_FILE ) {
+ $img = wfFindFile( $nt, array( 'time' => $time ) );
+ } else {
+ $img = false;
+ }
+
+ if( !$img ) {
+ # We're dealing with a non-image, spit out the name and be done with it.
+ $thumbhtml = "\n\t\t\t".'<div style="height: '.(30 + $this->mHeights).'px;">'
+ . htmlspecialchars( $nt->getText() ) . '</div>';
+ } elseif( $this->mHideBadImages && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() ) ) {
+ # The image is blacklisted, just show it as a text link.
+ $thumbhtml = "\n\t\t\t".'<div style="height: '.(30 + $this->mHeights).'px;">' .
+ $sk->link(
+ $nt,
+ htmlspecialchars( $nt->getText() ),
+ array(),
+ array(),
+ array( 'known', 'noclasses' )
+ ) .
+ '</div>';
+ } elseif( !( $thumb = $img->transform( $params ) ) ) {
+ # Error generating thumbnail.
+ $thumbhtml = "\n\t\t\t".'<div style="height: '.(30 + $this->mHeights).'px;">'
+ . htmlspecialchars( $img->getLastError() ) . '</div>';
+ } else {
+ $vpad = floor(( 30 + $this->mHeights - $thumb->height ) /2);
+
+ $imageParameters = array(
+ 'desc-link' => true,
+ 'desc-query' => $descQuery
+ );
+ # In the absence of a caption, fall back on providing screen readers with the filename as alt text
+ if ( $text == '' ) {
+ $imageParameters['alt'] = $nt->getText();
+ }
+
+ # Set both fixed width and height. Otherwise we might have problems
+ # with the vertical centering of images where height<line-size
+ $thumbhtml = "\n\t\t\t".
+ '<div class="thumb" style="width: ' .($this->mWidths+30).'px; height: ' .($this->mHeights+30).'px;">'
+ # Auto-margin centering for block-level elements. Needed now that we have video
+ # handlers since they may emit block-level elements as opposed to simple <img> tags.
+ # ref http://css-discuss.incutio.com/?page=CenteringBlockElement
+ . '<div style="margin:'.$vpad.'px auto;">'
+ . $thumb->toHtml( $imageParameters ) . '</div></div>';
- continue;
+ // Call parser transform hook
+ if ( $this->mParser && $img->getHandler() ) {
+ $img->getHandler()->parserTransformHook( $this->mParser, $img );
+ }
}
//TODO
- //$ul = $sk->makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut );
+ // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}" );
+ // $ul = $sk->link( $linkTarget, $ut );
if( $this->mShowBytes ) {
- if( $img->exists() ) {
- $nb = wfMsg( 'nbytes', $wgLang->formatNum( $img->getSize() ) );
+ if( $img ) {
+ $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
+ $wgLang->formatNum( $img->getSize() ) );
} else {
- $nb = wfMsg( 'filemissing' );
+ $nb = wfMsgHtml( 'filemissing' );
}
- $nb = htmlspecialchars( $nb ) . '<br />';
+ $nb = "$nb<br />\n";
} else {
$nb = '';
}
-
- '' ;
+
$textlink = $this->mShowFilename ?
- $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . '<br />' :
+ $sk->link(
+ $nt,
+ htmlspecialchars( $wgLang->truncate( $nt->getText(), $this->mCaptionLength ) ),
+ array(),
+ array(),
+ array( 'known', 'noclasses' )
+ ) . "<br />\n" :
'' ;
- $s .= ($i%4==0) ? '<tr>' : '';
- $thumb = $img->getThumbnail( 120, 120 );
- $vpad = floor( ( 150 - $thumb->height ) /2 ) - 2;
- $s .= '<td><div class="gallerybox">' .
- '<div class="thumb" style="padding: ' . $vpad . 'px 0;">'.
- $sk->makeKnownLinkObj( $nt, $thumb->toHtml() ) . '</div><div class="gallerytext">' .
- $textlink . $text . $nb .
- '</div>';
- $s .= "</div></td>\n";
- $s .= ($i%4==3) ? '</tr>' : '';
- $i++;
- }
- if( $i %4 != 0 ) {
- $s .= "</tr>\n";
+ # ATTENTION: The newline after <div class="gallerytext"> is needed to accommodate htmltidy which
+ # in version 4.8.6 generated crackpot html in its absence, see:
+ # http://bugzilla.wikimedia.org/show_bug.cgi?id=1765 -Ævar
+
+ # Weird double wrapping in div needed due to FF2 bug
+ # Can be safely removed if FF2 falls completely out of existance
+ $s .=
+ "\n\t\t" . '<li class="gallerybox" style="width: ' . ( $this->mWidths + 35 ) . 'px">'
+ . '<div style="width: ' . ( $this->mWidths + 35 ) . 'px">'
+ . $thumbhtml
+ . "\n\t\t\t" . '<div class="gallerytext">' . "\n"
+ . $textlink . $text . $nb
+ . "\n\t\t\t</div>"
+ . "\n\t\t</div></li>";
+ ++$i;
}
- $s .= '</table>';
+ $s .= "\n</ul>";
return $s;
}
-} //class
-
+ /**
+ * @return Integer: number of images in the gallery
+ */
+ public function count() {
+ return count( $this->mImages );
+ }
+ /**
+ * Set the contextual title
+ *
+ * @param $title Title: contextual title
+ */
+ public function setContextTitle( $title ) {
+ $this->contextTitle = $title;
+ }
+ /**
+ * Get the contextual title, if applicable
+ *
+ * @return mixed Title or false
+ */
+ public function getContextTitle() {
+ return is_object( $this->contextTitle ) && $this->contextTitle instanceof Title
+ ? $this->contextTitle
+ : false;
+ }
-} // defined( 'MEDIAWIKI' )
-?>
+} //class
dépôts / lhc / web / wiklou.git / blobdiff