X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/a4b52d2fe555a507c376e78ee624898c55968364..2acc6b86c3191c408dc027d5164c397bea97d37b:/includes/Exif.php diff --git a/includes/Exif.php b/includes/Exif.php index 629a946b..594e633a 100644 --- a/includes/Exif.php +++ b/includes/Exif.php @@ -1,60 +1,52 @@ - * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason - * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License - * * 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 + * 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., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * - * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification - * @bug 1555, 1947 - */ - -/**#@+ - * Exif tag type definition + * @ingroup Media + * @author Ævar Arnfjörð Bjarmason + * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason + * @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 */ -define('MW_EXIF_BYTE', 1); # An 8-bit unsigned integer. -define('MW_EXIF_ASCII', 2); # An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL. -define('MW_EXIF_SHORT', 3); # A 16-bit (2-byte) unsigned integer. -define('MW_EXIF_LONG', 4); # A 32-bit (4-byte) unsigned integer. -define('MW_EXIF_RATIONAL', 5); # Two LONGs. The first LONG is the numerator and the second LONG expresses the denominator -define('MW_EXIF_UNDEFINED', 7); # An 8-bit byte that can take any value depending on the field definition -define('MW_EXIF_SLONG', 9); # A 32-bit (4-byte) signed integer (2's complement notation), -define('MW_EXIF_SRATIONAL', 10); # Two SLONGs. The first SLONG is the numerator and the second SLONG is the denominator. -/**#@-*/ - /** - * @package MediaWiki - * @subpackage Metadata + * @todo document (e.g. one-sentence class-overview description) + * @ingroup Media */ class Exif { - /**#@+ - * @var array - * @access private + + const BYTE = 1; //!< An 8-bit (1-byte) unsigned integer. + const ASCII = 2; //!< An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL. + const SHORT = 3; //!< A 16-bit (2-byte) unsigned integer. + const LONG = 4; //!< A 32-bit (4-byte) unsigned integer. + const RATIONAL = 5; //!< Two LONGs. The first LONG is the numerator and the second LONG expresses the denominator + const UNDEFINED = 7; //!< An 8-bit byte that can take any value depending on the field definition + const SLONG = 9; //!< A 32-bit (4-byte) signed integer (2's complement notation), + const SRATIONAL = 10; //!< Two SLONGs. The first SLONG is the numerator and the second SLONG is the denominator. + + //@{ + /* @var array + * @private */ - + /** * Exif tags grouped by category, the tagname itself is the key and the type - * is the value, in the case of more than one possible value type they are - * seperated by commas. + * is the value, in the case of more than one possible value type they are + * separated by commas. */ var $mExifTags; @@ -79,15 +71,37 @@ class Exif { * Filtered and formatted Exif data, see FormatExif::getFormattedData() */ var $mFormattedExifData; - - /**#@-*/ + + //@} + + //@{ + /* @var string + * @private + */ + + /** + * The file being processed + */ + var $file; + + /** + * The basename of the file being processed + */ + var $basename; + + /** + * The private log to log to, e.g. 'exif' + */ + var $log = false; + + //@} /** * Constructor * - * @param string $file + * @param $file String: filename. */ - function Exif( $file ) { + function __construct( $file ) { /** * Page numbers here refer to pages in the EXIF 2.2 standard * @@ -98,191 +112,205 @@ class Exif { 'tiff' => array( # Tags relating to image structure 'structure' => array( - 'ImageWidth' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Image width - 'ImageLength' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Image height - 'BitsPerSample' => MW_EXIF_SHORT, # Number of bits per component + 'ImageWidth' => Exif::SHORT.','.Exif::LONG, # Image width + 'ImageLength' => Exif::SHORT.','.Exif::LONG, # Image height + 'BitsPerSample' => Exif::SHORT, # Number of bits per component # "When a primary image is JPEG compressed, this designation is not" # "necessary and is omitted." (p23) - 'Compression' => MW_EXIF_SHORT, # Compression scheme #p23 - 'PhotometricInterpretation' => MW_EXIF_SHORT, # Pixel composition #p23 - 'Orientation' => MW_EXIF_SHORT, # Orientation of image #p24 - 'SamplesPerPixel' => MW_EXIF_SHORT, # Number of components - 'PlanarConfiguration' => MW_EXIF_SHORT, # Image data arrangement #p24 - 'YCbCrSubSampling' => MW_EXIF_SHORT, # Subsampling ratio of Y to C #p24 - 'YCbCrPositioning' => MW_EXIF_SHORT, # Y and C positioning #p24-25 - 'XResolution' => MW_EXIF_RATIONAL, # Image resolution in width direction - 'YResolution' => MW_EXIF_RATIONAL, # Image resolution in height direction - 'ResolutionUnit' => MW_EXIF_SHORT, # Unit of X and Y resolution #(p26) + 'Compression' => Exif::SHORT, # Compression scheme #p23 + 'PhotometricInterpretation' => Exif::SHORT, # Pixel composition #p23 + 'Orientation' => Exif::SHORT, # Orientation of image #p24 + 'SamplesPerPixel' => Exif::SHORT, # Number of components + 'PlanarConfiguration' => Exif::SHORT, # Image data arrangement #p24 + 'YCbCrSubSampling' => Exif::SHORT, # Subsampling ratio of Y to C #p24 + 'YCbCrPositioning' => Exif::SHORT, # Y and C positioning #p24-25 + 'XResolution' => Exif::RATIONAL, # Image resolution in width direction + 'YResolution' => Exif::RATIONAL, # Image resolution in height direction + 'ResolutionUnit' => Exif::SHORT, # Unit of X and Y resolution #(p26) ), - + # Tags relating to recording offset 'offset' => array( - 'StripOffsets' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Image data location - 'RowsPerStrip' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Number of rows per strip - 'StripByteCounts' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Bytes per compressed strip - 'JPEGInterchangeFormat' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Offset to JPEG SOI - 'JPEGInterchangeFormatLength' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Bytes of JPEG data + 'StripOffsets' => Exif::SHORT.','.Exif::LONG, # Image data location + 'RowsPerStrip' => Exif::SHORT.','.Exif::LONG, # Number of rows per strip + 'StripByteCounts' => Exif::SHORT.','.Exif::LONG, # Bytes per compressed strip + 'JPEGInterchangeFormat' => Exif::SHORT.','.Exif::LONG, # Offset to JPEG SOI + 'JPEGInterchangeFormatLength' => Exif::SHORT.','.Exif::LONG, # Bytes of JPEG data ), - + # Tags relating to image data characteristics 'characteristics' => array( - 'TransferFunction' => MW_EXIF_SHORT, # Transfer function - 'WhitePoint' => MW_EXIF_RATIONAL, # White point chromaticity - 'PrimaryChromaticities' => MW_EXIF_RATIONAL, # Chromaticities of primarities - 'YCbCrCoefficients' => MW_EXIF_RATIONAL, # Color space transformation matrix coefficients #p27 - 'ReferenceBlackWhite' => MW_EXIF_RATIONAL # Pair of black and white reference values + 'TransferFunction' => Exif::SHORT, # Transfer function + 'WhitePoint' => Exif::RATIONAL, # White point chromaticity + 'PrimaryChromaticities' => Exif::RATIONAL, # Chromaticities of primarities + 'YCbCrCoefficients' => Exif::RATIONAL, # Color space transformation matrix coefficients #p27 + 'ReferenceBlackWhite' => Exif::RATIONAL # Pair of black and white reference values ), - + # Other tags 'other' => array( - 'DateTime' => MW_EXIF_ASCII, # File change date and time - 'ImageDescription' => MW_EXIF_ASCII, # Image title - 'Make' => MW_EXIF_ASCII, # Image input equipment manufacturer - 'Model' => MW_EXIF_ASCII, # Image input equipment model - 'Software' => MW_EXIF_ASCII, # Software used - 'Artist' => MW_EXIF_ASCII, # Person who created the image - 'Copyright' => MW_EXIF_ASCII, # Copyright holder + 'DateTime' => Exif::ASCII, # File change date and time + 'ImageDescription' => Exif::ASCII, # Image title + 'Make' => Exif::ASCII, # Image input equipment manufacturer + 'Model' => Exif::ASCII, # Image input equipment model + 'Software' => Exif::ASCII, # Software used + 'Artist' => Exif::ASCII, # Person who created the image + 'Copyright' => Exif::ASCII, # Copyright holder ), ), - + # Exif IFD Attribute Information (p30-31) 'exif' => array( # Tags relating to version 'version' => array( # TODO: NOTE: Nonexistence of this field is taken to mean nonconformance # to the EXIF 2.1 AND 2.2 standards - 'ExifVersion' => MW_EXIF_UNDEFINED, # Exif version - 'FlashpixVersion' => MW_EXIF_UNDEFINED, # Supported Flashpix version #p32 + 'ExifVersion' => Exif::UNDEFINED, # Exif version + 'FlashpixVersion' => Exif::UNDEFINED, # Supported Flashpix version #p32 ), - + # Tags relating to Image Data Characteristics 'characteristics' => array( - 'ColorSpace' => MW_EXIF_SHORT, # Color space information #p32 + 'ColorSpace' => Exif::SHORT, # Color space information #p32 ), - + # Tags relating to image configuration 'configuration' => array( - 'ComponentsConfiguration' => MW_EXIF_UNDEFINED, # Meaning of each component #p33 - 'CompressedBitsPerPixel' => MW_EXIF_RATIONAL, # Image compression mode - 'PixelYDimension' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Valid image width - 'PixelXDimension' => MW_EXIF_SHORT.','.MW_EXIF_LONG, # Valind image height + 'ComponentsConfiguration' => Exif::UNDEFINED, # Meaning of each component #p33 + 'CompressedBitsPerPixel' => Exif::RATIONAL, # Image compression mode + 'PixelYDimension' => Exif::SHORT.','.Exif::LONG, # Valid image width + 'PixelXDimension' => Exif::SHORT.','.Exif::LONG, # Valind image height ), - + # Tags relating to related user information 'user' => array( - 'MakerNote' => MW_EXIF_UNDEFINED, # Manufacturer notes - 'UserComment' => MW_EXIF_UNDEFINED, # User comments #p34 + 'MakerNote' => Exif::UNDEFINED, # Manufacturer notes + 'UserComment' => Exif::UNDEFINED, # User comments #p34 ), - + # Tags relating to related file information 'related' => array( - 'RelatedSoundFile' => MW_EXIF_ASCII, # Related audio file + 'RelatedSoundFile' => Exif::ASCII, # Related audio file ), - + # Tags relating to date and time 'dateandtime' => array( - 'DateTimeOriginal' => MW_EXIF_ASCII, # Date and time of original data generation #p36 - 'DateTimeDigitized' => MW_EXIF_ASCII, # Date and time of original data generation - 'SubSecTime' => MW_EXIF_ASCII, # DateTime subseconds - 'SubSecTimeOriginal' => MW_EXIF_ASCII, # DateTimeOriginal subseconds - 'SubSecTimeDigitized' => MW_EXIF_ASCII, # DateTimeDigitized subseconds + 'DateTimeOriginal' => Exif::ASCII, # Date and time of original data generation #p36 + 'DateTimeDigitized' => Exif::ASCII, # Date and time of original data generation + 'SubSecTime' => Exif::ASCII, # DateTime subseconds + 'SubSecTimeOriginal' => Exif::ASCII, # DateTimeOriginal subseconds + 'SubSecTimeDigitized' => Exif::ASCII, # DateTimeDigitized subseconds ), - + # Tags relating to picture-taking conditions (p31) 'conditions' => array( - 'ExposureTime' => MW_EXIF_RATIONAL, # Exposure time - 'FNumber' => MW_EXIF_RATIONAL, # F Number - 'ExposureProgram' => MW_EXIF_SHORT, # Exposure Program #p38 - 'SpectralSensitivity' => MW_EXIF_ASCII, # Spectral sensitivity - 'ISOSpeedRatings' => MW_EXIF_SHORT, # ISO speed rating - 'OECF' => MW_EXIF_UNDEFINED, # Optoelectronic conversion factor - 'ShutterSpeedValue' => MW_EXIF_SRATIONAL, # Shutter speed - 'ApertureValue' => MW_EXIF_RATIONAL, # Aperture - 'BrightnessValue' => MW_EXIF_SRATIONAL, # Brightness - 'ExposureBiasValue' => MW_EXIF_SRATIONAL, # Exposure bias - 'MaxApertureValue' => MW_EXIF_RATIONAL, # Maximum land aperture - 'SubjectDistance' => MW_EXIF_RATIONAL, # Subject distance - 'MeteringMode' => MW_EXIF_SHORT, # Metering mode #p40 - 'LightSource' => MW_EXIF_SHORT, # Light source #p40-41 - 'Flash' => MW_EXIF_SHORT, # Flash #p41-42 - 'FocalLength' => MW_EXIF_RATIONAL, # Lens focal length - 'SubjectArea' => MW_EXIF_SHORT, # Subject area - 'FlashEnergy' => MW_EXIF_RATIONAL, # Flash energy - 'SpatialFrequencyResponse' => MW_EXIF_UNDEFINED, # Spatial frequency response - 'FocalPlaneXResolution' => MW_EXIF_RATIONAL, # Focal plane X resolution - 'FocalPlaneYResolution' => MW_EXIF_RATIONAL, # Focal plane Y resolution - 'FocalPlaneResolutionUnit' => MW_EXIF_SHORT, # Focal plane resolution unit #p46 - 'SubjectLocation' => MW_EXIF_SHORT, # Subject location - 'ExposureIndex' => MW_EXIF_RATIONAL, # Exposure index - 'SensingMethod' => MW_EXIF_SHORT, # Sensing method #p46 - 'FileSource' => MW_EXIF_UNDEFINED, # File source #p47 - 'SceneType' => MW_EXIF_UNDEFINED, # Scene type #p47 - 'CFAPattern' => MW_EXIF_UNDEFINED, # CFA pattern - 'CustomRendered' => MW_EXIF_SHORT, # Custom image processing #p48 - 'ExposureMode' => MW_EXIF_SHORT, # Exposure mode #p48 - 'WhiteBalance' => MW_EXIF_SHORT, # White Balance #p49 - 'DigitalZoomRatio' => MW_EXIF_RATIONAL, # Digital zoom ration - 'FocalLengthIn35mmFilm' => MW_EXIF_SHORT, # Focal length in 35 mm film - 'SceneCaptureType' => MW_EXIF_SHORT, # Scene capture type #p49 - 'GainControl' => MW_EXIF_RATIONAL, # Scene control #p49-50 - 'Contrast' => MW_EXIF_SHORT, # Contrast #p50 - 'Saturation' => MW_EXIF_SHORT, # Saturation #p50 - 'Sharpness' => MW_EXIF_SHORT, # Sharpness #p50 - 'DeviceSettingDescription' => MW_EXIF_UNDEFINED, # Desice settings description - 'SubjectDistanceRange' => MW_EXIF_SHORT, # Subject distance range #p51 + 'ExposureTime' => Exif::RATIONAL, # Exposure time + 'FNumber' => Exif::RATIONAL, # F Number + 'ExposureProgram' => Exif::SHORT, # Exposure Program #p38 + 'SpectralSensitivity' => Exif::ASCII, # Spectral sensitivity + 'ISOSpeedRatings' => Exif::SHORT, # ISO speed rating + 'OECF' => Exif::UNDEFINED, # Optoelectronic conversion factor + 'ShutterSpeedValue' => Exif::SRATIONAL, # Shutter speed + 'ApertureValue' => Exif::RATIONAL, # Aperture + 'BrightnessValue' => Exif::SRATIONAL, # Brightness + 'ExposureBiasValue' => Exif::SRATIONAL, # Exposure bias + 'MaxApertureValue' => Exif::RATIONAL, # Maximum land aperture + 'SubjectDistance' => Exif::RATIONAL, # Subject distance + 'MeteringMode' => Exif::SHORT, # Metering mode #p40 + 'LightSource' => Exif::SHORT, # Light source #p40-41 + 'Flash' => Exif::SHORT, # Flash #p41-42 + 'FocalLength' => Exif::RATIONAL, # Lens focal length + 'SubjectArea' => Exif::SHORT, # Subject area + 'FlashEnergy' => Exif::RATIONAL, # Flash energy + 'SpatialFrequencyResponse' => Exif::UNDEFINED, # Spatial frequency response + 'FocalPlaneXResolution' => Exif::RATIONAL, # Focal plane X resolution + 'FocalPlaneYResolution' => Exif::RATIONAL, # Focal plane Y resolution + 'FocalPlaneResolutionUnit' => Exif::SHORT, # Focal plane resolution unit #p46 + 'SubjectLocation' => Exif::SHORT, # Subject location + 'ExposureIndex' => Exif::RATIONAL, # Exposure index + 'SensingMethod' => Exif::SHORT, # Sensing method #p46 + 'FileSource' => Exif::UNDEFINED, # File source #p47 + 'SceneType' => Exif::UNDEFINED, # Scene type #p47 + 'CFAPattern' => Exif::UNDEFINED, # CFA pattern + 'CustomRendered' => Exif::SHORT, # Custom image processing #p48 + 'ExposureMode' => Exif::SHORT, # Exposure mode #p48 + 'WhiteBalance' => Exif::SHORT, # White Balance #p49 + 'DigitalZoomRatio' => Exif::RATIONAL, # Digital zoom ration + 'FocalLengthIn35mmFilm' => Exif::SHORT, # Focal length in 35 mm film + 'SceneCaptureType' => Exif::SHORT, # Scene capture type #p49 + 'GainControl' => Exif::RATIONAL, # Scene control #p49-50 + 'Contrast' => Exif::SHORT, # Contrast #p50 + 'Saturation' => Exif::SHORT, # Saturation #p50 + 'Sharpness' => Exif::SHORT, # Sharpness #p50 + 'DeviceSettingDescription' => Exif::UNDEFINED, # Desice settings description + 'SubjectDistanceRange' => Exif::SHORT, # Subject distance range #p51 ), - + 'other' => array( - 'ImageUniqueID' => MW_EXIF_ASCII, # Unique image ID + 'ImageUniqueID' => Exif::ASCII, # Unique image ID ), ), - + # GPS Attribute Information (p52) 'gps' => array( - 'GPSVersionID' => MW_EXIF_BYTE, # GPS tag version - 'GPSLatitudeRef' => MW_EXIF_ASCII, # North or South Latitude #p52-53 - 'GPSLatitude' => MW_EXIF_RATIONAL, # Latitude - 'GPSLongitudeRef' => MW_EXIF_ASCII, # East or West Longitude #p53 - 'GPSLongitude' => MW_EXIF_RATIONAL, # Longitude - 'GPSAltitudeRef' => MW_EXIF_BYTE, # Altitude reference - 'GPSAltitude' => MW_EXIF_RATIONAL, # Altitude - 'GPSTimeStamp' => MW_EXIF_RATIONAL, # GPS time (atomic clock) - 'GPSSatellites' => MW_EXIF_ASCII, # Satellites used for measurement - 'GPSStatus' => MW_EXIF_ASCII, # Receiver status #p54 - 'GPSMeasureMode' => MW_EXIF_ASCII, # Measurement mode #p54-55 - 'GPSDOP' => MW_EXIF_RATIONAL, # Measurement precision - 'GPSSpeedRef' => MW_EXIF_ASCII, # Speed unit #p55 - 'GPSSpeed' => MW_EXIF_RATIONAL, # Speed of GPS receiver - 'GPSTrackRef' => MW_EXIF_ASCII, # Reference for direction of movement #p55 - 'GPSTrack' => MW_EXIF_RATIONAL, # Direction of movement - 'GPSImgDirectionRef' => MW_EXIF_ASCII, # Reference for direction of image #p56 - 'GPSImgDirection' => MW_EXIF_RATIONAL, # Direction of image - 'GPSMapDatum' => MW_EXIF_ASCII, # Geodetic survey data used - 'GPSDestLatitudeRef' => MW_EXIF_ASCII, # Reference for latitude of destination #p56 - 'GPSDestLatitude' => MW_EXIF_RATIONAL, # Latitude destination - 'GPSDestLongitudeRef' => MW_EXIF_ASCII, # Reference for longitude of destination #p57 - 'GPSDestLongitude' => MW_EXIF_RATIONAL, # Longitude of destination - 'GPSDestBearingRef' => MW_EXIF_ASCII, # Reference for bearing of destination #p57 - 'GPSDestBearing' => MW_EXIF_RATIONAL, # Bearing of destination - 'GPSDestDistanceRef' => MW_EXIF_ASCII, # Reference for distance to destination #p57-58 - 'GPSDestDistance' => MW_EXIF_RATIONAL, # Distance to destination - 'GPSProcessingMethod' => MW_EXIF_UNDEFINED, # Name of GPS processing method - 'GPSAreaInformation' => MW_EXIF_UNDEFINED, # Name of GPS area - 'GPSDateStamp' => MW_EXIF_ASCII, # GPS date - 'GPSDifferential' => MW_EXIF_SHORT, # GPS differential correction + 'GPSVersionID' => Exif::BYTE, # GPS tag version + 'GPSLatitudeRef' => Exif::ASCII, # North or South Latitude #p52-53 + 'GPSLatitude' => Exif::RATIONAL, # Latitude + 'GPSLongitudeRef' => Exif::ASCII, # East or West Longitude #p53 + 'GPSLongitude' => Exif::RATIONAL, # Longitude + 'GPSAltitudeRef' => Exif::BYTE, # Altitude reference + 'GPSAltitude' => Exif::RATIONAL, # Altitude + 'GPSTimeStamp' => Exif::RATIONAL, # GPS time (atomic clock) + 'GPSSatellites' => Exif::ASCII, # Satellites used for measurement + 'GPSStatus' => Exif::ASCII, # Receiver status #p54 + 'GPSMeasureMode' => Exif::ASCII, # Measurement mode #p54-55 + 'GPSDOP' => Exif::RATIONAL, # Measurement precision + 'GPSSpeedRef' => Exif::ASCII, # Speed unit #p55 + 'GPSSpeed' => Exif::RATIONAL, # Speed of GPS receiver + 'GPSTrackRef' => Exif::ASCII, # Reference for direction of movement #p55 + 'GPSTrack' => Exif::RATIONAL, # Direction of movement + 'GPSImgDirectionRef' => Exif::ASCII, # Reference for direction of image #p56 + 'GPSImgDirection' => Exif::RATIONAL, # Direction of image + 'GPSMapDatum' => Exif::ASCII, # Geodetic survey data used + 'GPSDestLatitudeRef' => Exif::ASCII, # Reference for latitude of destination #p56 + 'GPSDestLatitude' => Exif::RATIONAL, # Latitude destination + 'GPSDestLongitudeRef' => Exif::ASCII, # Reference for longitude of destination #p57 + 'GPSDestLongitude' => Exif::RATIONAL, # Longitude of destination + 'GPSDestBearingRef' => Exif::ASCII, # Reference for bearing of destination #p57 + 'GPSDestBearing' => Exif::RATIONAL, # Bearing of destination + 'GPSDestDistanceRef' => Exif::ASCII, # Reference for distance to destination #p57-58 + 'GPSDestDistance' => Exif::RATIONAL, # Distance to destination + 'GPSProcessingMethod' => Exif::UNDEFINED, # Name of GPS processing method + 'GPSAreaInformation' => Exif::UNDEFINED, # Name of GPS area + 'GPSDateStamp' => Exif::ASCII, # GPS date + 'GPSDifferential' => Exif::SHORT, # GPS differential correction ), ); + $this->file = $file; + $this->basename = wfBaseName( $this->file ); + $this->makeFlatExifTags(); + + $this->debugFile( $this->basename, __FUNCTION__, true ); wfSuppressWarnings(); - $this->mRawExifData = exif_read_data( $file ); + $data = exif_read_data( $this->file ); wfRestoreWarnings(); + /** + * exif_read_data() will return false on invalid input, such as + * when somebody uploads a file called something.jpeg + * containing random gibberish. + */ + $this->mRawExifData = $data ? $data : array(); + $this->makeFilteredData(); $this->makeFormattedData(); + + $this->debugFile( __FUNCTION__, false ); } - + /**#@+ - * @access private + * @private */ /** * Generate a flat list of the exif tags @@ -290,7 +318,7 @@ class Exif { function makeFlatExifTags() { $this->extractTags( $this->mExifTags ); } - + /** * A recursing extractor function used by makeFlatExifTags() * @@ -306,13 +334,13 @@ class Exif { } } } - + /** * Make $this->mFilteredExifData */ function makeFilteredData() { $this->mFilteredExifData = $this->mRawExifData; - + foreach( $this->mFilteredExifData as $k => $v ) { if ( !in_array( $k, array_keys( $this->mFlatExifTags ) ) ) { $this->debug( $v, __FUNCTION__, "'$k' is not a valid Exif tag" ); @@ -328,7 +356,10 @@ class Exif { } } - function makeFormattedData( $data = null ) { + /** + * @todo document + */ + function makeFormattedData( ) { $format = new FormatExif( $this->getFilteredData() ); $this->mFormattedExifData = $format->getFormattedData(); } @@ -358,7 +389,7 @@ class Exif { return $this->mFormattedExifData; } /**#@-*/ - + /** * The version of the output format * @@ -371,20 +402,20 @@ class Exif { * * @return int */ - function version() { + public static function version() { return 1; // We don't need no bloddy constants! } /**#@+ * Validates if a tag value is of the type it should be according to the Exif spec * - * @access private + * @private * - * @param mixed $in The input value to check + * @param $in Mixed: the input value to check * @return bool */ function isByte( $in ) { - if ( sprintf('%d', $in) == $in && $in >= 0 && $in <= 255 ) { + if ( !is_array( $in ) && sprintf('%d', $in) == $in && $in >= 0 && $in <= 255 ) { $this->debug( $in, __FUNCTION__, true ); return true; } else { @@ -392,23 +423,27 @@ class Exif { return false; } } - + function isASCII( $in ) { + if ( is_array( $in ) ) { + return false; + } + if ( preg_match( "/[^\x0a\x20-\x7e]/", $in ) ) { $this->debug( $in, __FUNCTION__, 'found a character not in our whitelist' ); return false; } - - if ( preg_match( "/^\s*$/", $in ) ) { + + if ( preg_match( '/^\s*$/', $in ) ) { $this->debug( $in, __FUNCTION__, 'input consisted solely of whitespace' ); return false; } - + return true; } function isShort( $in ) { - if ( sprintf('%d', $in) == $in && $in >= 0 && $in <= 65536 ) { + if ( !is_array( $in ) && sprintf('%d', $in) == $in && $in >= 0 && $in <= 65536 ) { $this->debug( $in, __FUNCTION__, true ); return true; } else { @@ -418,7 +453,7 @@ class Exif { } function isLong( $in ) { - if ( sprintf('%d', $in) == $in && $in >= 0 && $in <= 4294967296 ) { + if ( !is_array( $in ) && sprintf('%d', $in) == $in && $in >= 0 && $in <= 4294967296 ) { $this->debug( $in, __FUNCTION__, true ); return true; } else { @@ -426,9 +461,10 @@ class Exif { return false; } } - + function isRational( $in ) { - if ( @preg_match( "/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/", $in, $m ) ) { # Avoid division by zero + $m = array(); + if ( !is_array( $in ) && @preg_match( '/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/', $in, $m ) ) { # Avoid division by zero return $this->isLong( $m[1] ) && $this->isLong( $m[2] ); } else { $this->debug( $in, __FUNCTION__, 'fed a non-fraction value' ); @@ -437,7 +473,7 @@ class Exif { } function isUndefined( $in ) { - if ( preg_match( "/^\d{4}$/", $in ) ) { // Allow ExifVersion and FlashpixVersion + if ( !is_array( $in ) && preg_match( '/^\d{4}$/', $in ) ) { // Allow ExifVersion and FlashpixVersion $this->debug( $in, __FUNCTION__, true ); return true; } else { @@ -457,7 +493,8 @@ class Exif { } function isSrational( $in ) { - if ( preg_match( "/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/", $in, $m ) ) { # Avoid division by zero + $m = array(); + if ( !is_array( $in ) && preg_match( '/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/', $in, $m ) ) { # Avoid division by zero return $this->isSlong( $m[0] ) && $this->isSlong( $m[1] ); } else { $this->debug( $in, __FUNCTION__, 'fed a non-fraction value' ); @@ -469,41 +506,41 @@ class Exif { /** * Validates if a tag has a legal value according to the Exif spec * - * @access private + * @private * - * @param string $tag The tag to check - * @param mixed $val The value of the tag + * @param $tag String: the tag to check. + * @param $val Mixed: the value of the tag. * @return bool */ function validate( $tag, $val ) { $debug = "tag is '$tag'"; - // Fucks up if not typecast + // Does not work if not typecast switch( (string)$this->mFlatExifTags[$tag] ) { - case (string)MW_EXIF_BYTE: + case (string)Exif::BYTE: $this->debug( $val, __FUNCTION__, $debug ); return $this->isByte( $val ); - case (string)MW_EXIF_ASCII: + case (string)Exif::ASCII: $this->debug( $val, __FUNCTION__, $debug ); return $this->isASCII( $val ); - case (string)MW_EXIF_SHORT: + case (string)Exif::SHORT: $this->debug( $val, __FUNCTION__, $debug ); return $this->isShort( $val ); - case (string)MW_EXIF_LONG: + case (string)Exif::LONG: $this->debug( $val, __FUNCTION__, $debug ); return $this->isLong( $val ); - case (string)MW_EXIF_RATIONAL: + case (string)Exif::RATIONAL: $this->debug( $val, __FUNCTION__, $debug ); return $this->isRational( $val ); - case (string)MW_EXIF_UNDEFINED: + case (string)Exif::UNDEFINED: $this->debug( $val, __FUNCTION__, $debug ); return $this->isUndefined( $val ); - case (string)MW_EXIF_SLONG: + case (string)Exif::SLONG: $this->debug( $val, __FUNCTION__, $debug ); return $this->isSlong( $val ); - case (string)MW_EXIF_SRATIONAL: + case (string)Exif::SRATIONAL: $this->debug( $val, __FUNCTION__, $debug ); return $this->isSrational( $val ); - case (string)MW_EXIF_SHORT.','.MW_EXIF_LONG: + case (string)Exif::SHORT.','.Exif::LONG: $this->debug( $val, __FUNCTION__, $debug ); return $this->isShort( $val ) || $this->isLong( $val ); default: @@ -513,55 +550,78 @@ class Exif { } /** - * Conviniance function for debugging output + * Convenience function for debugging output * - * @access private + * @private * - * @param mixed $in - * @param string $fname - * @param mixed $action + * @param $in Mixed: + * @param $fname String: + * @param $action Mixed: , default NULL. */ - function debug( $in, $fname, $action = null ) { + function debug( $in, $fname, $action = null ) { + if ( !$this->log ) { + return; + } $type = gettype( $in ); $class = ucfirst( __CLASS__ ); if ( $type === 'array' ) - $in = print_r( $in, true ); - + $in = print_r( $in, true ); + if ( $action === true ) - wfDebug( "$class::$fname: accepted: '$in' (type: $type)\n"); - elseif ( $action === false ) - wfDebug( "$class::$fname: rejected: '$in' (type: $type)\n"); + wfDebugLog( $this->log, "$class::$fname: accepted: '$in' (type: $type)\n"); + elseif ( $action === false ) + wfDebugLog( $this->log, "$class::$fname: rejected: '$in' (type: $type)\n"); elseif ( $action === null ) - wfDebug( "$class::$fname: input was: '$in' (type: $type)\n"); + wfDebugLog( $this->log, "$class::$fname: input was: '$in' (type: $type)\n"); else - wfDebug( "$class::$fname: $action (type: $type; content: '$in')\n"); + wfDebugLog( $this->log, "$class::$fname: $action (type: $type; content: '$in')\n"); + } + + /** + * Convenience function for debugging output + * + * @private + * + * @param $fname String: the name of the function calling this function + * @param $io Boolean: Specify whether we're beginning or ending + */ + function debugFile( $fname, $io ) { + if ( !$this->log ) { + return; + } + $class = ucfirst( __CLASS__ ); + if ( $io ) { + wfDebugLog( $this->log, "$class::$fname: begin processing: '{$this->basename}'\n" ); + } else { + wfDebugLog( $this->log, "$class::$fname: end processing: '{$this->basename}'\n" ); + } } } /** - * @package MediaWiki - * @subpackage Metadata + * @todo document (e.g. one-sentence class-overview description) + * @ingroup Media */ class FormatExif { /** * The Exif data to format * * @var array - * @access private + * @private */ var $mExif; - + /** * Constructor * - * @param array $exif The Exif data to format ( as returned by + * @param $exif Array: the Exif data to format ( as returned by * Exif::getFilteredData() ) */ function FormatExif( $exif ) { $this->mExif = $exif; } - + /** * Numbers given by Exif user agents are often magical, that is they * should be replaced by a detailed explanation depending on their @@ -572,12 +632,12 @@ class FormatExif { */ function getFormattedData() { global $wgLang; - + $tags =& $this->mExif; $resolutionunit = !isset( $tags['ResolutionUnit'] ) || $tags['ResolutionUnit'] == 2 ? 2 : 3; unset( $tags['ResolutionUnit'] ); - + foreach( $tags as $tag => $val ) { switch( $tag ) { case 'Compression': @@ -590,7 +650,7 @@ class FormatExif { break; } break; - + case 'PhotometricInterpretation': switch( $val ) { case 2: case 6: @@ -601,7 +661,7 @@ class FormatExif { break; } break; - + case 'Orientation': switch( $val ) { case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8: @@ -612,7 +672,7 @@ class FormatExif { break; } break; - + case 'PlanarConfiguration': switch( $val ) { case 1: case 2: @@ -623,10 +683,10 @@ class FormatExif { break; } break; - + // TODO: YCbCrSubSampling // TODO: YCbCrPositioning - + case 'XResolution': case 'YResolution': switch( $resolutionunit ) { @@ -641,12 +701,12 @@ class FormatExif { break; } break; - + // TODO: YCbCrCoefficients #p27 (see annex E) case 'ExifVersion': case 'FlashpixVersion': $tags[$tag] = "$val"/100; break; - + case 'ColorSpace': switch( $val ) { case 1: case 'FFFF.H': @@ -657,7 +717,7 @@ class FormatExif { break; } break; - + case 'ComponentsConfiguration': switch( $val ) { case 0: case 1: case 2: case 3: case 4: case 5: case 6: @@ -668,13 +728,17 @@ class FormatExif { break; } break; - + case 'DateTime': case 'DateTimeOriginal': case 'DateTimeDigitized': - $tags[$tag] = $wgLang->timeanddate( wfTimestamp(TS_MW, $val) ); + if( $val == '0000:00:00 00:00:00' ) { + $tags[$tag] = wfMsg('exif-unknowndate'); + } elseif( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d):(?:\d\d)$/', $val ) ) { + $tags[$tag] = $wgLang->timeanddate( wfTimestamp(TS_MW, $val) ); + } break; - + case 'ExposureProgram': switch( $val ) { case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8: @@ -689,7 +753,7 @@ class FormatExif { case 'SubjectDistance': $tags[$tag] = $this->msg( $tag, '', $this->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: @@ -700,7 +764,7 @@ class FormatExif { break; } break; - + case 'LightSource': switch( $val ) { case 0: case 1: case 2: case 3: case 4: case 9: case 10: case 11: @@ -713,8 +777,29 @@ class FormatExif { break; } break; - - // TODO: Flash + + 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, + ); + + # 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[] = $this->msg( $fullTag, $subValue ); + } + $tags[$tag] = $wgLang->commaList( $flashMsgs ); + break; + case 'FocalPlaneResolutionUnit': switch( $val ) { case 2: @@ -725,7 +810,7 @@ class FormatExif { break; } break; - + case 'SensingMethod': switch( $val ) { case 1: case 2: case 3: case 4: case 5: case 7: case 8: @@ -736,7 +821,7 @@ class FormatExif { break; } break; - + case 'FileSource': switch( $val ) { case 3: @@ -747,7 +832,7 @@ class FormatExif { break; } break; - + case 'SceneType': switch( $val ) { case 1: @@ -758,7 +843,7 @@ class FormatExif { break; } break; - + case 'CustomRendered': switch( $val ) { case 0: case 1: @@ -769,7 +854,7 @@ class FormatExif { break; } break; - + case 'ExposureMode': switch( $val ) { case 0: case 1: case 2: @@ -780,7 +865,7 @@ class FormatExif { break; } break; - + case 'WhiteBalance': switch( $val ) { case 0: case 1: @@ -791,7 +876,7 @@ class FormatExif { break; } break; - + case 'SceneCaptureType': switch( $val ) { case 0: case 1: case 2: case 3: @@ -802,7 +887,7 @@ class FormatExif { break; } break; - + case 'GainControl': switch( $val ) { case 0: case 1: case 2: case 3: case 4: @@ -813,7 +898,7 @@ class FormatExif { break; } break; - + case 'Contrast': switch( $val ) { case 0: case 1: case 2: @@ -824,7 +909,7 @@ class FormatExif { break; } break; - + case 'Saturation': switch( $val ) { case 0: case 1: case 2: @@ -835,7 +920,7 @@ class FormatExif { break; } break; - + case 'Sharpness': switch( $val ) { case 0: case 1: case 2: @@ -846,7 +931,7 @@ class FormatExif { break; } break; - + case 'SubjectDistanceRange': switch( $val ) { case 0: case 1: case 2: case 3: @@ -857,7 +942,7 @@ class FormatExif { break; } break; - + case 'GPSLatitudeRef': case 'GPSDestLatitudeRef': switch( $val ) { @@ -869,7 +954,7 @@ class FormatExif { break; } break; - + case 'GPSLongitudeRef': case 'GPSDestLongitudeRef': switch( $val ) { @@ -881,7 +966,7 @@ class FormatExif { break; } break; - + case 'GPSStatus': switch( $val ) { case 'A': case 'V': @@ -892,7 +977,7 @@ class FormatExif { break; } break; - + case 'GPSMeasureMode': switch( $val ) { case 2: case 3: @@ -903,7 +988,7 @@ class FormatExif { break; } break; - + case 'GPSSpeedRef': case 'GPSDestDistanceRef': switch( $val ) { @@ -915,7 +1000,7 @@ class FormatExif { break; } break; - + case 'GPSTrackRef': case 'GPSImgDirectionRef': case 'GPSDestBearingRef': @@ -928,11 +1013,11 @@ class FormatExif { break; } break; - + case 'GPSDateStamp': $tags[$tag] = $wgLang->date( substr( $val, 0, 4 ) . substr( $val, 5, 2 ) . substr( $val, 8, 2 ) . '000000' ); 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. @@ -941,6 +1026,31 @@ class FormatExif { case 'Software': $tags[$tag] = $this->msg( $tag, '', $val ); break; + + case 'ExposureTime': + // Show the pretty fraction as well as decimal version + $tags[$tag] = wfMsg( 'exif-exposuretime-format', + $this->formatFraction( $val ), $this->formatNum( $val ) ); + break; + + case 'FNumber': + $tags[$tag] = wfMsg( 'exif-fnumber-format', + $this->formatNum( $val ) ); + break; + + case 'FocalLength': + $tags[$tag] = wfMsg( 'exif-focallength-format', + $this->formatNum( $val ) ); + 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 + case 'ImageDescription': + case 'Artist': + case 'Copyright': + $tags[$tag] = htmlspecialchars( $val ); + break; default: $tags[$tag] = $this->formatNum( $val ); break; @@ -951,34 +1061,100 @@ class FormatExif { } /** - * Conviniance function for getFormattedData() + * Convenience function for getFormattedData() * - * @access private + * @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 $tag String: the tag name to pass on + * @param $val String: the value of the tag + * @param $arg String: an argument to pass ($1) * @return string A wfMsg of "exif-$tag-$val" in lower case */ function msg( $tag, $val, $arg = null ) { + global $wgContLang; + if ($val === '') $val = 'value'; - return wfMsg( strtolower( "exif-$tag-$val" ), $arg ); + return wfMsg( $wgContLang->lc( "exif-$tag-$val" ), $arg ); } /** * Format a number, convert numbers from fractions into floating point * numbers * - * @access private + * @private * - * @param mixed $num The value to format + * @param $num Mixed: the value to format * @return mixed A floating point number or whatever we were fed */ function formatNum( $num ) { + global $wgLang; + + $m = array(); if ( preg_match( '/^(\d+)\/(\d+)$/', $num, $m ) ) - return $m[2] != 0 ? $m[1] / $m[2] : $num; + return $wgLang->formatNum( $m[2] != 0 ? $m[1] / $m[2] : $num ); else - return $num; + 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 + */ + function formatFraction( $num ) { + $m = array(); + if ( preg_match( '/^(\d+)\/(\d+)$/', $num, $m ) ) { + $numerator = intval( $m[1] ); + $denominator = intval( $m[2] ); + $gcd = $this->gcd( $numerator, $denominator ); + if( $gcd != 0 ) { + // 0 shouldn't happen! ;) + return $this->formatNum( $numerator / $gcd ) . '/' . $this->formatNum( $denominator / $gcd ); + } + } + return $this->formatNum( $num ); + } + + /** + * Calculate the greatest common divisor of two integers. + * + * @param $a Integer: FIXME + * @param $b Integer: FIXME + * @return int + * @private + */ + 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; } } + +/** + * MW 1.6 compatibility + */ +define( 'MW_EXIF_BYTE', Exif::BYTE ); +define( 'MW_EXIF_ASCII', Exif::ASCII ); +define( 'MW_EXIF_SHORT', Exif::SHORT ); +define( 'MW_EXIF_LONG', Exif::LONG ); +define( 'MW_EXIF_RATIONAL', Exif::RATIONAL ); +define( 'MW_EXIF_UNDEFINED', Exif::UNDEFINED ); +define( 'MW_EXIF_SLONG', Exif::SLONG ); +define( 'MW_EXIF_SRATIONAL', Exif::SRATIONAL );