Refactored parser output handling slightly, and added a hook function, to allow exten...
[lhc/web/wiklou.git] / includes / ImageGallery.php
index a65b40d..7ff456b 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 if ( ! defined( 'MEDIAWIKI' ) )
-       die();
+       die( 1 );
 
 /**
  * @package MediaWiki
@@ -16,6 +16,13 @@ if ( ! defined( 'MEDIAWIKI' ) )
 class ImageGallery
 {
        var $mImages, $mShowBytes, $mShowFilename;
+       var $mCaption = false;
+       var $mSkin = false;
+       
+       /**
+        * Is the gallery on a wiki page (i.e. not a special page)
+        */
+       var $mParsing;
 
        /**
         * Create a new image gallery object.
@@ -24,23 +31,65 @@ class ImageGallery
                $this->mImages = array();
                $this->mShowBytes = true;
                $this->mShowFilename = true;
+               $this->mParsing = false;
+       }
+
+       /**
+        * Set the "parse" bit so we know to hide "bad" images
+        */
+       function setParsing( $val = true ) {
+               $this->mParsing = $val;
+       }
+       
+       /**
+        * Set the caption
+        *
+        * @param $caption Caption
+        */
+       function setCaption( $caption ) {
+               $this->mCaption = $caption;
+       }
+
+       /**
+        * 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 $image Image object 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" );
        }
 
        /**
        * 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 $image Image object 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 ) );
@@ -58,7 +107,7 @@ class ImageGallery
         * 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);
@@ -68,7 +117,7 @@ class ImageGallery
         * 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);
@@ -85,11 +134,14 @@ class ImageGallery
         *
         */
        function toHTML() {
-               global $wgLang, $wgUser;
+               global $wgLang, $wgIgnoreImageErrors, $wgGenerateThumbnailOnParse;
 
-               $sk = $wgUser->getSkin();
+               $sk = $this->getSkin();
 
                $s = '<table class="gallery" cellspacing="0" cellpadding="0">';
+               if( $this->mCaption )
+                       $s .= '<td class="galleryheader" colspan="4"><big>' . htmlspecialchars( $this->mCaption ) . '</big></td>';
+               
                $i = 0;
                foreach ( $this->mImages as $pair ) {
                        $img =& $pair[0];
@@ -98,13 +150,23 @@ class ImageGallery
                        $name = $img->getName();
                        $nt = $img->getTitle();
 
-                       // 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++;
-
-                               continue;
+                       if( $nt->getNamespace() != NS_IMAGE ) {
+                               # We're dealing with a non-image, spit out the name and be done with it.
+                               $thumbhtml = '<div style="height: 152px;">' . htmlspecialchars( $nt->getText() ) . '</div>';
+                       }
+                       else if( $this->mParsing && wfIsBadImage( $nt->getDBkey() ) ) {
+                               # The image is blacklisted, just show it as a text link.
+                               $thumbhtml = '<div style="height: 152px;">'
+                                       . $sk->makeKnownLinkObj( $nt, htmlspecialchars( $nt->getText() ) ) . '</div>';
+                       } else if( !( $thumb = $img->getThumbnail( 120, 120, $wgGenerateThumbnailOnParse ) ) ) {
+                               # Error generating thumbnail.
+                               $thumbhtml = '<div style="height: 152px;">'
+                                       . htmlspecialchars( $img->getLastError() ) . '</div>';
+                       }
+                       else {
+                               $vpad = floor( ( 150 - $thumb->height ) /2 ) - 2;
+                               $thumbhtml = '<div class="thumb" style="padding: ' . $vpad . 'px 0;">'
+                                       . $sk->makeKnownLinkObj( $nt, $thumb->toHtml() ) . '</div>';
                        }
 
                        //TODO
@@ -112,7 +174,8 @@ class ImageGallery
 
                        if( $this->mShowBytes ) {
                                if( $img->exists() ) {
-                                       $nb = wfMsgHtml( 'nbytes', $wgLang->formatNum( $img->getSize() ) );
+                                       $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
+                                               $wgLang->formatNum( $img->getSize() ) );
                                } else {
                                        $nb = wfMsgHtml( 'filemissing' );
                                }
@@ -125,18 +188,14 @@ class ImageGallery
                                $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "<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;">';
-
                        # 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
-                       $s .= $sk->makeKnownLinkObj( $nt, $thumb->toHtml() ) . '</div><div class="gallerytext">' . "\n" .
-                               $textlink . $text . $nb .
-                               '</div>';
-                       $s .= "</div></td>\n";
+
+                       $s .= ($i%4==0) ? '<tr>' : '';
+                       $s .= '<td><div class="gallerybox">' . $thumbhtml
+                               . '<div class="gallerytext">' . "\n" . $textlink . $text . $nb
+                               . "</div></div></td>\n";
                        $s .= ($i%4==3) ? '</tr>' : '';
                        $i++;
                }