MediaWiki REL1_35
JpegHandler.php
Go to the documentation of this file.
1<?php
25
36 private const SRGB_EXIF_COLOR_SPACE = 'sRGB';
37 private const SRGB_ICC_PROFILE_DESCRIPTION = 'sRGB IEC61966-2.1';
38
39 public function normaliseParams( $image, &$params ) {
40 if ( !parent::normaliseParams( $image, $params ) ) {
41 return false;
42 }
43 if ( isset( $params['quality'] ) && !self::validateQuality( $params['quality'] ) ) {
44 return false;
45 }
46 return true;
47 }
48
49 public function validateParam( $name, $value ) {
50 if ( $name === 'quality' ) {
51 return self::validateQuality( $value );
52 } else {
53 return parent::validateParam( $name, $value );
54 }
55 }
56
61 private static function validateQuality( $value ) {
62 return $value === 'low';
63 }
64
65 public function makeParamString( $params ) {
66 // Prepend quality as "qValue-". This has to match parseParamString() below
67 $res = parent::makeParamString( $params );
68 if ( $res && isset( $params['quality'] ) ) {
69 $res = "q{$params['quality']}-$res";
70 }
71 return $res;
72 }
73
74 public function parseParamString( $str ) {
75 // $str contains "qlow-200px" or "200px" strings because thumb.php would strip the filename
76 // first - check if the string begins with "qlow-", and if so, treat it as quality.
77 // Pass the first portion, or the whole string if "qlow-" not found, to the parent
78 // The parsing must match the makeParamString() above
79 $res = false;
80 $m = false;
81 if ( preg_match( '/q([^-]+)-(.*)$/', $str, $m ) ) {
82 $v = $m[1];
83 if ( self::validateQuality( $v ) ) {
84 $res = parent::parseParamString( $m[2] );
85 if ( $res ) {
86 $res['quality'] = $v;
87 }
88 }
89 } else {
90 $res = parent::parseParamString( $str );
91 }
92 return $res;
93 }
94
95 protected function getScriptParams( $params ) {
96 $res = parent::getScriptParams( $params );
97 if ( isset( $params['quality'] ) ) {
98 $res['quality'] = $params['quality'];
99 }
100 return $res;
101 }
102
103 public function getMetadata( $image, $filename ) {
104 try {
105 $meta = BitmapMetadataHandler::Jpeg( $filename );
106 if ( !is_array( $meta ) ) {
107 // This should never happen, but doesn't hurt to be paranoid.
108 throw new MWException( 'Metadata array is not an array' );
109 }
110 $meta['MEDIAWIKI_EXIF_VERSION'] = Exif::version();
111
112 return serialize( $meta );
113 } catch ( Exception $e ) {
114 // BitmapMetadataHandler throws an exception in certain exceptional
115 // cases like if file does not exist.
116 wfDebug( __METHOD__ . ': ' . $e->getMessage() );
117
118 /* This used to use 0 (ExifBitmapHandler::OLD_BROKEN_FILE) for the cases
119 * * No metadata in the file
120 * * Something is broken in the file.
121 * However, if the metadata support gets expanded then you can't tell if the 0 is from
122 * a broken file, or just no props found. A broken file is likely to stay broken, but
123 * a file which had no props could have props once the metadata support is improved.
124 * Thus switch to using -1 to denote only a broken file, and use an array with only
125 * MEDIAWIKI_EXIF_VERSION to denote no props.
126 */
127
129 }
130 }
131
139 public function rotate( $file, $params ) {
140 global $wgJpegTran;
141
142 $rotation = ( $params['rotation'] + $this->getRotation( $file ) ) % 360;
143
144 if ( $wgJpegTran && is_executable( $wgJpegTran ) ) {
145 $command = Shell::command( $wgJpegTran,
146 '-rotate',
147 $rotation,
148 '-outfile',
149 $params['dstPath'],
150 $params['srcPath']
151 );
152 $result = $command
153 ->includeStderr()
154 ->execute();
155 if ( $result->getExitCode() !== 0 ) {
156 $this->logErrorForExternalProcess( $result->getExitCode(),
157 $result->getStdout(),
159 );
160
161 return new MediaTransformError( 'thumbnail_error', 0, 0, $result->getStdout() );
162 }
163
164 return false;
165 } else {
166 return parent::rotate( $file, $params );
167 }
168 }
169
170 public function supportsBucketing() {
171 return true;
172 }
173
174 public function sanitizeParamsForBucketing( $params ) {
175 $params = parent::sanitizeParamsForBucketing( $params );
176
177 // Quality needs to be cleared for bucketing. Buckets need to be default quality
178 if ( isset( $params['quality'] ) ) {
179 unset( $params['quality'] );
180 }
181
182 return $params;
183 }
184
188 protected function transformImageMagick( $image, $params ) {
190
191 $ret = parent::transformImageMagick( $image, $params );
192
193 if ( $ret ) {
194 return $ret;
195 }
196
198 // T100976 If the profile embedded in the JPG is sRGB, swap it for the smaller
199 // (and free) TinyRGB
200
210 $colorSpaces = [ self::SRGB_EXIF_COLOR_SPACE, '-' ];
212
213 // we'll also add TinyRGB profile to images lacking a profile, but
214 // only if they're not low quality (which are meant to save bandwith
215 // and we don't want to increase the filesize by adding a profile)
216 if ( isset( $params['quality'] ) && $params['quality'] > 30 ) {
217 $profiles[] = '-';
218 }
219
220 $this->swapICCProfile(
221 $params['dstPath'],
222 $colorSpaces,
223 $profiles,
224 realpath( __DIR__ ) . '/tinyrgb.icc'
225 );
226 }
227
228 return false;
229 }
230
242 public function swapICCProfile( $filepath, array $colorSpaces,
243 array $oldProfileStrings, $profileFilepath
244 ) {
245 global $wgExiftool;
246
247 if ( !$wgExiftool || !is_executable( $wgExiftool ) ) {
248 return false;
249 }
250
251 $result = Shell::command(
253 '-EXIF:ColorSpace',
254 '-ICC_Profile:ProfileDescription',
255 '-S',
256 '-T',
257 $filepath
258 )
259 ->includeStderr()
260 ->execute();
261
262 // Explode EXIF data into an array with [0 => Color Space, 1 => Device Model Desc]
263 $data = explode( "\t", trim( $result->getStdout() ) );
264
265 if ( $result->getExitCode() !== 0 ) {
266 return false;
267 }
268
269 // Make a regex out of the source data to match it to an array of color
270 // spaces in a case-insensitive way
271 $colorSpaceRegex = '/' . preg_quote( $data[0], '/' ) . '/i';
272 if ( empty( preg_grep( $colorSpaceRegex, $colorSpaces ) ) ) {
273 // We can't establish that this file matches the color space, don't process it
274 return false;
275 }
276
277 $profileRegex = '/' . preg_quote( $data[1], '/' ) . '/i';
278 if ( empty( preg_grep( $profileRegex, $oldProfileStrings ) ) ) {
279 // We can't establish that this file has the expected ICC profile, don't process it
280 return false;
281 }
282
283 $command = Shell::command( $wgExiftool,
284 '-overwrite_original',
285 '-icc_profile<=' . $profileFilepath,
286 $filepath
287 );
288 $result = $command
289 ->includeStderr()
290 ->execute();
291
292 if ( $result->getExitCode() !== 0 ) {
293 $this->logErrorForExternalProcess( $result->getExitCode(),
294 $result->getStdout(),
296 );
297
298 return false;
299 }
300
301 return true;
302 }
303}
serialize()
$wgUseTinyRGBForJPGThumbnails
When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and ...
$wgJpegTran
used for lossless jpeg rotation
$wgExiftool
Path to exiftool binary.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static Jpeg( $filename)
Main entry point for jpeg's.
Stuff specific to JPEG and (built-in) TIFF handler.
getRotation( $file)
On supporting image formats, try to read out the low-level orientation of the file and return the ang...
const BROKEN_FILE
Error extracting metadata.
static version()
#-
Definition Exif.php:582
JPEG specific handler.
makeParamString( $params)
Merge a parameter array into a string appropriate for inclusion in filenames.string Stable to overrid...
validateParam( $name, $value)
Validate a thumbnail parameter at parse time.Return true to accept the parameter, and false to reject...
const SRGB_ICC_PROFILE_DESCRIPTION
getScriptParams( $params)
Stable to override Stable to override
getMetadata( $image, $filename)
Get handler-specific metadata which will be saved in the img_metadata field.
swapICCProfile( $filepath, array $colorSpaces, array $oldProfileStrings, $profileFilepath)
Swaps an embedded ICC profile for another, if found.
static validateQuality( $value)
Validate and normalize quality value to be between 1 and 100 (inclusive).
supportsBucketing()
Returns whether or not this handler supports the chained generation of thumbnails according to bucket...
rotate( $file, $params)
const SRGB_EXIF_COLOR_SPACE
parseParamString( $str)
Parse a param string made with makeParamString back into an array.array|bool Array of parameters or f...
sanitizeParamsForBucketing( $params)
Returns a normalised params array for which parameters have been cleaned up for bucketing purposes St...
normaliseParams( $image, &$params)
Stable to override.
transformImageMagick( $image, $params)
Transform an image using ImageMagick Stable to override.MediaTransformError|false Error object if err...
MediaWiki exception.
logErrorForExternalProcess( $retval, $err, $cmd)
Log an error that occurred in an external process.
Basic media transform error class.
Executes shell commands.
Definition Shell.php:44
$command
Definition mcc.php:125
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition router.php:42