includes/media/ThumbnailImage.php

   1 <?php
   2 /**
   3  * Base class for the output of file transformation methods.
   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  * @ingroup Media
  22  */
  23
  24 /**
  25  * Media transform output for images
  26  *
  27  * @ingroup Media
  28  */
  29 class ThumbnailImage extends MediaTransformOutput {
  30         private static $firstNonIconImageRendered = false;
  31
  32         /**
  33          * Get a thumbnail object from a file and parameters.
  34          * If $path is set to null, the output file is treated as a source copy.
  35          * If $path is set to false, no output file will be created.
  36          * $parameters should include, as a minimum, (file) 'width' and 'height'.
  37          * It may also include a 'page' parameter for multipage files.
  38          *
  39          * @param File $file
  40          * @param string $url URL path to the thumb
  41          * @param string|bool $path Filesystem path to the thumb
  42          * @param array $parameters Associative array of parameters
  43          */
  44         function __construct( $file, $url, $path = false, $parameters = [] ) {
  45                 # Previous parameters:
  46                 #   $file, $url, $width, $height, $path = false, $page = false
  47
  48                 $defaults = [
  49                         'page' => false,
  50                         'lang' => false
  51                 ];
  52
  53                 if ( is_array( $parameters ) ) {
  54                         $actualParams = $parameters + $defaults;
  55                 } else {
  56                         # Using old format, should convert. Later a warning could be added here.
  57                         $numArgs = func_num_args();
  58                         $actualParams = [
  59                                 'width' => $path,
  60                                 'height' => $parameters,
  61                                 'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
  62                         ] + $defaults;
  63                         $path = ( $numArgs > 4 ) ? func_get_arg( 4 ) : false;
  64                 }
  65
  66                 $this->file = $file;
  67                 $this->url = $url;
  68                 $this->path = $path;
  69
  70                 # These should be integers when they get here.
  71                 # If not, there's a bug somewhere.  But let's at
  72                 # least produce valid HTML code regardless.
  73                 $this->width = round( $actualParams['width'] );
  74                 $this->height = round( $actualParams['height'] );
  75
  76                 $this->page = $actualParams['page'];
  77                 $this->lang = $actualParams['lang'];
  78         }
  79
  80         /**
  81          * Return HTML <img ... /> tag for the thumbnail, will include
  82          * width and height attributes and a blank alt text (as required).
  83          *
  84          * @param array $options Associative array of options. Boolean options
  85          *     should be indicated with a value of true for true, and false or
  86          *     absent for false.
  87          *
  88          *     alt          HTML alt attribute
  89          *     title        HTML title attribute
  90          *     desc-link    Boolean, show a description link
  91          *     file-link    Boolean, show a file download link
  92          *     valign       vertical-align property, if the output is an inline element
  93          *     img-class    Class applied to the \<img\> tag, if there is such a tag
  94          *     desc-query   String, description link query params
  95          *     override-width     Override width attribute. Should generally not set
  96          *     override-height    Override height attribute. Should generally not set
  97          *     no-dimensions      Boolean, skip width and height attributes (useful if
  98          *                        set in CSS)
  99          *     custom-url-link    Custom URL to link to
 100          *     custom-title-link  Custom Title object to link to
 101          *     custom target-link Value of the target attribute, for custom-target-link
 102          *     parser-extlink-*   Attributes added by parser for external links:
 103          *          parser-extlink-rel: add rel="nofollow"
 104          *          parser-extlink-target: link target, but overridden by custom-target-link
 105          *
 106          * For images, desc-link and file-link are implemented as a click-through. For
 107          * sounds and videos, they may be displayed in other ways.
 108          *
 109          * @throws MWException
 110          * @return string
 111          */
 112         function toHtml( $options = [] ) {
 113                 global $wgPriorityHints, $wgPriorityHintsRatio, $wgElementTiming, $wgNativeImageLazyLoading;
 114
 115                 if ( func_num_args() == 2 ) {
 116                         throw new MWException( __METHOD__ . ' called in the old style' );
 117                 }
 118
 119                 $alt = $options['alt'] ?? '';
 120
 121                 $query = $options['desc-query'] ?? '';
 122
 123                 $attribs = [
 124                         'alt' => $alt,
 125                         'src' => $this->url,
 126                         'decoding' => 'async',
 127                 ];
 128
 129                 if ( $wgNativeImageLazyLoading ) {
 130                         $attribs['loading'] = 'lazy';
 131                 }
 132
 133                 $elementTimingName = 'thumbnail';
 134
 135                 if ( $wgPriorityHints
 136                         && !self::$firstNonIconImageRendered
 137                         && $this->width * $this->height > 100 * 100 ) {
 138                         self::$firstNonIconImageRendered = true;
 139
 140                         // Generate a random number between 0.01 and 1.0, included
 141                         $random = rand( 1, 100 ) / 100.0;
 142
 143                         if ( $random <= $wgPriorityHintsRatio ) {
 144                                 $attribs['importance'] = 'high';
 145                                 $elementTimingName = 'thumbnail-high';
 146                         } else {
 147                                 // This lets us track that the thumbnail *would* have gotten high priority but didn't.
 148                                 $elementTimingName = 'thumbnail-top';
 149                         }
 150                 }
 151
 152                 if ( $wgElementTiming ) {
 153                         $attribs['elementtiming'] = $elementTimingName;
 154                 }
 155
 156                 if ( !empty( $options['custom-url-link'] ) ) {
 157                         $linkAttribs = [ 'href' => $options['custom-url-link'] ];
 158                         if ( !empty( $options['title'] ) ) {
 159                                 $linkAttribs['title'] = $options['title'];
 160                         }
 161                         if ( !empty( $options['custom-target-link'] ) ) {
 162                                 $linkAttribs['target'] = $options['custom-target-link'];
 163                         } elseif ( !empty( $options['parser-extlink-target'] ) ) {
 164                                 $linkAttribs['target'] = $options['parser-extlink-target'];
 165                         }
 166                         if ( !empty( $options['parser-extlink-rel'] ) ) {
 167                                 $linkAttribs['rel'] = $options['parser-extlink-rel'];
 168                         }
 169                 } elseif ( !empty( $options['custom-title-link'] ) ) {
 170                         /** @var Title $title */
 171                         $title = $options['custom-title-link'];
 172                         $linkAttribs = [
 173                                 'href' => $title->getLinkURL(),
 174                                 'title' => empty( $options['title'] ) ? $title->getFullText() : $options['title']
 175                         ];
 176                 } elseif ( !empty( $options['desc-link'] ) ) {
 177                         $linkAttribs = $this->getDescLinkAttribs(
 178                                 empty( $options['title'] ) ? null : $options['title'],
 179                                 $query
 180                         );
 181                 } elseif ( !empty( $options['file-link'] ) ) {
 182                         $linkAttribs = [ 'href' => $this->file->getUrl() ];
 183                 } else {
 184                         $linkAttribs = false;
 185                         if ( !empty( $options['title'] ) ) {
 186                                 $attribs['title'] = $options['title'];
 187                         }
 188                 }
 189
 190                 if ( empty( $options['no-dimensions'] ) ) {
 191                         $attribs['width'] = $this->width;
 192                         $attribs['height'] = $this->height;
 193                 }
 194                 if ( !empty( $options['valign'] ) ) {
 195                         $attribs['style'] = "vertical-align: {$options['valign']}";
 196                 }
 197                 if ( !empty( $options['img-class'] ) ) {
 198                         $attribs['class'] = $options['img-class'];
 199                 }
 200                 if ( isset( $options['override-height'] ) ) {
 201                         $attribs['height'] = $options['override-height'];
 202                 }
 203                 if ( isset( $options['override-width'] ) ) {
 204                         $attribs['width'] = $options['override-width'];
 205                 }
 206
 207                 // Additional densities for responsive images, if specified.
 208                 // If any of these urls is the same as src url, it'll be excluded.
 209                 $responsiveUrls = array_diff( $this->responsiveUrls, [ $this->url ] );
 210                 if ( !empty( $responsiveUrls ) ) {
 211                         $attribs['srcset'] = Html::srcSet( $responsiveUrls );
 212                 }
 213
 214                 Hooks::run( 'ThumbnailBeforeProduceHTML', [ $this, &$attribs, &$linkAttribs ] );
 215
 216                 return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
 217         }
 218 }