7 class XMPTest
extends PHPUnit\Framework\TestCase
{
9 use MediaWikiCoversValidator
;
11 protected function setUp() {
13 # Requires libxml to do XMP parsing
14 if ( !extension_loaded( 'exif' ) ) {
15 $this->markTestSkipped( "PHP extension 'exif' is not loaded, skipping." );
20 * Put XMP in, compare what comes out...
22 * @param string $xmp The actual xml data.
23 * @param array $expected Expected result of parsing the xmp.
24 * @param string $info Short sentence on what's being tested.
27 * @dataProvider provideXMPParse
29 * @covers XMPReader::parse
31 public function testXMPParse( $xmp, $expected, $info ) {
32 if ( !is_string( $xmp ) ||
!is_array( $expected ) ) {
33 throw new Exception( "Invalid data provided to " . __METHOD__
);
35 $reader = new XMPReader
;
36 $reader->parse( $xmp );
37 $this->assertEquals( $expected, $reader->getResults(), $info, 0.0000000001 );
40 public static function provideXMPParse() {
41 $xmpPath = __DIR__
. '/../../../data/xmp/';
44 // $xmpFiles format: array of arrays with first arg file base name,
45 // with the actual file having .xmp on the end for the xmp
46 // and .result.php on the end for a php file containing the result
47 // array. Second argument is some info on what's being tested.
49 [ '1', 'parseType=Resource test' ],
50 [ '2', 'Structure with mixed attribute and element props' ],
51 [ '3', 'Extra qualifiers (that should be ignored)' ],
52 [ '3-invalid', 'Test ignoring qualifiers that look like normal props' ],
53 [ '4', 'Flash as qualifier' ],
54 [ '5', 'Flash as qualifier 2' ],
55 [ '6', 'Multiple rdf:Description' ],
56 [ '7', 'Generic test of several property types' ],
57 [ 'flash', 'Test of Flash property' ],
58 [ 'invalid-child-not-struct', 'Test child props not in struct or ignored' ],
59 [ 'no-recognized-props', 'Test namespace and no recognized props' ],
60 [ 'no-namespace', 'Test non-namespaced attributes are ignored' ],
61 [ 'bag-for-seq', "Allow bag's instead of seq's. (T29105)" ],
62 [ 'utf16BE', 'UTF-16BE encoding' ],
63 [ 'utf16LE', 'UTF-16LE encoding' ],
64 [ 'utf32BE', 'UTF-32BE encoding' ],
65 [ 'utf32LE', 'UTF-32LE encoding' ],
66 [ 'xmpExt', 'Extended XMP missing second part' ],
67 [ 'gps', 'Handling of exif GPS parameters in XMP' ],
70 $xmpFiles[] = [ 'doctype-included', 'XMP includes doctype' ];
72 foreach ( $xmpFiles as $file ) {
73 $xmp = file_get_contents( $xmpPath . $file[0] . '.xmp' );
74 // I'm not sure if this is the best way to handle getting the
75 // result array, but it seems kind of big to put directly in the test
78 include $xmpPath . $file[0] . '.result.php';
79 $data[] = [ $xmp, $result, '[' . $file[0] . '.xmp] ' . $file[1] ];
85 /** Test ExtendedXMP block support. (Used when the XMP has to be split
86 * over multiple jpeg segments, due to 64k size limit on jpeg segments.
88 * @todo This is based on what the standard says. Need to find a real
89 * world example file to double check the support for this is right.
91 * @covers XMPReader::parseExtended
93 public function testExtendedXMP() {
94 $xmpPath = __DIR__
. '/../../../data/xmp/';
95 $standardXMP = file_get_contents( $xmpPath . 'xmpExt.xmp' );
96 $extendedXMP = file_get_contents( $xmpPath . 'xmpExt2.xmp' );
98 $md5sum = '28C74E0AC2D796886759006FBE2E57B7'; // of xmpExt2.xmp
99 $length = pack( 'N', strlen( $extendedXMP ) );
100 $offset = pack( 'N', 0 );
101 $extendedPacket = $md5sum . $length . $offset . $extendedXMP;
103 $reader = new XMPReader();
104 $reader->parse( $standardXMP );
105 $reader->parseExtended( $extendedPacket );
106 $actual = $reader->getResults();
110 'DigitalZoomRatio' => '0/10',
116 $this->assertEquals( $expected, $actual );
120 * This test has an extended XMP block with a wrong guid (md5sum)
121 * and thus should only return the StandardXMP, not the ExtendedXMP.
123 * @covers XMPReader::parseExtended
125 public function testExtendedXMPWithWrongGUID() {
126 $xmpPath = __DIR__
. '/../../../data/xmp/';
127 $standardXMP = file_get_contents( $xmpPath . 'xmpExt.xmp' );
128 $extendedXMP = file_get_contents( $xmpPath . 'xmpExt2.xmp' );
130 $md5sum = '28C74E0AC2D796886759006FBE2E57B9'; // Note last digit.
131 $length = pack( 'N', strlen( $extendedXMP ) );
132 $offset = pack( 'N', 0 );
133 $extendedPacket = $md5sum . $length . $offset . $extendedXMP;
135 $reader = new XMPReader();
136 $reader->parse( $standardXMP );
137 $reader->parseExtended( $extendedPacket );
138 $actual = $reader->getResults();
142 'DigitalZoomRatio' => '0/10',
147 $this->assertEquals( $expected, $actual );
151 * Have a high offset to simulate a missing packet,
152 * which should cause it to ignore the ExtendedXMP packet.
154 * @covers XMPReader::parseExtended
156 public function testExtendedXMPMissingPacket() {
157 $xmpPath = __DIR__
. '/../../../data/xmp/';
158 $standardXMP = file_get_contents( $xmpPath . 'xmpExt.xmp' );
159 $extendedXMP = file_get_contents( $xmpPath . 'xmpExt2.xmp' );
161 $md5sum = '28C74E0AC2D796886759006FBE2E57B7'; // of xmpExt2.xmp
162 $length = pack( 'N', strlen( $extendedXMP ) );
163 $offset = pack( 'N', 2048 );
164 $extendedPacket = $md5sum . $length . $offset . $extendedXMP;
166 $reader = new XMPReader();
167 $reader->parse( $standardXMP );
168 $reader->parseExtended( $extendedPacket );
169 $actual = $reader->getResults();
173 'DigitalZoomRatio' => '0/10',
178 $this->assertEquals( $expected, $actual );
182 * Test for multi-section, hostile XML
183 * @covers XMPReader::checkParseSafety
185 public function testCheckParseSafety() {
186 // Test for detection
187 $xmpPath = __DIR__
. '/../../../data/xmp/';
188 $file = fopen( $xmpPath . 'doctype-included.xmp', 'rb' );
190 $reader = new XMPReader();
192 $chunk = fread( $file, 10 );
193 $valid = $reader->parse( $chunk, feof( $file ) );
194 } while ( !feof( $file ) );
195 $this->assertFalse( $valid, 'Check that doctype is detected in fragmented XML' );
198 $reader->getResults(),
199 'Check that doctype is detected in fragmented XML'
204 // Test for false positives
205 $file = fopen( $xmpPath . 'doctype-not-included.xmp', 'rb' );
207 $reader = new XMPReader();
209 $chunk = fread( $file, 10 );
210 $valid = $reader->parse( $chunk, feof( $file ) );
211 } while ( !feof( $file ) );
214 'Check for false-positive detecting doctype in fragmented XML'
219 'DigitalZoomRatio' => '0/10',
223 $reader->getResults(),
224 'Check that doctype is detected in fragmented XML'