X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=492a3e06e9ca3e370dffb44908e439d4ae27caa0;hb=69e49e832ef17d6458ec28db33d9b2c3d4475433;hp=7e6307eff469c1d915a0f1157ac9d10e88d8ecde;hpb=fa239349f2d5d4456c45efae16d1673d6472e165;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index 7e6307eff4..492a3e06e9 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -2,72 +2,168 @@ if ( ! defined( 'MEDIAWIKI' ) ) die( 1 ); -/** - * @package MediaWiki - */ - /** * 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; + /** - * Is the gallery on a wiki page (i.e. not a special page) + * Hide blacklisted images? */ - var $mParsing; + 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 $mPerRow = 4; // How many images wide should the gallery be? + private $mWidths = 120, $mHeights = 120; // How wide/tall each thumbnail should be + + private $mAttribs = array(); /** * Create a new image gallery object. */ - function ImageGallery( ) { + function __construct( ) { $this->mImages = array(); $this->mShowBytes = true; $this->mShowFilename = true; - $this->mParsing = false; + $this->mParser = false; + $this->mHideBadImages = false; + } + + /** + * Register a parser object + */ + function setParser( $parser ) { + $this->mParser = $parser; } /** - * Set the "parse" bit so we know to hide "bad" images + * Set bad image flag */ - function setParsing( $val = true ) { - $this->mParsing = $val; + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; } - + /** - * Set the caption + * Set the caption (as plain text) * * @param $caption Caption */ function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param $caption Caption + */ + public function setCaptionHtml( $caption ) { $this->mCaption = $caption; } + /** + * Set how many images will be displayed per row. + * + * @param int $num > 0; 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 int $num > 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 int $num > 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 object that is added to the gallery + * @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 ); - wfDebug( "ImageGallery::add " . $image->getName() . "\n" ); + 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 object that is added to the gallery + * @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 ) ); } @@ -98,6 +194,19 @@ class ImageGallery $this->mShowFilename = ( $f == true); } + /** + * Set arbitrary attributes to go on the HTML gallery output element. + * Should be suitable for a <table> element. + * + * Note -- if taking from user input, you should probably run through + * Sanitizer::validateAttributes() first. + * + * @param array of HTML attribute pairs + */ + function setAttributes( $attribs ) { + $this->mAttribs = $attribs; + } + /** * Return a HTML representation of the image gallery * @@ -109,44 +218,66 @@ class ImageGallery * */ function toHTML() { - global $wgLang, $wgIgnoreImageErrors, $wgGenerateThumbnailOnParse; + global $wgLang; + + $sk = $this->getSkin(); - $s = ''; + $attribs = Sanitizer::mergeAttributes( + array( + 'class' => 'gallery', + 'cellspacing' => '0', + 'cellpadding' => '0' ), + $this->mAttribs ); + $s = Xml::openElement( 'table', $attribs ); if( $this->mCaption ) - $s .= ''; - + $s .= "\n\t"; + + $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights ); $i = 0; foreach ( $this->mImages as $pair ) { - $img =& $pair[0]; + $nt = $pair[0]; $text = $pair[1]; - $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 ) ); + + $img = wfFindFile( $nt, $time ); - if( $nt->getNamespace() != NS_IMAGE ) { + if( $nt->getNamespace() != NS_IMAGE || !$img ) { # We're dealing with a non-image, spit out the name and be done with it. - $thumbhtml = '
' . htmlspecialchars( $nt->getText() ) . '
'; - } - else if( $this->mParsing && wfIsBadImage( $nt->getDBkey() ) ) { + $thumbhtml = "\n\t\t\t".'
' + . htmlspecialchars( $nt->getText() ) . '
'; + } elseif( $this->mHideBadImages && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() ) ) { # The image is blacklisted, just show it as a text link. - $thumbhtml = '
' - . Linker::makeKnownLinkObj( $nt, htmlspecialchars( $nt->getText() ) ) . '
'; - } else if( !( $thumb = $img->getThumbnail( 120, 120, $wgGenerateThumbnailOnParse ) ) ) { + $thumbhtml = "\n\t\t\t".'
' + . $sk->makeKnownLinkObj( $nt, htmlspecialchars( $nt->getText() ) ) . '
'; + } elseif( !( $thumb = $img->transform( $params ) ) ) { # Error generating thumbnail. - $thumbhtml = '
' + $thumbhtml = "\n\t\t\t".'
' . htmlspecialchars( $img->getLastError() ) . '
'; - } - else { - $vpad = floor( ( 150 - $thumb->height ) /2 ) - 2; - $thumbhtml = '
' - . Linker::makeKnownLinkObj( $nt, $thumb->toHtml() ) . '
'; + } else { + $vpad = floor( ( 1.25*$this->mHeights - $thumb->height ) /2 ) - 2; + + $thumbhtml = "\n\t\t\t". + '
' + # 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 tags. + # ref http://css-discuss.incutio.com/?page=CenteringBlockElement + . '
' + . $thumb->toHtml( array( 'desc-link' => true, 'desc-query' => $descQuery ) ) . '
'; + + // Call parser transform hook + if ( $this->mParser && $img->getHandler() ) { + $img->getHandler()->parserTransformHook( $this->mParser, $img ); + } } //TODO - //$ul = Linker::makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut ); + //$ul = $sk->makeLink( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}", $ut ); if( $this->mShowBytes ) { - if( $img->exists() ) { + if( $img ) { $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'), $wgLang->formatNum( $img->getSize() ) ); } else { @@ -158,27 +289,61 @@ class ImageGallery } $textlink = $this->mShowFilename ? - Linker::makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "
\n" : + $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "
\n" : '' ; # ATTENTION: The newline after
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 - $s .= ($i%4==0) ? '
' : ''; - $s .= '\n"; - $s .= ($i%4==3) ? '' : ''; - $i++; + if ( $i % $this->mPerRow == 0 ) { + $s .= "\n\t"; + } + $s .= + "\n\t\t" . '"; + if ( $i % $this->mPerRow == $this->mPerRow - 1 ) { + $s .= "\n\t"; + } + ++$i; } - if( $i %4 != 0 ) { - $s .= "\n"; + if( $i % $this->mPerRow != 0 ) { + $s .= "\n\t"; } - $s .= '
' . htmlspecialchars( $this->mCaption ) . '
{$this->mCaption}
' . $thumbhtml - . '
' . "\n" . $textlink . $text . $nb - . "
' + . $thumbhtml + . "\n\t\t\t" . '
' . "\n" + . $textlink . $text . $nb + . "\n\t\t\t
" + . "\n\t\t
'; + $s .= "\n"; return $s; } + /** + * @return int 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; + } + } //class -?>