3 * Handler for bitmap images with exif metadata.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Stuff specific to JPEG and (built-in) TIFF handler.
26 * All metadata related, since both JPEG and TIFF support Exif.
30 class ExifBitmapHandler
extends BitmapHandler
{
31 const BROKEN_FILE
= '-1'; // error extracting metadata
32 const OLD_BROKEN_FILE
= '0'; // outdated error extracting metadata.
34 function convertMetadataVersion( $metadata, $version = 1 ) {
35 // basically flattens arrays.
36 $version = explode( ';', $version, 2 );
37 $version = intval( $version[0] );
38 if ( $version < 1 ||
$version >= 2 ) {
44 if ( !is_array( $metadata ) ) {
45 $metadata = unserialize( $metadata );
47 if ( !isset( $metadata['MEDIAWIKI_EXIF_VERSION'] ) ||
$metadata['MEDIAWIKI_EXIF_VERSION'] != 2 ) {
51 // Treat Software as a special case because in can contain
52 // an array of (SoftwareName, Version).
53 if ( isset( $metadata['Software'] )
54 && is_array( $metadata['Software'] )
55 && is_array( $metadata['Software'][0] )
56 && isset( $metadata['Software'][0][0] )
57 && isset( $metadata['Software'][0][1] )
59 $metadata['Software'] = $metadata['Software'][0][0] . ' (Version '
60 . $metadata['Software'][0][1] . ')';
63 $formatter = new FormatMetadata
;
65 // ContactInfo also has to be dealt with specially
66 if ( isset( $metadata['Contact'] ) ) {
67 $metadata['Contact'] =
68 $formatter->collapseContactInfo(
69 $metadata['Contact'] );
72 foreach ( $metadata as &$val ) {
73 if ( is_array( $val ) ) {
74 $val = $formatter->flattenArrayReal( $val, 'ul', $avoidHtml );
77 $metadata['MEDIAWIKI_EXIF_VERSION'] = 1;
84 * @param array $metadata
87 function isMetadataValid( $image, $metadata ) {
90 # Metadata disabled and so an empty field is expected
91 return self
::METADATA_GOOD
;
93 if ( $metadata === self
::OLD_BROKEN_FILE
) {
94 # Old special value indicating that there is no Exif data in the file.
95 # or that there was an error well extracting the metadata.
96 wfDebug( __METHOD__
. ": back-compat version\n" );
98 return self
::METADATA_COMPATIBLE
;
100 if ( $metadata === self
::BROKEN_FILE
) {
101 return self
::METADATA_GOOD
;
103 wfSuppressWarnings();
104 $exif = unserialize( $metadata );
106 if ( !isset( $exif['MEDIAWIKI_EXIF_VERSION'] )
107 ||
$exif['MEDIAWIKI_EXIF_VERSION'] != Exif
::version()
109 if ( isset( $exif['MEDIAWIKI_EXIF_VERSION'] )
110 && $exif['MEDIAWIKI_EXIF_VERSION'] == 1
112 //back-compatible but old
113 wfDebug( __METHOD__
. ": back-compat version\n" );
115 return self
::METADATA_COMPATIBLE
;
117 # Wrong (non-compatible) version
118 wfDebug( __METHOD__
. ": wrong version\n" );
120 return self
::METADATA_BAD
;
123 return self
::METADATA_GOOD
;
128 * @param bool|IContextSource $context Context to use (optional)
131 function formatMetadata( $image, $context = false ) {
132 $meta = $this->getCommonMetaArray( $image );
133 if ( count( $meta ) === 0 ) {
137 return $this->formatMetadataHelper( $meta, $context );
140 public function getCommonMetaArray( File
$file ) {
141 $metadata = $file->getMetadata();
142 if ( $metadata === self
::OLD_BROKEN_FILE
143 ||
$metadata === self
::BROKEN_FILE
144 ||
$this->isMetadataValid( $file, $metadata ) === self
::METADATA_BAD
146 // So we don't try and display metadata from PagedTiffHandler
147 // for example when using InstantCommons.
151 $exif = unserialize( $metadata );
155 unset( $exif['MEDIAWIKI_EXIF_VERSION'] );
160 function getMetadataType( $image ) {
165 * Wrapper for base classes ImageHandler::getImageSize() that checks for
166 * rotation reported from metadata and swaps the sizes to match.
169 * @param string $path
172 function getImageSize( $image, $path ) {
173 $gis = parent
::getImageSize( $image, $path );
175 // Don't just call $image->getMetadata(); FSFile::getPropsFromPath() calls us with a bogus object.
176 // This may mean we read EXIF data twice on initial upload.
177 if ( $this->autoRotateEnabled() ) {
178 $meta = $this->getMetadata( $image, $path );
179 $rotation = $this->getRotationForExif( $meta );
184 if ( $rotation == 90 ||
$rotation == 270 ) {
194 * On supporting image formats, try to read out the low-level orientation
195 * of the file and return the angle that the file needs to be rotated to
198 * This information is only useful when manipulating the original file;
199 * the width and height we normally work with is logical, and will match
200 * any produced output views.
203 * @return int 0, 90, 180 or 270
205 public function getRotation( $file ) {
206 if ( !$this->autoRotateEnabled() ) {
210 $data = $file->getMetadata();
212 return $this->getRotationForExif( $data );
216 * Given a chunk of serialized Exif metadata, return the orientation as
217 * degrees of rotation.
219 * @param string $data
220 * @return int 0, 90, 180 or 270
221 * @todo FIXME: Orientation can include flipping as well; see if this is an issue!
223 protected function getRotationForExif( $data ) {
227 wfSuppressWarnings();
228 $data = unserialize( $data );
230 if ( isset( $data['Orientation'] ) ) {
231 # See http://sylvana.net/jpegcrop/exif_orientation.html
232 switch ( $data['Orientation'] ) {