feat: extract City/State/Country from IPTC tags

docs/docs/features/reverse-geocoding.md

@@ -6,6 +6,8 @@ Immich supports local [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_
 
 During Exif Extraction, assets with latitudes and longitudes are reverse geocoded to determine their City, State, and Country.
 
+Note that if your assets already contain any of the IPTC tags (`City`, `Country-PrimaryLocationName`, `Province-State`), the reverse geocoding will not be performed and these tag values will be used instead
+
 ## Usage
 
 Data from a reverse geocode is displayed in the image details, and used in [Smart Search](/docs/features/searching.md).

server/src/interfaces/metadata.interface.ts

@@ -14,6 +14,9 @@ type TagsWithWrongTypes =
   | 'Duration'
   | 'Description'
   | 'ImageDescription'
+  | 'City'
+  | 'State'
+  | 'Country'
   | 'RegionInfo'
   | 'TagsList'
   | 'Keywords'
@@ -39,6 +42,9 @@ export interface ImmichTags extends Omit<Tags, TagsWithWrongTypes> {
   // Type is wrong, can also be number.
   Description?: StringOrNumber;
   ImageDescription?: StringOrNumber;
+  City?: StringOrNumber;
+  State?: StringOrNumber;
+  Country?: StringOrNumber;
 
   // Extended properties for image regions, such as faces
   RegionInfo?: {

server/src/services/metadata.service.spec.ts

@@ -364,6 +364,31 @@ describe(MetadataService.name, () => {
       });
     });
 
+    it('should use existing tags instead of geocoding', async () => {
+      assetMock.getByIds.mockResolvedValue([assetStub.withLocation]);
+      systemMock.get.mockResolvedValue({ reverseGeocoding: { enabled: true } });
+      mockReadTags({
+        GPSLatitude: assetStub.withLocation.exifInfo!.latitude!,
+        GPSLongitude: assetStub.withLocation.exifInfo!.longitude!,
+        City: 'City',
+        State: 'State',
+        Country: 'Country',
+      });
+
+      await sut.handleMetadataExtraction({ id: assetStub.image.id });
+      expect(assetMock.getByIds).toHaveBeenCalledWith([assetStub.image.id], { faces: { person: false } });
+      expect(assetMock.upsertExif).toHaveBeenCalledWith(
+        expect.objectContaining({ city: 'City', state: 'State', country: 'Country' }),
+      );
+      expect(assetMock.update).toHaveBeenCalledWith({
+        id: assetStub.withLocation.id,
+        duration: null,
+        fileCreatedAt: assetStub.withLocation.createdAt,
+        localDateTime: new Date('2023-02-22T05:06:29.716Z'),
+      });
+      expect(mapMock.reverseGeocode).not.toHaveBeenCalled();
+    });
+
     it('should discard latitude and longitude on null island', async () => {
       assetMock.getByIds.mockResolvedValue([assetStub.withLocation]);
       mockReadTags({

server/src/services/metadata.service.ts

@@ -629,6 +629,13 @@ export class MetadataService extends BaseService {
       longitude = null;
     }
 
+    const city = String(tags.City || '');
+    const state = String(tags.State || '');
+    const country = String(tags.Country || '');
+    if (city || state || country) {
+      return { city, state, country, latitude, longitude };
+    }
+
     let result: ReverseGeocodeResult = { country: null, state: null, city: null };
     if (reverseGeocoding.enabled && longitude && latitude) {
       result = await this.mapRepository.reverseGeocode({ latitude, longitude });