2011-08-21 18:05:34 +00:00
|
|
|
|
<?php
|
2014-07-15 17:31:07 +00:00
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
* @group Media
|
|
|
|
|
|
*/
|
2019-07-02 17:04:44 +00:00
|
|
|
|
class GIFMetadataExtractorTest extends \MediaWikiUnitTestCase {
|
2011-08-21 18:05:34 +00:00
|
|
|
|
|
2021-07-22 03:11:47 +00:00
|
|
|
|
protected function setUp(): void {
|
2012-10-08 10:56:20 +00:00
|
|
|
|
parent::setUp();
|
|
|
|
|
|
|
2019-07-02 17:04:44 +00:00
|
|
|
|
$this->mediaPath = __DIR__ . '/../../../data/media/';
|
2011-08-21 18:05:34 +00:00
|
|
|
|
}
|
2013-02-15 10:17:52 +00:00
|
|
|
|
|
2011-08-21 18:05:34 +00:00
|
|
|
|
/**
|
|
|
|
|
|
* Put in a file, and see if the metadata coming out is as expected.
|
2014-04-17 18:43:42 +00:00
|
|
|
|
* @param string $filename
|
|
|
|
|
|
* @param array $expected The extracted metadata.
|
2012-10-08 10:56:20 +00:00
|
|
|
|
* @dataProvider provideGetMetadata
|
2013-10-23 22:12:39 +00:00
|
|
|
|
* @covers GIFMetadataExtractor::getMetadata
|
2011-08-21 18:05:34 +00:00
|
|
|
|
*/
|
|
|
|
|
|
public function testGetMetadata( $filename, $expected ) {
|
|
|
|
|
|
$actual = GIFMetadataExtractor::getMetadata( $this->mediaPath . $filename );
|
|
|
|
|
|
$this->assertEquals( $expected, $actual );
|
|
|
|
|
|
}
|
2013-02-15 10:17:52 +00:00
|
|
|
|
|
2012-10-08 10:56:20 +00:00
|
|
|
|
public static function provideGetMetadata() {
|
2011-08-21 18:05:34 +00:00
|
|
|
|
$xmpNugget = <<<EOF
|
|
|
|
|
|
<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?>
|
|
|
|
|
|
<x:xmpmeta xmlns:x='adobe:ns:meta/' x:xmptk='Image::ExifTool 7.30'>
|
|
|
|
|
|
<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>
|
|
|
|
|
|
|
|
|
|
|
|
<rdf:Description rdf:about=''
|
|
|
|
|
|
xmlns:Iptc4xmpCore='http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/'>
|
|
|
|
|
|
<Iptc4xmpCore:Location>The interwebs</Iptc4xmpCore:Location>
|
|
|
|
|
|
</rdf:Description>
|
|
|
|
|
|
|
|
|
|
|
|
<rdf:Description rdf:about=''
|
|
|
|
|
|
xmlns:tiff='http://ns.adobe.com/tiff/1.0/'>
|
|
|
|
|
|
<tiff:Artist>Bawolff</tiff:Artist>
|
|
|
|
|
|
<tiff:ImageDescription>
|
|
|
|
|
|
<rdf:Alt>
|
|
|
|
|
|
<rdf:li xml:lang='x-default'>A file to test GIF</rdf:li>
|
|
|
|
|
|
</rdf:Alt>
|
|
|
|
|
|
</tiff:ImageDescription>
|
|
|
|
|
|
</rdf:Description>
|
|
|
|
|
|
</rdf:RDF>
|
|
|
|
|
|
</x:xmpmeta>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<?xpacket end='w'?>
|
|
|
|
|
|
EOF;
|
2011-11-04 20:46:04 +00:00
|
|
|
|
$xmpNugget = str_replace( "\r", '', $xmpNugget ); // Windows compat
|
2011-08-21 18:05:34 +00:00
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
|
return [
|
|
|
|
|
|
[
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'nonanimated.gif',
|
2016-02-17 09:09:32 +00:00
|
|
|
|
[
|
Use the unserialized form of image metadata internally
Image metadata is usually a serialized string representing an array.
Passing the string around internally and having everything unserialize
it is an awkward convention.
Also, many image handlers were reading the file twice: once for
getMetadata() and again for getImageSize(). Often getMetadata()
would actually read the width and height and then throw it away.
So, in filerepo:
* Add File::getMetadataItem(), which promises to allow partial
loading of metadata per my proposal on T275268 in a future commit.
* Add File::getMetadataArray(), which returns the unserialized array.
Some file handlers were returning non-serializable strings from
getMetadata(), so I gave them a legacy array form ['_error' => ...]
* Changed MWFileProps to return the array form of metadata.
* Deprecate the weird File::getImageSize(). It was apparently not
called by anything, but was overridden by UnregisteredLocalFile.
* Wrap serialize/unserialize with File::getMetadataForDb() and
File::loadMetadataFromDb() in preparation for T275268.
In MediaHandler:
* Merged MediaHandler::getImageSize() and MediaHandler::getMetadata()
into getSizeAndMetadata(). Deprecated the old methods.
* Instead of isMetadataValid() we now have isFileMetadataValid(), which
only gets a File object, so it can decide what data it needs to load.
* Simplified getPageDimensions() by having it return false for non-paged
media. It was not called in that case, but was implemented anyway.
In specific handlers:
* Rename DjVuHandler::getUnserializedMetadata() and
extractTreesFromMetadata() for clarity. "Metadata" in these function
names meant an XML string.
* Updated DjVuImage::getImageSize() to provide image sizes in the new
style.
* In ExifBitmapHandler, getRotationForExif() now takes just the
Orientation tag, rather than a serialized string. Also renamed for
clarity.
* In GIFMetadataExtractor, return the width, height and bits per channel
instead of throwing them away. There was some conflation in
decodeBPP() which I picked apart. Refer to GIF89a section 18.
* In JpegMetadataExtractor, process the SOF0/SOF2 segment to extract
bits per channel, width, height and components (channel count). This
is essentially a port of PHP's getimagesize(), so should be bugwards
compatible.
* In PNGMetadataExtractor, return the width and height, which were
previously assigned to unused local variables. I verified the
implementation by referring to the specification.
* In SvgHandler, retain the version validation from unpackMetadata(),
but rename the function since it now takes an array as input.
In tests:
* In ExifBitmapTest, refactored some tests by using a provider.
* In GIFHandlerTest and PNGHandlerTest, I removed the tests in which
getMetadata() returns null, since it doesn't make sense when ported to
getMetadataArray(). I added tests for empty arrays instead.
* In tests, I retained serialization of input data since I figure it's
useful to confirm that existing database rows will continue to be read
correctly. I removed serialization of expected values, replacing them
with plain data.
* In tests, I replaced access to private class constants like
BROKEN_FILE with string literals, since stability is essential. If
the class constant changes, the test should fail.
Elsewhere:
* In maintenance/refreshImageMetadata.php, I removed the check for
shrinking image metadata, since it's not easy to implement and is
not future compatible. Image metadata is expected to shrink in
future.
Bug: T275268
Change-Id: I039785d5b6439d71dcc21dcb972177dba5c3a67d
2021-05-19 00:24:32 +00:00
|
|
|
|
'width' => 45,
|
|
|
|
|
|
'height' => 30,
|
|
|
|
|
|
'bits' => 1,
|
2016-02-17 09:09:32 +00:00
|
|
|
|
'comment' => [ 'GIF test file ⁕ Created with GIMP' ],
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'duration' => 0.1,
|
|
|
|
|
|
'frameCount' => 1,
|
|
|
|
|
|
'looped' => false,
|
|
|
|
|
|
'xmp' => '',
|
2016-02-17 09:09:32 +00:00
|
|
|
|
]
|
|
|
|
|
|
],
|
|
|
|
|
|
[
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'animated.gif',
|
2016-02-17 09:09:32 +00:00
|
|
|
|
[
|
Use the unserialized form of image metadata internally
Image metadata is usually a serialized string representing an array.
Passing the string around internally and having everything unserialize
it is an awkward convention.
Also, many image handlers were reading the file twice: once for
getMetadata() and again for getImageSize(). Often getMetadata()
would actually read the width and height and then throw it away.
So, in filerepo:
* Add File::getMetadataItem(), which promises to allow partial
loading of metadata per my proposal on T275268 in a future commit.
* Add File::getMetadataArray(), which returns the unserialized array.
Some file handlers were returning non-serializable strings from
getMetadata(), so I gave them a legacy array form ['_error' => ...]
* Changed MWFileProps to return the array form of metadata.
* Deprecate the weird File::getImageSize(). It was apparently not
called by anything, but was overridden by UnregisteredLocalFile.
* Wrap serialize/unserialize with File::getMetadataForDb() and
File::loadMetadataFromDb() in preparation for T275268.
In MediaHandler:
* Merged MediaHandler::getImageSize() and MediaHandler::getMetadata()
into getSizeAndMetadata(). Deprecated the old methods.
* Instead of isMetadataValid() we now have isFileMetadataValid(), which
only gets a File object, so it can decide what data it needs to load.
* Simplified getPageDimensions() by having it return false for non-paged
media. It was not called in that case, but was implemented anyway.
In specific handlers:
* Rename DjVuHandler::getUnserializedMetadata() and
extractTreesFromMetadata() for clarity. "Metadata" in these function
names meant an XML string.
* Updated DjVuImage::getImageSize() to provide image sizes in the new
style.
* In ExifBitmapHandler, getRotationForExif() now takes just the
Orientation tag, rather than a serialized string. Also renamed for
clarity.
* In GIFMetadataExtractor, return the width, height and bits per channel
instead of throwing them away. There was some conflation in
decodeBPP() which I picked apart. Refer to GIF89a section 18.
* In JpegMetadataExtractor, process the SOF0/SOF2 segment to extract
bits per channel, width, height and components (channel count). This
is essentially a port of PHP's getimagesize(), so should be bugwards
compatible.
* In PNGMetadataExtractor, return the width and height, which were
previously assigned to unused local variables. I verified the
implementation by referring to the specification.
* In SvgHandler, retain the version validation from unpackMetadata(),
but rename the function since it now takes an array as input.
In tests:
* In ExifBitmapTest, refactored some tests by using a provider.
* In GIFHandlerTest and PNGHandlerTest, I removed the tests in which
getMetadata() returns null, since it doesn't make sense when ported to
getMetadataArray(). I added tests for empty arrays instead.
* In tests, I retained serialization of input data since I figure it's
useful to confirm that existing database rows will continue to be read
correctly. I removed serialization of expected values, replacing them
with plain data.
* In tests, I replaced access to private class constants like
BROKEN_FILE with string literals, since stability is essential. If
the class constant changes, the test should fail.
Elsewhere:
* In maintenance/refreshImageMetadata.php, I removed the check for
shrinking image metadata, since it's not easy to implement and is
not future compatible. Image metadata is expected to shrink in
future.
Bug: T275268
Change-Id: I039785d5b6439d71dcc21dcb972177dba5c3a67d
2021-05-19 00:24:32 +00:00
|
|
|
|
'width' => 45,
|
|
|
|
|
|
'height' => 30,
|
|
|
|
|
|
'bits' => 1,
|
2016-02-17 09:09:32 +00:00
|
|
|
|
'comment' => [ 'GIF test file . Created with GIMP' ],
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'duration' => 2.4,
|
|
|
|
|
|
'frameCount' => 4,
|
|
|
|
|
|
'looped' => true,
|
|
|
|
|
|
'xmp' => '',
|
2016-02-17 09:09:32 +00:00
|
|
|
|
]
|
|
|
|
|
|
],
|
2011-08-21 18:05:34 +00:00
|
|
|
|
|
2016-02-17 09:09:32 +00:00
|
|
|
|
[
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'animated-xmp.gif',
|
2016-02-17 09:09:32 +00:00
|
|
|
|
[
|
Use the unserialized form of image metadata internally
Image metadata is usually a serialized string representing an array.
Passing the string around internally and having everything unserialize
it is an awkward convention.
Also, many image handlers were reading the file twice: once for
getMetadata() and again for getImageSize(). Often getMetadata()
would actually read the width and height and then throw it away.
So, in filerepo:
* Add File::getMetadataItem(), which promises to allow partial
loading of metadata per my proposal on T275268 in a future commit.
* Add File::getMetadataArray(), which returns the unserialized array.
Some file handlers were returning non-serializable strings from
getMetadata(), so I gave them a legacy array form ['_error' => ...]
* Changed MWFileProps to return the array form of metadata.
* Deprecate the weird File::getImageSize(). It was apparently not
called by anything, but was overridden by UnregisteredLocalFile.
* Wrap serialize/unserialize with File::getMetadataForDb() and
File::loadMetadataFromDb() in preparation for T275268.
In MediaHandler:
* Merged MediaHandler::getImageSize() and MediaHandler::getMetadata()
into getSizeAndMetadata(). Deprecated the old methods.
* Instead of isMetadataValid() we now have isFileMetadataValid(), which
only gets a File object, so it can decide what data it needs to load.
* Simplified getPageDimensions() by having it return false for non-paged
media. It was not called in that case, but was implemented anyway.
In specific handlers:
* Rename DjVuHandler::getUnserializedMetadata() and
extractTreesFromMetadata() for clarity. "Metadata" in these function
names meant an XML string.
* Updated DjVuImage::getImageSize() to provide image sizes in the new
style.
* In ExifBitmapHandler, getRotationForExif() now takes just the
Orientation tag, rather than a serialized string. Also renamed for
clarity.
* In GIFMetadataExtractor, return the width, height and bits per channel
instead of throwing them away. There was some conflation in
decodeBPP() which I picked apart. Refer to GIF89a section 18.
* In JpegMetadataExtractor, process the SOF0/SOF2 segment to extract
bits per channel, width, height and components (channel count). This
is essentially a port of PHP's getimagesize(), so should be bugwards
compatible.
* In PNGMetadataExtractor, return the width and height, which were
previously assigned to unused local variables. I verified the
implementation by referring to the specification.
* In SvgHandler, retain the version validation from unpackMetadata(),
but rename the function since it now takes an array as input.
In tests:
* In ExifBitmapTest, refactored some tests by using a provider.
* In GIFHandlerTest and PNGHandlerTest, I removed the tests in which
getMetadata() returns null, since it doesn't make sense when ported to
getMetadataArray(). I added tests for empty arrays instead.
* In tests, I retained serialization of input data since I figure it's
useful to confirm that existing database rows will continue to be read
correctly. I removed serialization of expected values, replacing them
with plain data.
* In tests, I replaced access to private class constants like
BROKEN_FILE with string literals, since stability is essential. If
the class constant changes, the test should fail.
Elsewhere:
* In maintenance/refreshImageMetadata.php, I removed the check for
shrinking image metadata, since it's not easy to implement and is
not future compatible. Image metadata is expected to shrink in
future.
Bug: T275268
Change-Id: I039785d5b6439d71dcc21dcb972177dba5c3a67d
2021-05-19 00:24:32 +00:00
|
|
|
|
'width' => 45,
|
|
|
|
|
|
'height' => 30,
|
|
|
|
|
|
'bits' => 1,
|
2013-02-15 10:17:52 +00:00
|
|
|
|
'xmp' => $xmpNugget,
|
|
|
|
|
|
'duration' => 2.4,
|
|
|
|
|
|
'frameCount' => 4,
|
|
|
|
|
|
'looped' => true,
|
2016-02-17 09:09:32 +00:00
|
|
|
|
'comment' => [ 'GIƒ·test·file' ],
|
|
|
|
|
|
]
|
|
|
|
|
|
],
|
|
|
|
|
|
];
|
2011-08-21 18:05:34 +00:00
|
|
|
|
}
|
|
|
|
|
|
}
|
