Revert r21461 for now; a cleanup patch which doesn't change functionality but makes...
[lhc/web/wiklou.git] / includes / ImageGallery.php
index 4ae92d0..036d717 100644 (file)
@@ -3,7 +3,6 @@ if ( ! defined( 'MEDIAWIKI' ) )
        die( 1 );
 
 /**
- * @package MediaWiki
  */
 
 /**
@@ -11,21 +10,31 @@ if ( ! defined( 'MEDIAWIKI' ) )
  *
  * Add images to the gallery using add(), then render that list to HTML using toHTML().
  *
- * @package 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;
 
+       /**
+        * 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
+
        /**
         * Create a new image gallery object.
         */
-       function ImageGallery( ) {
+       function __construct( ) {
                $this->mImages = array();
                $this->mShowBytes = true;
                $this->mShowFilename = true;
@@ -39,6 +48,81 @@ class ImageGallery
                $this->mParsing = $val;
        }
 
+       /**
+        * 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.
         *
@@ -47,6 +131,7 @@ class ImageGallery
         */
        function add( $image, $html='' ) {
                $this->mImages[] = array( &$image, $html );
+               wfDebug( "ImageGallery::add " . $image->getName() . "\n" );
        }
 
        /**
@@ -98,31 +183,38 @@ class ImageGallery
         *
         */
        function toHTML() {
-               global $wgLang, $wgUser, $wgIgnoreImageErrors;
+               global $wgLang;
 
-               $sk = $wgUser->getSkin();
+               $sk = $this->getSkin();
 
                $s = '<table class="gallery" cellspacing="0" cellpadding="0">';
+               if( $this->mCaption )
+                       $s .= "\n\t<caption>{$this->mCaption}</caption>";
+
+               $params = array( 'width' => $this->mWidths, 'height' => $this->mHeights );
                $i = 0;
                foreach ( $this->mImages as $pair ) {
                        $img =& $pair[0];
                        $text = $pair[1];
 
-                       $name = $img->getName();
                        $nt = $img->getTitle();
 
-                       # If we're dealing with a non-image, or a blacklisted image,
-                       # spit out the name and be done with it
-                       if( $nt->getNamespace() != NS_IMAGE
-                               || ( $this->mParsing && wfIsBadImage( $nt->getDBkey() ) ) ) {
-                               $s .=
-                                       (($i%4==0) ? "<tr>\n" : '') .
-                                       '<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 = "\n\t\t\t".'<div style="height: '.($this->mHeights*1.25+2).'px;">'
+                                       . htmlspecialchars( $nt->getText() ) . '</div>';
+                       } elseif( $this->mParsing && 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>';
+                       } elseif( !( $thumb = $img->transform( $params ) ) ) {
+                               # Error generating thumbnail.
+                               $thumbhtml = "\n\t\t\t".'<div style="height: '.($this->mHeights*1.25+2).'px;">'
+                                       . htmlspecialchars( $img->getLastError() ) . '</div>';
+                       } else {
+                               $vpad = floor( ( 1.25*$this->mHeights - $thumb->height ) /2 ) - 2;
+                               $thumbhtml = "\n\t\t\t".'<div class="thumb" style="padding: ' . $vpad . 'px 0; width: '.($this->mWidths+30).'px;">'
+                                       . $sk->makeKnownLinkObj( $nt, $thumb->toHtml() ) . '</div>';
                        }
 
                        //TODO
@@ -144,41 +236,59 @@ class ImageGallery
                                $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "<br />\n" :
                                '' ;
 
-                       $s .= ($i%4==0) ? '<tr>' : '';
-                       $thumb = $img->getThumbnail( 120, 120 );
-                       if ( !$thumb && $wgIgnoreImageErrors ) {
-                               $thumb = $img->iconThumb();
+                       # 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>";
                        }
-                       if ( $thumb ) {
-                               $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";
-                       } else {
-                               # Error during thumbnail generation
-                               $s .= '<td><div class="gallerybox" style="height: 152px;">' .
-                                       #htmlspecialchars( $nt->getText() ) . "<br />\n" .
-                                       htmlspecialchars( $img->getLastError() ) .
-                                       "</div><div class=\"gallerytext\">\n" .
-                                       $textlink . $text . $nb .
-                                       "</div></td>\n";
+                       $s .=
+                               "\n\t\t" . '<td><div class="gallerybox" style="width: '.($this->mWidths*1.25).'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>";
                        }
-                       $s .= ($i%4==3) ? '</tr>' : '';
-                       $i++;
+                       ++$i;
                }
-               if( $i %4 != 0 ) {
-                       $s .= "</tr>\n";
+               if( $i % $this->mPerRow != 0 ) {
+                       $s .= "\n\t</tr>";
                }
-               $s .= '</table>';
+               $s .= "\n</table>";
 
                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
 ?>