MediaWiki master
ImageHandler.php
Go to the documentation of this file.
1<?php
24use Wikimedia\AtEase\AtEase;
25
33abstract 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
66 public function makeParamString( $params ) {
67 if ( isset( $params['physicalWidth'] ) ) {
68 $width = $params['physicalWidth'];
69 } elseif ( isset( $params['width'] ) ) {
70 $width = $params['width'];
71 } else {
72 throw new MediaTransformInvalidParametersException( 'No width specified to ' . __METHOD__ );
73 }
74
75 # Removed for ProofreadPage
76 # $width = intval( $width );
77 return "{$width}px";
78 }
79
84 public function parseParamString( $str ) {
85 $m = false;
86 if ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
87 return [ 'width' => $m[1] ];
88 }
89 return false;
90 }
91
97 protected function getScriptParams( $params ) {
98 return [ 'width' => $params['width'] ];
99 }
100
109 public function normaliseParams( $image, &$params ) {
110 if ( !isset( $params['width'] ) ) {
111 return false;
112 }
113
114 if ( !isset( $params['page'] ) ) {
115 $params['page'] = 1;
116 } else {
117 $params['page'] = (int)$params['page'];
118 if ( $params['page'] > $image->pageCount() ) {
119 $params['page'] = $image->pageCount();
120 }
121
122 if ( $params['page'] < 1 ) {
123 $params['page'] = 1;
124 }
125 }
126
127 $srcWidth = $image->getWidth( $params['page'] );
128 $srcHeight = $image->getHeight( $params['page'] );
129
130 if ( isset( $params['height'] ) && $params['height'] !== -1 ) {
131 # Height & width were both set
132 if ( $params['width'] * $srcHeight > $params['height'] * $srcWidth ) {
133 # Height is the relative smaller dimension, so scale width accordingly
134 $params['width'] = self::fitBoxWidth( $srcWidth, $srcHeight, $params['height'] );
135
136 if ( $params['width'] == 0 ) {
137 # Very small image, so we need to rely on client side scaling :(
138 $params['width'] = 1;
139 }
140
141 $params['physicalWidth'] = $params['width'];
142 } else {
143 # Height was crap, unset it so that it will be calculated later
144 unset( $params['height'] );
145 }
146 }
147
148 if ( !isset( $params['physicalWidth'] ) ) {
149 # Passed all validations, so set the physicalWidth
150 // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive, checked above
151 $params['physicalWidth'] = $params['width'];
152 }
153
154 # Because thumbs are only referred to by width, the height always needs
155 # to be scaled by the width to keep the thumbnail sizes consistent,
156 # even if it was set inside the if block above
157 $params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight,
158 $params['physicalWidth'] );
159
160 # Set the height if it was not validated in the if block higher up
161 if ( !isset( $params['height'] ) || $params['height'] === -1 ) {
162 $params['height'] = $params['physicalHeight'];
163 }
164
165 if ( !$this->validateThumbParams( $params['physicalWidth'],
166 $params['physicalHeight'], $srcWidth, $srcHeight )
167 ) {
168 return false;
169 }
170
171 return true;
172 }
173
183 private function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight ) {
184 $width = (int)$width;
185
186 if ( $width <= 0 ) {
187 wfDebug( __METHOD__ . ": Invalid destination width: $width" );
188
189 return false;
190 }
191 if ( $srcWidth <= 0 ) {
192 wfDebug( __METHOD__ . ": Invalid source width: $srcWidth" );
193
194 return false;
195 }
196
197 $height = File::scaleHeight( $srcWidth, $srcHeight, $width );
198 if ( $height == 0 ) {
199 # Force height to be at least 1 pixel
200 $height = 1;
201 }
202
203 return true;
204 }
205
214 public function getScriptedTransform( $image, $script, $params ) {
215 if ( !$this->normaliseParams( $image, $params ) ) {
216 return false;
217 }
218 $url = wfAppendQuery( $script, $this->getScriptParams( $params ) );
219
220 if ( $image->mustRender() || $params['width'] < $image->getWidth() ) {
221 return new ThumbnailImage( $image, $url, false, $params );
222 }
223 }
224
225 public function getImageSize( $image, $path ) {
226 AtEase::suppressWarnings();
227 $gis = getimagesize( $path );
228 AtEase::restoreWarnings();
229
230 return $gis;
231 }
232
233 public function getSizeAndMetadata( $state, $path ) {
234 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
235 $gis = @getimagesize( $path );
236 if ( $gis ) {
237 $info = [
238 'width' => $gis[0],
239 'height' => $gis[1],
240 ];
241 if ( isset( $gis['bits'] ) ) {
242 $info['bits'] = $gis['bits'];
243 }
244 } else {
245 $info = [];
246 }
247 return $info;
248 }
249
260 public function getImageArea( $image ) {
261 return $image->getWidth() * $image->getHeight();
262 }
263
270 public function getShortDesc( $file ) {
271 global $wgLang;
272 $nbytes = htmlspecialchars( $wgLang->formatSize( $file->getSize() ) );
273 $widthheight = wfMessage( 'widthheight' )
274 ->numParams( $file->getWidth(), $file->getHeight() )->escaped();
275
276 return "$widthheight ($nbytes)";
277 }
278
285 public function getLongDesc( $file ) {
286 $pages = $file->pageCount();
287 if ( $pages === false || $pages <= 1 ) {
288 $msg = wfMessage( 'file-info-size' )->numParams( $file->getWidth(),
289 $file->getHeight() )->sizeParams( $file->getSize() )->params(
290 '<span class="mime-type">' . $file->getMimeType() . '</span>' )->parse();
291 } else {
292 $msg = wfMessage( 'file-info-size-pages' )->numParams( $file->getWidth(),
293 $file->getHeight() )->sizeParams( $file->getSize() )->params(
294 '<span class="mime-type">' . $file->getMimeType() . '</span>' )->numParams( $pages )->parse();
295 }
296
297 return $msg;
298 }
299
306 public function getDimensionsString( $file ) {
307 $pages = $file->pageCount();
308 if ( $pages > 1 ) {
309 return wfMessage( 'widthheightpage' )
310 ->numParams( $file->getWidth(), $file->getHeight(), $pages )->text();
311 }
312 return wfMessage( 'widthheight' )
313 ->numParams( $file->getWidth(), $file->getHeight() )->text();
314 }
315
321 $params = parent::sanitizeParamsForBucketing( $params );
322
323 // We unset the height parameters in order to let normaliseParams recalculate them
324 // Otherwise there might be a height discrepancy
325 unset( $params['height'] );
326 unset( $params['physicalHeight'] );
327
328 return $params;
329 }
330}
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') &&MW_ENTRY_POINT !=='cli' $wgLang
Definition Setup.php:572
array $params
The job parameters.
static scaleHeight( $srcWidth, $srcHeight, $dstWidth)
Calculate the height of a thumbnail using the source and destination width.
Definition File.php:2216
Media handler abstract base class for images.
canRender( $file)
True if the handled types can be transformed.to 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.array|false Array of parameters or ...
makeParamString( $params)
Merge a parameter array into a string appropriate for inclusion in filenames.string
getLongDesc( $file)
Long description.Shown under image on image description page surrounded by ().to overridestring
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.to overridestring Dimensions
getShortDesc( $file)
Short description.Shown on Special:Search results.to 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.