MediaWiki  master
ImageHandler.php
Go to the documentation of this file.
1 <?php
24 use Wikimedia\AtEase\AtEase;
25 
33 abstract class ImageHandler extends MediaHandler {
40  public function canRender( $file ) {
41  return ( $file->getWidth() && $file->getHeight() );
42  }
43 
49  public function getParamMap() {
50  return [ 'img_width' => 'width' ];
51  }
52 
57  public function validateParam( $name, $value ) {
58  return in_array( $name, [ 'width', 'height' ] ) && $value > 0;
59  }
60 
65  public function makeParamString( $params ) {
66  if ( isset( $params['physicalWidth'] ) ) {
67  $width = $params['physicalWidth'];
68  } elseif ( isset( $params['width'] ) ) {
69  $width = $params['width'];
70  } else {
71  throw new MediaTransformInvalidParametersException( 'No width specified to ' . __METHOD__ );
72  }
73 
74  # Removed for ProofreadPage
75  # $width = intval( $width );
76  return "{$width}px";
77  }
78 
83  public function parseParamString( $str ) {
84  $m = false;
85  if ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
86  return [ 'width' => $m[1] ];
87  }
88  return false;
89  }
90 
95  protected function getScriptParams( $params ) {
96  return [ 'width' => $params['width'] ];
97  }
98 
107  public function normaliseParams( $image, &$params ) {
108  if ( !isset( $params['width'] ) ) {
109  return false;
110  }
111 
112  if ( !isset( $params['page'] ) ) {
113  $params['page'] = 1;
114  } else {
115  $params['page'] = (int)$params['page'];
116  if ( $params['page'] > $image->pageCount() ) {
117  $params['page'] = $image->pageCount();
118  }
119 
120  if ( $params['page'] < 1 ) {
121  $params['page'] = 1;
122  }
123  }
124 
125  $srcWidth = $image->getWidth( $params['page'] );
126  $srcHeight = $image->getHeight( $params['page'] );
127 
128  if ( isset( $params['height'] ) && $params['height'] !== -1 ) {
129  # Height & width were both set
130  if ( $params['width'] * $srcHeight > $params['height'] * $srcWidth ) {
131  # Height is the relative smaller dimension, so scale width accordingly
132  $params['width'] = self::fitBoxWidth( $srcWidth, $srcHeight, $params['height'] );
133 
134  if ( $params['width'] == 0 ) {
135  # Very small image, so we need to rely on client side scaling :(
136  $params['width'] = 1;
137  }
138 
139  $params['physicalWidth'] = $params['width'];
140  } else {
141  # Height was crap, unset it so that it will be calculated later
142  unset( $params['height'] );
143  }
144  }
145 
146  if ( !isset( $params['physicalWidth'] ) ) {
147  # Passed all validations, so set the physicalWidth
148  // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive, checked above
149  $params['physicalWidth'] = $params['width'];
150  }
151 
152  # Because thumbs are only referred to by width, the height always needs
153  # to be scaled by the width to keep the thumbnail sizes consistent,
154  # even if it was set inside the if block above
155  $params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight,
156  $params['physicalWidth'] );
157 
158  # Set the height if it was not validated in the if block higher up
159  if ( !isset( $params['height'] ) || $params['height'] === -1 ) {
160  $params['height'] = $params['physicalHeight'];
161  }
162 
163  if ( !$this->validateThumbParams( $params['physicalWidth'],
164  $params['physicalHeight'], $srcWidth, $srcHeight )
165  ) {
166  return false;
167  }
168 
169  return true;
170  }
171 
181  private function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight ) {
182  $width = (int)$width;
183 
184  if ( $width <= 0 ) {
185  wfDebug( __METHOD__ . ": Invalid destination width: $width" );
186 
187  return false;
188  }
189  if ( $srcWidth <= 0 ) {
190  wfDebug( __METHOD__ . ": Invalid source width: $srcWidth" );
191 
192  return false;
193  }
194 
195  $height = File::scaleHeight( $srcWidth, $srcHeight, $width );
196  if ( $height == 0 ) {
197  # Force height to be at least 1 pixel
198  $height = 1;
199  }
200 
201  return true;
202  }
203 
212  public function getScriptedTransform( $image, $script, $params ) {
213  if ( !$this->normaliseParams( $image, $params ) ) {
214  return false;
215  }
216  $url = wfAppendQuery( $script, $this->getScriptParams( $params ) );
217 
218  if ( $image->mustRender() || $params['width'] < $image->getWidth() ) {
219  return new ThumbnailImage( $image, $url, false, $params );
220  }
221  }
222 
223  public function getImageSize( $image, $path ) {
224  AtEase::suppressWarnings();
225  $gis = getimagesize( $path );
226  AtEase::restoreWarnings();
227 
228  return $gis;
229  }
230 
231  public function getSizeAndMetadata( $state, $path ) {
232  // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
233  $gis = @getimagesize( $path );
234  if ( $gis ) {
235  $info = [
236  'width' => $gis[0],
237  'height' => $gis[1],
238  ];
239  if ( isset( $gis['bits'] ) ) {
240  $info['bits'] = $gis['bits'];
241  }
242  } else {
243  $info = [];
244  }
245  return $info;
246  }
247 
258  public function getImageArea( $image ) {
259  return $image->getWidth() * $image->getHeight();
260  }
261 
268  public function getShortDesc( $file ) {
269  global $wgLang;
270  $nbytes = htmlspecialchars( $wgLang->formatSize( $file->getSize() ) );
271  $widthheight = wfMessage( 'widthheight' )
272  ->numParams( $file->getWidth(), $file->getHeight() )->escaped();
273 
274  return "$widthheight ($nbytes)";
275  }
276 
283  public function getLongDesc( $file ) {
284  $pages = $file->pageCount();
285  if ( $pages === false || $pages <= 1 ) {
286  $msg = wfMessage( 'file-info-size' )->numParams( $file->getWidth(),
287  $file->getHeight() )->sizeParams( $file->getSize() )->params(
288  '<span class="mime-type">' . $file->getMimeType() . '</span>' )->parse();
289  } else {
290  $msg = wfMessage( 'file-info-size-pages' )->numParams( $file->getWidth(),
291  $file->getHeight() )->sizeParams( $file->getSize() )->params(
292  '<span class="mime-type">' . $file->getMimeType() . '</span>' )->numParams( $pages )->parse();
293  }
294 
295  return $msg;
296  }
297 
304  public function getDimensionsString( $file ) {
305  $pages = $file->pageCount();
306  if ( $pages > 1 ) {
307  return wfMessage( 'widthheightpage' )
308  ->numParams( $file->getWidth(), $file->getHeight(), $pages )->text();
309  }
310  return wfMessage( 'widthheight' )
311  ->numParams( $file->getWidth(), $file->getHeight() )->text();
312  }
313 
318  public function sanitizeParamsForBucketing( $params ) {
319  $params = parent::sanitizeParamsForBucketing( $params );
320 
321  // We unset the height parameters in order to let normaliseParams recalculate them
322  // Otherwise there might be a height discrepancy
323  unset( $params['height'] );
324  unset( $params['physicalHeight'] );
325 
326  return $params;
327  }
328 }
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
if(!defined( 'MW_NO_SESSION') &&! $wgCommandLineMode) $wgLang
Definition: Setup.php:519
static scaleHeight( $srcWidth, $srcHeight, $dstWidth)
Calculate the height of a thumbnail using the source and destination width.
Definition: File.php:2188
Media handler abstract base class for images.
canRender( $file)
True if the handled types can be transformed.Stability: stableto overridebool
getImageSize( $image, $path)
Get an image size array like that returned by getimagesize(), or false if it can't be determined.
sanitizeParamsForBucketing( $params)
Returns a normalised params array for which parameters have been cleaned up for bucketing purposes....
getImageArea( $image)
Function that returns the number of pixels to be thumbnailed.
getParamMap()
Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to iden...
getSizeAndMetadata( $state, $path)
Get image size information and metadata array.
normaliseParams( $image, &$params)
Changes the parameter array as necessary, ready for transformation.Should be idempotent....
parseParamString( $str)
Parse a param string made with makeParamString back into an array.The parameter string without file n...
makeParamString( $params)
Merge a parameter array into a string appropriate for inclusion in filenames.Array of parameters that...
getLongDesc( $file)
Long description.Shown under image on image description page surrounded by ().Stability: stableto ove...
validateParam( $name, $value)
Validate a thumbnail parameter at parse time.Return true to accept the parameter, and false to reject...
getScriptedTransform( $image, $script, $params)
Get a MediaTransformOutput object representing an alternate of the transformed output which will call...
getScriptParams( $params)
getDimensionsString( $file)
Shown in file history box on image description page.Stability: stableto overridestring Dimensions
getShortDesc( $file)
Short description.Shown on Special:Search results.Stability: stableto overridestring
Base media handler class.
static fitBoxWidth( $boxWidth, $boxHeight, $maxHeight)
Calculate the largest thumbnail width for a given original file size such that the thumbnail's height...
MediaWiki exception thrown by some methods when the transform parameter array is invalid.
Media transform output for images.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42