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                         [ '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                 if ( $this->mShowFilename ) {
  63                         // Preload LinkCache info for when generating links
  64                         // of the filename below
  65                         $lb = new LinkBatch();
  66                         foreach ( $this->mImages as $img ) {
  67                                 $lb->addObj( $img[0] );
  68                         }
  69                         $lb->execute();
  70                 }
  71
  72                 $lang = $this->getRenderLang();
  73                 # Output each image...
  74                 foreach ( $this->mImages as $pair ) {
  75                         /** @var Title $nt */
  76                         $nt = $pair[0];
  77                         $text = $pair[1]; # "text" means "caption" here
  78                         $alt = $pair[2];
  79                         $link = $pair[3];
  80
  81                         $descQuery = false;
  82                         if ( $nt->getNamespace() === NS_FILE ) {
  83                                 # Get the file...
  84                                 if ( $this->mParser instanceof Parser ) {
  85                                         # Give extensions a chance to select the file revision for us
  86                                         $options = [];
  87                                         Hooks::run( 'BeforeParserFetchFileAndTitle',
  88                                                 [ $this->mParser, $nt, &$options, &$descQuery ] );
  89                                         # Fetch and register the file (file title may be different via hooks)
  90                                         list( $img, $nt ) = $this->mParser->fetchFileAndTitle( $nt, $options );
  91                                 } else {
  92                                         $img = wfFindFile( $nt );
  93                                 }
  94                         } else {
  95                                 $img = false;
  96                         }
  97
  98                         $params = $this->getThumbParams( $img );
  99                         // $pair[4] is per image handler options
 100                         $transformOptions = $params + $pair[4];
 101
 102                         $thumb = false;
 103
 104                         if ( !$img ) {
 105                                 # We're dealing with a non-image, spit out the name and be done with it.
 106                                 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
 107                                         . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
 108                                         . htmlspecialchars( $nt->getText() ) . '</div>';
 109
 110                                 if ( $this->mParser instanceof Parser ) {
 111                                         $this->mParser->addTrackingCategory( 'broken-file-category' );
 112                                 }
 113                         } elseif ( $this->mHideBadImages
 114                                 && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() )
 115                         ) {
 116                                 # The image is blacklisted, just show it as a text link.
 117                                 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
 118                                         ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' .
 119                                         Linker::linkKnown(
 120                                                 $nt,
 121                                                 htmlspecialchars( $nt->getText() )
 122                                         ) .
 123                                         '</div>';
 124                         } else {
 125                                 $thumb = $img->transform( $transformOptions );
 126                                 if ( !$thumb ) {
 127                                         # Error generating thumbnail.
 128                                         $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
 129                                                 . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
 130                                                 . htmlspecialchars( $img->getLastError() ) . '</div>';
 131                                 } else {
 132                                         /** @var MediaTransformOutput $thumb */
 133                                         $vpad = $this->getVPad( $this->mHeights, $thumb->getHeight() );
 134
 135                                         $imageParameters = [
 136                                                 'desc-link' => true,
 137                                                 'desc-query' => $descQuery,
 138                                                 'alt' => $alt,
 139                                                 'custom-url-link' => $link
 140                                         ];
 141
 142                                         // In the absence of both alt text and caption, fall back on
 143                                         // providing screen readers with the filename as alt text
 144                                         if ( $alt == '' && $text == '' ) {
 145                                                 $imageParameters['alt'] = $nt->getText();
 146                                         }
 147
 148                                         $this->adjustImageParameters( $thumb, $imageParameters );
 149
 150                                         Linker::processResponsiveImages( $img, $thumb, $transformOptions );
 151
 152                                         # Set both fixed width and min-height.
 153                                         $thumbhtml = "\n\t\t\t"
 154                                                 . '<div class="thumb" style="width: '
 155                                                 . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">'
 156                                                 # Auto-margin centering for block-level elements. Needed
 157                                                 # now that we have video handlers since they may emit block-
 158                                                 # level elements as opposed to simple <img> tags. ref
 159                                                 # http://css-discuss.incutio.com/?page=CenteringBlockElement
 160                                                 . '<div style="margin:' . $vpad . 'px auto;">'
 161                                                 . $thumb->toHtml( $imageParameters ) . '</div></div>';
 162
 163                                         // Call parser transform hook
 164                                         /** @var MediaHandler $handler */
 165                                         $handler = $img->getHandler();
 166                                         if ( $this->mParser && $handler ) {
 167                                                 $handler->parserTransformHook( $this->mParser, $img );
 168                                         }
 169                                 }
 170                         }
 171
 172                         // @todo Code is incomplete.
 173                         // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) .
 174                         // ":{$ut}" );
 175                         // $ul = Linker::link( $linkTarget, $ut );
 176
 177                         if ( $this->mShowBytes ) {
 178                                 if ( $img ) {
 179                                         $fileSize = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
 180                                 } else {
 181                                         $fileSize = $this->msg( 'filemissing' )->escaped();
 182                                 }
 183                                 $fileSize = "$fileSize<br />\n";
 184                         } else {
 185                                 $fileSize = '';
 186                         }
 187
 188                         $textlink = $this->mShowFilename ?
 189                                 // Preloaded into LinkCache above
 190                                 Linker::linkKnown(
 191                                         $nt,
 192                                         htmlspecialchars( $lang->truncate( $nt->getText(), $this->mCaptionLength ) )
 193                                 ) . "<br />\n" :
 194                                 '';
 195
 196                         $galleryText = $textlink . $text . $fileSize;
 197                         $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
 198
 199                         # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
 200                         # Can be safely removed if FF2 falls completely out of existence
 201                         $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
 202                                 . $this->getGBWidth( $thumb ) . 'px">'
 203                                 . '<div style="width: ' . $this->getGBWidth( $thumb ) . 'px">'
 204                                 . $thumbhtml
 205                                 . $galleryText
 206                                 . "\n\t\t</div></li>";
 207                 }
 208                 $output .= "\n</ul>";
 209
 210                 return $output;
 211         }
 212
 213         /**
 214          * Add the wrapper html around the thumb's caption
 215          *
 216          * @param string $galleryText The caption
 217          * @param MediaTransformOutput|bool $thumb The thumb this caption is for
 218          *   or false for bad image.
 219          * @return string
 220          */
 221         protected function wrapGalleryText( $galleryText, $thumb ) {
 222                 # ATTENTION: The newline after <div class="gallerytext"> is needed to
 223                 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
 224                 # its absence, see: https://phabricator.wikimedia.org/T3765
 225                 # -Ævar
 226
 227                 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
 228                         . $galleryText
 229                         . "\n\t\t\t</div>";
 230         }
 231
 232         /**
 233          * How much padding such the thumb have between image and inner div that
 234          * that contains the border. This is both for verical and horizontal
 235          * padding. (However, it is cut in half in the vertical direction).
 236          * @return int
 237          */
 238         protected function getThumbPadding() {
 239                 return 30;
 240         }
 241
 242         /**
 243          * @note GB stands for gallerybox (as in the <li class="gallerybox"> element)
 244          *
 245          * @return int
 246          */
 247         protected function getGBPadding() {
 248                 return 5;
 249         }
 250
 251         /**
 252          * Get how much extra space the borders around the image takes up.
 253          *
 254          * For this mode, it is 2px borders on each side + 2px implied padding on
 255          * each side from the stylesheet, giving us 2*2+2*2 = 8.
 256          * @return int
 257          */
 258         protected function getGBBorders() {
 259                 return 8;
 260         }
 261
 262         /**
 263          * Get total padding.
 264          *
 265          * @return int Number of pixels of whitespace surrounding the thumbnail.
 266          */
 267         protected function getAllPadding() {
 268                 return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
 269         }
 270
 271         /**
 272          * Get vertical padding for a thumbnail
 273          *
 274          * Generally this is the total height minus how high the thumb is.
 275          *
 276          * @param int $boxHeight How high we want the box to be.
 277          * @param int $thumbHeight How high the thumbnail is.
 278          * @return int Vertical padding to add on each side.
 279          */
 280         protected function getVPad( $boxHeight, $thumbHeight ) {
 281                 return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
 282         }
 283
 284         /**
 285          * Get the transform parameters for a thumbnail.
 286          *
 287          * @param File $img The file in question. May be false for invalid image
 288          * @return array
 289          */
 290         protected function getThumbParams( $img ) {
 291                 return [
 292                         'width' => $this->mWidths,
 293                         'height' => $this->mHeights
 294                 ];
 295         }
 296
 297         /**
 298          * Get the width of the inner div that contains the thumbnail in
 299          * question. This is the div with the class of "thumb".
 300          *
 301          * @param int $thumbWidth The width of the thumbnail.
 302          * @return int Width of inner thumb div.
 303          */
 304         protected function getThumbDivWidth( $thumbWidth ) {
 305                 return $this->mWidths + $this->getThumbPadding();
 306         }
 307
 308         /**
 309          * Width of gallerybox <li>.
 310          *
 311          * Generally is the width of the image, plus padding on image
 312          * plus padding on gallerybox.
 313          *
 314          * @note Important: parameter will be false if no thumb used.
 315          * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
 316          * @return int Width of gallerybox element
 317          */
 318         protected function getGBWidth( $thumb ) {
 319                 return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
 320         }
 321
 322         /**
 323          * Get a list of modules to include in the page.
 324          *
 325          * Primarily intended for subclasses.
 326          *
 327          * @return array Modules to include
 328          */
 329         protected function getModules() {
 330                 return [];
 331         }
 332
 333         /**
 334          * Adjust the image parameters for a thumbnail.
 335          *
 336          * Used by a subclass to insert extra high resolution images.
 337          * @param MediaTransformOutput $thumb The thumbnail
 338          * @param array $imageParameters Array of options
 339          */
 340         protected function adjustImageParameters( $thumb, &$imageParameters ) {
 341         }
 342 }
 343
 344 /**
 345  * Backwards compatibility. This always uses traditional mode
 346  * if called the old way, for extensions that may expect traditional
 347  * mode.
 348  *
 349  * @deprecated since 1.22 Use ImageGalleryBase::factory instead.
 350  */
 351 class ImageGallery extends TraditionalImageGallery {
 352         function __construct( $mode = 'traditional' ) {
 353                 wfDeprecated( __METHOD__, '1.22' );
 354                 parent::__construct( $mode );
 355         }
 356 }