MediaWiki  master
SvgHandler.php
Go to the documentation of this file.
1 <?php
26 
32 class SvgHandler extends ImageHandler {
34 
39  private static $metaConversion = [
40  'originalwidth' => 'ImageWidth',
41  'originalheight' => 'ImageLength',
42  'description' => 'ImageDescription',
43  'title' => 'ObjectName',
44  ];
45 
46  public function isEnabled() {
48  if ( !isset( $wgSVGConverters[$wgSVGConverter] ) ) {
49  wfDebug( "\$wgSVGConverter is invalid, disabling SVG rendering.\n" );
50 
51  return false;
52  } else {
53  return true;
54  }
55  }
56 
57  public function mustRender( $file ) {
58  return true;
59  }
60 
61  function isVectorized( $file ) {
62  return true;
63  }
64 
69  function isAnimatedImage( $file ) {
70  # @todo Detect animated SVGs
71  $metadata = $file->getMetadata();
72  if ( $metadata ) {
73  $metadata = $this->unpackMetadata( $metadata );
74  if ( isset( $metadata['animated'] ) ) {
75  return $metadata['animated'];
76  }
77  }
78 
79  return false;
80  }
81 
94  public function getAvailableLanguages( File $file ) {
95  $metadata = $file->getMetadata();
96  $langList = [];
97  if ( $metadata ) {
98  $metadata = $this->unpackMetadata( $metadata );
99  if ( isset( $metadata['translations'] ) ) {
100  foreach ( $metadata['translations'] as $lang => $langType ) {
101  if ( $langType === SVGReader::LANG_FULL_MATCH ) {
102  $langList[] = strtolower( $lang );
103  }
104  }
105  }
106  }
107  return array_unique( $langList );
108  }
109 
125  public function getMatchedLanguage( $userPreferredLanguage, array $svgLanguages ) {
126  foreach ( $svgLanguages as $svgLang ) {
127  if ( strcasecmp( $svgLang, $userPreferredLanguage ) === 0 ) {
128  return $svgLang;
129  }
130  $trimmedSvgLang = $svgLang;
131  while ( strpos( $trimmedSvgLang, '-' ) !== false ) {
132  $trimmedSvgLang = substr( $trimmedSvgLang, 0, strrpos( $trimmedSvgLang, '-' ) );
133  if ( strcasecmp( $trimmedSvgLang, $userPreferredLanguage ) === 0 ) {
134  return $svgLang;
135  }
136  }
137  }
138  return null;
139  }
140 
147  protected function getLanguageFromParams( array $params ) {
148  return $params['lang'] ?? $params['targetlang'] ?? 'en';
149  }
150 
157  public function getDefaultRenderLanguage( File $file ) {
158  return 'en';
159  }
160 
167  return false;
168  }
169 
175  public function normaliseParams( $image, &$params ) {
176  if ( parent::normaliseParams( $image, $params ) ) {
178  return true;
179  }
180 
181  return false;
182  }
183 
193  protected function normaliseParamsInternal( $image, $params ) {
194  global $wgSVGMaxSize;
195 
196  # Don't make an image bigger than wgMaxSVGSize on the smaller side
197  if ( $params['physicalWidth'] <= $params['physicalHeight'] ) {
198  if ( $params['physicalWidth'] > $wgSVGMaxSize ) {
199  $srcWidth = $image->getWidth( $params['page'] );
200  $srcHeight = $image->getHeight( $params['page'] );
201  $params['physicalWidth'] = $wgSVGMaxSize;
202  $params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight, $wgSVGMaxSize );
203  }
204  } elseif ( $params['physicalHeight'] > $wgSVGMaxSize ) {
205  $srcWidth = $image->getWidth( $params['page'] );
206  $srcHeight = $image->getHeight( $params['page'] );
207  $params['physicalWidth'] = File::scaleHeight( $srcHeight, $srcWidth, $wgSVGMaxSize );
208  $params['physicalHeight'] = $wgSVGMaxSize;
209  }
210  // To prevent the proliferation of thumbnails in languages not present in SVGs, unless
211  // explicitly forced by user.
212  if ( isset( $params['targetlang'] ) && !$image->getMatchedLanguage( $params['targetlang'] ) ) {
213  unset( $params['targetlang'] );
214  }
215 
216  return $params;
217  }
218 
227  function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
228  if ( !$this->normaliseParams( $image, $params ) ) {
229  return new TransformParameterError( $params );
230  }
231  $clientWidth = $params['width'];
232  $clientHeight = $params['height'];
233  $physicalWidth = $params['physicalWidth'];
234  $physicalHeight = $params['physicalHeight'];
235  $lang = $this->getLanguageFromParams( $params );
236 
237  if ( $flags & self::TRANSFORM_LATER ) {
238  return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
239  }
240 
241  $metadata = $this->unpackMetadata( $image->getMetadata() );
242  if ( isset( $metadata['error'] ) ) { // sanity check
243  $err = wfMessage( 'svg-long-error', $metadata['error']['message'] );
244 
245  return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight, $err );
246  }
247 
248  if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__ ) ) {
249  return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight,
250  wfMessage( 'thumbnail_dest_directory' ) );
251  }
252 
253  $srcPath = $image->getLocalRefPath();
254  if ( $srcPath === false ) { // Failed to get local copy
255  wfDebugLog( 'thumbnail',
256  sprintf( 'Thumbnail failed on %s: could not get local copy of "%s"',
257  wfHostname(), $image->getName() ) );
258 
259  return new MediaTransformError( 'thumbnail_error',
260  $params['width'], $params['height'],
261  wfMessage( 'filemissing' )
262  );
263  }
264 
265  // Make a temp dir with a symlink to the local copy in it.
266  // This plays well with rsvg-convert policy for external entities.
267  // https://git.gnome.org/browse/librsvg/commit/?id=f01aded72c38f0e18bc7ff67dee800e380251c8e
268  $tmpDir = wfTempDir() . '/svg_' . wfRandomString( 24 );
269  $lnPath = "$tmpDir/" . basename( $srcPath );
270  $ok = mkdir( $tmpDir, 0771 );
271  if ( !$ok ) {
272  wfDebugLog( 'thumbnail',
273  sprintf( 'Thumbnail failed on %s: could not create temporary directory %s',
274  wfHostname(), $tmpDir ) );
275  return new MediaTransformError( 'thumbnail_error',
276  $params['width'], $params['height'],
277  wfMessage( 'thumbnail-temp-create' )->text()
278  );
279  }
280  $ok = symlink( $srcPath, $lnPath );
282  $cleaner = new ScopedCallback( function () use ( $tmpDir, $lnPath ) {
283  Wikimedia\suppressWarnings();
284  unlink( $lnPath );
285  rmdir( $tmpDir );
286  Wikimedia\restoreWarnings();
287  } );
288  if ( !$ok ) {
289  wfDebugLog( 'thumbnail',
290  sprintf( 'Thumbnail failed on %s: could not link %s to %s',
291  wfHostname(), $lnPath, $srcPath ) );
292  return new MediaTransformError( 'thumbnail_error',
293  $params['width'], $params['height'],
294  wfMessage( 'thumbnail-temp-create' )
295  );
296  }
297 
298  $status = $this->rasterize( $lnPath, $dstPath, $physicalWidth, $physicalHeight, $lang );
299  if ( $status === true ) {
300  return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
301  } else {
302  return $status; // MediaTransformError
303  }
304  }
305 
317  public function rasterize( $srcPath, $dstPath, $width, $height, $lang = false ) {
319  $err = false;
320  $retval = '';
321  if ( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
322  if ( is_array( $wgSVGConverters[$wgSVGConverter] ) ) {
323  // This is a PHP callable
324  $func = $wgSVGConverters[$wgSVGConverter][0];
325  if ( !is_callable( $func ) ) {
326  throw new MWException( "$func is not callable" );
327  }
328  $err = $func( $srcPath,
329  $dstPath,
330  $width,
331  $height,
332  $lang,
333  ...array_slice( $wgSVGConverters[$wgSVGConverter], 1 )
334  );
335  $retval = (bool)$err;
336  } else {
337  // External command
338  $cmd = str_replace(
339  [ '$path/', '$width', '$height', '$input', '$output' ],
340  [ $wgSVGConverterPath ? Shell::escape( "$wgSVGConverterPath/" ) : "",
341  intval( $width ),
342  intval( $height ),
343  Shell::escape( $srcPath ),
344  Shell::escape( $dstPath ) ],
345  $wgSVGConverters[$wgSVGConverter]
346  );
347 
348  $env = [];
349  if ( $lang !== false ) {
350  $env['LANG'] = $lang;
351  }
352 
353  wfDebug( __METHOD__ . ": $cmd\n" );
354  $err = wfShellExecWithStderr( $cmd, $retval, $env );
355  }
356  }
357  $removed = $this->removeBadFile( $dstPath, $retval );
358  if ( $retval != 0 || $removed ) {
359  $this->logErrorForExternalProcess( $retval, $err, $cmd );
360  return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
361  }
362 
363  return true;
364  }
365 
366  public static function rasterizeImagickExt( $srcPath, $dstPath, $width, $height ) {
367  $im = new Imagick( $srcPath );
368  $im->setImageFormat( 'png' );
369  $im->setBackgroundColor( 'transparent' );
370  $im->setImageDepth( 8 );
371 
372  if ( !$im->thumbnailImage( intval( $width ), intval( $height ), /* fit */ false ) ) {
373  return 'Could not resize image';
374  }
375  if ( !$im->writeImage( $dstPath ) ) {
376  return "Could not write to $dstPath";
377  }
378  }
379 
386  function getImageSize( $file, $path, $metadata = false ) {
387  if ( $metadata === false && $file instanceof File ) {
388  $metadata = $file->getMetadata();
389  }
390  $metadata = $this->unpackMetadata( $metadata );
391 
392  if ( isset( $metadata['width'] ) && isset( $metadata['height'] ) ) {
393  return [ $metadata['width'], $metadata['height'], 'SVG',
394  "width=\"{$metadata['width']}\" height=\"{$metadata['height']}\"" ];
395  } else { // error
396  return [ 0, 0, 'SVG', "width=\"0\" height=\"0\"" ];
397  }
398  }
399 
400  public function getThumbType( $ext, $mime, $params = null ) {
401  return [ 'png', 'image/png' ];
402  }
403 
413  public function getLongDesc( $file ) {
414  global $wgLang;
415 
416  $metadata = $this->unpackMetadata( $file->getMetadata() );
417  if ( isset( $metadata['error'] ) ) {
418  return wfMessage( 'svg-long-error', $metadata['error']['message'] )->text();
419  }
420 
421  $size = $wgLang->formatSize( $file->getSize() );
422 
423  if ( $this->isAnimatedImage( $file ) ) {
424  $msg = wfMessage( 'svg-long-desc-animated' );
425  } else {
426  $msg = wfMessage( 'svg-long-desc' );
427  }
428 
429  $msg->numParams( $file->getWidth(), $file->getHeight() )->params( $size );
430 
431  return $msg->parse();
432  }
433 
439  public function getMetadata( $file, $filename ) {
440  $metadata = [ 'version' => self::SVG_METADATA_VERSION ];
441  try {
442  $metadata += SVGMetadataExtractor::getMetadata( $filename );
443  } catch ( Exception $e ) { // @todo SVG specific exceptions
444  // File not found, broken, etc.
445  $metadata['error'] = [
446  'message' => $e->getMessage(),
447  'code' => $e->getCode()
448  ];
449  wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
450  }
451 
452  return serialize( $metadata );
453  }
454 
455  function unpackMetadata( $metadata ) {
456  Wikimedia\suppressWarnings();
457  $unser = unserialize( $metadata );
458  Wikimedia\restoreWarnings();
459  if ( isset( $unser['version'] ) && $unser['version'] == self::SVG_METADATA_VERSION ) {
460  return $unser;
461  } else {
462  return false;
463  }
464  }
465 
466  function getMetadataType( $image ) {
467  return 'parsed-svg';
468  }
469 
470  public function isMetadataValid( $image, $metadata ) {
471  $meta = $this->unpackMetadata( $metadata );
472  if ( $meta === false ) {
473  return self::METADATA_BAD;
474  }
475  if ( !isset( $meta['originalWidth'] ) ) {
476  // Old but compatible
477  return self::METADATA_COMPATIBLE;
478  }
479 
480  return self::METADATA_GOOD;
481  }
482 
483  protected function visibleMetadataFields() {
484  $fields = [ 'objectname', 'imagedescription' ];
485 
486  return $fields;
487  }
488 
494  public function formatMetadata( $file, $context = false ) {
495  $result = [
496  'visible' => [],
497  'collapsed' => []
498  ];
499  $metadata = $file->getMetadata();
500  if ( !$metadata ) {
501  return false;
502  }
503  $metadata = $this->unpackMetadata( $metadata );
504  if ( !$metadata || isset( $metadata['error'] ) ) {
505  return false;
506  }
507 
508  /* @todo Add a formatter
509  $format = new FormatSVG( $metadata );
510  $formatted = $format->getFormattedData();
511  */
512 
513  // Sort fields into visible and collapsed
514  $visibleFields = $this->visibleMetadataFields();
515 
516  $showMeta = false;
517  foreach ( $metadata as $name => $value ) {
518  $tag = strtolower( $name );
519  if ( isset( self::$metaConversion[$tag] ) ) {
520  $tag = strtolower( self::$metaConversion[$tag] );
521  } else {
522  // Do not output other metadata not in list
523  continue;
524  }
525  $showMeta = true;
526  self::addMeta( $result,
527  in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed',
528  'exif',
529  $tag,
530  $value
531  );
532  }
533 
534  return $showMeta ? $result : false;
535  }
536 
542  public function validateParam( $name, $value ) {
543  if ( in_array( $name, [ 'width', 'height' ] ) ) {
544  // Reject negative heights, widths
545  return ( $value > 0 );
546  } elseif ( $name == 'lang' ) {
547  // Validate $code
548  if ( $value === '' || !Language::isValidCode( $value ) ) {
549  return false;
550  }
551 
552  return true;
553  }
554 
555  // Only lang, width and height are acceptable keys
556  return false;
557  }
558 
563  public function makeParamString( $params ) {
564  $lang = '';
565  $code = $this->getLanguageFromParams( $params );
566  if ( $code !== 'en' ) {
567  $lang = 'lang' . strtolower( $code ) . '-';
568  }
569  if ( !isset( $params['width'] ) ) {
570  return false;
571  }
572 
573  return "$lang{$params['width']}px";
574  }
575 
576  public function parseParamString( $str ) {
577  $m = false;
578  if ( preg_match( '/^lang([a-z]+(?:-[a-z]+)*)-(\d+)px$/i', $str, $m ) ) {
579  return [ 'width' => array_pop( $m ), 'lang' => $m[1] ];
580  } elseif ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
581  return [ 'width' => $m[1], 'lang' => 'en' ];
582  } else {
583  return false;
584  }
585  }
586 
587  public function getParamMap() {
588  return [ 'img_lang' => 'lang', 'img_width' => 'width' ];
589  }
590 
595  protected function getScriptParams( $params ) {
596  $scriptParams = [ 'width' => $params['width'] ];
597  if ( isset( $params['lang'] ) ) {
598  $scriptParams['lang'] = $params['lang'];
599  }
600 
601  return $scriptParams;
602  }
603 
604  public function getCommonMetaArray( File $file ) {
605  $metadata = $file->getMetadata();
606  if ( !$metadata ) {
607  return [];
608  }
609  $metadata = $this->unpackMetadata( $metadata );
610  if ( !$metadata || isset( $metadata['error'] ) ) {
611  return [];
612  }
613  $stdMetadata = [];
614  foreach ( $metadata as $name => $value ) {
615  $tag = strtolower( $name );
616  if ( $tag === 'originalwidth' || $tag === 'originalheight' ) {
617  // Skip these. In the exif metadata stuff, it is assumed these
618  // are measured in px, which is not the case here.
619  continue;
620  }
621  if ( isset( self::$metaConversion[$tag] ) ) {
622  $tag = self::$metaConversion[$tag];
623  $stdMetadata[$tag] = $value;
624  }
625  }
626 
627  return $stdMetadata;
628  }
629 }
removeBadFile( $dstPath, $retval=0)
Check for zero-sized thumbnails.
isVectorized( $file)
Definition: SvgHandler.php:61
static getMetadata( $filename)
getAvailableLanguages(File $file)
Which languages (systemLanguage attribute) is supported.
Definition: SvgHandler.php:94
serialize()
getMetadataType( $image)
Definition: SvgHandler.php:466
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMatchedLanguage( $userPreferredLanguage, array $svgLanguages)
SVG&#39;s systemLanguage matching rules state: &#39;The systemLanguage attribute ...
Definition: SvgHandler.php:125
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2146
unpackMetadata( $metadata)
Definition: SvgHandler.php:455
wfHostname()
Fetch server name for use in error reporting etc.
if(!isset( $args[0])) $lang
isAnimatedImage( $file)
Definition: SvgHandler.php:69
static scaleHeight( $srcWidth, $srcHeight, $dstWidth)
Calculate the height of a thumbnail using the source and destination width.
Definition: File.php:2010
$value
getScriptParams( $params)
Definition: SvgHandler.php:595
makeParamString( $params)
Definition: SvgHandler.php:563
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
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=(\*-\*)") 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. '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 '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 since 1.28! 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:1969
Shortcut class for parameter validation errors.
getLanguageFromParams(array $params)
Determines render language from image parameters.
Definition: SvgHandler.php:147
validateParam( $name, $value)
Definition: SvgHandler.php:542
getMetadata( $file, $filename)
Definition: SvgHandler.php:439
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1244
parseParamString( $str)
Definition: SvgHandler.php:576
$wgLang
Definition: Setup.php:940
wfTempDir()
Tries to get the system directory for temporary files.
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 use $formDescriptor instead 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
$wgSVGConverterPath
If not in the executable PATH, specify the SVG converter path.
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
getMetadata()
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB.
Definition: File.php:663
const LANG_FULL_MATCH
Definition: SVGReader.php:36
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$wgSVGConverters
Scalable Vector Graphics (SVG) may be uploaded as images.
Media transform output for images.
getCommonMetaArray(File $file)
Definition: SvgHandler.php:604
getThumbType( $ext, $mime, $params=null)
Definition: SvgHandler.php:400
$params
unserialize( $serialized)
normaliseParams( $image, &$params)
Definition: SvgHandler.php:175
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
canAnimateThumbnail( $file)
We do not support making animated svg thumbnails.
Definition: SvgHandler.php:166
static array isEnabled()
Definition: SvgHandler.php:46
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 & $code
Definition: hooks.txt:767
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:9
rasterize( $srcPath, $dstPath, $width, $height, $lang=false)
Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
Definition: SvgHandler.php:317
$wgSVGMaxSize
Don&#39;t scale a SVG larger than this.
const SVG_METADATA_VERSION
Definition: SvgHandler.php:33
getLongDesc( $file)
Subtitle for the image.
Definition: SvgHandler.php:413
normaliseParamsInternal( $image, $params)
Code taken out of normaliseParams() for testability.
Definition: SvgHandler.php:193
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:35
visibleMetadataFields()
Definition: SvgHandler.php:483
Media handler abstract base class for images.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don&#39;t exist.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
logErrorForExternalProcess( $retval, $err, $cmd)
Log an error that occurred in an external process.
static rasterizeImagickExt( $srcPath, $dstPath, $width, $height)
Definition: SvgHandler.php:366
formatMetadata( $file, $context=false)
Definition: SvgHandler.php:494
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
if(!is_readable( $file)) $ext
Definition: router.php:48
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 also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2620
getDefaultRenderLanguage(File $file)
What language to render file in if none selected.
Definition: SvgHandler.php:157
doTransform( $image, $dstPath, $dstUrl, $params, $flags=0)
Definition: SvgHandler.php:227
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getImageSize( $file, $path, $metadata=false)
Definition: SvgHandler.php:386
static array $metaConversion
A list of metadata tags that can be converted to the commonly used exif tags.
Definition: SvgHandler.php:39
mustRender( $file)
Definition: SvgHandler.php:57
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
static isValidCode( $code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:388
$wgSVGConverter
Pick a converter defined in $wgSVGConverters.
isMetadataValid( $image, $metadata)
Definition: SvgHandler.php:470
Handler for SVG images.
Definition: SvgHandler.php:32
Basic media transform error class.