fix(deps): exiftool-vendored

immich-app · Jul 24, 2024 · ea0de04 · ea0de04
1 parent 2179f83
commit ea0de04
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 62 deletions.
diff --git a/e2e/src/api/specs/asset.e2e-spec.ts b/e2e/src/api/specs/asset.e2e-spec.ts
@@ -1137,7 +1137,7 @@ describe('/asset', () => {
           type: AssetTypeEnum.Image,
           originalFileName: '14bit-uncompressed-(3_2).arw',
           resized: true,
-          fileCreatedAt: '2016-01-08T15:08:01.000Z',
+          fileCreatedAt: '2016-01-08T14:08:01.000Z',
           exifInfo: {
             make: 'SONY',
             model: 'ILCE-7M2',
@@ -1149,7 +1149,7 @@ describe('/asset', () => {
             iso: 100,
             lensModel: 'E 25mm F2',
             fileSizeInByte: 49_512_448,
-            dateTimeOriginal: '2016-01-08T15:08:01.000Z',
+            dateTimeOriginal: '2016-01-08T14:08:01.000Z',
             latitude: null,
             longitude: null,
             orientation: '1',

diff --git a/server/package-lock.json b/server/package-lock.json
diff --git a/server/package.json b/server/package.json
@@ -60,7 +60,7 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "cookie-parser": "^1.4.6",
-    "exiftool-vendored": "26.0.0",
+    "exiftool-vendored": "^28.1.0",
     "fast-glob": "^3.3.2",
     "fluent-ffmpeg": "^2.1.2",
     "geo-tz": "^8.0.0",

diff --git a/server/src/repositories/metadata.repository.ts b/server/src/repositories/metadata.repository.ts
@@ -1,6 +1,6 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
-import { DefaultReadTaskOptions, Tags, exiftool } from 'exiftool-vendored';
+import { DefaultReadTaskOptions, ExifTool, Tags } from 'exiftool-vendored';
 import geotz from 'geo-tz';
 import { DummyValue, GenerateSql } from 'src/decorators';
 import { ExifEntity } from 'src/entities/exif.entity';
@@ -12,6 +12,19 @@ import { Repository } from 'typeorm';
 @Instrumentation()
 @Injectable()
 export class MetadataRepository implements IMetadataRepository {
+  private exiftool = new ExifTool({
+    defaultVideosToUTC: true,
+    backfillTimezones: true,
+    inferTimezoneFromDatestamps: true,
+    useMWG: true,
+    numericTags: [...DefaultReadTaskOptions.numericTags, 'FocalLength'],
+    /* eslint unicorn/no-array-callback-reference: off, unicorn/no-array-method-this-argument: off */
+    geoTz: (lat, lon) => geotz.find(lat, lon)[0],
+    // Enable exiftool LFS to parse metadata for files larger than 2GB.
+    readArgs: ['-api', 'largefilesupport=1'],
+    writeArgs: ['-api', 'largefilesupport=1', '-overwrite_original'],
+  });
+
   constructor(
     @InjectRepository(ExifEntity) private exifRepository: Repository<ExifEntity>,
     @Inject(ILoggerRepository) private logger: ILoggerRepository,
@@ -20,37 +33,23 @@ export class MetadataRepository implements IMetadataRepository {
   }
 
   async teardown() {
-    await exiftool.end();
+    await this.exiftool.end();
   }
 
   readTags(path: string): Promise<ImmichTags | null> {
-    return exiftool
-      .read(path, undefined, {
-        ...DefaultReadTaskOptions,
-
-        // Enable exiftool LFS to parse metadata for files larger than 2GB.
-        optionalArgs: ['-api', 'largefilesupport=1'],
-        defaultVideosToUTC: true,
-        backfillTimezones: true,
-        inferTimezoneFromDatestamps: true,
-        useMWG: true,
-        numericTags: [...DefaultReadTaskOptions.numericTags, 'FocalLength'],
-        /* eslint unicorn/no-array-callback-reference: off, unicorn/no-array-method-this-argument: off */
-        geoTz: (lat, lon) => geotz.find(lat, lon)[0],
-      })
-      .catch((error) => {
-        this.logger.warn(`Error reading exif data (${path}): ${error}`, error?.stack);
-        return null;
-      }) as Promise<ImmichTags | null>;
+    return this.exiftool.read(path).catch((error) => {
+      this.logger.warn(`Error reading exif data (${path}): ${error}`, error?.stack);
+      return null;
+    }) as Promise<ImmichTags | null>;
   }
 
   extractBinaryTag(path: string, tagName: string): Promise<Buffer> {
-    return exiftool.extractBinaryTagToBuffer(tagName, path);
+    return this.exiftool.extractBinaryTagToBuffer(tagName, path);
   }
 
   async writeTags(path: string, tags: Partial<Tags>): Promise<void> {
     try {
-      await exiftool.write(path, tags, ['-overwrite_original']);
+      await this.exiftool.write(path, tags);
     } catch (error) {
       this.logger.warn(`Error writing exif data (${path}): ${error}`);
     }

diff --git a/server/src/services/metadata.service.ts b/server/src/services/metadata.service.ts
@@ -1,5 +1,5 @@
 import { Inject, Injectable } from '@nestjs/common';
-import { ExifDateTime, Tags } from 'exiftool-vendored';
+import { ContainerDirectoryItem, ExifDateTime, Tags } from 'exiftool-vendored';
 import { firstDateTime } from 'exiftool-vendored/dist/FirstDateTime';
 import _ from 'lodash';
 import { Duration } from 'luxon';
@@ -48,17 +48,6 @@ const EXIF_DATE_TAGS: Array<keyof Tags> = [
   'DateTimeCreated',
 ];
 
-interface DirectoryItem {
-  Length?: number;
-  Mime: string;
-  Padding?: number;
-  Semantic?: string;
-}
-
-interface DirectoryEntry {
-  Item: DirectoryItem;
-}
-
 export enum Orientation {
   Horizontal = '1',
   MirrorHorizontal = '2',
@@ -362,13 +351,14 @@ export class MetadataService implements OnEvents {
       return;
     }
 
-    const rawDirectory = tags.Directory;
     const isMotionPhoto = tags.MotionPhoto;
     const isMicroVideo = tags.MicroVideo;
     const videoOffset = tags.MicroVideoOffset;
     const hasMotionPhotoVideo = tags.MotionPhotoVideo;
     const hasEmbeddedVideoFile = tags.EmbeddedVideoType === 'MotionPhoto_Data' && tags.EmbeddedVideoFile;
-    const directory = Array.isArray(rawDirectory) ? (rawDirectory as DirectoryEntry[]) : null;
+    const directory = Array.isArray(tags.ContainerDirectory)
+      ? (tags.ContainerDirectory as ContainerDirectoryItem[])
+      : null;
 
     let length = 0;
     let padding = 0;