Added a function that returns the list of supported formats to ApiMain
[lhc/web/wiklou.git] / includes / ImageGallery.php
index 3220c39..3c0365f 100644 (file)
@@ -13,8 +13,6 @@ class ImageGallery
 {
        var $mImages, $mShowBytes, $mShowFilename;
        var $mCaption = false;
-       var $mSkin = false;
-       var $mRevisionId = 0;
 
        /**
         * Hide blacklisted images?
@@ -23,6 +21,7 @@ class ImageGallery
 
        /**
         * Registered parser object for output callbacks
+        * @var Parser
         */
        var $mParser;
 
@@ -39,7 +38,8 @@ class ImageGallery
         */
        const THUMB_PADDING = 30;
        const GB_PADDING = 5;
-       const GB_BORDERS = 6;
+       //2px borders on each side + 2px implied padding on each side
+       const GB_BORDERS = 8;
 
        /**
         * Create a new image gallery object.
@@ -127,38 +127,25 @@ class ImageGallery
         * Instruct the class to use a specific skin for rendering
         *
         * @param $skin Skin object
+        * @deprecated Not used anymore
         */
        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;
+               /* no op */
        }
 
        /**
         * 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.
+        * @param $alt   String: Alt text for the image
         */
-       function add( $title, $html='' ) {
+       function add( $title, $html = '', $alt = '' ) {
                if ( $title instanceof File ) {
                        // Old calling convention
                        $title = $title->getTitle();
                }
-               $this->mImages[] = array( $title, $html );
+               $this->mImages[] = array( $title, $html, $alt );
                wfDebug( "ImageGallery::add " . $title->getText() . "\n" );
        }
 
@@ -166,14 +153,15 @@ class ImageGallery
        * Add an image at the beginning of 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.
+       * @param $alt   String: Alt text for the image
        */
-       function insert( $title, $html='' ) {
+       function insert( $title, $html='', $alt='' ) {
                if ( $title instanceof File ) {
                        // Old calling convention
                        $title = $title->getTitle();
                }
-               array_unshift( $this->mImages, array( &$title, $html ) );
+               array_unshift( $this->mImages, array( &$title, $html, $alt ) );
        }
 
 
@@ -230,35 +218,41 @@ class ImageGallery
        function toHTML() {
                global $wgLang;
 
-               $sk = $this->getSkin();
-
                if ( $this->mPerRow > 0 ) {
                        $maxwidth = $this->mPerRow * ( $this->mWidths + self::THUMB_PADDING + self::GB_PADDING + self::GB_BORDERS );
                        $oldStyle = isset( $this->mAttribs['style'] ) ? $this->mAttribs['style'] : ""; 
+                       # _width is ignored by any sane browser. IE6 doesn't know max-width so it uses _width instead
                        $this->mAttribs['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;" . $oldStyle;
                }
 
                $attribs = Sanitizer::mergeAttributes(
-                       array(
-                               'class' => 'gallery'),
-                       $this->mAttribs );
-               $s = Xml::openElement( 'ul', $attribs );
+                       array( 'class' => 'gallery' ), $this->mAttribs );
+
+               $output = Xml::openElement( 'ul', $attribs );
                if ( $this->mCaption ) {
-                       $s .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
+                       $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
                }
 
                $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights );
-               $i = 0;
+               # Output each image...
                foreach ( $this->mImages as $pair ) {
                        $nt = $pair[0];
                        $text = $pair[1]; # "text" means "caption" here
+                       $alt = $pair[2];
 
-                       # Give extensions a chance to select the file revision for us
-                       $time = $descQuery = false;
-                       wfRunHooks( 'BeforeGalleryFindFile', array( &$this, &$nt, &$time, &$descQuery ) );
-
+                       $descQuery = false;
                        if ( $nt->getNamespace() == NS_FILE ) {
-                               $img = wfFindFile( $nt, array( 'time' => $time ) );
+                               # Get the file...
+                               if ( $this->mParser instanceof Parser ) {
+                                       # Give extensions a chance to select the file revision for us
+                                       $time = $sha1 = false;
+                                       wfRunHooks( 'BeforeParserFetchFileAndTitle',
+                                               array( $this->mParser, $nt, &$time, &$sha1, &$descQuery ) );
+                                       # Fetch and register the file (file title may be different via hooks)
+                                       list( $img, $nt ) = $this->mParser->fetchFileAndTitle( $nt, $time, $sha1 );
+                               } else {
+                                       $img = wfFindFile( $nt );
+                               }
                        } else {
                                $img = false;
                        }
@@ -270,7 +264,7 @@ class ImageGallery
                        } 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: '.(self::THUMB_PADDING + $this->mHeights).'px;">' .
-                                       $sk->link(
+                                       Linker::link(
                                                $nt,
                                                htmlspecialchars( $nt->getText() ),
                                                array(),
@@ -283,18 +277,19 @@ class ImageGallery
                                $thumbhtml = "\n\t\t\t".'<div style="height: '.(self::THUMB_PADDING + $this->mHeights).'px;">'
                                        . htmlspecialchars( $img->getLastError() ) . '</div>';
                        } else {
-                               //We get layout problems with the margin, if the image is smaller 
-                               //than the line-height, so we less margin in these cases.
+                               We get layout problems with the margin, if the image is smaller 
+                               # than the line-height (17), so we add less margin in these cases.
                                $minThumbHeight =  $thumb->height > 17 ? $thumb->height : 17;
                                $vpad = floor(( self::THUMB_PADDING + $this->mHeights - $minThumbHeight ) /2);
                                
 
                                $imageParameters = array(
                                        'desc-link' => true,
-                                       'desc-query' => $descQuery
+                                       'desc-query' => $descQuery,
+                                       'alt' => $alt,
                                );
-                               # In the absence of a caption, fall back on providing screen readers with the filename as alt text
-                               if ( $text == '' ) {
+                               # In the absence of both alt text and caption, fall back on providing screen readers with the filename as alt text
+                               if ( $alt == '' && $text == '' ) {
                                        $imageParameters['alt'] = $nt->getText();
                                }
 
@@ -315,22 +310,22 @@ class ImageGallery
 
                        //TODO
                        // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}" );
-                       // $ul = $sk->link( $linkTarget, $ut );
+                       // $ul = Linker::link( $linkTarget, $ut );
 
                        if( $this->mShowBytes ) {
                                if( $img ) {
-                                       $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
+                                       $fileSize = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
                                                $wgLang->formatNum( $img->getSize() ) );
                                } else {
-                                       $nb = wfMsgHtml( 'filemissing' );
+                                       $fileSize = wfMsgHtml( 'filemissing' );
                                }
-                               $nb = "$nb<br />\n";
+                               $fileSize = "$fileSize<br />\n";
                        } else {
-                               $nb = '';
+                               $fileSize = '';
                        }
 
                        $textlink = $this->mShowFilename ?
-                               $sk->link(
+                               Linker::link(
                                        $nt,
                                        htmlspecialchars( $wgLang->truncate( $nt->getText(), $this->mCaptionLength ) ),
                                        array(),
@@ -343,21 +338,20 @@ class ImageGallery
                        # 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
+                       # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
                        # Can be safely removed if FF2 falls completely out of existance
-                       $s .=
+                       $output .=
                                "\n\t\t" . '<li class="gallerybox" style="width: ' . ( $this->mWidths + self::THUMB_PADDING + self::GB_PADDING ) . 'px">'
                                        . '<div style="width: ' . ( $this->mWidths + self::THUMB_PADDING + self::GB_PADDING ) . 'px">'
                                        . $thumbhtml
                                        . "\n\t\t\t" . '<div class="gallerytext">' . "\n"
-                                               . $textlink . $text . $nb
+                                               . $textlink . $text . $fileSize
                                        . "\n\t\t\t</div>"
                                . "\n\t\t</div></li>";
-                       ++$i;
                }
-               $s .= "\n</ul>";
+               $output .= "\n</ul>";
 
-               return $s;
+               return $output;
        }
 
        /**