Skip to content

fix(server): allow clearing asset description to blank #26900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
saurav61091 wants to merge 1 commit into from
Closed

fix(server): allow clearing asset description to blank #26900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions server/src/services/metadata.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { constants } from 'node:fs/promises';
import { join, parse } from 'node:path';
import { JOBS_ASSET_PAGINATION_SIZE } from 'src/constants';
import { StorageCore } from 'src/cores/storage.core';
import { Asset, AssetFile } from 'src/database';
import { Asset, AssetFile, LockableProperty } from 'src/database';
import { OnEvent, OnJob } from 'src/decorators';
import {
AssetFileType,
Expand Down Expand Up @@ -459,10 +459,17 @@ export class MetadataService extends BaseService {
lockedProperties,
);

// exiftool treats empty strings as "delete field", which would cause the EXIF-embedded
// description to reappear on re-extraction. When the user has explicitly cleared the
// description, skip writing it to the sidecar and keep 'description' locked so that
// metadata extraction preserves the empty value from the database.
const descriptionCleared = description !== undefined && description === '';
const sidecarDescription = descriptionCleared ? undefined : description;

const exif = _.omitBy(
<Tags>{
Description: description,
ImageDescription: description,
Description: sidecarDescription,
ImageDescription: sidecarDescription,
DateTimeOriginal: mergeTimeZone(dateTimeOriginal, timeZone)?.toISO(),
GPSLatitude: latitude,
GPSLongitude: longitude,
Expand All @@ -472,17 +479,26 @@ export class MetadataService extends BaseService {
_.isUndefined,
);

if (Object.keys(exif).length === 0) {
// Properties that should remain locked because they cannot be represented in the sidecar
// (e.g. an empty description would be treated as "delete" by exiftool).
const keepLocked: LockableProperty[] = descriptionCleared ? ['description'] : [];
const propertiesToUnlock = lockedProperties.filter((p) => !keepLocked.includes(p));

if (Object.keys(exif).length === 0 && keepLocked.length === 0) {
return JobStatus.Skipped;
}

await this.metadataRepository.writeTags(sidecarPath, exif);
if (Object.keys(exif).length > 0) {
await this.metadataRepository.writeTags(sidecarPath, exif);

if (asset.files.length === 0) {
await this.assetRepository.upsertFile({ assetId: id, type: AssetFileType.Sidecar, path: sidecarPath });
if (asset.files.length === 0) {
await this.assetRepository.upsertFile({ assetId: id, type: AssetFileType.Sidecar, path: sidecarPath });
}
}

await this.assetRepository.unlockProperties(asset.id, lockedProperties);
if (propertiesToUnlock.length > 0) {
await this.assetRepository.unlockProperties(asset.id, propertiesToUnlock);
}

return JobStatus.Success;
}
Expand Down
Loading