X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fmedia%2FGeneric.php;h=c3bd102c7a0ab93812e1aea036b07f2272d14811;hb=5c3a804b6ca1657fd0de746fc7dc4dc8ebd1e33f;hp=58bd674edab6629afd879af32a404a320013a572;hpb=dfcc5bb7fcbce2e3288318dfb8982abad694879b;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/media/Generic.php b/includes/media/Generic.php index 58bd674eda..c3bd102c7a 100644 --- a/includes/media/Generic.php +++ b/includes/media/Generic.php @@ -13,7 +13,9 @@ */ abstract class MediaHandler { const TRANSFORM_LATER = 1; - + const METADATA_GOOD = true; + const METADATA_BAD = false; + const METADATA_COMPATIBLE = 2; // for old but backwards compatible. /** * Instance cache */ @@ -21,6 +23,8 @@ abstract class MediaHandler { /** * Get a MediaHandler for a given MIME type from the instance cache + * + * @return MediaHandler */ static function getHandler( $type ) { global $wgMediaHandlers; @@ -81,12 +85,56 @@ abstract class MediaHandler { /** * Get handler-specific metadata which will be saved in the img_metadata field. * - * @param $image File: the image object, or false if there isn't one + * @param $image File: the image object, or false if there isn't one. + * Warning, File::getPropsFromPath might pass an (object)array() instead (!) * @param $path String: 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 () { + $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. + */ + function convertMetadataVersion( $metadata, $version = 1 ) { + if ( !is_array( $metadata ) ) { + + //unserialize to keep return parameter consistent. + wfSuppressWarnings(); + $ret = unserialize( $metadata ); + wfRestoreWarnings(); + return $ret; + } + return $metadata; + } + /** * Get a string describing the type of metadata, for display purposes. */ @@ -94,9 +142,15 @@ abstract class MediaHandler { /** * Check if the metadata string is valid for this handler. - * If it returns false, Image will reload the metadata from the file and update the database - */ - function isMetadataValid( $image, $metadata ) { return true; } + * If it returns MediaHandler::METADATA_BAD (or false), Image + * will reload the metadata from the file and update the database. + * MediaHandler::METADATA_GOOD for if the metadata is a-ok, + * MediaHanlder::METADATA_COMPATIBLE if metadata is old but backwards + * compatible (which may or may not trigger a metadata reload). + */ + function isMetadataValid( $image, $metadata ) { + return self::METADATA_GOOD; + } /** @@ -236,18 +290,98 @@ abstract class MediaHandler { return false; } + /** sorts the visible/invisible field. + * Split off from ImageHandler::formatMetadata, as used by more than + * one type of handler. + * + * This is used by the media handlers that use the FormatMetadata class + * + * @param $metadataArray Array metadata array + * @return array for use displaying metadata. + */ + function formatMetadataHelper( $metadataArray ) { + $result = array( + 'visible' => array(), + 'collapsed' => array() + ); + + $formatted = FormatMetadata::getFormattedData( $metadataArray ); + // Sort fields into visible and collapsed + $visibleFields = $this->visibleMetadataFields(); + foreach ( $formatted as $name => $value ) { + $tag = strtolower( $name ); + self::addMeta( $result, + in_array( $tag, $visibleFields ) ? 'visible' : 'collapsed', + 'exif', + $tag, + $value + ); + } + return $result; + } + + /** + * Get a list of metadata items which should be displayed when + * the metadata table is collapsed. + * + * @return array of strings + * @access private + */ + function visibleMetadataFields() { + $fields = array(); + $lines = explode( "\n", wfMsgForContent( 'metadata-fields' ) ); + foreach( $lines as $line ) { + $matches = array(); + if( preg_match( '/^\\*\s*(.*?)\s*$/', $line, $matches ) ) { + $fields[] = $matches[1]; + } + } + $fields = array_map( 'strtolower', $fields ); + return $fields; + } + + /** - * @todo Fixme: document this! - * 'value' thingy goes into a wikitext table; it used to be escaped but - * that was incompatible with previous practice of customized display + * This is used to generate an array element for each metadata value + * That array is then used to generate the table of metadata values + * on the image page + * + * @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 + * 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). + * 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 + * 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 + * as $1. Currently this parameter doesn't seem to ever be used. + * + * @return Array $array but with the new metadata field added. + * + * Note, everything here is passed through the parser later on (!) */ protected static function addMeta( &$array, $visibility, $type, $id, $value, $param = false ) { + $msgName = "$type-$id"; + if ( wfEmptyMsg( $msgName ) ) { + // This is for future compatibility when using instant commons. + // So as to not display as ugly a name if a new metadata + // property is defined that we don't know about + // (not a major issue since such a property would be collapsed + // by default). + wfDebug( __METHOD__ . ' Unknown metadata name: ' . $id . "\n" ); + $name = wfEscapeWikiText( $id ); + } else { + $name = wfMsg( $msgName, $param ); + } $array[$visibility][] = array( 'id' => "$type-$id", - 'name' => wfMsg( "$type-$id", $param ), + 'name' => $name, 'value' => $value ); }