3 * Media-handling base classes and generic functionality
9 * Base media handler class
13 abstract class MediaHandler
{
14 const TRANSFORM_LATER
= 1;
19 static $handlers = array();
22 * Get a MediaHandler for a given MIME type from the instance cache
24 static function getHandler( $type ) {
25 global $wgMediaHandlers;
26 if ( !isset( $wgMediaHandlers[$type] ) ) {
27 wfDebug( __METHOD__
. ": no handler found for $type.\n");
30 $class = $wgMediaHandlers[$type];
31 if ( !isset( self
::$handlers[$class] ) ) {
32 self
::$handlers[$class] = new $class;
33 if ( !self
::$handlers[$class]->isEnabled() ) {
34 self
::$handlers[$class] = false;
37 return self
::$handlers[$class];
41 * Get an associative array mapping magic word IDs to parameter names.
42 * Will be used by the parser to identify parameters.
44 abstract function getParamMap();
47 * Validate a thumbnail parameter at parse time.
48 * Return true to accept the parameter, and false to reject it.
49 * If you return false, the parser will do something quiet and forgiving.
51 abstract function validateParam( $name, $value );
54 * Merge a parameter array into a string appropriate for inclusion in filenames
56 abstract function makeParamString( $params );
59 * Parse a param string made with makeParamString back into an array
61 abstract function parseParamString( $str );
64 * Changes the parameter array as necessary, ready for transformation.
65 * Should be idempotent.
66 * Returns false if the parameters are unacceptable and the transform should fail
68 abstract function normaliseParams( $image, &$params );
71 * Get an image size array like that returned by getimagesize(), or false if it
72 * can't be determined.
74 * @param Image $image The image object, or false if there isn't one
75 * @param string $fileName The filename
78 abstract function getImageSize( $image, $path );
81 * Get handler-specific metadata which will be saved in the img_metadata field.
83 * @param Image $image The image object, or false if there isn't one
84 * @param string $fileName The filename
87 function getMetadata( $image, $path ) { return ''; }
90 * Get a string describing the type of metadata, for display purposes.
92 function getMetadataType( $image ) { return false; }
95 * Check if the metadata string is valid for this handler.
96 * If it returns false, Image will reload the metadata from the file and update the database
98 function isMetadataValid( $image, $metadata ) { return true; }
102 * Get a MediaTransformOutput object representing an alternate of the transformed
103 * output which will call an intermediary thumbnail assist script.
105 * Used when the repository has a thumbnailScriptUrl option configured.
107 * Return false to fall back to the regular getTransform().
109 function getScriptedTransform( $image, $script, $params ) {
114 * Get a MediaTransformOutput object representing the transformed output. Does not
115 * actually do the transform.
117 * @param Image $image The image object
118 * @param string $dstPath Filesystem destination path
119 * @param string $dstUrl Destination URL to use in output HTML
120 * @param array $params Arbitrary set of parameters validated by $this->validateParam()
122 function getTransform( $image, $dstPath, $dstUrl, $params ) {
123 return $this->doTransform( $image, $dstPath, $dstUrl, $params, self
::TRANSFORM_LATER
);
127 * Get a MediaTransformOutput object representing the transformed output. Does the
128 * transform unless $flags contains self::TRANSFORM_LATER.
130 * @param Image $image The image object
131 * @param string $dstPath Filesystem destination path
132 * @param string $dstUrl Destination URL to use in output HTML
133 * @param array $params Arbitrary set of parameters validated by $this->validateParam()
134 * @param integer $flags A bitfield, may contain self::TRANSFORM_LATER
136 abstract function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 );
139 * Get the thumbnail extension and MIME type for a given source MIME type
140 * @return array thumbnail extension and MIME type
142 function getThumbType( $ext, $mime ) {
143 return array( $ext, $mime );
147 * True if the handled types can be transformed
149 function canRender( $file ) { return true; }
151 * True if handled types cannot be displayed directly in a browser
152 * but can be rendered
154 function mustRender( $file ) { return false; }
156 * True if the type has multi-page capabilities
158 function isMultiPage( $file ) { return false; }
160 * Page count for a multi-page document, false if unsupported or unknown
162 function pageCount( $file ) { return false; }
164 * False if the handler is disabled for all files
166 function isEnabled() { return true; }
169 * Get an associative array of page dimensions
170 * Currently "width" and "height" are understood, but this might be
171 * expanded in the future.
172 * Returns false if unknown or if the document is not multi-page.
174 function getPageDimensions( $image, $page ) {
175 $gis = $this->getImageSize( $image, $image->getPath() );
183 * Get an array structure that looks like this:
186 * 'visible' => array(
187 * 'Human-readable name' => 'Human readable value',
190 * 'collapsed' => array(
191 * 'Human-readable name' => 'Human readable value',
195 * The UI will format this into a table where the visible fields are always
196 * visible, and the collapsed fields are optionally visible.
198 * The function should return false if there is no metadata to display.
202 * FIXME: I don't really like this interface, it's not very flexible
203 * I think the media handler should generate HTML instead. It can do
204 * all the formatting according to some standard. That makes it possible
205 * to do things like visual indication of grouped and chained streams
206 * in ogg container files.
208 function formatMetadata( $image ) {
213 * @fixme document this!
214 * 'value' thingy goes into a wikitext table; it used to be escaped but
215 * that was incompatible with previous practice of customized display
216 * with wikitext formatting via messages such as 'exif-model-value'.
217 * So the escaping is taken back out, but generally this seems a confusing
220 protected static function addMeta( &$array, $visibility, $type, $id, $value, $param = false ) {
221 $array[$visibility][] = array(
223 'name' => wfMsg( "$type-$id", $param ),
228 function getShortDesc( $file ) {
230 $nbytes = '(' . wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
231 $wgLang->formatNum( $file->getSize() ) ) . ')';
235 function getLongDesc( $file ) {
237 $sk = $wgUser->getSkin();
238 return wfMsgExt( 'file-info', 'parseinline',
239 $sk->formatSize( $file->getSize() ),
240 $file->getMimeType() );
243 function getDimensionsString( $file ) {
248 * Modify the parser object post-transform
250 function parserTransformHook( $parser, $file ) {}
253 * Check for zero-sized thumbnails. These can be generated when
254 * no disk space is available or some other error occurs
256 * @param $dstPath The location of the suspect file
257 * @param $retval Return value of some shell process, file will be deleted if this is non-zero
258 * @return true if removed, false otherwise
260 function removeBadFile( $dstPath, $retval = 0 ) {
261 if( file_exists( $dstPath ) ) {
262 $thumbstat = stat( $dstPath );
263 if( $thumbstat['size'] == 0 ||
$retval != 0 ) {
264 wfDebugLog( 'thumbnail',
265 sprintf( 'Removing bad %d-byte thumbnail "%s"',
266 $thumbstat['size'], $dstPath ) );
276 * Media handler abstract base class for images
280 abstract class ImageHandler
extends MediaHandler
{
281 function canRender( $file ) {
282 if ( $file->getWidth() && $file->getHeight() ) {
289 function getParamMap() {
290 return array( 'img_width' => 'width' );
293 function validateParam( $name, $value ) {
294 if ( in_array( $name, array( 'width', 'height' ) ) ) {
305 function makeParamString( $params ) {
306 if ( isset( $params['physicalWidth'] ) ) {
307 $width = $params['physicalWidth'];
308 } elseif ( isset( $params['width'] ) ) {
309 $width = $params['width'];
311 throw new MWException( 'No width specified to '.__METHOD__
);
313 # Removed for ProofreadPage
314 #$width = intval( $width );
318 function parseParamString( $str ) {
320 if ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
321 return array( 'width' => $m[1] );
327 function getScriptParams( $params ) {
328 return array( 'width' => $params['width'] );
331 function normaliseParams( $image, &$params ) {
332 $mimeType = $image->getMimeType();
334 if ( !isset( $params['width'] ) ) {
337 if ( !isset( $params['page'] ) ) {
340 $srcWidth = $image->getWidth( $params['page'] );
341 $srcHeight = $image->getHeight( $params['page'] );
342 if ( isset( $params['height'] ) && $params['height'] != -1 ) {
343 if ( $params['width'] * $srcHeight > $params['height'] * $srcWidth ) {
344 $params['width'] = wfFitBoxWidth( $srcWidth, $srcHeight, $params['height'] );
347 $params['height'] = File
::scaleHeight( $srcWidth, $srcHeight, $params['width'] );
348 if ( !$this->validateThumbParams( $params['width'], $params['height'], $srcWidth, $srcHeight, $mimeType ) ) {
355 * Get a transform output object without actually doing the transform
357 function getTransform( $image, $dstPath, $dstUrl, $params ) {
358 return $this->doTransform( $image, $dstPath, $dstUrl, $params, self
::TRANSFORM_LATER
);
362 * Validate thumbnail parameters and fill in the correct height
364 * @param integer &$width Specified width (input/output)
365 * @param integer &$height Height (output only)
366 * @return false to indicate that an error should be returned to the user.
368 function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight, $mimeType ) {
369 $width = intval( $width );
371 # Sanity check $width
373 wfDebug( __METHOD__
.": Invalid destination width: $width\n" );
376 if ( $srcWidth <= 0 ) {
377 wfDebug( __METHOD__
.": Invalid source width: $srcWidth\n" );
381 $height = File
::scaleHeight( $srcWidth, $srcHeight, $width );
385 function getScriptedTransform( $image, $script, $params ) {
386 if ( !$this->normaliseParams( $image, $params ) ) {
389 $url = $script . '&' . wfArrayToCGI( $this->getScriptParams( $params ) );
390 $page = isset( $params['page'] ) ?
$params['page'] : false;
392 if( $image->mustRender() ||
$params['width'] < $image->getWidth() ) {
393 return new ThumbnailImage( $image, $url, $params['width'], $params['height'], $page );
397 function getImageSize( $image, $path ) {
398 wfSuppressWarnings();
399 $gis = getimagesize( $path );
404 function getShortDesc( $file ) {
406 $nbytes = wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
407 $wgLang->formatNum( $file->getSize() ) );
408 $widthheight = wfMsgHtml( 'widthheight', $wgLang->formatNum( $file->getWidth() ) ,$wgLang->formatNum( $file->getHeight() ) );
410 return "$widthheight ($nbytes)";
413 function getLongDesc( $file ) {
415 return wfMsgExt('file-info-size', 'parseinline',
416 $wgLang->formatNum( $file->getWidth() ),
417 $wgLang->formatNum( $file->getHeight() ),
418 $wgLang->formatSize( $file->getSize() ),
419 $file->getMimeType() );
422 function getDimensionsString( $file ) {
424 $pages = $file->pageCount();
425 $width = $wgLang->formatNum( $file->getWidth() );
426 $height = $wgLang->formatNum( $file->getHeight() );
427 $pagesFmt = $wgLang->formatNum( $pages );
430 return wfMsgExt( 'widthheightpage', 'parsemag', $width, $height, $pagesFmt );
432 return wfMsg( 'widthheight', $width, $height );