Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-05-31 20:25:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(server) harden EXIF extraction (#1347)

Browse Source 
* chore(server) Harden EXIF extraction

* Remove unused function in timeutil

* Remove deadcode
This commit is contained in:
Alex 2023-01-17 13:41:00 -06:00 committed by GitHub
parent dff10e89fe
commit 3e4a14b299
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 45 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
server/apps/immich/src/api-v1/asset/asset.service.ts
View File

@ -188,16 +188,12 @@ export class AssetService {
isVisible: boolean, isVisible: boolean,
livePhotoAssetEntity?: AssetEntity, livePhotoAssetEntity?: AssetEntity,
): Promise<AssetEntity> { ): Promise<AssetEntity> {
// Check valid time. if (!timeUtils.checkValidTimestamp(createAssetDto.createdAt)) {
const createdAt = createAssetDto.createdAt; createAssetDto.createdAt = new Date().toISOString();
const modifiedAt = createAssetDto.modifiedAt;
if (!timeUtils.checkValidTimestamp(createdAt)) {
createAssetDto.createdAt = await timeUtils.getTimestampFromExif(originalPath);
} }
if (!timeUtils.checkValidTimestamp(modifiedAt)) { if (!timeUtils.checkValidTimestamp(createAssetDto.modifiedAt)) {
createAssetDto.modifiedAt = await timeUtils.getTimestampFromExif(originalPath); createAssetDto.modifiedAt = new Date().toISOString();
} }
const assetEntity = await this._assetRepository.create( const assetEntity = await this._assetRepository.create(

71
server/apps/microservices/src/processors/metadata-extraction.processor.ts
View File

@ -18,8 +18,7 @@ import { Repository } from 'typeorm/repository/Repository';
import geocoder, { InitOptions } from 'local-reverse-geocoder'; import geocoder, { InitOptions } from 'local-reverse-geocoder';
import { getName } from 'i18n-iso-countries'; import { getName } from 'i18n-iso-countries';
import fs from 'node:fs'; import fs from 'node:fs';
import { ExifDateTime, ExifTool } from 'exiftool-vendored'; import { ExifDateTime, exiftool } from 'exiftool-vendored';
import { timeUtils } from '@app/common';
function geocoderInit(init: InitOptions) { function geocoderInit(init: InitOptions) {
return new Promise<void>(function (resolve) { return new Promise<void>(function (resolve) {
@ -140,43 +139,52 @@ export class MetadataExtractionProcessor {
async extractExifInfo(job: Job<IExifExtractionProcessor>) { async extractExifInfo(job: Job<IExifExtractionProcessor>) {
try { try {
const { asset, fileName }: { asset: AssetEntity; fileName: string } = job.data; const { asset, fileName }: { asset: AssetEntity; fileName: string } = job.data;
const exiftool = new ExifTool();
const exifData = await exiftool.read(asset.originalPath).catch((e) => { const exifData = await exiftool.read(asset.originalPath).catch((e) => {
this.logger.warn(`The exifData parsing failed due to: ${e} on file ${asset.originalPath}`); this.logger.warn(`The exifData parsing failed due to: ${e} on file ${asset.originalPath}`);
return null;
}); });
const exifToDate = (exifDate: string | ExifDateTime | undefined) => const exifToDate = (exifDate: string | ExifDateTime | undefined) => {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion if (!exifDate) return null;
exifDate ? new Date(exifDate.toString()!) : null;
let createdAt = exifToDate(asset.createdAt); if (typeof exifDate === 'string') {
const newExif = new ExifEntity(); return new Date(exifDate);
if (exifData) { }
createdAt = exifToDate(exifData.DateTimeOriginal ?? exifData.CreateDate ?? asset.createdAt);
const modifyDate = exifToDate(exifData.ModifyDate); return exifDate.toDate();
newExif.make = exifData['Make'] || null; };
newExif.model = exifData['Model'] || null;
newExif.exifImageHeight = exifData['ExifImageHeight'] || exifData['ImageHeight'] || null; const getExposureTimeDenominator = (exposureTime: string | undefined) => {
newExif.exifImageWidth = exifData['ExifImageWidth'] || exifData['ImageWidth'] || null; if (!exposureTime) return null;
newExif.exposureTime = (await timeUtils.parseStringToNumber(exifData['ExposureTime'])) || null;
newExif.orientation = exifData['Orientation']?.toString() || null; const exposureTimeSplit = exposureTime.split('/');
newExif.dateTimeOriginal = createdAt; return exposureTimeSplit.length === 2 ? parseInt(exposureTimeSplit[1]) : null;
newExif.modifyDate = modifyDate || null; };
newExif.lensModel = exifData['LensModel'] || null;
newExif.fNumber = exifData['FNumber'] || null; const createdAt = exifToDate(exifData?.DateTimeOriginal ?? exifData?.CreateDate ?? asset.createdAt);
newExif.focalLength = (await timeUtils.parseStringToNumber(exifData['FocalLength'])) || null; const modifyDate = exifToDate(exifData?.ModifyDate ?? asset.modifiedAt);
newExif.iso = exifData['ISO'] || null;
newExif.latitude = exifData['GPSLatitude'] || null;
newExif.longitude = exifData['GPSLongitude'] || null;
} else {
newExif.dateTimeOriginal = createdAt;
newExif.modifyDate = exifToDate(asset.modifiedAt);
}
const fileStats = fs.statSync(asset.originalPath); const fileStats = fs.statSync(asset.originalPath);
const fileSizeInBytes = fileStats.size; const fileSizeInBytes = fileStats.size;
const newExif = new ExifEntity();
newExif.assetId = asset.id; newExif.assetId = asset.id;
newExif.imageName = path.parse(fileName).name || null; newExif.imageName = path.parse(fileName).name;
newExif.fileSizeInByte = fileSizeInBytes || null; newExif.fileSizeInByte = fileSizeInBytes;
newExif.make = exifData?.Make || null;
newExif.model = exifData?.Model || null;
newExif.exifImageHeight = exifData?.ExifImageHeight || exifData?.ImageHeight || null;
newExif.exifImageWidth = exifData?.ExifImageWidth || exifData?.ImageWidth || null;
newExif.exposureTime = getExposureTimeDenominator(exifData?.ExposureTime);
newExif.orientation = exifData?.Orientation?.toString() || null;
newExif.dateTimeOriginal = createdAt;
newExif.modifyDate = modifyDate;
newExif.lensModel = exifData?.LensModel || null;
newExif.fNumber = exifData?.FNumber || null;
newExif.focalLength = exifData?.FocalLength ? parseFloat(exifData.FocalLength) : null;
newExif.iso = exifData?.ISO || null;
newExif.latitude = exifData?.GPSLatitude || null;
newExif.longitude = exifData?.GPSLongitude || null;
await this.assetRepository.save({ await this.assetRepository.save({
id: asset.id, id: asset.id,
@ -217,7 +225,6 @@ export class MetadataExtractionProcessor {
} }
await this.exifRepository.save(newExif); await this.exifRepository.save(newExif);
await exiftool.end();
} catch (error: any) { } catch (error: any) {
this.logger.error(`Error extracting EXIF ${error}`, error?.stack); this.logger.error(`Error extracting EXIF ${error}`, error?.stack);
} }

35
server/libs/common/src/utils/time-utils.ts
View File

@ -1,12 +1,4 @@
// This is needed as resolving for the vendored
// exiftool fails in tests otherwise but as it's not meant to be a requirement
// of a project directly I had to include the line below the comment.
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
import { exiftool } from 'exiftool-vendored.pl';
function createTimeUtils() { function createTimeUtils() {
const floatRegex = /[+-]?([0-9]*[.])?[0-9]+/;
const checkValidTimestamp = (timestamp: string): boolean => { const checkValidTimestamp = (timestamp: string): boolean => {
const parsedTimestamp = Date.parse(timestamp); const parsedTimestamp = Date.parse(timestamp);
@ -23,32 +15,7 @@ function createTimeUtils() {
return date.getFullYear() > 0; return date.getFullYear() > 0;
}; };
const getTimestampFromExif = async (originalPath: string): Promise<string> => { return { checkValidTimestamp };
try {
const exifData = await exiftool.read(originalPath);
if (exifData && exifData['DateTimeOriginal']) {
await exiftool.end();
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return exifData['DateTimeOriginal'].toString()!;
} else {
return new Date().toISOString();
}
} catch (error) {
return new Date().toISOString();
}
};
const parseStringToNumber = async (original: string | undefined): Promise<number | null> => {
const match = original?.match(floatRegex)?.[0];
if (match) {
return parseFloat(match);
} else {
return null;
}
};
return { checkValidTimestamp, getTimestampFromExif, parseStringToNumber };
} }
export const timeUtils = createTimeUtils(); export const timeUtils = createTimeUtils();

2
web/src/lib/components/asset-viewer/detail-panel.svelte
View File

@ -152,7 +152,7 @@
<p>{`ƒ/${asset.exifInfo.fNumber.toLocaleString(locale)}` || ''}</p> <p>{`ƒ/${asset.exifInfo.fNumber.toLocaleString(locale)}` || ''}</p>
{#if asset.exifInfo.exposureTime} {#if asset.exifInfo.exposureTime}
<p>{`1/${Math.floor(1 / asset.exifInfo.exposureTime)}`}</p> <p>{`1/${asset.exifInfo.exposureTime}`}</p>
{/if} {/if}
{#if asset.exifInfo.focalLength} {#if asset.exifInfo.focalLength}