diff options
Diffstat (limited to 'includes/media/MediaHandler.php')
-rw-r--r-- | includes/media/MediaHandler.php | 265 |
1 files changed, 186 insertions, 79 deletions
diff --git a/includes/media/MediaHandler.php b/includes/media/MediaHandler.php index 965099fd..779e23c9 100644 --- a/includes/media/MediaHandler.php +++ b/includes/media/MediaHandler.php @@ -46,7 +46,7 @@ abstract class MediaHandler { static function getHandler( $type ) { global $wgMediaHandlers; if ( !isset( $wgMediaHandlers[$type] ) ) { - wfDebug( __METHOD__ . ": no handler found for $type.\n"); + wfDebug( __METHOD__ . ": no handler found for $type.\n" ); return false; } $class = $wgMediaHandlers[$type]; @@ -78,14 +78,16 @@ abstract class MediaHandler { /** * Merge a parameter array into a string appropriate for inclusion in filenames * - * @param $params array + * @param $params array Array of parameters that have been through normaliseParams. + * @return String */ abstract function makeParamString( $params ); /** * Parse a param string made with makeParamString back into an array * - * @param $str string + * @param $str string The parameter string without file name (e.g. 122px) + * @return Array|Boolean Array of parameters or false on failure. */ abstract function parseParamString( $str ); @@ -103,7 +105,7 @@ abstract class MediaHandler { * can't be determined. * * @param $image File: the image object, or false if there isn't one - * @param $path String: the filename + * @param string $path the filename * @return Array Follow the format of PHP getimagesize() internal function. See http://www.php.net/getimagesize */ abstract function getImageSize( $image, $path ); @@ -113,42 +115,44 @@ abstract class MediaHandler { * * @param $image File: the image object, or false if there isn't one. * Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!) - * @param $path String: the filename + * @param string $path the filename * @return String */ - function getMetadata( $image, $path ) { return ''; } - - /** - * Get metadata version. - * - * This is not used for validating metadata, this is used for the api when returning - * metadata, since api content formats should stay the same over time, and so things - * using ForiegnApiRepo can keep backwards compatibility - * - * All core media handlers share a common version number, and extensions can - * use the GetMetadataVersion hook to append to the array (they should append a unique - * string so not to get confusing). If there was a media handler named 'foo' with metadata - * version 3 it might add to the end of the array the element 'foo=3'. if the core metadata - * version is 2, the end version string would look like '2;foo=3'. - * - * @return string version string - */ - static function getMetadataVersion () { + function getMetadata( $image, $path ) { + return ''; + } + + /** + * Get metadata version. + * + * This is not used for validating metadata, this is used for the api when returning + * metadata, since api content formats should stay the same over time, and so things + * using ForiegnApiRepo can keep backwards compatibility + * + * All core media handlers share a common version number, and extensions can + * use the GetMetadataVersion hook to append to the array (they should append a unique + * string so not to get confusing). If there was a media handler named 'foo' with metadata + * version 3 it might add to the end of the array the element 'foo=3'. if the core metadata + * version is 2, the end version string would look like '2;foo=3'. + * + * @return string version string + */ + static function getMetadataVersion() { $version = Array( '2' ); // core metadata version - wfRunHooks('GetMetadataVersion', Array(&$version)); - return implode( ';', $version); - } - - /** - * Convert metadata version. - * - * By default just returns $metadata, but can be used to allow - * media handlers to convert between metadata versions. - * - * @param $metadata Mixed String or Array metadata array (serialized if string) - * @param $version Integer target version - * @return Array serialized metadata in specified version, or $metadata on fail. - */ + wfRunHooks( 'GetMetadataVersion', Array( &$version ) ); + return implode( ';', $version ); + } + + /** + * Convert metadata version. + * + * By default just returns $metadata, but can be used to allow + * media handlers to convert between metadata versions. + * + * @param $metadata Mixed String or Array metadata array (serialized if string) + * @param $version Integer target version + * @return Array serialized metadata in specified version, or $metadata on fail. + */ function convertMetadataVersion( $metadata, $version = 1 ) { if ( !is_array( $metadata ) ) { @@ -166,7 +170,9 @@ abstract class MediaHandler { * * @return string */ - function getMetadataType( $image ) { return false; } + function getMetadataType( $image ) { + return false; + } /** * Check if the metadata string is valid for this handler. @@ -181,7 +187,6 @@ abstract class MediaHandler { return self::METADATA_GOOD; } - /** * Get a MediaTransformOutput object representing an alternate of the transformed * output which will call an intermediary thumbnail assist script. @@ -200,9 +205,9 @@ abstract class MediaHandler { * actually do the transform. * * @param $image File: the image object - * @param $dstPath String: filesystem destination path - * @param $dstUrl String: Destination URL to use in output HTML - * @param $params Array: Arbitrary set of parameters validated by $this->validateParam() + * @param string $dstPath filesystem destination path + * @param string $dstUrl Destination URL to use in output HTML + * @param array $params Arbitrary set of parameters validated by $this->validateParam() * @return MediaTransformOutput */ final function getTransform( $image, $dstPath, $dstUrl, $params ) { @@ -214,9 +219,10 @@ abstract class MediaHandler { * transform unless $flags contains self::TRANSFORM_LATER. * * @param $image File: the image object - * @param $dstPath String: filesystem destination path - * @param $dstUrl String: destination URL to use in output HTML - * @param $params Array: arbitrary set of parameters validated by $this->validateParam() + * @param string $dstPath filesystem destination path + * @param string $dstUrl destination URL to use in output HTML + * @param array $params arbitrary set of parameters validated by $this->validateParam() + * Note: These parameters have *not* gone through $this->normaliseParams() * @param $flags Integer: a bitfield, may contain self::TRANSFORM_LATER * * @return MediaTransformOutput @@ -225,6 +231,10 @@ abstract class MediaHandler { /** * Get the thumbnail extension and MIME type for a given source MIME type + * + * @param String $ext Extension of original file + * @param String $mime Mime type of original file + * @param Array $params Handler specific rendering parameters * @return array thumbnail extension and MIME type */ function getThumbType( $ext, $mime, $params = null ) { @@ -244,66 +254,108 @@ abstract class MediaHandler { } /** + * Get useful response headers for GET/HEAD requests for a file with the given metadata + * @param $metadata mixed Result of the getMetadata() function of this handler for a file + * @return Array + */ + public function getStreamHeaders( $metadata ) { + return array(); + } + + /** * True if the handled types can be transformed * @return bool */ - function canRender( $file ) { return true; } + function canRender( $file ) { + return true; + } + /** * True if handled types cannot be displayed directly in a browser * but can be rendered * @return bool */ - function mustRender( $file ) { return false; } + function mustRender( $file ) { + return false; + } + /** * True if the type has multi-page capabilities * @return bool */ - function isMultiPage( $file ) { return false; } + function isMultiPage( $file ) { + return false; + } + /** * Page count for a multi-page document, false if unsupported or unknown * @return bool */ - function pageCount( $file ) { return false; } + function pageCount( $file ) { + return false; + } + /** * The material is vectorized and thus scaling is lossless * @return bool */ - function isVectorized( $file ) { return false; } + function isVectorized( $file ) { + return false; + } + /** * The material is an image, and is animated. * In particular, video material need not return true. * @note Before 1.20, this was a method of ImageHandler only * @return bool */ - function isAnimatedImage( $file ) { return false; } + function isAnimatedImage( $file ) { + return false; + } + /** * If the material is animated, we can animate the thumbnail * @since 1.20 * @return bool If material is not animated, handler may return any value. */ - function canAnimateThumbnail( $file ) { return true; } + function canAnimateThumbnail( $file ) { + return true; + } + /** * False if the handler is disabled for all files * @return bool */ - function isEnabled() { return true; } + function isEnabled() { + return true; + } /** * Get an associative array of page dimensions * Currently "width" and "height" are understood, but this might be * expanded in the future. - * Returns false if unknown or if the document is not multi-page. + * Returns false if unknown. + * + * It is expected that handlers for paged media (e.g. DjVuHandler) + * will override this method so that it gives the correct results + * for each specific page of the file, using the $page argument. + * + * @note For non-paged media, use getImageSize. * * @param $image File - * @param $page Unused, left for backcompatibility? - * @return array + * @param $page What page to get dimensions of + * @return array|bool */ function getPageDimensions( $image, $page ) { $gis = $this->getImageSize( $image, $image->getLocalRefPath() ); - return array( - 'width' => $gis[0], - 'height' => $gis[1] - ); + if ( $gis ) { + return array( + 'width' => $gis[0], + 'height' => $gis[1] + ); + } else { + return false; + } } /** @@ -352,11 +404,11 @@ abstract class MediaHandler { * * This is used by the media handlers that use the FormatMetadata class * - * @param $metadataArray Array metadata array + * @param array $metadataArray metadata array * @return array for use displaying metadata. */ function formatMetadataHelper( $metadataArray ) { - $result = array( + $result = array( 'visible' => array(), 'collapsed' => array() ); @@ -386,9 +438,9 @@ abstract class MediaHandler { function visibleMetadataFields() { $fields = array(); $lines = explode( "\n", wfMessage( 'metadata-fields' )->inContentLanguage()->text() ); - foreach( $lines as $line ) { + foreach ( $lines as $line ) { $matches = array(); - if( preg_match( '/^\\*\s*(.*?)\s*$/', $line, $matches ) ) { + if ( preg_match( '/^\\*\s*(.*?)\s*$/', $line, $matches ) ) { $fields[] = $matches[1]; } } @@ -396,7 +448,6 @@ abstract class MediaHandler { return $fields; } - /** * This is used to generate an array element for each metadata value * That array is then used to generate the table of metadata values @@ -405,17 +456,17 @@ abstract class MediaHandler { * @param &$array Array An array containing elements for each type of visibility * and each of those elements being an array of metadata items. This function adds * a value to that array. - * @param $visibility string ('visible' or 'collapsed') if this value is hidden + * @param string $visibility ('visible' or 'collapsed') if this value is hidden * by default. - * @param $type String type of metadata tag (currently always 'exif') - * @param $id String the name of the metadata tag (like 'artist' for example). + * @param string $type type of metadata tag (currently always 'exif') + * @param string $id the name of the metadata tag (like 'artist' for example). * its name in the table displayed is the message "$type-$id" (Ex exif-artist ). - * @param $value String thingy goes into a wikitext table; it used to be escaped but + * @param string $value thingy goes into a wikitext table; it used to be escaped but * that was incompatible with previous practise of customized display * with wikitext formatting via messages such as 'exif-model-value'. * So the escaping is taken back out, but generally this seems a confusing * interface. - * @param $param String value to pass to the message for the name of the field + * @param string $param value to pass to the message for the name of the field * as $1. Currently this parameter doesn't seem to ever be used. * * Note, everything here is passed through the parser later on (!) @@ -441,6 +492,8 @@ abstract class MediaHandler { } /** + * Used instead of getLongDesc if there is no handler registered for file. + * * @param $file File * @return string */ @@ -450,6 +503,8 @@ abstract class MediaHandler { } /** + * Short description. Shown on Special:Search results. + * * @param $file File * @return string */ @@ -460,6 +515,8 @@ abstract class MediaHandler { } /** + * Long description. Shown under image on image description page surounded by (). + * * @param $file File * @return string */ @@ -469,6 +526,8 @@ abstract class MediaHandler { } /** + * Used instead of getShortDesc if there is no handler registered for file. + * * @param $file File * @return string */ @@ -489,19 +548,32 @@ abstract class MediaHandler { public static function fitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) { $idealWidth = $boxWidth * $maxHeight / $boxHeight; $roundedUp = ceil( $idealWidth ); - if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight ) { + if ( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight ) { return floor( $idealWidth ); } else { return $roundedUp; } } + /** + * Shown in file history box on image description page. + * + * @param File $file + * @return String Dimensions + */ function getDimensionsString( $file ) { return ''; } /** - * Modify the parser object post-transform + * Modify the parser object post-transform. + * + * This is often used to do $parser->addOutputHook(), + * in order to add some javascript to render a viewer. + * See TimedMediaHandler or OggHandler for an example. + * + * @param Parser $parser + * @param File $file */ function parserTransformHook( $parser, $file ) {} @@ -512,7 +584,7 @@ abstract class MediaHandler { * match the handler class, a Status object should be returned containing * relevant errors. * - * @param $fileName string The local path to the file. + * @param string $fileName The local path to the file. * @return Status object */ function verifyUpload( $fileName ) { @@ -523,14 +595,14 @@ abstract class MediaHandler { * Check for zero-sized thumbnails. These can be generated when * no disk space is available or some other error occurs * - * @param $dstPath string The location of the suspect file - * @param $retval int Return value of some shell process, file will be deleted if this is non-zero + * @param string $dstPath The location of the suspect file + * @param int $retval Return value of some shell process, file will be deleted if this is non-zero * @return bool True if removed, false otherwise */ function removeBadFile( $dstPath, $retval = 0 ) { - if( file_exists( $dstPath ) ) { + if ( file_exists( $dstPath ) ) { $thumbstat = stat( $dstPath ); - if( $thumbstat['size'] == 0 || $retval != 0 ) { + if ( $thumbstat['size'] == 0 || $retval != 0 ) { $result = unlink( $dstPath ); if ( $result ) { @@ -549,12 +621,47 @@ abstract class MediaHandler { } /** - * Remove files from the purge list + * Remove files from the purge list. + * + * This is used by some video handlers to prevent ?action=purge + * from removing a transcoded video, which is expensive to + * regenerate. + * + * @see LocalFile::purgeThumbnails * * @param array $files - * @param array $options + * @param array $options Purge options. Currently will always be + * an array with a single key 'forThumbRefresh' set to true. */ public function filterThumbnailPurgeList( &$files, $options ) { // Do nothing } + + /* + * True if the handler can rotate the media + * @since 1.21 + * @return bool + */ + public static function canRotate() { + return false; + } + + /** + * On supporting image formats, try to read out the low-level orientation + * of the file and return the angle that the file needs to be rotated to + * be viewed. + * + * This information is only useful when manipulating the original file; + * the width and height we normally work with is logical, and will match + * any produced output views. + * + * For files we don't know, we return 0. + * + * @param $file File + * @return int 0, 90, 180 or 270 + */ + public function getRotation( $file ) { + return 0; + } + } |