MediaWiki  REL1_31
PNG.php
Go to the documentation of this file.
1 <?php
29 class PNGHandler extends BitmapHandler {
30  const BROKEN_FILE = '0';
31 
37  function getMetadata( $image, $filename ) {
38  try {
39  $metadata = BitmapMetadataHandler::PNG( $filename );
40  } catch ( Exception $e ) {
41  // Broken file?
42  wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
43 
44  return self::BROKEN_FILE;
45  }
46 
47  return serialize( $metadata );
48  }
49 
55  function formatMetadata( $image, $context = false ) {
56  $meta = $this->getCommonMetaArray( $image );
57  if ( count( $meta ) === 0 ) {
58  return false;
59  }
60 
61  return $this->formatMetadataHelper( $meta, $context );
62  }
63 
70  public function getCommonMetaArray( File $image ) {
71  $meta = $image->getMetadata();
72 
73  if ( !$meta ) {
74  return [];
75  }
76  $meta = unserialize( $meta );
77  if ( !isset( $meta['metadata'] ) ) {
78  return [];
79  }
80  unset( $meta['metadata']['_MW_PNG_VERSION'] );
81 
82  return $meta['metadata'];
83  }
84 
89  function isAnimatedImage( $image ) {
90  $ser = $image->getMetadata();
91  if ( $ser ) {
92  $metadata = unserialize( $ser );
93  if ( $metadata['frameCount'] > 1 ) {
94  return true;
95  }
96  }
97 
98  return false;
99  }
100 
107  return false;
108  }
109 
110  function getMetadataType( $image ) {
111  return 'parsed-png';
112  }
113 
114  function isMetadataValid( $image, $metadata ) {
115  if ( $metadata === self::BROKEN_FILE ) {
116  // Do not repetitivly regenerate metadata on broken file.
117  return self::METADATA_GOOD;
118  }
119 
120  Wikimedia\suppressWarnings();
121  $data = unserialize( $metadata );
122  Wikimedia\restoreWarnings();
123 
124  if ( !$data || !is_array( $data ) ) {
125  wfDebug( __METHOD__ . " invalid png metadata\n" );
126 
127  return self::METADATA_BAD;
128  }
129 
130  if ( !isset( $data['metadata']['_MW_PNG_VERSION'] )
131  || $data['metadata']['_MW_PNG_VERSION'] != PNGMetadataExtractor::VERSION
132  ) {
133  wfDebug( __METHOD__ . " old but compatible png metadata\n" );
134 
136  }
137 
138  return self::METADATA_GOOD;
139  }
140 
145  function getLongDesc( $image ) {
146  global $wgLang;
147  $original = parent::getLongDesc( $image );
148 
149  Wikimedia\suppressWarnings();
150  $metadata = unserialize( $image->getMetadata() );
151  Wikimedia\restoreWarnings();
152 
153  if ( !$metadata || $metadata['frameCount'] <= 0 ) {
154  return $original;
155  }
156 
157  $info = [];
158  $info[] = $original;
159 
160  if ( $metadata['loopCount'] == 0 ) {
161  $info[] = wfMessage( 'file-info-png-looped' )->parse();
162  } elseif ( $metadata['loopCount'] > 1 ) {
163  $info[] = wfMessage( 'file-info-png-repeat' )->numParams( $metadata['loopCount'] )->parse();
164  }
165 
166  if ( $metadata['frameCount'] > 0 ) {
167  $info[] = wfMessage( 'file-info-png-frames' )->numParams( $metadata['frameCount'] )->parse();
168  }
169 
170  if ( $metadata['duration'] ) {
171  $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
172  }
173 
174  return $wgLang->commaList( $info );
175  }
176 
185  public function getLength( $file ) {
186  $serMeta = $file->getMetadata();
187  Wikimedia\suppressWarnings();
188  $metadata = unserialize( $serMeta );
189  Wikimedia\restoreWarnings();
190 
191  if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
192  return 0.0;
193  } else {
194  return (float)$metadata['duration'];
195  }
196  }
197 
198  // PNGs should be easy to support, but it will need some sharpening applied
199  // and another user test to check if the perceived quality change is noticeable
200  public function supportsBucketing() {
201  return false;
202  }
203 }
PNGHandler\canAnimateThumbnail
canAnimateThumbnail( $image)
We do not support making APNG thumbnails, so always false.
Definition: PNG.php:106
PNGMetadataExtractor\VERSION
const VERSION
Definition: PNGMetadataExtractor.php:43
PNGHandler\isMetadataValid
isMetadataValid( $image, $metadata)
Check if the metadata string is valid for this handler.
Definition: PNG.php:114
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
PNGHandler\BROKEN_FILE
const BROKEN_FILE
Definition: PNG.php:30
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
serialize
serialize()
Definition: ApiMessage.php:184
PNGHandler\getLength
getLength( $file)
Return the duration of an APNG file.
Definition: PNG.php:185
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
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
BitmapHandler
Generic handler for bitmap images.
Definition: Bitmap.php:29
PNGHandler\getCommonMetaArray
getCommonMetaArray(File $image)
Get a file type independent array of metadata.
Definition: PNG.php:70
PNGHandler\getMetadata
getMetadata( $image, $filename)
Definition: PNG.php:37
PNGHandler\isAnimatedImage
isAnimatedImage( $image)
Definition: PNG.php:89
PNGHandler\getLongDesc
getLongDesc( $image)
Definition: PNG.php:145
$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
PNGHandler\getMetadataType
getMetadataType( $image)
Get a string describing the type of metadata, for display purposes.
Definition: PNG.php:110
BitmapMetadataHandler\PNG
static PNG( $filename)
Entry point for png At some point in the future this might merge the png various tEXt chunks to that ...
Definition: BitmapMetadataHandler.php:200
PNGHandler
Handler for PNG images.
Definition: PNG.php:29
PNGHandler\formatMetadata
formatMetadata( $image, $context=false)
Definition: PNG.php:55
PNGHandler\supportsBucketing
supportsBucketing()
Returns whether or not this handler supports the chained generation of thumbnails according to bucket...
Definition: PNG.php:200
$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
MediaHandler\formatMetadataHelper
formatMetadataHelper( $metadataArray, $context=false)
sorts the visible/invisible field.
Definition: MediaHandler.php:504
MediaHandler\METADATA_BAD
const METADATA_BAD
Definition: MediaHandler.php:33
$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
MediaHandler\METADATA_GOOD
const METADATA_GOOD
Definition: MediaHandler.php:32
$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