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                         $meta = [];
 178                         if ( $img ) {
 179                                 if ( $this->mShowDimensions ) {
 180                                         $meta[] = $img->getDimensionsString();
 181                                 }
 182                                 if ( $this->mShowBytes ) {
 183                                         $meta[] = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
 184                                 }
 185                         } elseif ( $this->mShowDimensions || $this->mShowBytes ) {
 186                                 $meta[] = $this->msg( 'filemissing' )->escaped();
 187                         }
 188                         $meta = $lang->semicolonList( $meta );
 189                         if ( $meta ) {
 190                                 $meta .= "<br />\n";
 191                         }
 192
 193                         $textlink = $this->mShowFilename ?
 194                                 // Preloaded into LinkCache above
 195                                 Linker::linkKnown(
 196                                         $nt,
 197                                         htmlspecialchars(
 198                                                 is_int( $this->getCaptionLength() ) ?
 199                                                         $lang->truncate( $nt->getText(), $this->getCaptionLength() ) :
 200                                                         $nt->getText()
 201                                         ),
 202                                         [
 203                                                 'class' => 'galleryfilename' .
 204                                                         ( $this->getCaptionLength() === true ? ' galleryfilename-truncate' : '' )
 205                                         ]
 206                                 ) . "\n" :
 207                                 '';
 208
 209                         $galleryText = $textlink . $text . $meta;
 210                         $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
 211
 212                         $gbWidth = $this->getGBWidth( $thumb ) . 'px';
 213                         if ( $this->getGBWidthOverwrite( $thumb ) ) {
 214                                 $gbWidth = $this->getGBWidthOverwrite( $thumb );
 215                         }
 216                         # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
 217                         # Can be safely removed if FF2 falls completely out of existence
 218                         $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
 219                                 . $gbWidth . '">'
 220                                 . '<div style="width: ' . $gbWidth . '">'
 221                                 . $thumbhtml
 222                                 . $galleryText
 223                                 . "\n\t\t</div></li>";
 224                 }
 225                 $output .= "\n</ul>";
 226
 227                 return $output;
 228         }
 229
 230         /**
 231          * Add the wrapper html around the thumb's caption
 232          *
 233          * @param string $galleryText The caption
 234          * @param MediaTransformOutput|bool $thumb The thumb this caption is for
 235          *   or false for bad image.
 236          * @return string
 237          */
 238         protected function wrapGalleryText( $galleryText, $thumb ) {
 239                 # ATTENTION: The newline after <div class="gallerytext"> is needed to
 240                 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
 241                 # its absence, see: https://phabricator.wikimedia.org/T3765
 242                 # -Ævar
 243
 244                 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
 245                         . $galleryText
 246                         . "\n\t\t\t</div>";
 247         }
 248
 249         /**
 250          * How much padding the thumb has between the image and the inner div
 251          * that contains the border. This is for both vertical and horizontal
 252          * padding. (However, it is cut in half in the vertical direction).
 253          * @return int
 254          */
 255         protected function getThumbPadding() {
 256                 return 30;
 257         }
 258
 259         /**
 260          * @note GB stands for gallerybox (as in the <li class="gallerybox"> element)
 261          *
 262          * @return int
 263          */
 264         protected function getGBPadding() {
 265                 return 5;
 266         }
 267
 268         /**
 269          * Get how much extra space the borders around the image takes up.
 270          *
 271          * For this mode, it is 2px borders on each side + 2px implied padding on
 272          * each side from the stylesheet, giving us 2*2+2*2 = 8.
 273          * @return int
 274          */
 275         protected function getGBBorders() {
 276                 return 8;
 277         }
 278
 279         /**
 280          * Length to truncate filename to in caption when using "showfilename" (if int).
 281          * A value of 'true' will truncate the filename to one line using CSS, while
 282          * 'false' will disable truncating.
 283          *
 284          * @return int|bool
 285          */
 286         protected function getCaptionLength() {
 287                 return $this->mCaptionLength;
 288         }
 289
 290         /**
 291          * Get total padding.
 292          *
 293          * @return int Number of pixels of whitespace surrounding the thumbnail.
 294          */
 295         protected function getAllPadding() {
 296                 return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
 297         }
 298
 299         /**
 300          * Get vertical padding for a thumbnail
 301          *
 302          * Generally this is the total height minus how high the thumb is.
 303          *
 304          * @param int $boxHeight How high we want the box to be.
 305          * @param int $thumbHeight How high the thumbnail is.
 306          * @return int Vertical padding to add on each side.
 307          */
 308         protected function getVPad( $boxHeight, $thumbHeight ) {
 309                 return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
 310         }
 311
 312         /**
 313          * Get the transform parameters for a thumbnail.
 314          *
 315          * @param File $img The file in question. May be false for invalid image
 316          * @return array
 317          */
 318         protected function getThumbParams( $img ) {
 319                 return [
 320                         'width' => $this->mWidths,
 321                         'height' => $this->mHeights
 322                 ];
 323         }
 324
 325         /**
 326          * Get the width of the inner div that contains the thumbnail in
 327          * question. This is the div with the class of "thumb".
 328          *
 329          * @param int $thumbWidth The width of the thumbnail.
 330          * @return int Width of inner thumb div.
 331          */
 332         protected function getThumbDivWidth( $thumbWidth ) {
 333                 return $this->mWidths + $this->getThumbPadding();
 334         }
 335
 336         /**
 337          * Computed width of gallerybox <li>.
 338          *
 339          * Generally is the width of the image, plus padding on image
 340          * plus padding on gallerybox.
 341          *
 342          * @note Important: parameter will be false if no thumb used.
 343          * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
 344          * @return int Width of gallerybox element
 345          */
 346         protected function getGBWidth( $thumb ) {
 347                 return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
 348         }
 349
 350         /**
 351          * Allows overwriting the computed width of the gallerybox <li> with a string,
 352          * like '100%'.
 353          *
 354          * Generally is the width of the image, plus padding on image
 355          * plus padding on gallerybox.
 356          *
 357          * @note Important: parameter will be false if no thumb used.
 358          * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
 359          * @return bool|string Ignored if false.
 360          */
 361         protected function getGBWidthOverwrite( $thumb ) {
 362                 return false;
 363         }
 364
 365         /**
 366          * Get a list of modules to include in the page.
 367          *
 368          * Primarily intended for subclasses.
 369          *
 370          * @return array Modules to include
 371          */
 372         protected function getModules() {
 373                 return [];
 374         }
 375
 376         /**
 377          * Adjust the image parameters for a thumbnail.
 378          *
 379          * Used by a subclass to insert extra high resolution images.
 380          * @param MediaTransformOutput $thumb The thumbnail
 381          * @param array &$imageParameters Array of options
 382          */
 383         protected function adjustImageParameters( $thumb, &$imageParameters ) {
 384         }
 385 }