If 'tables' is a string that starts with a space, treat it as user-enforced FROM...
[lhc/web/wiklou.git] / includes / ImageGallery.php
index b652e49..86bf786 100644 (file)
-
 <?php
-/**
- * @package MediaWiki
- */
+if ( ! defined( 'MEDIAWIKI' ) )
+       die( 1 );
 
 /**
- * This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
  */
-if( defined( 'MEDIAWIKI' ) ) {
-
 
 /**
  * Image gallery
- * 
+ *
  * 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;
+               $this->mParsing = false;
+       }
+
+       /**
+        * Set the "parse" bit so we know to hide "bad" images
+        */
+       function setParsing( $val = true ) {
+               $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.
         *
-        * @param Image  $image  Image object that is added to the gallery
-        * @param string $text   Additional 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, $text='' ) {
-               $this->mImages[] = array( &$image, $text );
+       function add( $image, $html='' ) {
+               $this->mImages[] = array( &$image, $html );
+               wfDebug( "ImageGallery::add " . $image->getName() . "\n" );
        }
 
        /**
-        * isEmpty() returns false iff the gallery doesn't contain any images
+       * Add an image at the beginning of the gallery.
+       *
+       * @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 ) );
+       }
+
+
+       /**
+        * isEmpty() returns true if the gallery contains no images
         */
        function isEmpty() {
                return empty( $this->mImages );
@@ -50,8 +155,8 @@ 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);
@@ -60,8 +165,8 @@ 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);
@@ -69,7 +174,7 @@ class ImageGallery
 
        /**
         * Return a HTML representation of the image gallery
-        * 
+        *
         * For each image in the gallery, display
         * - a thumbnail
         * - the image name
@@ -78,80 +183,111 @@ class ImageGallery
         *
         */
        function toHTML() {
-               global $wgLang, $wgContLang, $wgUser;
+               global $wgLang, $wgGenerateThumbnailOnParse;
+
+               $sk = $this->getSkin();
 
-               $sk = $wgUser->getSkin();
+               $s = '<table class="gallery" cellspacing="0" cellpadding="0">';
+               if( $this->mCaption )
+                       $s .= "\n\t<caption>{$this->mCaption}</caption>";
 
-               $s = '<table  style="border:solid 1px #DDDDDD; cellspacing:0; cellpadding:0; margin:1em;">';
                $i = 0;
                foreach ( $this->mImages as $pair ) {
                        $img =& $pair[0];
                        $text = $pair[1];
 
-                       $name = $img->getName();
                        $nt = $img->getTitle();
 
+                       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->getThumbnail( $this->mWidths, $this->mHeights, $wgGenerateThumbnailOnParse ) ) ) {
+                               # 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
                        //$ul = $sk->makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut );
 
-                       $nb = $this->mShowBytes ? 
-                               wfMsg( "nbytes", $wgLang->formatNum( $img->getSize() ) )  . '<br />' :
-                               '' ;
+                       if( $this->mShowBytes ) {
+                               if( $img->exists() ) {
+                                       $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
+                                               $wgLang->formatNum( $img->getSize() ) );
+                               } else {
+                                       $nb = wfMsgHtml( 'filemissing' );
+                               }
+                               $nb = "$nb<br />\n";
+                       } else {
+                               $nb = '';
+                       }
+
                        $textlink = $this->mShowFilename ?
-                               $sk->makeKnownLinkObj( $nt, Language::truncate( $nt->getText(), 20, '...' ) ) . '<br />' :
+                               $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "<br />\n" :
                                '' ;
 
-                       $s .= ($i%4==0) ? '<tr>' : '';
-                       $s .= '<td valign="top" width="150px" style="background-color:#F0F0F0;">' .
-                               '<table width="100%" height="150px">'.
-                               '<tr><td align="center" valign="center" style="background-color:#F8F8F8;border:solid 1px #888888;">' .
-                               $sk->makeKnownLinkObj( $nt, '<img  src="'.$img->createThumb(120,120).'" alt="">' ) . '</td></tr></table> ' .
-                               $textlink . $text . $nb; 
-
-                       $s .= '</td>' .  (($i%4==3) ? '</tr>' : '');
+                       # 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
 
-                       $i++;
+                       if ( $i % $this->mPerRow == 0 ) {
+                               $s .= "\n\t<tr>";
+                       }
+                       $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>";
+                       }
+                       ++$i;
+               }
+               if( $i % $this->mPerRow != 0 ) {
+                       $s .= "\n\t</tr>";
                }
-               $s .= '</table>';
+               $s .= "\n</table>";
 
                return $s;
        }
 
        /**
-        * Transparently generates an image gallery from a text with one line per image.
-        * text labels may be given by using |-style alternative text. E.g.
-        *   Image:one.jpg|The number "1"
-        *   Image:tree.jpg|A tree
-        * given as text will return a gallery with two images, labeled 'The number "1"' and
-        * 'A tree'.
-        */
-       function newFromTextList( $text ) {
-               $ig = new ImageGallery();
-               $ig->setShowBytes( false );
-               $ig->setShowFilename( false );
-               $lines = explode( "\n", $text );
-               foreach ( $lines as $line ) {
-                       preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
-                       # Skip empty lines
-                       if ( count( $matches ) == 0 ) {
-                               continue;
-                       }
-                       $nt = Title::newFromURL( $matches[1] );
-                       if ( isset( $matches[3] ) ) {
-                               $label = $matches[3];
-                       } else {
-                               $label = '';
-                       }
-                       $ig->add( Image::newFromTitle( $nt ), $label );
-               }
-               return $ig;
+        * @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
-
-
-
-
-} // defined( 'MEDIAWIKI' )
 ?>