MediaWiki  REL1_31
Bitmap.php
Go to the documentation of this file.
1 <?php
30 
39  protected function getScalerType( $dstPath, $checkDstPath = true ) {
41 
42  if ( !$dstPath && $checkDstPath ) {
43  # No output path available, client side scaling only
44  $scaler = 'client';
45  } elseif ( !$wgUseImageResize ) {
46  $scaler = 'client';
47  } elseif ( $wgUseImageMagick ) {
48  $scaler = 'im';
49  } elseif ( $wgCustomConvertCommand ) {
50  $scaler = 'custom';
51  } elseif ( function_exists( 'imagecreatetruecolor' ) ) {
52  $scaler = 'gd';
53  } elseif ( class_exists( 'Imagick' ) ) {
54  $scaler = 'imext';
55  } else {
56  $scaler = 'client';
57  }
58 
59  return $scaler;
60  }
61 
62  public function makeParamString( $params ) {
63  $res = parent::makeParamString( $params );
64  if ( isset( $params['interlace'] ) && $params['interlace'] ) {
65  return "interlaced-{$res}";
66  } else {
67  return $res;
68  }
69  }
70 
71  public function parseParamString( $str ) {
72  $remainder = preg_replace( '/^interlaced-/', '', $str );
73  $params = parent::parseParamString( $remainder );
74  if ( $params === false ) {
75  return false;
76  }
77  $params['interlace'] = $str !== $remainder;
78  return $params;
79  }
80 
81  public function validateParam( $name, $value ) {
82  if ( $name === 'interlace' ) {
83  return $value === false || $value === true;
84  } else {
85  return parent::validateParam( $name, $value );
86  }
87  }
88 
94  function normaliseParams( $image, &$params ) {
96  if ( !parent::normaliseParams( $image, $params ) ) {
97  return false;
98  }
99  $mimeType = $image->getMimeType();
100  $interlace = isset( $params['interlace'] ) && $params['interlace']
101  && isset( $wgMaxInterlacingAreas[$mimeType] )
102  && $this->getImageArea( $image ) <= $wgMaxInterlacingAreas[$mimeType];
103  $params['interlace'] = $interlace;
104  return true;
105  }
106 
113  protected function imageMagickSubsampling( $pixelFormat ) {
114  switch ( $pixelFormat ) {
115  case 'yuv444':
116  return [ '1x1', '1x1', '1x1' ];
117  case 'yuv422':
118  return [ '2x1', '1x1', '1x1' ];
119  case 'yuv420':
120  return [ '2x2', '1x1', '1x1' ];
121  default:
122  throw new MWException( 'Invalid pixel format for JPEG output' );
123  }
124  }
125 
134  protected function transformImageMagick( $image, $params ) {
135  # use ImageMagick
138 
139  $quality = [];
140  $sharpen = [];
141  $scene = false;
142  $animation_pre = [];
143  $animation_post = [];
144  $decoderHint = [];
145  $subsampling = [];
146 
147  if ( $params['mimeType'] == 'image/jpeg' ) {
148  $qualityVal = isset( $params['quality'] ) ? (string)$params['quality'] : null;
149  $quality = [ '-quality', $qualityVal ?: '80' ]; // 80%
150  if ( $params['interlace'] ) {
151  $animation_post = [ '-interlace', 'JPEG' ];
152  }
153  # Sharpening, see T8193
154  if ( ( $params['physicalWidth'] + $params['physicalHeight'] )
155  / ( $params['srcWidth'] + $params['srcHeight'] )
157  ) {
158  $sharpen = [ '-sharpen', $wgSharpenParameter ];
159  }
160  if ( version_compare( $this->getMagickVersion(), "6.5.6" ) >= 0 ) {
161  // JPEG decoder hint to reduce memory, available since IM 6.5.6-2
162  $decoderHint = [ '-define', "jpeg:size={$params['physicalDimensions']}" ];
163  }
164  if ( $wgJpegPixelFormat ) {
165  $factors = $this->imageMagickSubsampling( $wgJpegPixelFormat );
166  $subsampling = [ '-sampling-factor', implode( ',', $factors ) ];
167  }
168  } elseif ( $params['mimeType'] == 'image/png' ) {
169  $quality = [ '-quality', '95' ]; // zlib 9, adaptive filtering
170  if ( $params['interlace'] ) {
171  $animation_post = [ '-interlace', 'PNG' ];
172  }
173  } elseif ( $params['mimeType'] == 'image/webp' ) {
174  $quality = [ '-quality', '95' ]; // zlib 9, adaptive filtering
175  } elseif ( $params['mimeType'] == 'image/gif' ) {
176  if ( $this->getImageArea( $image ) > $wgMaxAnimatedGifArea ) {
177  // Extract initial frame only; we're so big it'll
178  // be a total drag. :P
179  $scene = 0;
180  } elseif ( $this->isAnimatedImage( $image ) ) {
181  // Coalesce is needed to scale animated GIFs properly (T3017).
182  $animation_pre = [ '-coalesce' ];
183  // We optimize the output, but -optimize is broken,
184  // use optimizeTransparency instead (T13822)
185  if ( version_compare( $this->getMagickVersion(), "6.3.5" ) >= 0 ) {
186  $animation_post = [ '-fuzz', '5%', '-layers', 'optimizeTransparency' ];
187  }
188  }
189  if ( $params['interlace'] && version_compare( $this->getMagickVersion(), "6.3.4" ) >= 0
190  && !$this->isAnimatedImage( $image ) ) { // interlacing animated GIFs is a bad idea
191  $animation_post[] = '-interlace';
192  $animation_post[] = 'GIF';
193  }
194  } elseif ( $params['mimeType'] == 'image/x-xcf' ) {
195  // Before merging layers, we need to set the background
196  // to be transparent to preserve alpha, as -layers merge
197  // merges all layers on to a canvas filled with the
198  // background colour. After merging we reset the background
199  // to be white for the default background colour setting
200  // in the PNG image (which is used in old IE)
201  $animation_pre = [
202  '-background', 'transparent',
203  '-layers', 'merge',
204  '-background', 'white',
205  ];
206  Wikimedia\suppressWarnings();
207  $xcfMeta = unserialize( $image->getMetadata() );
208  Wikimedia\restoreWarnings();
209  if ( $xcfMeta
210  && isset( $xcfMeta['colorType'] )
211  && $xcfMeta['colorType'] === 'greyscale-alpha'
212  && version_compare( $this->getMagickVersion(), "6.8.9-3" ) < 0
213  ) {
214  // T68323 - Greyscale images not rendered properly.
215  // So only take the "red" channel.
216  $channelOnly = [ '-channel', 'R', '-separate' ];
217  $animation_pre = array_merge( $animation_pre, $channelOnly );
218  }
219  }
220 
221  // Use one thread only, to avoid deadlock bugs on OOM
222  $env = [ 'OMP_NUM_THREADS' => 1 ];
223  if ( strval( $wgImageMagickTempDir ) !== '' ) {
224  $env['MAGICK_TMPDIR'] = $wgImageMagickTempDir;
225  }
226 
227  $rotation = isset( $params['disableRotation'] ) ? 0 : $this->getRotation( $image );
228  list( $width, $height ) = $this->extractPreRotationDimensions( $params, $rotation );
229 
230  $cmd = call_user_func_array( 'wfEscapeShellArg', array_merge(
232  $quality,
233  // Specify white background color, will be used for transparent images
234  // in Internet Explorer/Windows instead of default black.
235  [ '-background', 'white' ],
236  $decoderHint,
237  [ $this->escapeMagickInput( $params['srcPath'], $scene ) ],
238  $animation_pre,
239  // For the -thumbnail option a "!" is needed to force exact size,
240  // or ImageMagick may decide your ratio is wrong and slice off
241  // a pixel.
242  [ '-thumbnail', "{$width}x{$height}!" ],
243  // Add the source url as a comment to the thumb, but don't add the flag if there's no comment
244  ( $params['comment'] !== ''
245  ? [ '-set', 'comment', $this->escapeMagickProperty( $params['comment'] ) ]
246  : [] ),
247  // T108616: Avoid exposure of local file path
248  [ '+set', 'Thumb::URI' ],
249  [ '-depth', 8 ],
250  $sharpen,
251  [ '-rotate', "-$rotation" ],
252  $subsampling,
253  $animation_post,
254  [ $this->escapeMagickOutput( $params['dstPath'] ) ] ) );
255 
256  wfDebug( __METHOD__ . ": running ImageMagick: $cmd\n" );
257  $retval = 0;
258  $err = wfShellExecWithStderr( $cmd, $retval, $env );
259 
260  if ( $retval !== 0 ) {
261  $this->logErrorForExternalProcess( $retval, $err, $cmd );
262 
263  return $this->getMediaTransformError( $params, "$err\nError code: $retval" );
264  }
265 
266  return false; # No error
267  }
268 
277  protected function transformImageMagickExt( $image, $params ) {
280 
281  try {
282  $im = new Imagick();
283  $im->readImage( $params['srcPath'] );
284 
285  if ( $params['mimeType'] == 'image/jpeg' ) {
286  // Sharpening, see T8193
287  if ( ( $params['physicalWidth'] + $params['physicalHeight'] )
288  / ( $params['srcWidth'] + $params['srcHeight'] )
290  ) {
291  // Hack, since $wgSharpenParameter is written specifically for the command line convert
292  list( $radius, $sigma ) = explode( 'x', $wgSharpenParameter );
293  $im->sharpenImage( $radius, $sigma );
294  }
295  $qualityVal = isset( $params['quality'] ) ? (string)$params['quality'] : null;
296  $im->setCompressionQuality( $qualityVal ?: 80 );
297  if ( $params['interlace'] ) {
298  $im->setInterlaceScheme( Imagick::INTERLACE_JPEG );
299  }
300  if ( $wgJpegPixelFormat ) {
301  $factors = $this->imageMagickSubsampling( $wgJpegPixelFormat );
302  $im->setSamplingFactors( $factors );
303  }
304  } elseif ( $params['mimeType'] == 'image/png' ) {
305  $im->setCompressionQuality( 95 );
306  if ( $params['interlace'] ) {
307  $im->setInterlaceScheme( Imagick::INTERLACE_PNG );
308  }
309  } elseif ( $params['mimeType'] == 'image/gif' ) {
310  if ( $this->getImageArea( $image ) > $wgMaxAnimatedGifArea ) {
311  // Extract initial frame only; we're so big it'll
312  // be a total drag. :P
313  $im->setImageScene( 0 );
314  } elseif ( $this->isAnimatedImage( $image ) ) {
315  // Coalesce is needed to scale animated GIFs properly (T3017).
316  $im = $im->coalesceImages();
317  }
318  // GIF interlacing is only available since 6.3.4
319  $v = Imagick::getVersion();
320  preg_match( '/ImageMagick ([0-9]+\.[0-9]+\.[0-9]+)/', $v['versionString'], $v );
321 
322  if ( $params['interlace'] && version_compare( $v[1], '6.3.4' ) >= 0 ) {
323  $im->setInterlaceScheme( Imagick::INTERLACE_GIF );
324  }
325  }
326 
327  $rotation = isset( $params['disableRotation'] ) ? 0 : $this->getRotation( $image );
328  list( $width, $height ) = $this->extractPreRotationDimensions( $params, $rotation );
329 
330  $im->setImageBackgroundColor( new ImagickPixel( 'white' ) );
331 
332  // Call Imagick::thumbnailImage on each frame
333  foreach ( $im as $i => $frame ) {
334  if ( !$frame->thumbnailImage( $width, $height, /* fit */ false ) ) {
335  return $this->getMediaTransformError( $params, "Error scaling frame $i" );
336  }
337  }
338  $im->setImageDepth( 8 );
339 
340  if ( $rotation ) {
341  if ( !$im->rotateImage( new ImagickPixel( 'white' ), 360 - $rotation ) ) {
342  return $this->getMediaTransformError( $params, "Error rotating $rotation degrees" );
343  }
344  }
345 
346  if ( $this->isAnimatedImage( $image ) ) {
347  wfDebug( __METHOD__ . ": Writing animated thumbnail\n" );
348  // This is broken somehow... can't find out how to fix it
349  $result = $im->writeImages( $params['dstPath'], true );
350  } else {
351  $result = $im->writeImage( $params['dstPath'] );
352  }
353  if ( !$result ) {
354  return $this->getMediaTransformError( $params,
355  "Unable to write thumbnail to {$params['dstPath']}" );
356  }
357  } catch ( ImagickException $e ) {
358  return $this->getMediaTransformError( $params, $e->getMessage() );
359  }
360 
361  return false;
362  }
363 
372  protected function transformCustom( $image, $params ) {
373  # Use a custom convert command
375 
376  # Variables: %s %d %w %h
377  $src = wfEscapeShellArg( $params['srcPath'] );
378  $dst = wfEscapeShellArg( $params['dstPath'] );
380  $cmd = str_replace( '%s', $src, str_replace( '%d', $dst, $cmd ) ); # Filenames
381  $cmd = str_replace( '%h', wfEscapeShellArg( $params['physicalHeight'] ),
382  str_replace( '%w', wfEscapeShellArg( $params['physicalWidth'] ), $cmd ) ); # Size
383  wfDebug( __METHOD__ . ": Running custom convert command $cmd\n" );
384  $retval = 0;
385  $err = wfShellExecWithStderr( $cmd, $retval );
386 
387  if ( $retval !== 0 ) {
388  $this->logErrorForExternalProcess( $retval, $err, $cmd );
389 
390  return $this->getMediaTransformError( $params, $err );
391  }
392 
393  return false; # No error
394  }
395 
404  protected function transformGd( $image, $params ) {
405  # Use PHP's builtin GD library functions.
406  # First find out what kind of file this is, and select the correct
407  # input routine for this.
408 
409  $typemap = [
410  'image/gif' => [ 'imagecreatefromgif', 'palette', false, 'imagegif' ],
411  'image/jpeg' => [ 'imagecreatefromjpeg', 'truecolor', true,
412  [ __CLASS__, 'imageJpegWrapper' ] ],
413  'image/png' => [ 'imagecreatefrompng', 'bits', false, 'imagepng' ],
414  'image/vnd.wap.wbmp' => [ 'imagecreatefromwbmp', 'palette', false, 'imagewbmp' ],
415  'image/xbm' => [ 'imagecreatefromxbm', 'palette', false, 'imagexbm' ],
416  ];
417 
418  if ( !isset( $typemap[$params['mimeType']] ) ) {
419  $err = 'Image type not supported';
420  wfDebug( "$err\n" );
421  $errMsg = wfMessage( 'thumbnail_image-type' )->text();
422 
423  return $this->getMediaTransformError( $params, $errMsg );
424  }
425  list( $loader, $colorStyle, $useQuality, $saveType ) = $typemap[$params['mimeType']];
426 
427  if ( !function_exists( $loader ) ) {
428  $err = "Incomplete GD library configuration: missing function $loader";
429  wfDebug( "$err\n" );
430  $errMsg = wfMessage( 'thumbnail_gd-library', $loader )->text();
431 
432  return $this->getMediaTransformError( $params, $errMsg );
433  }
434 
435  if ( !file_exists( $params['srcPath'] ) ) {
436  $err = "File seems to be missing: {$params['srcPath']}";
437  wfDebug( "$err\n" );
438  $errMsg = wfMessage( 'thumbnail_image-missing', $params['srcPath'] )->text();
439 
440  return $this->getMediaTransformError( $params, $errMsg );
441  }
442 
443  if ( filesize( $params['srcPath'] ) === 0 ) {
444  $err = "Image file size seems to be zero.";
445  wfDebug( "$err\n" );
446  $errMsg = wfMessage( 'thumbnail_image-size-zero', $params['srcPath'] )->text();
447 
448  return $this->getMediaTransformError( $params, $errMsg );
449  }
450 
451  $src_image = call_user_func( $loader, $params['srcPath'] );
452 
453  $rotation = function_exists( 'imagerotate' ) && !isset( $params['disableRotation'] ) ?
454  $this->getRotation( $image ) :
455  0;
456  list( $width, $height ) = $this->extractPreRotationDimensions( $params, $rotation );
457  $dst_image = imagecreatetruecolor( $width, $height );
458 
459  // Initialise the destination image to transparent instead of
460  // the default solid black, to support PNG and GIF transparency nicely
461  $background = imagecolorallocate( $dst_image, 0, 0, 0 );
462  imagecolortransparent( $dst_image, $background );
463  imagealphablending( $dst_image, false );
464 
465  if ( $colorStyle == 'palette' ) {
466  // Don't resample for paletted GIF images.
467  // It may just uglify them, and completely breaks transparency.
468  imagecopyresized( $dst_image, $src_image,
469  0, 0, 0, 0,
470  $width, $height,
471  imagesx( $src_image ), imagesy( $src_image ) );
472  } else {
473  imagecopyresampled( $dst_image, $src_image,
474  0, 0, 0, 0,
475  $width, $height,
476  imagesx( $src_image ), imagesy( $src_image ) );
477  }
478 
479  if ( $rotation % 360 != 0 && $rotation % 90 == 0 ) {
480  $rot_image = imagerotate( $dst_image, $rotation, 0 );
481  imagedestroy( $dst_image );
482  $dst_image = $rot_image;
483  }
484 
485  imagesavealpha( $dst_image, true );
486 
487  $funcParams = [ $dst_image, $params['dstPath'] ];
488  if ( $useQuality && isset( $params['quality'] ) ) {
489  $funcParams[] = $params['quality'];
490  }
491  call_user_func_array( $saveType, $funcParams );
492 
493  imagedestroy( $dst_image );
494  imagedestroy( $src_image );
495 
496  return false; # No error
497  }
498 
502  // FIXME: transformImageMagick() & transformImageMagickExt() uses JPEG quality 80, here it's 95?
503  static function imageJpegWrapper( $dst_image, $thumbPath, $quality = 95 ) {
504  imageinterlace( $dst_image );
505  imagejpeg( $dst_image, $thumbPath, $quality );
506  }
507 
513  public function canRotate() {
514  $scaler = $this->getScalerType( null, false );
515  switch ( $scaler ) {
516  case 'im':
517  # ImageMagick supports autorotation
518  return true;
519  case 'imext':
520  # Imagick::rotateImage
521  return true;
522  case 'gd':
523  # GD's imagerotate function is used to rotate images, but not
524  # all precompiled PHP versions have that function
525  return function_exists( 'imagerotate' );
526  default:
527  # Other scalers don't support rotation
528  return false;
529  }
530  }
531 
536  public function autoRotateEnabled() {
538 
539  if ( $wgEnableAutoRotation === null ) {
540  // Only enable auto-rotation when we actually can
541  return $this->canRotate();
542  }
543 
544  return $wgEnableAutoRotation;
545  }
546 
554  public function rotate( $file, $params ) {
556 
557  $rotation = ( $params['rotation'] + $this->getRotation( $file ) ) % 360;
558  $scene = false;
559 
560  $scaler = $this->getScalerType( null, false );
561  switch ( $scaler ) {
562  case 'im':
564  wfEscapeShellArg( $this->escapeMagickInput( $params['srcPath'], $scene ) ) .
565  " -rotate " . wfEscapeShellArg( "-$rotation" ) . " " .
566  wfEscapeShellArg( $this->escapeMagickOutput( $params['dstPath'] ) );
567  wfDebug( __METHOD__ . ": running ImageMagick: $cmd\n" );
568  $retval = 0;
569  $err = wfShellExecWithStderr( $cmd, $retval );
570  if ( $retval !== 0 ) {
571  $this->logErrorForExternalProcess( $retval, $err, $cmd );
572 
573  return new MediaTransformError( 'thumbnail_error', 0, 0, $err );
574  }
575 
576  return false;
577  case 'imext':
578  $im = new Imagick();
579  $im->readImage( $params['srcPath'] );
580  if ( !$im->rotateImage( new ImagickPixel( 'white' ), 360 - $rotation ) ) {
581  return new MediaTransformError( 'thumbnail_error', 0, 0,
582  "Error rotating $rotation degrees" );
583  }
584  $result = $im->writeImage( $params['dstPath'] );
585  if ( !$result ) {
586  return new MediaTransformError( 'thumbnail_error', 0, 0,
587  "Unable to write image to {$params['dstPath']}" );
588  }
589 
590  return false;
591  default:
592  return new MediaTransformError( 'thumbnail_error', 0, 0,
593  "$scaler rotation not implemented" );
594  }
595  }
596 }
BitmapHandler\parseParamString
parseParamString( $str)
Parse a param string made with makeParamString back into an array.
Definition: Bitmap.php:71
MediaTransformError
Basic media transform error class.
Definition: MediaTransformOutput.php:441
BitmapHandler\validateParam
validateParam( $name, $value)
Validate a thumbnail parameter at parse time.
Definition: Bitmap.php:81
BitmapHandler\transformImageMagickExt
transformImageMagickExt( $image, $params)
Transform an image using the Imagick PHP extension.
Definition: Bitmap.php:277
error
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition: hooks.txt:2612
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
$wgJpegPixelFormat
$wgJpegPixelFormat
At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size...
Definition: DefaultSettings.php:1107
TransformationalImageHandler\getMediaTransformError
getMediaTransformError( $params, $errMsg)
Get a MediaTransformError with error 'thumbnail_error'.
Definition: TransformationalImageHandler.php:390
$wgSharpenParameter
$wgSharpenParameter
Sharpening parameter to ImageMagick.
Definition: DefaultSettings.php:1054
string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:181
TransformationalImageHandler\escapeMagickOutput
escapeMagickOutput( $path, $scene=false)
Escape a string for ImageMagick's output filename.
Definition: TransformationalImageHandler.php:465
BitmapHandler\rotate
rotate( $file, $params)
Definition: Bitmap.php:554
TransformationalImageHandler\escapeMagickProperty
escapeMagickProperty( $s)
Escape a string for ImageMagick's property input (e.g.
Definition: TransformationalImageHandler.php:415
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
TransformationalImageHandler
Handler for images that need to be transformed.
Definition: TransformationalImageHandler.php:36
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
BitmapHandler\transformCustom
transformCustom( $image, $params)
Transform an image using a custom command.
Definition: Bitmap.php:372
MWException
MediaWiki exception.
Definition: MWException.php:26
BitmapHandler
Generic handler for bitmap images.
Definition: Bitmap.php:29
$wgUseImageMagick
$wgUseImageMagick
Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party...
Definition: DefaultSettings.php:1038
TransformationalImageHandler\extractPreRotationDimensions
extractPreRotationDimensions( $params, $rotation)
Extracts the width/height if the image will be scaled before rotating.
Definition: TransformationalImageHandler.php:80
TransformationalImageHandler\escapeMagickInput
escapeMagickInput( $path, $scene=false)
Escape a string for ImageMagick's input filenames.
Definition: TransformationalImageHandler.php:445
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
$wgMaxInterlacingAreas
$wgMaxInterlacingAreas
Array of max pixel areas for interlacing per MIME type.
Definition: DefaultSettings.php:1049
BitmapHandler\canRotate
canRotate()
Returns whether the current scaler supports rotation (im and gd do)
Definition: Bitmap.php:513
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$wgMaxAnimatedGifArea
$wgMaxAnimatedGifArea
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnai...
Definition: DefaultSettings.php:1198
BitmapHandler\makeParamString
makeParamString( $params)
Merge a parameter array into a string appropriate for inclusion in filenames.
Definition: Bitmap.php:62
BitmapHandler\imageJpegWrapper
static imageJpegWrapper( $dst_image, $thumbPath, $quality=95)
Callback for transformGd when transforming jpeg images.
Definition: Bitmap.php:503
$value
$value
Definition: styleTest.css.php:45
$wgImageMagickConvertCommand
$wgImageMagickConvertCommand
The convert command shipped with ImageMagick.
Definition: DefaultSettings.php:1043
$wgSharpenReductionThreshold
$wgSharpenReductionThreshold
Reduction in linear dimensions below which sharpening will be enabled.
Definition: DefaultSettings.php:1059
BitmapHandler\imageMagickSubsampling
imageMagickSubsampling( $pixelFormat)
Get ImageMagick subsampling factors for the target JPEG pixel format.
Definition: Bitmap.php:113
wfEscapeShellArg
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2209
BitmapHandler\transformGd
transformGd( $image, $params)
Transform an image using the built in GD library.
Definition: Bitmap.php:404
TransformationalImageHandler\getMagickVersion
getMagickVersion()
Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this valu...
Definition: TransformationalImageHandler.php:511
BitmapHandler\autoRotateEnabled
autoRotateEnabled()
Definition: Bitmap.php:536
$wgCustomConvertCommand
$wgCustomConvertCommand
Use another resizing converter, e.g.
Definition: DefaultSettings.php:1079
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition: hooks.txt:895
BitmapHandler\normaliseParams
normaliseParams( $image, &$params)
Definition: Bitmap.php:94
BitmapHandler\transformImageMagick
transformImageMagick( $image, $params)
Transform an image using ImageMagick.
Definition: Bitmap.php:134
MediaHandler\logErrorForExternalProcess
logErrorForExternalProcess( $retval, $err, $cmd)
Log an error that occurred in an external process.
Definition: MediaHandler.php:763
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
MediaHandler\isAnimatedImage
isAnimatedImage( $file)
The material is an image, and is animated.
Definition: MediaHandler.php:375
BitmapHandler\getScalerType
getScalerType( $dstPath, $checkDstPath=true)
Returns which scaler type should be used.
Definition: Bitmap.php:39
$wgUseImageResize
$wgUseImageResize
Whether to enable server-side image thumbnailing.
Definition: DefaultSettings.php:1028
ImageHandler\getImageArea
getImageArea( $image)
Function that returns the number of pixels to be thumbnailed.
Definition: ImageHandler.php:220
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
MediaHandler\getRotation
getRotation( $file)
On supporting image formats, try to read out the low-level orientation of the file and return the ang...
Definition: MediaHandler.php:748
$wgEnableAutoRotation
$wgEnableAutoRotation
If set to true, images that contain certain the exif orientation tag will be rotated accordingly.
Definition: DefaultSettings.php:1263
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
wfShellExecWithStderr
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
Definition: GlobalFunctions.php:2303
$wgImageMagickTempDir
$wgImageMagickTempDir
Temporary directory used for ImageMagick.
Definition: DefaultSettings.php:1065