ImageMetadataExtractorTest.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tika.parser.image;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import com.drew.lang.Rational;
import com.drew.metadata.Directory;
import com.drew.metadata.MetadataException;
import com.drew.metadata.Tag;
import com.drew.metadata.exif.ExifIFD0Directory;
import com.drew.metadata.exif.ExifSubIFDDirectory;
import com.drew.metadata.exif.GpsDirectory;
import com.drew.metadata.icc.IccDirectory;
import com.drew.metadata.jpeg.JpegCommentDirectory;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.metadata.TIFF;
import org.apache.tika.metadata.TikaCoreProperties;
public class ImageMetadataExtractorTest {
@SuppressWarnings({"rawtypes", "unchecked"})
@Test
public void testHandleDirectories() throws MetadataException {
Metadata metadata = Mockito.mock(Metadata.class);
ImageMetadataExtractor.DirectoryHandler handler1 =
Mockito.mock(ImageMetadataExtractor.DirectoryHandler.class);
ImageMetadataExtractor e = new ImageMetadataExtractor(metadata, handler1);
Directory directory = new JpegCommentDirectory();
Iterator directories = Mockito.mock(Iterator.class);
Mockito.when(directories.hasNext()).thenReturn(true, false);
Mockito.when(directories.next()).thenReturn(directory);
Mockito.when(handler1.supports(JpegCommentDirectory.class)).thenReturn(true);
e.handle(directories);
Mockito.verify(handler1).supports(JpegCommentDirectory.class);
Mockito.verify(handler1).handle(directory, metadata);
}
@Test
public void testExifHandlerSupports() {
assertTrue(new ImageMetadataExtractor.ExifHandler().supports(ExifIFD0Directory.class));
assertTrue(new ImageMetadataExtractor.ExifHandler().supports(ExifSubIFDDirectory.class));
assertFalse(new ImageMetadataExtractor.ExifHandler().supports(Directory.class));
assertFalse(new ImageMetadataExtractor.ExifHandler().supports(JpegCommentDirectory.class));
}
@Test
public void testExifHandlerParseDate() throws MetadataException {
ExifSubIFDDirectory exif = Mockito.mock(ExifSubIFDDirectory.class);
Mockito.when(exif.containsTag(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn(true);
Mockito.when(exif.getObject(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn("2000:01:01 00:00:00");
Metadata metadata = new Metadata();
new ImageMetadataExtractor.ExifHandler().handle(exif, metadata);
assertEquals("2000-01-01T00:00:00", metadata.get(TikaCoreProperties.CREATED),
"Should be ISO date without time zone");
}
@Test
public void testGeotagHandlerAltitude() throws MetadataException {
GpsDirectory gps = Mockito.mock(GpsDirectory.class);
Mockito.when(gps.getRational(GpsDirectory.TAG_ALTITUDE)).thenReturn(new Rational(2274, 10));
Mockito.when(gps.getInteger(GpsDirectory.TAG_ALTITUDE_REF)).thenReturn(0);
Metadata metadata = new Metadata();
new ImageMetadataExtractor.GeotagHandler().handle(gps, metadata);
assertEquals("227.4", metadata.get(TikaCoreProperties.ALTITUDE));
}
@Test
public void testGeotagHandlerAltitudeBelowSeaLevel() throws MetadataException {
GpsDirectory gps = Mockito.mock(GpsDirectory.class);
Mockito.when(gps.getRational(GpsDirectory.TAG_ALTITUDE)).thenReturn(new Rational(2274, 10));
Mockito.when(gps.getInteger(GpsDirectory.TAG_ALTITUDE_REF)).thenReturn(1);
Metadata metadata = new Metadata();
new ImageMetadataExtractor.GeotagHandler().handle(gps, metadata);
assertEquals("-227.4", metadata.get(TikaCoreProperties.ALTITUDE));
}
@Test
public void testExifHandlerParseDateFallback() throws MetadataException {
ExifIFD0Directory exif = Mockito.mock(ExifIFD0Directory.class);
Mockito.when(exif.containsTag(ExifIFD0Directory.TAG_DATETIME)).thenReturn(true);
Mockito.when(exif.getObject(ExifIFD0Directory.TAG_DATETIME)).thenReturn("1999:01:01 00:00:00");
Metadata metadata = new Metadata();
new ImageMetadataExtractor.ExifHandler().handle(exif, metadata);
assertEquals("1999-01-01T00:00:00", metadata.get(TikaCoreProperties.CREATED),
"Should try EXIF Date/Time if Original is not set");
}
@Test
public void testExifHandlerParseDateOutOfBounds() throws MetadataException {
ExifSubIFDDirectory exif = Mockito.mock(ExifSubIFDDirectory.class);
Mockito.when(exif.containsTag(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn(true);
Mockito.when(exif.getObject(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn("0004:12:31 23:00:00");
Metadata metadata = new Metadata();
new ImageMetadataExtractor.ExifHandler().handle(exif, metadata);
assertNull(metadata.get(TikaCoreProperties.CREATED));
assertNull(metadata.get(TIFF.ORIGINAL_DATE));
}
@Test
public void testExifHandlerParseDateError() throws MetadataException {
ExifIFD0Directory exif = Mockito.mock(ExifIFD0Directory.class);
Mockito.when(exif.containsTag(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn(true);
Mockito.when(exif.getObject(ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL)).thenReturn(" : : : : ");
Metadata metadata = new Metadata();
new ImageMetadataExtractor.ExifHandler().handle(exif, metadata);
assertNull(metadata.get(TikaCoreProperties.CREATED),
"Parsing should proceed without date");
}
@Test
public void testCopyUnknownFieldsHandler() throws MetadataException {
Directory d = Mockito.mock(Directory.class);
Tag t1 = Mockito.mock(Tag.class);
Mockito.when(t1.getTagName()).thenReturn("Image Description");
Mockito.when(t1.getDescription()).thenReturn("t1");
Tag t2 = Mockito.mock(Tag.class);
Mockito.when(t2.getTagName()).thenReturn(TikaCoreProperties.SUBJECT.toString());
Mockito.when(t2.getDescription()).thenReturn("known");
Tag t3 = Mockito.mock(Tag.class);
Mockito.when(t3.getTagName()).thenReturn(TikaCoreProperties.DESCRIPTION.getName());
Mockito.when(t3.getDescription()).thenReturn("known");
List<Tag> tags = Arrays.asList(t1, t2, t3);
Mockito.when(d.getTags()).thenReturn(tags);
Metadata metadata = new Metadata();
new ImageMetadataExtractor.CopyUnknownFieldsHandler().handle(d, metadata);
assertEquals("t1", metadata.get(ImageMetadataExtractor.UNKNOWN_IMG_NS + "Image Description"));
assertNull(metadata.get(TikaCoreProperties.SUBJECT),
"keywords should be excluded from bulk copy because it is a defined field");
assertNull(metadata.get(TikaCoreProperties.DESCRIPTION));
}
@Test
public void testIccCurvesSkippedUnlessConfigured() throws MetadataException {
List<Integer> described = new ArrayList<>();
IccDirectory d = new IccDirectory() {
@Override
public String getDescription(int tagType) {
described.add(tagType);
return super.getDescription(tagType);
}
};
d.setString(IccDirectory.TAG_COLOR_SPACE, "RGB ");
d.setByteArray(IccDirectory.TAG_TAG_desc, iccDesc("sRGB"));
d.setByteArray(IccDirectory.TAG_TAG_rTRC, iccCurve(2));
Metadata metadata = new Metadata();
new ImageMetadataExtractor.CopyUnknownFieldsHandler().handle(d, metadata);
assertEquals("RGB", metadata.get(ImageMetadataExtractor.ICC_NS + "Color space"));
assertEquals("sRGB", metadata.get(ImageMetadataExtractor.ICC_NS + "Profile Description"));
assertNull(metadata.get(ImageMetadataExtractor.ICC_NS + "Red TRC"));
//the skip happens before the curve is formatted, not after
assertFalse(described.contains(IccDirectory.TAG_TAG_rTRC));
ImageMetadataConfig config = new ImageMetadataConfig();
config.setIncludeIccCurvesAndLuts(true);
metadata = new Metadata();
new ImageMetadataExtractor.CopyUnknownFieldsHandler(config).handle(d, metadata);
assertEquals("sRGB", metadata.get(ImageMetadataExtractor.ICC_NS + "Profile Description"));
assertEquals("0.0, 1.0", metadata.get(ImageMetadataExtractor.ICC_NS + "Red TRC"));
}
@Test
public void testIccCurveSpecialCounts() {
assertEquals("1.0", ImageMetadataExtractor.CopyUnknownFieldsHandler.formatIccCurve(
iccCurveRaw(0)));
assertEquals("1.0", ImageMetadataExtractor.CopyUnknownFieldsHandler.formatIccCurve(
iccCurveRaw(1, (short) 0x0100)));
assertEquals("2.1992188", ImageMetadataExtractor.CopyUnknownFieldsHandler.formatIccCurve(
iccCurveRaw(1, (short) 0x0233)));
assertEquals("0.0, 0.4999924, 1.0",
ImageMetadataExtractor.CopyUnknownFieldsHandler.formatIccCurve(iccCurve(3)));
}
//ICC 'desc' tag: type, reserved, byte count including the NUL, ASCII, NUL
private static byte[] iccDesc(String text) {
byte[] ascii = text.getBytes(StandardCharsets.US_ASCII);
ByteBuffer b = ByteBuffer.allocate(12 + ascii.length + 1);
b.put("desc".getBytes(StandardCharsets.US_ASCII)).putInt(0).putInt(ascii.length + 1)
.put(ascii).put((byte) 0);
return b.array();
}
//ICC 'curv' tag: type, reserved, count, count uint16 samples spread over 0..1
static byte[] iccCurveRaw(int count, short... entries) {
ByteBuffer b = ByteBuffer.allocate(12 + 2 * entries.length);
b.put("curv".getBytes(StandardCharsets.US_ASCII)).putInt(0).putInt(count);
for (short e : entries) {
b.putShort(e);
}
return b.array();
}
static byte[] iccCurve(int count) {
ByteBuffer b = ByteBuffer.allocate(12 + 2 * count);
b.put("curv".getBytes(StandardCharsets.US_ASCII)).putInt(0).putInt(count);
for (int i = 0; i < count; i++) {
b.putShort((short) (65535L * i / (count - 1)));
}
return b.array();
}
}