Skip to content

Commit

Permalink
Reduce the complexity of ImageServiceProvider.getMetadata()
Browse files Browse the repository at this point in the history
  • Loading branch information
@steinarb
steinarb committed Oct 9, 2023
1 parent b4e2fa5 commit 7f1d303
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 61 deletions.
148 changes: 87 additions & 61 deletions src/main/java/no/priv/bang/demos/frontendkarafdemo/ImageServiceProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,24 @@
import org.w3c.dom.NodeList;

import com.twelvemonkeys.imageio.metadata.CompoundDirectory;
import com.twelvemonkeys.imageio.metadata.Entry;
import com.twelvemonkeys.imageio.metadata.jpeg.JPEG;
import com.twelvemonkeys.imageio.metadata.jpeg.JPEGSegment;
import com.twelvemonkeys.imageio.metadata.tiff.IFD;
import com.twelvemonkeys.imageio.metadata.tiff.TIFFReader;

import static com.twelvemonkeys.imageio.metadata.jpeg.JPEGSegmentUtil.*;

import no.priv.bang.demos.frontendkarafdemo.beans.ImageMetadata;
import no.priv.bang.demos.frontendkarafdemo.beans.ImageMetadata.ImageMetadataBuilder;

@Component
public class ImageServiceProvider implements ImageService {

private static final int EXIF_DATETIME = 306;
private static final int EXIF_DESCRIPTION = 0x010e;
private static final int EXIF_EXIF = 34665;
private static final int EXIF_USER_COMMENT = 37510;
static final int EXIF_DATETIME = 306;
static final int EXIF_DESCRIPTION = 0x010e;
static final int EXIF_EXIF = 34665;
static final int EXIF_USER_COMMENT = 37510;
private HttpConnectionFactory connectionFactory;
private Logger logger;

Expand All @@ -50,68 +53,91 @@ public void setLogservice(LogService logservice) {
@Override
public ImageMetadata getMetadata(String imageUrl) {
if (imageUrl != null && !imageUrl.isEmpty()) {
try {
final var metadataBuilder = ImageMetadata.with();
var connection = getConnectionFactory().connect(imageUrl);
connection.setRequestMethod("GET");
try(var input = ImageIO.createImageInputStream(connection.getInputStream())) {
metadataBuilder.lastModified(new Date(connection.getLastModified()));
var readers = ImageIO.getImageReaders(input);
if (readers.hasNext()) {
var reader = readers.next();
try {
logger.info("reader class: {}", reader.getClass().getCanonicalName());
reader.setInput(input, true);
var metadata = reader.getImageMetadata(0);
metadataBuilder.description(findJfifComment(metadata));
} finally {
reader.dispose();
}
}
var exifSegment = readSegments(input, JPEG.APP1, "Exif");
exifSegment.stream().map(s -> s.data()).findFirst().ifPresent(exifData -> {
try {
exifData.read();
var exif = (CompoundDirectory) new TIFFReader().read(ImageIO.createImageInputStream(exifData));
for (var entry : exif) {
if (entry.getIdentifier().equals(EXIF_DATETIME)) {
var exifDateTimeFormat = new SimpleDateFormat("yyyy:MM:dd hh:mm:ss");
exifDateTimeFormat.setTimeZone(TimeZone.getTimeZone("Europe/Oslo"));
var datetime = exifDateTimeFormat.parse(entry.getValueAsString());
metadataBuilder.lastModified(datetime);
} else if (entry.getIdentifier().equals(EXIF_DESCRIPTION)) {
metadataBuilder.title(entry.getValueAsString());
} else if (entry.getIdentifier().equals(EXIF_EXIF)) {
var nestedExif = (IFD) entry.getValue();
for (var nestedEntry : nestedExif) {
if (nestedEntry.getIdentifier().equals(EXIF_USER_COMMENT)) {
var userCommentRaw = (byte[]) nestedEntry.getValue();
var splitUserComment = splitUserCommentInEncodingAndComment(userCommentRaw);
metadataBuilder.description(new String(splitUserComment.get(1), StandardCharsets.UTF_8));
}
}
}
}
} catch (IOException e) {
throw new RuntimeException(String.format("Error reading EXIF data of %s", imageUrl), e);
} catch (ParseException e) {
throw new RuntimeException(String.format("Error parsing EXIF 306/DateTime entry of %s", imageUrl), e);
}
});
return fetchImageWithHttpAndReadImageMetadata(imageUrl);
}

return null;
}

private ImageMetadata fetchImageWithHttpAndReadImageMetadata(String imageUrl) {
try {
final var metadataBuilder = ImageMetadata.with();
var connection = getConnectionFactory().connect(imageUrl);
connection.setRequestMethod("GET");
readAndParseImageMetadata(imageUrl, metadataBuilder, connection);

return metadataBuilder
.status(connection.getResponseCode())
.contentType(connection.getContentType())
.contentLength(getAndParseContentLengthHeader(connection))
.build();
} catch (IOException e) {
throw new RuntimeException(String.format("Error when reading metadata for %s", imageUrl), e);
}
}

private void readAndParseImageMetadata(String imageUrl, final ImageMetadataBuilder metadataBuilder, HttpURLConnection connection) {
try(var input = ImageIO.createImageInputStream(connection.getInputStream())) {
metadataBuilder.lastModified(new Date(connection.getLastModified()));
var readers = ImageIO.getImageReaders(input);
if (readers.hasNext()) {
var reader = readers.next();
try {
logger.info("reader class: {}", reader.getClass().getCanonicalName());
reader.setInput(input, true);
var metadata = reader.getImageMetadata(0);
metadataBuilder.description(findJfifComment(metadata));
} finally {
reader.dispose();
}
}
var exifSegment = readSegments(input, JPEG.APP1, "Exif");
readExifImageMetadata(imageUrl, metadataBuilder, exifSegment);
} catch (IOException e) {
throw new RuntimeException(String.format("Error when reading image metadata for %s", imageUrl), e);
}
}

void readExifImageMetadata(String imageUrl, final ImageMetadataBuilder metadataBuilder, List<JPEGSegment> exifSegment) throws IOException {
exifSegment.stream().map(s -> s.data()).findFirst().ifPresent(exifData -> {
try {
exifData.read();
var exif = (CompoundDirectory) new TIFFReader().read(ImageIO.createImageInputStream(exifData));
extractMetadataFromExifTags(metadataBuilder, exif, imageUrl);
} catch (IOException e) {
throw new RuntimeException(String.format("Error when reading image metadata for %s", imageUrl), e);
throw new RuntimeException(String.format("Error reading EXIF data of %s", imageUrl), e);
}
});
}

return metadataBuilder
.status(connection.getResponseCode())
.contentType(connection.getContentType())
.contentLength(getAndParseContentLengthHeader(connection))
.build();
} catch (IOException e) {
throw new RuntimeException(String.format("Error when reading metadata for %s", imageUrl), e);
private void extractMetadataFromExifTags(final ImageMetadataBuilder metadataBuilder, CompoundDirectory exif, String imageUrl) {
for (var entry : exif) {
if (entry.getIdentifier().equals(EXIF_DATETIME)) {
extractExifDatetime(metadataBuilder, entry, imageUrl);
} else if (entry.getIdentifier().equals(EXIF_DESCRIPTION)) {
metadataBuilder.title(entry.getValueAsString());
} else if (entry.getIdentifier().equals(EXIF_EXIF)) {
var nestedExif = (IFD) entry.getValue();
for (var nestedEntry : nestedExif) {
if (nestedEntry.getIdentifier().equals(EXIF_USER_COMMENT)) {
var userCommentRaw = (byte[]) nestedEntry.getValue();
var splitUserComment = splitUserCommentInEncodingAndComment(userCommentRaw);
metadataBuilder.description(new String(splitUserComment.get(1), StandardCharsets.UTF_8));
}
}
}
}
return null;
}

void extractExifDatetime(final ImageMetadataBuilder metadataBuilder, Entry entry, String imageUrl) {
try {
var exifDateTimeFormat = new SimpleDateFormat("yyyy:MM:dd hh:mm:ss");
exifDateTimeFormat.setTimeZone(TimeZone.getTimeZone("Europe/Oslo"));
var datetime = exifDateTimeFormat.parse(entry.getValueAsString());
metadataBuilder.lastModified(datetime);
} catch (ParseException e) {
throw new RuntimeException(String.format("Error parsing EXIF 306/DateTime entry of %s", imageUrl), e);
}
}

private String findJfifComment(IIOMetadata metadata) {
Expand Down
33 changes: 33 additions & 0 deletions src/test/java/no/priv/bang/demos/frontendkarafdemo/ImageServiceProviderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@
import static org.mockito.Mockito.*;

import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.Collections;
import java.util.Date;

import org.junit.jupiter.api.Test;

import com.twelvemonkeys.imageio.metadata.Entry;
import com.twelvemonkeys.imageio.metadata.jpeg.JPEGSegment;

import no.priv.bang.demos.frontendkarafdemo.beans.ImageMetadata;
import no.priv.bang.osgi.service.mocks.logservice.MockLogService;

class ImageServiceProviderTest {
Expand Down Expand Up @@ -161,6 +167,33 @@ void testGetMetadataWithIOExceptionWhenConnectingWithHttp() throws Exception {
assertThat(e.getMessage()).startsWith("Error when reading metadata for");
}

@Test
void testReadExifImageMetadataWithIOException() throws Exception {
var provider = new ImageServiceProvider();
var imageUrl = "http://localhost/image.jpg";
var builder = ImageMetadata.with();
var jpegSegment = mock(JPEGSegment.class);
var exifData = mock(InputStream.class);
when(exifData.read()).thenThrow(IOException.class);
when(jpegSegment.data()).thenReturn(exifData);
var exifSegment = Collections.singletonList(jpegSegment);

var e = assertThrows(RuntimeException.class, () -> provider.readExifImageMetadata(imageUrl, builder, exifSegment));
assertThat(e.getMessage()).startsWith("Error reading EXIF data of");
}

@Test
void testExtractExifDatetimeWithParseException() {
var provider = new ImageServiceProvider();
var builder = ImageMetadata.with();
var entry = mock(Entry.class);
when(entry.getValueAsString()).thenReturn("not a parsable date");
var imageUrl = "http://localhost/image.jpg";

var e = assertThrows(RuntimeException.class, () -> provider.extractExifDatetime(builder, entry, imageUrl));
assertThat(e.getMessage()).startsWith("Error parsing EXIF 306/DateTime entry of");
}

@Test
void testSplitUserCommentInEncodingAndComment() throws Exception {
byte[] userCommentRaw = {65, 83, 67, 73, 73, 0, 0, 0, 80, 114, 101, 116, 116, 121, 32, 114, 101, 100, 32, 108, 101, 97, 118, 101, 115};
Expand Down

0 comments on commit 7f1d303

Please sign in to comment.