YunoHost-Apps/mediawiki_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mediawiki_ynh.git synced 2024-09-03 19:46:05 +02:00
Code Issues Activity Actions 1
mediawiki_ynh/sources/mediawiki/includes/media/FormatMetadata.php

1373 lines
36 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/**
* Formatting of image metadata values into human readable form.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @ingroup Media
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
* @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason, 2009 Brent Garber, 2010 Brian Wolff
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
* @see http://exif.org/Exif2-2.PDF The Exif 2.2 specification
* @file
*/
/**
* Format Image metadata values into a human readable form.
*
* Note lots of these messages use the prefix 'exif' even though
* they may not be exif properties. For example 'exif-ImageDescription'
* can be the Exif ImageDescription, or it could be the iptc-iim caption
* property, or it could be the xmp dc:description property. This
* is because these messages should be independent of how the data is
* stored, sine the user doesn't care if the description is stored in xmp,
* exif, etc only that its a description. (Additionally many of these properties
* are merged together following the MWG standard, such that for example,
* exif properties override XMP properties that mean the same thing if
* there is a conflict).
*
* It should perhaps use a prefix like 'metadata' instead, but there
* is already a large number of messages using the 'exif' prefix.
*
* @ingroup Media
*/
class FormatMetadata {
/**
* Numbers given by Exif user agents are often magical, that is they
* should be replaced by a detailed explanation depending on their
* value which most of the time are plain integers. This function
* formats Exif (and other metadata) values into human readable form.
*
* @param array $tags the Exif data to format ( as returned by
* Exif::getFilteredData() or BitmapMetadataHandler )
* @return array
*/
public static function getFormattedData( $tags ) {
global $wgLang;
$resolutionunit = !isset( $tags['ResolutionUnit'] ) || $tags['ResolutionUnit'] == 2 ? 2 : 3;
unset( $tags['ResolutionUnit'] );
foreach ( $tags as $tag => &$vals ) {
// This seems ugly to wrap non-array's in an array just to unwrap again,
// especially when most of the time it is not an array
if ( !is_array( $tags[$tag] ) ) {
$vals = Array( $vals );
}
// _type is a special value to say what array type
if ( isset( $tags[$tag]['_type'] ) ) {
$type = $tags[$tag]['_type'];
unset( $vals['_type'] );
} else {
$type = 'ul'; // default unordered list.
}
//This is done differently as the tag is an array.
if ( $tag == 'GPSTimeStamp' && count( $vals ) === 3 ) {
//hour min sec array
$h = explode( '/', $vals[0] );
$m = explode( '/', $vals[1] );
$s = explode( '/', $vals[2] );
// this should already be validated
// when loaded from file, but it could
// come from a foreign repo, so be
// paranoid.
if ( !isset( $h[1] )
|| !isset( $m[1] )
|| !isset( $s[1] )
|| $h[1] == 0
|| $m[1] == 0
|| $s[1] == 0
) {
continue;
}
$tags[$tag] = str_pad( intval( $h[0] / $h[1] ), 2, '0', STR_PAD_LEFT )
. ':' . str_pad( intval( $m[0] / $m[1] ), 2, '0', STR_PAD_LEFT )
. ':' . str_pad( intval( $s[0] / $s[1] ), 2, '0', STR_PAD_LEFT );
try {
$time = wfTimestamp( TS_MW, '1971:01:01 ' . $tags[$tag] );
// the 1971:01:01 is just a placeholder, and not shown to user.
if ( $time && intval( $time ) > 0 ) {
$tags[$tag] = $wgLang->time( $time );
}
} catch ( TimestampException $e ) {
// This shouldn't happen, but we've seen bad formats
// such as 4-digit seconds in the wild.
// leave $tags[$tag] as-is
}
continue;
}
// The contact info is a multi-valued field
// instead of the other props which are single
// valued (mostly) so handle as a special case.
if ( $tag === 'Contact' ) {
$vals = self::collapseContactInfo( $vals );
continue;
}
foreach ( $vals as &$val ) {
switch ( $tag ) {
case 'Compression':
switch ( $val ) {
case 1: case 2: case 3: case 4:
case 5: case 6: case 7: case 8:
case 32773: case 32946: case 34712:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'PhotometricInterpretation':
switch ( $val ) {
case 2: case 6:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'Orientation':
switch ( $val ) {
case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'PlanarConfiguration':
switch ( $val ) {
case 1: case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
// TODO: YCbCrSubSampling
case 'YCbCrPositioning':
switch ( $val ) {
case 1:
case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'XResolution':
case 'YResolution':
switch ( $resolutionunit ) {
case 2:
$val = self::msg( 'XYResolution', 'i', self::formatNum( $val ) );
break;
case 3:
$val = self::msg( 'XYResolution', 'c', self::formatNum( $val ) );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
// TODO: YCbCrCoefficients #p27 (see annex E)
case 'ExifVersion': case 'FlashpixVersion':
$val = "$val" / 100;
break;
case 'ColorSpace':
switch ( $val ) {
case 1: case 65535:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'ComponentsConfiguration':
switch ( $val ) {
case 0: case 1: case 2: case 3: case 4: case 5: case 6:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'DateTime':
case 'DateTimeOriginal':
case 'DateTimeDigitized':
case 'DateTimeReleased':
case 'DateTimeExpires':
case 'GPSDateStamp':
case 'dc-date':
case 'DateTimeMetadata':
if ( $val == '0000:00:00 00:00:00' || $val == ' : : : : ' ) {
$val = wfMessage( 'exif-unknowndate' )->text();
} elseif ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d):(?:\d\d)$/D', $val ) ) {
// Full date.
$time = wfTimestamp( TS_MW, $val );
if ( $time && intval( $time ) > 0 ) {
$val = $wgLang->timeanddate( $time );
}
} elseif ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d)$/D', $val ) ) {
// No second field. Still format the same
// since timeanddate doesn't include seconds anyways,
// but second still available in api
$time = wfTimestamp( TS_MW, $val . ':00' );
if ( $time && intval( $time ) > 0 ) {
$val = $wgLang->timeanddate( $time );
}
} elseif ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d)$/D', $val ) ) {
// If only the date but not the time is filled in.
$time = wfTimestamp( TS_MW, substr( $val, 0, 4 )
. substr( $val, 5, 2 )
. substr( $val, 8, 2 )
. '000000' );
if ( $time && intval( $time ) > 0 ) {
$val = $wgLang->date( $time );
}
}
// else it will just output $val without formatting it.
break;
case 'ExposureProgram':
switch ( $val ) {
case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'SubjectDistance':
$val = self::msg( $tag, '', self::formatNum( $val ) );
break;
case 'MeteringMode':
switch ( $val ) {
case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 255:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'LightSource':
switch ( $val ) {
case 0: case 1: case 2: case 3: case 4: case 9: case 10: case 11:
case 12: case 13: case 14: case 15: case 17: case 18: case 19: case 20:
case 21: case 22: case 23: case 24: case 255:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'Flash':
$flashDecode = array(
'fired' => $val & bindec( '00000001' ),
'return' => ( $val & bindec( '00000110' ) ) >> 1,
'mode' => ( $val & bindec( '00011000' ) ) >> 3,
'function' => ( $val & bindec( '00100000' ) ) >> 5,
'redeye' => ( $val & bindec( '01000000' ) ) >> 6,
// 'reserved' => ($val & bindec( '10000000' )) >> 7,
);
$flashMsgs = array();
# We do not need to handle unknown values since all are used.
foreach ( $flashDecode as $subTag => $subValue ) {
# We do not need any message for zeroed values.
if ( $subTag != 'fired' && $subValue == 0 ) {
continue;
}
$fullTag = $tag . '-' . $subTag;
$flashMsgs[] = self::msg( $fullTag, $subValue );
}
$val = $wgLang->commaList( $flashMsgs );
break;
case 'FocalPlaneResolutionUnit':
switch ( $val ) {
case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'SensingMethod':
switch ( $val ) {
case 1: case 2: case 3: case 4: case 5: case 7: case 8:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'FileSource':
switch ( $val ) {
case 3:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'SceneType':
switch ( $val ) {
case 1:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'CustomRendered':
switch ( $val ) {
case 0: case 1:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'ExposureMode':
switch ( $val ) {
case 0: case 1: case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'WhiteBalance':
switch ( $val ) {
case 0: case 1:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'SceneCaptureType':
switch ( $val ) {
case 0: case 1: case 2: case 3:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GainControl':
switch ( $val ) {
case 0: case 1: case 2: case 3: case 4:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'Contrast':
switch ( $val ) {
case 0: case 1: case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'Saturation':
switch ( $val ) {
case 0: case 1: case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'Sharpness':
switch ( $val ) {
case 0: case 1: case 2:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'SubjectDistanceRange':
switch ( $val ) {
case 0: case 1: case 2: case 3:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
//The GPS...Ref values are kept for compatibility, probably won't be reached.
case 'GPSLatitudeRef':
case 'GPSDestLatitudeRef':
switch ( $val ) {
case 'N': case 'S':
$val = self::msg( 'GPSLatitude', $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSLongitudeRef':
case 'GPSDestLongitudeRef':
switch ( $val ) {
case 'E': case 'W':
$val = self::msg( 'GPSLongitude', $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSAltitude':
if ( $val < 0 ) {
$val = self::msg( 'GPSAltitude', 'below-sealevel', self::formatNum( -$val, 3 ) );
} else {
$val = self::msg( 'GPSAltitude', 'above-sealevel', self::formatNum( $val, 3 ) );
}
break;
case 'GPSStatus':
switch ( $val ) {
case 'A': case 'V':
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSMeasureMode':
switch ( $val ) {
case 2: case 3:
$val = self::msg( $tag, $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSTrackRef':
case 'GPSImgDirectionRef':
case 'GPSDestBearingRef':
switch ( $val ) {
case 'T': case 'M':
$val = self::msg( 'GPSDirection', $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSLatitude':
case 'GPSDestLatitude':
$val = self::formatCoords( $val, 'latitude' );
break;
case 'GPSLongitude':
case 'GPSDestLongitude':
$val = self::formatCoords( $val, 'longitude' );
break;
case 'GPSSpeedRef':
switch ( $val ) {
case 'K': case 'M': case 'N':
$val = self::msg( 'GPSSpeed', $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSDestDistanceRef':
switch ( $val ) {
case 'K': case 'M': case 'N':
$val = self::msg( 'GPSDestDistance', $val );
break;
default:
/* If not recognized, display as is. */
break;
}
break;
case 'GPSDOP':
// See http://en.wikipedia.org/wiki/Dilution_of_precision_(GPS)
if ( $val <= 2 ) {
$val = self::msg( $tag, 'excellent', self::formatNum( $val ) );
} elseif ( $val <= 5 ) {
$val = self::msg( $tag, 'good', self::formatNum( $val ) );
} elseif ( $val <= 10 ) {
$val = self::msg( $tag, 'moderate', self::formatNum( $val ) );
} elseif ( $val <= 20 ) {
$val = self::msg( $tag, 'fair', self::formatNum( $val ) );
} else {
$val = self::msg( $tag, 'poor', self::formatNum( $val ) );
}
break;
// This is not in the Exif standard, just a special
// case for our purposes which enables wikis to wikify
// the make, model and software name to link to their articles.
case 'Make':
case 'Model':
$val = self::msg( $tag, '', $val );
break;
case 'Software':
if ( is_array( $val ) ) {
//if its a software, version array.
$val = wfMessage( 'exif-software-version-value', $val[0], $val[1] )->text();
} else {
$val = self::msg( $tag, '', $val );
}
break;
case 'ExposureTime':
// Show the pretty fraction as well as decimal version
$val = wfMessage( 'exif-exposuretime-format',
self::formatFraction( $val ), self::formatNum( $val ) )->text();
break;
case 'ISOSpeedRatings':
// If its = 65535 that means its at the
// limit of the size of Exif::short and
// is really higher.
if ( $val == '65535' ) {
$val = self::msg( $tag, 'overflow' );
} else {
$val = self::formatNum( $val );
}
break;
case 'FNumber':
$val = wfMessage( 'exif-fnumber-format',
self::formatNum( $val ) )->text();
break;
case 'FocalLength': case 'FocalLengthIn35mmFilm':
$val = wfMessage( 'exif-focallength-format',
self::formatNum( $val ) )->text();
break;
case 'MaxApertureValue':
if ( strpos( $val, '/' ) !== false ) {
// need to expand this earlier to calculate fNumber
list( $n, $d ) = explode( '/', $val );
if ( is_numeric( $n ) && is_numeric( $d ) ) {
$val = $n / $d;
}
}
if ( is_numeric( $val ) ) {
$fNumber = pow( 2, $val / 2 );
if ( $fNumber !== false ) {
$val = wfMessage( 'exif-maxaperturevalue-value',
self::formatNum( $val ),
self::formatNum( $fNumber, 2 )
)->text();
}
}
break;
case 'iimCategory':
switch ( strtolower( $val ) ) {
// See pg 29 of IPTC photo
// metadata standard.
case 'ace': case 'clj':
case 'dis': case 'fin':
case 'edu': case 'evn':
case 'hth': case 'hum':
case 'lab': case 'lif':
case 'pol': case 'rel':
case 'sci': case 'soi':
case 'spo': case 'war':
case 'wea':
$val = self::msg(
'iimcategory',
$val
);
}
break;
case 'SubjectNewsCode':
// Essentially like iimCategory.
// 8 (numeric) digit hierarchical
// classification. We decode the
// first 2 digits, which provide
// a broad category.
$val = self::convertNewsCode( $val );
break;
case 'Urgency':
// 1-8 with 1 being highest, 5 normal
// 0 is reserved, and 9 is 'user-defined'.
$urgency = '';
if ( $val == 0 || $val == 9 ) {
$urgency = 'other';
} elseif ( $val < 5 && $val > 1 ) {
$urgency = 'high';
} elseif ( $val == 5 ) {
$urgency = 'normal';
} elseif ( $val <= 8 && $val > 5 ) {
$urgency = 'low';
}
if ( $urgency !== '' ) {
$val = self::msg( 'urgency',
$urgency, $val
);
}
break;
// Things that have a unit of pixels.
case 'OriginalImageHeight':
case 'OriginalImageWidth':
case 'PixelXDimension':
case 'PixelYDimension':
case 'ImageWidth':
case 'ImageLength':
$val = self::formatNum( $val ) . ' ' . wfMessage( 'unit-pixel' )->text();
break;
// Do not transform fields with pure text.
// For some languages the formatNum()
// conversion results to wrong output like
// foo,bar@example,com or foo٫bar@example٫com.
// Also some 'numeric' things like Scene codes
// are included here as we really don't want
// commas inserted.
case 'ImageDescription':
case 'Artist':
case 'Copyright':
case 'RelatedSoundFile':
case 'ImageUniqueID':
case 'SpectralSensitivity':
case 'GPSSatellites':
case 'GPSVersionID':
case 'GPSMapDatum':
case 'Keywords':
case 'WorldRegionDest':
case 'CountryDest':
case 'CountryCodeDest':
case 'ProvinceOrStateDest':
case 'CityDest':
case 'SublocationDest':
case 'WorldRegionCreated':
case 'CountryCreated':
case 'CountryCodeCreated':
case 'ProvinceOrStateCreated':
case 'CityCreated':
case 'SublocationCreated':
case 'ObjectName':
case 'SpecialInstructions':
case 'Headline':
case 'Credit':
case 'Source':
case 'EditStatus':
case 'FixtureIdentifier':
case 'LocationDest':
case 'LocationDestCode':
case 'Writer':
case 'JPEGFileComment':
case 'iimSupplementalCategory':
case 'OriginalTransmissionRef':
case 'Identifier':
case 'dc-contributor':
case 'dc-coverage':
case 'dc-publisher':
case 'dc-relation':
case 'dc-rights':
case 'dc-source':
case 'dc-type':
case 'Lens':
case 'SerialNumber':
case 'CameraOwnerName':
case 'Label':
case 'Nickname':
case 'RightsCertificate':
case 'CopyrightOwner':
case 'UsageTerms':
case 'WebStatement':
case 'OriginalDocumentID':
case 'LicenseUrl':
case 'MorePermissionsUrl':
case 'AttributionUrl':
case 'PreferredAttributionName':
case 'PNGFileComment':
case 'Disclaimer':
case 'ContentWarning':
case 'GIFFileComment':
case 'SceneCode':
case 'IntellectualGenre':
case 'Event':
case 'OrginisationInImage':
case 'PersonInImage':
$val = htmlspecialchars( $val );
break;
case 'ObjectCycle':
switch ( $val ) {
case 'a': case 'p': case 'b':
$val = self::msg( $tag, $val );
break;
default:
$val = htmlspecialchars( $val );
break;
}
break;
case 'Copyrighted':
switch ( $val ) {
case 'True': case 'False':
$val = self::msg( $tag, $val );
break;
}
break;
case 'Rating':
if ( $val == '-1' ) {
$val = self::msg( $tag, 'rejected' );
} else {
$val = self::formatNum( $val );
}
break;
case 'LanguageCode':
$lang = Language::fetchLanguageName( strtolower( $val ), $wgLang->getCode() );
if ( $lang ) {
$val = htmlspecialchars( $lang );
} else {
$val = htmlspecialchars( $val );
}
break;
default:
$val = self::formatNum( $val );
break;
}
}
// End formatting values, start flattening arrays.
$vals = self::flattenArray( $vals, $type );
}
return $tags;
}
/**
* A function to collapse multivalued tags into a single value.
* This turns an array of (for example) authors into a bulleted list.
*
* This is public on the basis it might be useful outside of this class.
*
* @param array $vals array of values
* @param string $type Type of array (either lang, ul, ol).
* lang = language assoc array with keys being the lang code
* ul = unordered list, ol = ordered list
* type can also come from the '_type' member of $vals.
* @param $noHtml Boolean If to avoid returning anything resembling
* html. (Ugly hack for backwards compatibility with old mediawiki).
* @return String single value (in wiki-syntax).
*/
public static function flattenArray( $vals, $type = 'ul', $noHtml = false ) {
if ( isset( $vals['_type'] ) ) {
$type = $vals['_type'];
unset( $vals['_type'] );
}
if ( !is_array( $vals ) ) {
return $vals; // do nothing if not an array;
}
elseif ( count( $vals ) === 1 && $type !== 'lang' ) {
return $vals[0];
}
elseif ( count( $vals ) === 0 ) {
wfDebug( __METHOD__ . " metadata array with 0 elements!\n" );
return ""; // paranoia. This should never happen
}
/* @todo FIXME: This should hide some of the list entries if there are
* say more than four. Especially if a field is translated into 20
* languages, we don't want to show them all by default
*/
else {
global $wgContLang;
switch ( $type ) {
case 'lang':
// Display default, followed by ContLang,
// followed by the rest in no particular
// order.
// Todo: hide some items if really long list.
$content = '';
$cLang = $wgContLang->getCode();
$defaultItem = false;
$defaultLang = false;
// If default is set, save it for later,
// as we don't know if it's equal to
// one of the lang codes. (In xmp
// you specify the language for a
// default property by having both
// a default prop, and one in the language
// that are identical)
if ( isset( $vals['x-default'] ) ) {
$defaultItem = $vals['x-default'];
unset( $vals['x-default'] );
}
// Do contentLanguage.
if ( isset( $vals[$cLang] ) ) {
$isDefault = false;
if ( $vals[$cLang] === $defaultItem ) {
$defaultItem = false;
$isDefault = true;
}
$content .= self::langItem(
$vals[$cLang], $cLang,
$isDefault, $noHtml );
unset( $vals[$cLang] );
}
// Now do the rest.
foreach ( $vals as $lang => $item ) {
if ( $item === $defaultItem ) {
$defaultLang = $lang;
continue;
}
$content .= self::langItem( $item,
$lang, false, $noHtml );
}
if ( $defaultItem !== false ) {
$content = self::langItem( $defaultItem,
$defaultLang, true, $noHtml ) .
$content;
}
if ( $noHtml ) {
return $content;
}
return '<ul class="metadata-langlist">' .
$content .
'</ul>';
case 'ol':
if ( $noHtml ) {
return "\n#" . implode( "\n#", $vals );
}
return "<ol><li>" . implode( "</li>\n<li>", $vals ) . '</li></ol>';
case 'ul':
default:
if ( $noHtml ) {
return "\n*" . implode( "\n*", $vals );
}
return "<ul><li>" . implode( "</li>\n<li>", $vals ) . '</li></ul>';
}
}
}
/** Helper function for creating lists of translations.
*
* @param string $value value (this is not escaped)
* @param string $lang lang code of item or false
* @param $default Boolean if it is default value.
* @param $noHtml Boolean If to avoid html (for back-compat)
* @throws MWException
* @return string language item (Note: despite how this looks,
* this is treated as wikitext not html).
*/
private static function langItem( $value, $lang, $default = false, $noHtml = false ) {
if ( $lang === false && $default === false ) {
throw new MWException( '$lang and $default cannot both '
. 'be false.' );
}
if ( $noHtml ) {
$wrappedValue = $value;
} else {
$wrappedValue = '<span class="mw-metadata-lang-value">'
. $value . '</span>';
}
if ( $lang === false ) {
if ( $noHtml ) {
return wfMessage( 'metadata-langitem-default',
$wrappedValue )->text() . "\n\n";
} /* else */
return '<li class="mw-metadata-lang-default">'
. wfMessage( 'metadata-langitem-default',
$wrappedValue )->text()
. "</li>\n";
}
$lowLang = strtolower( $lang );
$langName = Language::fetchLanguageName( $lowLang );
if ( $langName === '' ) {
//try just the base language name. (aka en-US -> en ).
list( $langPrefix ) = explode( '-', $lowLang, 2 );
$langName = Language::fetchLanguageName( $langPrefix );
if ( $langName === '' ) {
// give up.
$langName = $lang;
}
}
// else we have a language specified
if ( $noHtml ) {
return '*' . wfMessage( 'metadata-langitem',
$wrappedValue, $langName, $lang )->text();
} /* else: */
$item = '<li class="mw-metadata-lang-code-'
. $lang;
if ( $default ) {
$item .= ' mw-metadata-lang-default';
}
$item .= '" lang="' . $lang . '">';
$item .= wfMessage( 'metadata-langitem',
$wrappedValue, $langName, $lang )->text();
$item .= "</li>\n";
return $item;
}
/**
* Convenience function for getFormattedData()
*
* @private
*
* @param string $tag the tag name to pass on
* @param string $val the value of the tag
* @param string $arg an argument to pass ($1)
* @param string $arg2 a 2nd argument to pass ($2)
* @return string A wfMessage of "exif-$tag-$val" in lower case
*/
static function msg( $tag, $val, $arg = null, $arg2 = null ) {
global $wgContLang;
if ( $val === '' ) {
$val = 'value';
}
return wfMessage( $wgContLang->lc( "exif-$tag-$val" ), $arg, $arg2 )->text();
}
/**
* Format a number, convert numbers from fractions into floating point
* numbers, joins arrays of numbers with commas.
*
* @param $num Mixed: the value to format
* @param $round float|int|bool digits to round to or false.
* @return mixed A floating point number or whatever we were fed
*/
static function formatNum( $num, $round = false ) {
global $wgLang;
$m = array();
if ( is_array( $num ) ) {
$out = array();
foreach ( $num as $number ) {
$out[] = self::formatNum( $number );
}
return $wgLang->commaList( $out );
}
if ( preg_match( '/^(-?\d+)\/(\d+)$/', $num, $m ) ) {
if ( $m[2] != 0 ) {
$newNum = $m[1] / $m[2];
if ( $round !== false ) {
$newNum = round( $newNum, $round );
}
} else {
$newNum = $num;
}
return $wgLang->formatNum( $newNum );
} else {
if ( is_numeric( $num ) && $round !== false ) {
$num = round( $num, $round );
}
return $wgLang->formatNum( $num );
}
}
/**
* Format a rational number, reducing fractions
*
* @private
*
* @param $num Mixed: the value to format
* @return mixed A floating point number or whatever we were fed
*/
static function formatFraction( $num ) {
$m = array();
if ( preg_match( '/^(-?\d+)\/(\d+)$/', $num, $m ) ) {
$numerator = intval( $m[1] );
$denominator = intval( $m[2] );
$gcd = self::gcd( abs( $numerator ), $denominator );
if ( $gcd != 0 ) {
// 0 shouldn't happen! ;)
return self::formatNum( $numerator / $gcd ) . '/' . self::formatNum( $denominator / $gcd );
}
}
return self::formatNum( $num );
}
/**
* Calculate the greatest common divisor of two integers.
*
* @param $a Integer: Numerator
* @param $b Integer: Denominator
* @return int
* @private
*/
static function gcd( $a, $b ) {
/*
// http://en.wikipedia.org/wiki/Euclidean_algorithm
// Recursive form would be:
if( $b == 0 )
return $a;
else
return gcd( $b, $a % $b );
*/
while ( $b != 0 ) {
$remainder = $a % $b;
// tail recursion...
$a = $b;
$b = $remainder;
}
return $a;
}
/**
* Fetch the human readable version of a news code.
* A news code is an 8 digit code. The first two
* digits are a general classification, so we just
* translate that.
*
* Note, leading 0's are significant, so this is
* a string, not an int.
*
* @param string $val The 8 digit news code.
* @return string The human readable form
*/
private static function convertNewsCode( $val ) {
if ( !preg_match( '/^\d{8}$/D', $val ) ) {
// Not a valid news code.
return $val;
}
$cat = '';
switch ( substr( $val, 0, 2 ) ) {
case '01':
$cat = 'ace';
break;
case '02':
$cat = 'clj';
break;
case '03':
$cat = 'dis';
break;
case '04':
$cat = 'fin';
break;
case '05':
$cat = 'edu';
break;
case '06':
$cat = 'evn';
break;
case '07':
$cat = 'hth';
break;
case '08':
$cat = 'hum';
break;
case '09':
$cat = 'lab';
break;
case '10':
$cat = 'lif';
break;
case '11':
$cat = 'pol';
break;
case '12':
$cat = 'rel';
break;
case '13':
$cat = 'sci';
break;
case '14':
$cat = 'soi';
break;
case '15':
$cat = 'spo';
break;
case '16':
$cat = 'war';
break;
case '17':
$cat = 'wea';
break;
}
if ( $cat !== '' ) {
$catMsg = self::msg( 'iimcategory', $cat );
$val = self::msg( 'subjectnewscode', '', $val, $catMsg );
}
return $val;
}
/**
* Format a coordinate value, convert numbers from floating point
* into degree minute second representation.
*
* @param int $coord degrees, minutes and seconds
* @param string $type latitude or longitude (for if its a NWS or E)
* @return mixed A floating point number or whatever we were fed
*/
static function formatCoords( $coord, $type ) {
$ref = '';
if ( $coord < 0 ) {
$nCoord = -$coord;
if ( $type === 'latitude' ) {
$ref = 'S';
} elseif ( $type === 'longitude' ) {
$ref = 'W';
}
} else {
$nCoord = $coord;
if ( $type === 'latitude' ) {
$ref = 'N';
} elseif ( $type === 'longitude' ) {
$ref = 'E';
}
}
$deg = floor( $nCoord );
$min = floor( ( $nCoord - $deg ) * 60.0 );
$sec = round( ( ( $nCoord - $deg ) - $min / 60 ) * 3600, 2 );
$deg = self::formatNum( $deg );
$min = self::formatNum( $min );
$sec = self::formatNum( $sec );
return wfMessage( 'exif-coordinate-format', $deg, $min, $sec, $ref, $coord )->text();
}
/**
* Format the contact info field into a single value.
*
* @param array $vals array with fields of the ContactInfo
* struct defined in the IPTC4XMP spec. Or potentially
* an array with one element that is a free form text
* value from the older iptc iim 1:118 prop.
*
* This function might be called from
* JpegHandler::convertMetadataVersion which is why it is
* public.
*
* @return String of html-ish looking wikitext
*/
public static function collapseContactInfo( $vals ) {
if ( !( isset( $vals['CiAdrExtadr'] )
|| isset( $vals['CiAdrCity'] )
|| isset( $vals['CiAdrCtry'] )
|| isset( $vals['CiEmailWork'] )
|| isset( $vals['CiTelWork'] )
|| isset( $vals['CiAdrPcode'] )
|| isset( $vals['CiAdrRegion'] )
|| isset( $vals['CiUrlWork'] )
) ) {
// We don't have any sub-properties
// This could happen if its using old
// iptc that just had this as a free-form
// text value.
// Note: We run this through htmlspecialchars
// partially to be consistent, and partially
// because people often insert >, etc into
// the metadata which should not be interpreted
// but we still want to auto-link urls.
foreach ( $vals as &$val ) {
$val = htmlspecialchars( $val );
}
return self::flattenArray( $vals );
} else {
// We have a real ContactInfo field.
// Its unclear if all these fields have to be
// set, so assume they do not.
$url = $tel = $street = $city = $country = '';
$email = $postal = $region = '';
// Also note, some of the class names this uses
// are similar to those used by hCard. This is
// mostly because they're sensible names. This
// does not (and does not attempt to) output
// stuff in the hCard microformat. However it
// might output in the adr microformat.
if ( isset( $vals['CiAdrExtadr'] ) ) {
// Todo: This can potentially be multi-line.
// Need to check how that works in XMP.
$street = '<span class="extended-address">'
. htmlspecialchars(
$vals['CiAdrExtadr'] )
. '</span>';
}
if ( isset( $vals['CiAdrCity'] ) ) {
$city = '<span class="locality">'
. htmlspecialchars( $vals['CiAdrCity'] )
. '</span>';
}
if ( isset( $vals['CiAdrCtry'] ) ) {
$country = '<span class="country-name">'
. htmlspecialchars( $vals['CiAdrCtry'] )
. '</span>';
}
if ( isset( $vals['CiEmailWork'] ) ) {
$emails = array();
// Have to split multiple emails at commas/new lines.
$splitEmails = explode( "\n", $vals['CiEmailWork'] );
foreach ( $splitEmails as $e1 ) {
// Also split on comma
foreach ( explode( ',', $e1 ) as $e2 ) {
$finalEmail = trim( $e2 );
if ( $finalEmail == ',' || $finalEmail == '' ) {
continue;
}
if ( strpos( $finalEmail, '<' ) !== false ) {
// Don't do fancy formatting to
// "My name" <foo@bar.com> style stuff
$emails[] = $finalEmail;
} else {
$emails[] = '[mailto:'
. $finalEmail
. ' <span class="email">'
. $finalEmail
. '</span>]';
}
}
}
$email = implode( ', ', $emails );
}
if ( isset( $vals['CiTelWork'] ) ) {
$tel = '<span class="tel">'
. htmlspecialchars( $vals['CiTelWork'] )
. '</span>';
}
if ( isset( $vals['CiAdrPcode'] ) ) {
$postal = '<span class="postal-code">'
. htmlspecialchars(
$vals['CiAdrPcode'] )
. '</span>';
}
if ( isset( $vals['CiAdrRegion'] ) ) {
// Note this is province/state.
$region = '<span class="region">'
. htmlspecialchars(
$vals['CiAdrRegion'] )
. '</span>';
}
if ( isset( $vals['CiUrlWork'] ) ) {
$url = '<span class="url">'
. htmlspecialchars( $vals['CiUrlWork'] )
. '</span>';
}
return wfMessage( 'exif-contact-value', $email, $url,
$street, $city, $region, $postal, $country,
$tel )->text();
}
}
}
/** For compatability with old FormatExif class
* which some extensions use.
*
* @deprecated since 1.18
*
*/
class FormatExif {
var $meta;
/**
* @param $meta array
*/
function FormatExif( $meta ) {
wfDeprecated( __METHOD__, '1.18' );
$this->meta = $meta;
}
/**
* @return array
*/
function getFormattedData() {
return FormatMetadata::getFormattedData( $this->meta );
}
}
Reference in a new issue View git blame Copy permalink