MediaWiki  REL1_31
SVG.php
Go to the documentation of this file.
1 <?php
23 use Wikimedia\ScopedCallback;
24 
30 class SvgHandler extends ImageHandler {
32 
37  private static $metaConversion = [
38  'originalwidth' => 'ImageWidth',
39  'originalheight' => 'ImageLength',
40  'description' => 'ImageDescription',
41  'title' => 'ObjectName',
42  ];
43 
44  function isEnabled() {
46  if ( !isset( $wgSVGConverters[$wgSVGConverter] ) ) {
47  wfDebug( "\$wgSVGConverter is invalid, disabling SVG rendering.\n" );
48 
49  return false;
50  } else {
51  return true;
52  }
53  }
54 
55  public function mustRender( $file ) {
56  return true;
57  }
58 
59  function isVectorized( $file ) {
60  return true;
61  }
62 
67  function isAnimatedImage( $file ) {
68  # @todo Detect animated SVGs
69  $metadata = $file->getMetadata();
70  if ( $metadata ) {
71  $metadata = $this->unpackMetadata( $metadata );
72  if ( isset( $metadata['animated'] ) ) {
73  return $metadata['animated'];
74  }
75  }
76 
77  return false;
78  }
79 
92  public function getAvailableLanguages( File $file ) {
93  $metadata = $file->getMetadata();
94  $langList = [];
95  if ( $metadata ) {
96  $metadata = $this->unpackMetadata( $metadata );
97  if ( isset( $metadata['translations'] ) ) {
98  foreach ( $metadata['translations'] as $lang => $langType ) {
99  if ( $langType === SVGReader::LANG_FULL_MATCH ) {
100  $langList[] = strtolower( $lang );
101  }
102  }
103  }
104  }
105  return array_unique( $langList );
106  }
107 
123  public function getMatchedLanguage( $userPreferredLanguage, array $svgLanguages ) {
124  foreach ( $svgLanguages as $svgLang ) {
125  if ( strcasecmp( $svgLang, $userPreferredLanguage ) === 0 ) {
126  return $svgLang;
127  }
128  $trimmedSvgLang = $svgLang;
129  while ( strpos( $trimmedSvgLang, '-' ) !== false ) {
130  $trimmedSvgLang = substr( $trimmedSvgLang, 0, strrpos( $trimmedSvgLang, '-' ) );
131  if ( strcasecmp( $trimmedSvgLang, $userPreferredLanguage ) === 0 ) {
132  return $svgLang;
133  }
134  }
135  }
136  return null;
137  }
138 
145  public function getDefaultRenderLanguage( File $file ) {
146  return 'en';
147  }
148 
154  function canAnimateThumbnail( $file ) {
155  return false;
156  }
157 
165  if ( !parent::normaliseParams( $image, $params ) ) {
166  return false;
167  }
168  # Don't make an image bigger than wgMaxSVGSize on the smaller side
169  if ( $params['physicalWidth'] <= $params['physicalHeight'] ) {
170  if ( $params['physicalWidth'] > $wgSVGMaxSize ) {
171  $srcWidth = $image->getWidth( $params['page'] );
172  $srcHeight = $image->getHeight( $params['page'] );
173  $params['physicalWidth'] = $wgSVGMaxSize;
174  $params['physicalHeight'] = File::scaleHeight( $srcWidth, $srcHeight, $wgSVGMaxSize );
175  }
176  } else {
177  if ( $params['physicalHeight'] > $wgSVGMaxSize ) {
178  $srcWidth = $image->getWidth( $params['page'] );
179  $srcHeight = $image->getHeight( $params['page'] );
180  $params['physicalWidth'] = File::scaleHeight( $srcHeight, $srcWidth, $wgSVGMaxSize );
181  $params['physicalHeight'] = $wgSVGMaxSize;
182  }
183  }
184 
185  return true;
186  }
187 
196  function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
197  if ( !$this->normaliseParams( $image, $params ) ) {
198  return new TransformParameterError( $params );
199  }
200  $clientWidth = $params['width'];
201  $clientHeight = $params['height'];
202  $physicalWidth = $params['physicalWidth'];
203  $physicalHeight = $params['physicalHeight'];
204  $lang = isset( $params['lang'] ) ? $params['lang'] : $this->getDefaultRenderLanguage( $image );
205 
206  if ( $flags & self::TRANSFORM_LATER ) {
207  return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
208  }
209 
210  $metadata = $this->unpackMetadata( $image->getMetadata() );
211  if ( isset( $metadata['error'] ) ) { // sanity check
212  $err = wfMessage( 'svg-long-error', $metadata['error']['message'] );
213 
214  return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight, $err );
215  }
216 
217  if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__ ) ) {
218  return new MediaTransformError( 'thumbnail_error', $clientWidth, $clientHeight,
219  wfMessage( 'thumbnail_dest_directory' ) );
220  }
221 
222  $srcPath = $image->getLocalRefPath();
223  if ( $srcPath === false ) { // Failed to get local copy
224  wfDebugLog( 'thumbnail',
225  sprintf( 'Thumbnail failed on %s: could not get local copy of "%s"',
226  wfHostname(), $image->getName() ) );
227 
228  return new MediaTransformError( 'thumbnail_error',
229  $params['width'], $params['height'],
230  wfMessage( 'filemissing' )
231  );
232  }
233 
234  // Make a temp dir with a symlink to the local copy in it.
235  // This plays well with rsvg-convert policy for external entities.
236  // https://git.gnome.org/browse/librsvg/commit/?id=f01aded72c38f0e18bc7ff67dee800e380251c8e
237  $tmpDir = wfTempDir() . '/svg_' . wfRandomString( 24 );
238  $lnPath = "$tmpDir/" . basename( $srcPath );
239  $ok = mkdir( $tmpDir, 0771 );
240  if ( !$ok ) {
241  wfDebugLog( 'thumbnail',
242  sprintf( 'Thumbnail failed on %s: could not create temporary directory %s',
243  wfHostname(), $tmpDir ) );
244  return new MediaTransformError( 'thumbnail_error',
245  $params['width'], $params['height'],
246  wfMessage( 'thumbnail-temp-create' )->text()
247  );
248  }
249  $ok = symlink( $srcPath, $lnPath );
251  $cleaner = new ScopedCallback( function () use ( $tmpDir, $lnPath ) {
252  Wikimedia\suppressWarnings();
253  unlink( $lnPath );
254  rmdir( $tmpDir );
255  Wikimedia\restoreWarnings();
256  } );
257  if ( !$ok ) {
258  wfDebugLog( 'thumbnail',
259  sprintf( 'Thumbnail failed on %s: could not link %s to %s',
260  wfHostname(), $lnPath, $srcPath ) );
261  return new MediaTransformError( 'thumbnail_error',
262  $params['width'], $params['height'],
263  wfMessage( 'thumbnail-temp-create' )
264  );
265  }
266 
267  $status = $this->rasterize( $lnPath, $dstPath, $physicalWidth, $physicalHeight, $lang );
268  if ( $status === true ) {
269  return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
270  } else {
271  return $status; // MediaTransformError
272  }
273  }
274 
286  public function rasterize( $srcPath, $dstPath, $width, $height, $lang = false ) {
288  $err = false;
289  $retval = '';
290  if ( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
291  if ( is_array( $wgSVGConverters[$wgSVGConverter] ) ) {
292  // This is a PHP callable
293  $func = $wgSVGConverters[$wgSVGConverter][0];
294  $args = array_merge( [ $srcPath, $dstPath, $width, $height, $lang ],
295  array_slice( $wgSVGConverters[$wgSVGConverter], 1 ) );
296  if ( !is_callable( $func ) ) {
297  throw new MWException( "$func is not callable" );
298  }
299  $err = call_user_func_array( $func, $args );
300  $retval = (bool)$err;
301  } else {
302  // External command
303  $cmd = str_replace(
304  [ '$path/', '$width', '$height', '$input', '$output' ],
305  [ $wgSVGConverterPath ? wfEscapeShellArg( "$wgSVGConverterPath/" ) : "",
306  intval( $width ),
307  intval( $height ),
308  wfEscapeShellArg( $srcPath ),
309  wfEscapeShellArg( $dstPath ) ],
311  );
312 
313  $env = [];
314  if ( $lang !== false ) {
315  $env['LANG'] = $lang;
316  }
317 
318  wfDebug( __METHOD__ . ": $cmd\n" );
319  $err = wfShellExecWithStderr( $cmd, $retval, $env );
320  }
321  }
322  $removed = $this->removeBadFile( $dstPath, $retval );
323  if ( $retval != 0 || $removed ) {
324  $this->logErrorForExternalProcess( $retval, $err, $cmd );
325  return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
326  }
327 
328  return true;
329  }
330 
331  public static function rasterizeImagickExt( $srcPath, $dstPath, $width, $height ) {
332  $im = new Imagick( $srcPath );
333  $im->setImageFormat( 'png' );
334  $im->setBackgroundColor( 'transparent' );
335  $im->setImageDepth( 8 );
336 
337  if ( !$im->thumbnailImage( intval( $width ), intval( $height ), /* fit */ false ) ) {
338  return 'Could not resize image';
339  }
340  if ( !$im->writeImage( $dstPath ) ) {
341  return "Could not write to $dstPath";
342  }
343  }
344 
351  function getImageSize( $file, $path, $metadata = false ) {
352  if ( $metadata === false && $file instanceof File ) {
353  $metadata = $file->getMetadata();
354  }
355  $metadata = $this->unpackMetadata( $metadata );
356 
357  if ( isset( $metadata['width'] ) && isset( $metadata['height'] ) ) {
358  return [ $metadata['width'], $metadata['height'], 'SVG',
359  "width=\"{$metadata['width']}\" height=\"{$metadata['height']}\"" ];
360  } else { // error
361  return [ 0, 0, 'SVG', "width=\"0\" height=\"0\"" ];
362  }
363  }
364 
365  function getThumbType( $ext, $mime, $params = null ) {
366  return [ 'png', 'image/png' ];
367  }
368 
378  function getLongDesc( $file ) {
379  global $wgLang;
380 
381  $metadata = $this->unpackMetadata( $file->getMetadata() );
382  if ( isset( $metadata['error'] ) ) {
383  return wfMessage( 'svg-long-error', $metadata['error']['message'] )->text();
384  }
385 
386  $size = $wgLang->formatSize( $file->getSize() );
387 
388  if ( $this->isAnimatedImage( $file ) ) {
389  $msg = wfMessage( 'svg-long-desc-animated' );
390  } else {
391  $msg = wfMessage( 'svg-long-desc' );
392  }
393 
394  $msg->numParams( $file->getWidth(), $file->getHeight() )->params( $size );
395 
396  return $msg->parse();
397  }
398 
404  function getMetadata( $file, $filename ) {
405  $metadata = [ 'version' => self::SVG_METADATA_VERSION ];
406  try {
407  $metadata += SVGMetadataExtractor::getMetadata( $filename );
408  } catch ( Exception $e ) { // @todo SVG specific exceptions
409  // File not found, broken, etc.
410  $metadata['error'] = [
411  'message' => $e->getMessage(),
412  'code' => $e->getCode()
413  ];
414  wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
415  }
416 
417  return serialize( $metadata );
418  }
419 
420  function unpackMetadata( $metadata ) {
421  Wikimedia\suppressWarnings();
422  $unser = unserialize( $metadata );
423  Wikimedia\restoreWarnings();
424  if ( isset( $unser['version'] ) && $unser['version'] == self::SVG_METADATA_VERSION ) {
425  return $unser;
426  } else {
427  return false;
428  }
429  }
430 
431  function getMetadataType( $image ) {
432  return 'parsed-svg';
433  }
434 
435  function isMetadataValid( $image, $metadata ) {
436  $meta = $this->unpackMetadata( $metadata );
437  if ( $meta === false ) {
438  return self::METADATA_BAD;
439  }
440  if ( !isset( $meta['originalWidth'] ) ) {
441  // Old but compatible
443  }
444 
445  return self::METADATA_GOOD;
446  }
447 
448  protected function visibleMetadataFields() {
449  $fields = [ 'objectname', 'imagedescription' ];
450 
451  return $fields;
452  }
453 
459  function formatMetadata( $file, $context = false ) {
460  $result = [
461  'visible' => [],
462  'collapsed' => []
463  ];
464  $metadata = $file->getMetadata();
465  if ( !$metadata ) {
466  return false;
467  }
468  $metadata = $this->unpackMetadata( $metadata );
469  if ( !$metadata || isset( $metadata['error'] ) ) {
470  return false;
471  }
472 
473  /* @todo Add a formatter
474  $format = new FormatSVG( $metadata );
475  $formatted = $format->getFormattedData();
476  */
477 
478  // Sort fields into visible and collapsed
479  $visibleFields = $this->visibleMetadataFields();
480 
481  $showMeta = false;
482  foreach ( $metadata as $name => $value ) {
483  $tag = strtolower( $name );
484  if ( isset( self::$metaConversion[$tag] ) ) {
485  $tag = strtolower( self::$metaConversion[$tag] );
486  } else {
487  // Do not output other metadata not in list
488  continue;
489  }
490  $showMeta = true;
492  in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed',
493  'exif',
494  $tag,
495  $value
496  );
497  }
498 
499  return $showMeta ? $result : false;
500  }
501 
507  public function validateParam( $name, $value ) {
508  if ( in_array( $name, [ 'width', 'height' ] ) ) {
509  // Reject negative heights, widths
510  return ( $value > 0 );
511  } elseif ( $name == 'lang' ) {
512  // Validate $code
513  if ( $value === '' || !Language::isValidCode( $value ) ) {
514  return false;
515  }
516 
517  return true;
518  }
519 
520  // Only lang, width and height are acceptable keys
521  return false;
522  }
523 
528  public function makeParamString( $params ) {
529  $lang = '';
530  if ( isset( $params['lang'] ) && $params['lang'] !== 'en' ) {
531  $lang = 'lang' . strtolower( $params['lang'] ) . '-';
532  }
533  if ( !isset( $params['width'] ) ) {
534  return false;
535  }
536 
537  return "$lang{$params['width']}px";
538  }
539 
540  public function parseParamString( $str ) {
541  $m = false;
542  if ( preg_match( '/^lang([a-z]+(?:-[a-z]+)*)-(\d+)px$/i', $str, $m ) ) {
543  return [ 'width' => array_pop( $m ), 'lang' => $m[1] ];
544  } elseif ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
545  return [ 'width' => $m[1], 'lang' => 'en' ];
546  } else {
547  return false;
548  }
549  }
550 
551  public function getParamMap() {
552  return [ 'img_lang' => 'lang', 'img_width' => 'width' ];
553  }
554 
559  function getScriptParams( $params ) {
560  $scriptParams = [ 'width' => $params['width'] ];
561  if ( isset( $params['lang'] ) ) {
562  $scriptParams['lang'] = $params['lang'];
563  }
564 
565  return $scriptParams;
566  }
567 
568  public function getCommonMetaArray( File $file ) {
569  $metadata = $file->getMetadata();
570  if ( !$metadata ) {
571  return [];
572  }
573  $metadata = $this->unpackMetadata( $metadata );
574  if ( !$metadata || isset( $metadata['error'] ) ) {
575  return [];
576  }
577  $stdMetadata = [];
578  foreach ( $metadata as $name => $value ) {
579  $tag = strtolower( $name );
580  if ( $tag === 'originalwidth' || $tag === 'originalheight' ) {
581  // Skip these. In the exif metadata stuff, it is assumed these
582  // are measured in px, which is not the case here.
583  continue;
584  }
585  if ( isset( self::$metaConversion[$tag] ) ) {
586  $tag = self::$metaConversion[$tag];
587  $stdMetadata[$tag] = $value;
588  }
589  }
590 
591  return $stdMetadata;
592  }
593 }
MediaHandler\removeBadFile
removeBadFile( $dstPath, $retval=0)
Check for zero-sized thumbnails.
Definition: MediaHandler.php:685
SvgHandler\validateParam
validateParam( $name, $value)
Definition: SVG.php:507
SvgHandler\rasterizeImagickExt
static rasterizeImagickExt( $srcPath, $dstPath, $width, $height)
Definition: SVG.php:331
MediaTransformError
Basic media transform error class.
Definition: MediaTransformOutput.php:441
ThumbnailImage
Media transform output for images.
Definition: MediaTransformOutput.php:277
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SvgHandler\$metaConversion
static array $metaConversion
A list of metadata tags that can be converted to the commonly used exif tags.
Definition: SVG.php:37
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
wfMkdirParents
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
Definition: GlobalFunctions.php:2076
File\getMetadata
getMetadata()
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB.
Definition: File.php:658
SvgHandler\parseParamString
parseParamString( $str)
Parse a param string made with makeParamString back into an array.
Definition: SVG.php:540
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
SvgHandler\formatMetadata
formatMetadata( $file, $context=false)
Definition: SVG.php:459
SVGMetadataExtractor\getMetadata
static getMetadata( $filename)
Definition: SVGMetadataExtractor.php:32
SvgHandler\getMetadataType
getMetadataType( $image)
Get a string describing the type of metadata, for display purposes.
Definition: SVG.php:431
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
SvgHandler\getMatchedLanguage
getMatchedLanguage( $userPreferredLanguage, array $svgLanguages)
SVG's systemLanguage matching rules state: 'The systemLanguage attribute ...
Definition: SVG.php:123
$wgSVGMaxSize
$wgSVGMaxSize
Don't scale a SVG larger than this.
Definition: DefaultSettings.php:1156
SvgHandler\isAnimatedImage
isAnimatedImage( $file)
Definition: SVG.php:67
SvgHandler\mustRender
mustRender( $file)
True if handled types cannot be displayed directly in a browser but can be rendered.
Definition: SVG.php:55
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
$params
$params
Definition: styleTest.css.php:40
wfHostname
wfHostname()
Fetch server name for use in error reporting etc.
Definition: GlobalFunctions.php:1420
serialize
serialize()
Definition: ApiMessage.php:184
SvgHandler\getThumbType
getThumbType( $ext, $mime, $params=null)
Get the thumbnail extension and MIME type for a given source MIME type.
Definition: SVG.php:365
$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
SvgHandler\getScriptParams
getScriptParams( $params)
Definition: SVG.php:559
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
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
SvgHandler\getMetadata
getMetadata( $file, $filename)
Definition: SVG.php:404
SvgHandler\rasterize
rasterize( $srcPath, $dstPath, $width, $height, $lang=false)
Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
Definition: SVG.php:286
SvgHandler\getLongDesc
getLongDesc( $file)
Subtitle for the image.
Definition: SVG.php:378
MediaHandler\METADATA_COMPATIBLE
const METADATA_COMPATIBLE
Definition: MediaHandler.php:34
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
$wgSVGConverterPath
$wgSVGConverterPath
If not in the executable PATH, specify the SVG converter path.
Definition: DefaultSettings.php:1151
MWException
MediaWiki exception.
Definition: MWException.php:26
SvgHandler\normaliseParams
normaliseParams( $image, &$params)
Definition: SVG.php:163
SvgHandler\isEnabled
isEnabled()
False if the handler is disabled for all files.
Definition: SVG.php:44
ImageHandler
Media handler abstract base class for images.
Definition: ImageHandler.php:29
MediaHandler\addMeta
static addMeta(&$array, $visibility, $type, $id, $value, $param=false)
This is used to generate an array element for each metadata value That array is then used to generate...
Definition: MediaHandler.php:559
SvgHandler
Handler for SVG images.
Definition: SVG.php:30
SVGReader\LANG_FULL_MATCH
const LANG_FULL_MATCH
Definition: SVGMetadataExtractor.php:47
$wgLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
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
SvgHandler\doTransform
doTransform( $image, $dstPath, $dstUrl, $params, $flags=0)
Definition: SVG.php:196
$mime
if( $ext=='php'|| $ext=='php5') $mime
Definition: router.php:59
$value
$value
Definition: styleTest.css.php:45
TransformParameterError
Shortcut class for parameter validation errors.
Definition: MediaTransformOutput.php:487
wfEscapeShellArg
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2209
$status
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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:1255
SvgHandler\canAnimateThumbnail
canAnimateThumbnail( $file)
We do not support making animated svg thumbnails.
Definition: SVG.php:154
SvgHandler\getAvailableLanguages
getAvailableLanguages(File $file)
Which languages (systemLanguage attribute) is supported.
Definition: SVG.php:92
Language\isValidCode
static isValidCode( $code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:338
SvgHandler\getImageSize
getImageSize( $file, $path, $metadata=false)
Definition: SVG.php:351
File\scaleHeight
static scaleHeight( $srcWidth, $srcHeight, $dstWidth)
Calculate the height of a thumbnail using the source and destination width.
Definition: File.php:2010
$args
if( $line===false) $args
Definition: cdb.php:64
SvgHandler\getCommonMetaArray
getCommonMetaArray(File $file)
Get an array of standard (FormatMetadata type) metadata values.
Definition: SVG.php:568
$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
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2057
SvgHandler\getDefaultRenderLanguage
getDefaultRenderLanguage(File $file)
What language to render file in if none selected.
Definition: SVG.php:145
MediaHandler\logErrorForExternalProcess
logErrorForExternalProcess( $retval, $err, $cmd)
Log an error that occurred in an external process.
Definition: MediaHandler.php:763
$path
$path
Definition: NoLocalSettings.php:25
SvgHandler\visibleMetadataFields
visibleMetadataFields()
Get a list of metadata items which should be displayed when the metadata table is collapsed.
Definition: SVG.php:448
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\METADATA_BAD
const METADATA_BAD
Definition: MediaHandler.php:33
$wgSVGConverters
$wgSVGConverters
Scalable Vector Graphics (SVG) may be uploaded as images.
Definition: DefaultSettings.php:1131
SvgHandler\SVG_METADATA_VERSION
const SVG_METADATA_VERSION
Definition: SVG.php:31
SvgHandler\unpackMetadata
unpackMetadata( $metadata)
Definition: SVG.php:420
SvgHandler\makeParamString
makeParamString( $params)
Definition: SVG.php:528
$ext
$ext
Definition: router.php:55
SvgHandler\getParamMap
getParamMap()
Get an associative array mapping magic word IDs to parameter names.
Definition: SVG.php:551
$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
$wgSVGConverter
$wgSVGConverter
Pick a converter defined in $wgSVGConverters.
Definition: DefaultSettings.php:1146
$context
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:2811
SvgHandler\isVectorized
isVectorized( $file)
The material is vectorized and thus scaling is lossless.
Definition: SVG.php:59
MediaHandler\METADATA_GOOD
const METADATA_GOOD
Definition: MediaHandler.php:32
SvgHandler\isMetadataValid
isMetadataValid( $image, $metadata)
Check if the metadata string is valid for this handler.
Definition: SVG.php:435
$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
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:305