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 * Generic getter for text layer.
184 * Currently overloaded by PDF and DjVu handlers
186 function getPageText( $image, $page ) {
191 * Get an array structure that looks like this:
194 * 'visible' => array(
195 * 'Human-readable name' => 'Human readable value',
198 * 'collapsed' => array(
199 * 'Human-readable name' => 'Human readable value',
203 * The UI will format this into a table where the visible fields are always
204 * visible, and the collapsed fields are optionally visible.
206 * The function should return false if there is no metadata to display.
210 * FIXME: I don't really like this interface, it's not very flexible
211 * I think the media handler should generate HTML instead. It can do
212 * all the formatting according to some standard. That makes it possible
213 * to do things like visual indication of grouped and chained streams
214 * in ogg container files.
216 function formatMetadata( $image ) {
221 * @fixme document this!
222 * 'value' thingy goes into a wikitext table; it used to be escaped but
223 * that was incompatible with previous practice of customized display
224 * with wikitext formatting via messages such as 'exif-model-value'.
225 * So the escaping is taken back out, but generally this seems a confusing
228 protected static function addMeta( &$array, $visibility, $type, $id, $value, $param = false ) {
229 $array[$visibility][] = array(
231 'name' => wfMsg( "$type-$id", $param ),
236 function getShortDesc( $file ) {
238 $nbytes = '(' . wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
239 $wgLang->formatNum( $file->getSize() ) ) . ')';
243 function getLongDesc( $file ) {
245 $sk = $wgUser->getSkin();
246 return wfMsgExt( 'file-info', 'parseinline',
247 $sk->formatSize( $file->getSize() ),
248 $file->getMimeType() );
251 static function getGeneralShortDesc( $file ) {
253 $nbytes = '(' . wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
254 $wgLang->formatNum( $file->getSize() ) ) . ')';
258 static function getGeneralLongDesc( $file ) {
260 $sk = $wgUser->getSkin();
261 return wfMsgExt( 'file-info', 'parseinline',
262 $sk->formatSize( $file->getSize() ),
263 $file->getMimeType() );
266 function getDimensionsString( $file ) {
271 * Modify the parser object post-transform
273 function parserTransformHook( $parser, $file ) {}
276 * Check for zero-sized thumbnails. These can be generated when
277 * no disk space is available or some other error occurs
279 * @param $dstPath The location of the suspect file
280 * @param $retval Return value of some shell process, file will be deleted if this is non-zero
281 * @return true if removed, false otherwise
283 function removeBadFile( $dstPath, $retval = 0 ) {
284 if( file_exists( $dstPath ) ) {
285 $thumbstat = stat( $dstPath );
286 if( $thumbstat['size'] == 0 ||
$retval != 0 ) {
287 wfDebugLog( 'thumbnail',
288 sprintf( 'Removing bad %d-byte thumbnail "%s"',
289 $thumbstat['size'], $dstPath ) );
299 * Media handler abstract base class for images
303 abstract class ImageHandler
extends MediaHandler
{
304 function canRender( $file ) {
305 if ( $file->getWidth() && $file->getHeight() ) {
312 function getParamMap() {
313 return array( 'img_width' => 'width' );
316 function validateParam( $name, $value ) {
317 if ( in_array( $name, array( 'width', 'height' ) ) ) {
328 function makeParamString( $params ) {
329 if ( isset( $params['physicalWidth'] ) ) {
330 $width = $params['physicalWidth'];
331 } elseif ( isset( $params['width'] ) ) {
332 $width = $params['width'];
334 throw new MWException( 'No width specified to '.__METHOD__
);
336 # Removed for ProofreadPage
337 #$width = intval( $width );
341 function parseParamString( $str ) {
343 if ( preg_match( '/^(\d+)px$/', $str, $m ) ) {
344 return array( 'width' => $m[1] );
350 function getScriptParams( $params ) {
351 return array( 'width' => $params['width'] );
354 function normaliseParams( $image, &$params ) {
355 $mimeType = $image->getMimeType();
357 if ( !isset( $params['width'] ) ) {
360 if ( !isset( $params['page'] ) ) {
363 $srcWidth = $image->getWidth( $params['page'] );
364 $srcHeight = $image->getHeight( $params['page'] );
365 if ( isset( $params['height'] ) && $params['height'] != -1 ) {
366 if ( $params['width'] * $srcHeight > $params['height'] * $srcWidth ) {
367 $params['width'] = wfFitBoxWidth( $srcWidth, $srcHeight, $params['height'] );
370 $params['height'] = File
::scaleHeight( $srcWidth, $srcHeight, $params['width'] );
371 if ( !$this->validateThumbParams( $params['width'], $params['height'], $srcWidth, $srcHeight, $mimeType ) ) {
378 * Get a transform output object without actually doing the transform
380 function getTransform( $image, $dstPath, $dstUrl, $params ) {
381 return $this->doTransform( $image, $dstPath, $dstUrl, $params, self
::TRANSFORM_LATER
);
385 * Validate thumbnail parameters and fill in the correct height
387 * @param integer &$width Specified width (input/output)
388 * @param integer &$height Height (output only)
389 * @return false to indicate that an error should be returned to the user.
391 function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight, $mimeType ) {
392 $width = intval( $width );
394 # Sanity check $width
396 wfDebug( __METHOD__
.": Invalid destination width: $width\n" );
399 if ( $srcWidth <= 0 ) {
400 wfDebug( __METHOD__
.": Invalid source width: $srcWidth\n" );
404 $height = File
::scaleHeight( $srcWidth, $srcHeight, $width );
408 function getScriptedTransform( $image, $script, $params ) {
409 if ( !$this->normaliseParams( $image, $params ) ) {
412 $url = $script . '&' . wfArrayToCGI( $this->getScriptParams( $params ) );
413 $page = isset( $params['page'] ) ?
$params['page'] : false;
415 if( $image->mustRender() ||
$params['width'] < $image->getWidth() ) {
416 return new ThumbnailImage( $image, $url, $params['width'], $params['height'], $page );
420 function getImageSize( $image, $path ) {
421 wfSuppressWarnings();
422 $gis = getimagesize( $path );
427 function getShortDesc( $file ) {
429 $nbytes = wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),
430 $wgLang->formatNum( $file->getSize() ) );
431 $widthheight = wfMsgHtml( 'widthheight', $wgLang->formatNum( $file->getWidth() ) ,$wgLang->formatNum( $file->getHeight() ) );
433 return "$widthheight ($nbytes)";
436 function getLongDesc( $file ) {
438 return wfMsgExt('file-info-size', 'parseinline',
439 $wgLang->formatNum( $file->getWidth() ),
440 $wgLang->formatNum( $file->getHeight() ),
441 $wgLang->formatSize( $file->getSize() ),
442 $file->getMimeType() );
445 function getDimensionsString( $file ) {
447 $pages = $file->pageCount();
448 $width = $wgLang->formatNum( $file->getWidth() );
449 $height = $wgLang->formatNum( $file->getHeight() );
450 $pagesFmt = $wgLang->formatNum( $pages );
453 return wfMsgExt( 'widthheightpage', 'parsemag', $width, $height, $pagesFmt );
455 return wfMsg( 'widthheight', $width, $height );