includes/gallery/TraditionalImageGallery.php

   1 <?php
   2 /**
   3  * Image gallery.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 class TraditionalImageGallery extends ImageGalleryBase {
  24         /**
  25          * Return a HTML representation of the image gallery
  26          *
  27          * For each image in the gallery, display
  28          * - a thumbnail
  29          * - the image name
  30          * - the additional text provided when adding the image
  31          * - the size of the image
  32          *
  33          * @return string
  34          */
  35         function toHTML() {
  36                 if ( $this->mPerRow > 0 ) {
  37                         $maxwidth = $this->mPerRow * ( $this->mWidths + $this->getAllPadding() );
  38                         $oldStyle = isset( $this->mAttribs['style'] ) ? $this->mAttribs['style'] : '';
  39                         # _width is ignored by any sane browser. IE6 doesn't know max-width
  40                         # so it uses _width instead
  41                         $this->mAttribs['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;" .
  42                                 $oldStyle;
  43                 }
  44
  45                 $attribs = Sanitizer::mergeAttributes(
  46                         array( 'class' => 'gallery mw-gallery-' . $this->mMode ), $this->mAttribs );
  47
  48                 $modules = $this->getModules();
  49
  50                 if ( $this->mParser ) {
  51                         $this->mParser->getOutput()->addModules( $modules );
  52                         $this->mParser->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
  53                 } else {
  54                         $this->getOutput()->addModules( $modules );
  55                         $this->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
  56                 }
  57                 $output = Xml::openElement( 'ul', $attribs );
  58                 if ( $this->mCaption ) {
  59                         $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
  60                 }
  61
  62                 $lang = $this->getRenderLang();
  63                 # Output each image...
  64                 foreach ( $this->mImages as $pair ) {
  65                         /** @var Title $nt */
  66                         $nt = $pair[0];
  67                         $text = $pair[1]; # "text" means "caption" here
  68                         $alt = $pair[2];
  69                         $link = $pair[3];
  70
  71                         $descQuery = false;
  72                         if ( $nt->getNamespace() === NS_FILE ) {
  73                                 # Get the file...
  74                                 if ( $this->mParser instanceof Parser ) {
  75                                         # Give extensions a chance to select the file revision for us
  76                                         $options = array();
  77                                         Hooks::run( 'BeforeParserFetchFileAndTitle',
  78                                                 array( $this->mParser, $nt, &$options, &$descQuery ) );
  79                                         # Fetch and register the file (file title may be different via hooks)
  80                                         list( $img, $nt ) = $this->mParser->fetchFileAndTitle( $nt, $options );
  81                                 } else {
  82                                         $img = wfFindFile( $nt );
  83                                 }
  84                         } else {
  85                                 $img = false;
  86                         }
  87
  88                         $params = $this->getThumbParams( $img );
  89                         // $pair[4] is per image handler options
  90                         $transformOptions = $params + $pair[4];
  91
  92                         $thumb = false;
  93
  94                         if ( !$img ) {
  95                                 # We're dealing with a non-image, spit out the name and be done with it.
  96                                 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
  97                                         . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
  98                                         . htmlspecialchars( $nt->getText() ) . '</div>';
  99
 100                                 if ( $this->mParser instanceof Parser ) {
 101                                         $this->mParser->addTrackingCategory( 'broken-file-category' );
 102                                 }
 103                         } elseif ( $this->mHideBadImages
 104                                 && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() )
 105                         ) {
 106                                 # The image is blacklisted, just show it as a text link.
 107                                 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
 108                                         ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' .
 109                                         Linker::linkKnown(
 110                                                 $nt,
 111                                                 htmlspecialchars( $nt->getText() )
 112                                         ) .
 113                                         '</div>';
 114                         } elseif ( !( $thumb = $img->transform( $transformOptions ) ) ) {
 115                                 # Error generating thumbnail.
 116                                 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
 117                                         . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
 118                                         . htmlspecialchars( $img->getLastError() ) . '</div>';
 119                         } else {
 120                                 /** @var MediaTransformOutput $thumb */
 121                                 $vpad = $this->getVPad( $this->mHeights, $thumb->getHeight() );
 122
 123                                 $imageParameters = array(
 124                                         'desc-link' => true,
 125                                         'desc-query' => $descQuery,
 126                                         'alt' => $alt,
 127                                         'custom-url-link' => $link
 128                                 );
 129
 130                                 // In the absence of both alt text and caption, fall back on
 131                                 // providing screen readers with the filename as alt text
 132                                 if ( $alt == '' && $text == '' ) {
 133                                         $imageParameters['alt'] = $nt->getText();
 134                                 }
 135
 136                                 $this->adjustImageParameters( $thumb, $imageParameters );
 137
 138                                 Linker::processResponsiveImages( $img, $thumb, $transformOptions );
 139
 140                                 # Set both fixed width and min-height.
 141                                 $thumbhtml = "\n\t\t\t"
 142                                         . '<div class="thumb" style="width: '
 143                                         . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">'
 144                                         # Auto-margin centering for block-level elements. Needed
 145                                         # now that we have video handlers since they may emit block-
 146                                         # level elements as opposed to simple <img> tags. ref
 147                                         # http://css-discuss.incutio.com/?page=CenteringBlockElement
 148                                         . '<div style="margin:' . $vpad . 'px auto;">'
 149                                         . $thumb->toHtml( $imageParameters ) . '</div></div>';
 150
 151                                 // Call parser transform hook
 152                                 /** @var MediaHandler $handler */
 153                                 $handler = $img->getHandler();
 154                                 if ( $this->mParser && $handler ) {
 155                                         $handler->parserTransformHook( $this->mParser, $img );
 156                                 }
 157                         }
 158
 159                         // @todo Code is incomplete.
 160                         // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) .
 161                         // ":{$ut}" );
 162                         // $ul = Linker::link( $linkTarget, $ut );
 163
 164                         if ( $this->mShowBytes ) {
 165                                 if ( $img ) {
 166                                         $fileSize = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
 167                                 } else {
 168                                         $fileSize = $this->msg( 'filemissing' )->escaped();
 169                                 }
 170                                 $fileSize = "$fileSize<br />\n";
 171                         } else {
 172                                 $fileSize = '';
 173                         }
 174
 175                         $textlink = $this->mShowFilename ?
 176                                 Linker::linkKnown(
 177                                         $nt,
 178                                         htmlspecialchars( $lang->truncate( $nt->getText(), $this->mCaptionLength ) )
 179                                 ) . "<br />\n" :
 180                                 '';
 181
 182                         $galleryText = $textlink . $text . $fileSize;
 183                         $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
 184
 185                         # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
 186                         # Can be safely removed if FF2 falls completely out of existence
 187                         $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
 188                                 . $this->getGBWidth( $thumb ) . 'px">'
 189                                 . '<div style="width: ' . $this->getGBWidth( $thumb ) . 'px">'
 190                                 . $thumbhtml
 191                                 . $galleryText
 192                                 . "\n\t\t</div></li>";
 193                 }
 194                 $output .= "\n</ul>";
 195
 196                 return $output;
 197         }
 198
 199         /**
 200          * Add the wrapper html around the thumb's caption
 201          *
 202          * @param string $galleryText The caption
 203          * @param MediaTransformOutput|bool $thumb The thumb this caption is for
 204          *   or false for bad image.
 205          * @return string
 206          */
 207         protected function wrapGalleryText( $galleryText, $thumb ) {
 208                 # ATTENTION: The newline after <div class="gallerytext"> is needed to
 209                 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
 210                 # its absence, see: https://phabricator.wikimedia.org/T3765
 211                 # -Ævar
 212
 213                 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
 214                         . $galleryText
 215                         . "\n\t\t\t</div>";
 216         }
 217
 218         /**
 219          * How much padding such the thumb have between image and inner div that
 220          * that contains the border. This is both for verical and horizontal
 221          * padding. (However, it is cut in half in the vertical direction).
 222          * @return int
 223          */
 224         protected function getThumbPadding() {
 225                 return 30;
 226         }
 227
 228         /**
 229          * @note GB stands for gallerybox (as in the <li class="gallerybox"> element)
 230          *
 231          * @return int
 232          */
 233         protected function getGBPadding() {
 234                 return 5;
 235         }
 236
 237         /**
 238          * Get how much extra space the borders around the image takes up.
 239          *
 240          * For this mode, it is 2px borders on each side + 2px implied padding on
 241          * each side from the stylesheet, giving us 2*2+2*2 = 8.
 242          * @return int
 243          */
 244         protected function getGBBorders() {
 245                 return 8;
 246         }
 247
 248         /**
 249          * Get total padding.
 250          *
 251          * @return int Number of pixels of whitespace surrounding the thumbnail.
 252          */
 253         protected function getAllPadding() {
 254                 return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
 255         }
 256
 257         /**
 258          * Get vertical padding for a thumbnail
 259          *
 260          * Generally this is the total height minus how high the thumb is.
 261          *
 262          * @param int $boxHeight How high we want the box to be.
 263          * @param int $thumbHeight How high the thumbnail is.
 264          * @return int Vertical padding to add on each side.
 265          */
 266         protected function getVPad( $boxHeight, $thumbHeight ) {
 267                 return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
 268         }
 269
 270         /**
 271          * Get the transform parameters for a thumbnail.
 272          *
 273          * @param File $img The file in question. May be false for invalid image
 274          * @return array
 275          */
 276         protected function getThumbParams( $img ) {
 277                 return array(
 278                         'width' => $this->mWidths,
 279                         'height' => $this->mHeights
 280                 );
 281         }
 282
 283         /**
 284          * Get the width of the inner div that contains the thumbnail in
 285          * question. This is the div with the class of "thumb".
 286          *
 287          * @param int $thumbWidth The width of the thumbnail.
 288          * @return int Width of inner thumb div.
 289          */
 290         protected function getThumbDivWidth( $thumbWidth ) {
 291                 return $this->mWidths + $this->getThumbPadding();
 292         }
 293
 294         /**
 295          * Width of gallerybox <li>.
 296          *
 297          * Generally is the width of the image, plus padding on image
 298          * plus padding on gallerybox.
 299          *
 300          * @note Important: parameter will be false if no thumb used.
 301          * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
 302          * @return int Width of gallerybox element
 303          */
 304         protected function getGBWidth( $thumb ) {
 305                 return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
 306         }
 307
 308         /**
 309          * Get a list of modules to include in the page.
 310          *
 311          * Primarily intended for subclasses.
 312          *
 313          * @return array Modules to include
 314          */
 315         protected function getModules() {
 316                 return array();
 317         }
 318
 319         /**
 320          * Adjust the image parameters for a thumbnail.
 321          *
 322          * Used by a subclass to insert extra high resolution images.
 323          * @param MediaTransformOutput $thumb The thumbnail
 324          * @param array $imageParameters Array of options
 325          */
 326         protected function adjustImageParameters( $thumb, &$imageParameters ) {
 327         }
 328 }
 329
 330 /**
 331  * Backwards compatibility. This always uses traditional mode
 332  * if called the old way, for extensions that may expect traditional
 333  * mode.
 334  *
 335  * @deprecated since 1.22 Use ImageGalleryBase::factory instead.
 336  */
 337 class ImageGallery extends TraditionalImageGallery {
 338         function __construct( $mode = 'traditional' ) {
 339                 wfDeprecated( __METHOD__, '1.22' );
 340                 parent::__construct( $mode );
 341         }
 342 }