Followup r78924: keep track of exception/warning comments separately, to prevent...
[lhc/web/wiklou.git] / includes / ImageGallery.php
index 492a3e0..62f9eed 100644 (file)
@@ -32,20 +32,22 @@ class ImageGallery
         */
        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 __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'];
        }
 
        /**
@@ -74,7 +76,7 @@ class ImageGallery
        /**
         * Set the caption (as HTML)
         *
-        * @param $caption Caption
+        * @param $caption String: Caption
         */
        public function setCaptionHtml( $caption ) {
                $this->mCaption = $caption;
@@ -83,10 +85,11 @@ class ImageGallery
        /**
         * Set how many images will be displayed per row.
         *
-        * @param int $num > 0; invalid numbers will be rejected
+        * @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) {
+               if ($num >= 0) {
                        $this->mPerRow = (int)$num;
                }
        }
@@ -94,7 +97,7 @@ class ImageGallery
        /**
         * Set how wide each image will be, in pixels.
         *
-        * @param int $num > 0; invalid numbers will be ignored
+        * @param $num Integer > 0; invalid numbers will be ignored
         */
        public function setWidths( $num ) {
                if ($num > 0) {
@@ -105,7 +108,7 @@ class ImageGallery
        /**
         * Set how high each image will be, in pixels.
         *
-        * @param int $num > 0; invalid numbers will be ignored
+        * @param $num Integer > 0; invalid numbers will be ignored
         */
        public function setHeights( $num ) {
                if ($num > 0) {
@@ -141,7 +144,7 @@ class ImageGallery
         * Add an image 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.
+        * @param $html String: additional HTML text to be shown. The name and size of the image are always shown.
         */
        function add( $title, $html='' ) {
                if ( $title instanceof File ) {
@@ -181,7 +184,7 @@ class ImageGallery
         * @param $f Boolean: set to false to disable.
         */
        function setShowBytes( $f ) {
-               $this->mShowBytes = ( $f == true);
+               $this->mShowBytes = (bool)$f;
        }
 
        /**
@@ -191,17 +194,17 @@ class ImageGallery
         * @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 <table> element.
+        * Should be suitable for a <ul> element.
         *
         * Note -- if taking from user input, you should probably run through
         * Sanitizer::validateAttributes() first.
         *
-        * @param array of HTML attribute pairs
+        * @param $attribs Array of HTML attribute pairs
         */
        function setAttributes( $attribs ) {
                $this->mAttribs = $attribs;
@@ -222,50 +225,76 @@ class ImageGallery
 
                $sk = $this->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',
-                               'cellspacing' => '0',
-                               'cellpadding' => '0' ),
+                               'class' => 'gallery'),
                        $this->mAttribs );
-               $s = Xml::openElement( 'table', $attribs );
-               if( $this->mCaption )
-                       $s .= "\n\t<caption>{$this->mCaption}</caption>";
+               $s = Xml::openElement( 'ul', $attribs );
+               if ( $this->mCaption ) {
+                       $s .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
+               }
 
                $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights );
                $i = 0;
                foreach ( $this->mImages as $pair ) {
                        $nt = $pair[0];
-                       $text = $pair[1];
+                       $text = $pair[1]; # "text" means "caption" here
 
                        # 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_FILE ) {
+                               $img = wfFindFile( $nt, array( 'time' => $time ) );
+                       } else {
+                               $img = false;
+                       }
 
-                       if( $nt->getNamespace() != NS_IMAGE || !$img ) {
+                       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: '.($this->mHeights*1.25+2).'px;">'
+                               $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: '.($this->mHeights*1.25+2).'px;">'
-                                       . $sk->makeKnownLinkObj( $nt, htmlspecialchars( $nt->getText() ) ) . '</div>';
+                               $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: '.($this->mHeights*1.25+2).'px;">'
+                               $thumbhtml = "\n\t\t\t".'<div style="height: '.(30 + $this->mHeights).'px;">'
                                        . htmlspecialchars( $img->getLastError() ) . '</div>';
                        } else {
-                               $vpad = floor( ( 1.25*$this->mHeights - $thumb->height ) /2 ) - 2;
+                               $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="padding: ' . $vpad . 'px 0; width: ' .($this->mWidths+30).'px;">'
+                                       '<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-left: auto; margin-right: auto; width: ' .$this->mWidths.'px;">'
-                                       . $thumb->toHtml( array( 'desc-link' => true, 'desc-query' => $descQuery ) ) . '</div></div>';
+                                       . '<div style="margin:'.$vpad.'px auto;">'
+                                       . $thumb->toHtml( $imageParameters ) . '</div></div>';
 
                                // Call parser transform hook
                                if ( $this->mParser && $img->getHandler() ) {
@@ -274,7 +303,8 @@ class ImageGallery
                        }
 
                        //TODO
-                       //$ul = $sk->makeLink( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}", $ut );
+                       // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}" );
+                       // $ul = $sk->link( $linkTarget, $ut );
 
                        if( $this->mShowBytes ) {
                                if( $img ) {
@@ -289,38 +319,38 @@ class ImageGallery
                        }
 
                        $textlink = $this->mShowFilename ?
-                               $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "<br />\n" :
+                               $sk->link(
+                                       $nt,
+                                       htmlspecialchars( $wgLang->truncate( $nt->getText(), $this->mCaptionLength ) ),
+                                       array(),
+                                       array(),
+                                       array( 'known', 'noclasses' )
+                               ) . "<br />\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
 
-                       if ( $i % $this->mPerRow == 0 ) {
-                               $s .= "\n\t<tr>";
-                       }
+                       # 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" . '<td><div class="gallerybox" style="width: '.($this->mWidths+35).'px;">'
+                               "\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></td>";
-                       if ( $i % $this->mPerRow == $this->mPerRow - 1 ) {
-                               $s .= "\n\t</tr>";
-                       }
+                               . "\n\t\t</div></li>";
                        ++$i;
                }
-               if( $i % $this->mPerRow != 0 ) {
-                       $s .= "\n\t</tr>";
-               }
-               $s .= "\n</table>";
+               $s .= "\n</ul>";
 
                return $s;
        }
 
        /**
-        * @return int Number of images in the gallery
+        * @return Integer: number of images in the gallery
         */
        public function count() {
                return count( $this->mImages );
@@ -329,7 +359,7 @@ class ImageGallery
        /**
         * Set the contextual title
         *
-        * @param Title $title Contextual title
+        * @param $title Title: contextual title
         */
        public function setContextTitle( $title ) {
                $this->contextTitle = $title;