Collect image dimensions from Europeana

catalog/dags/providers/provider_api_scripts/europeana.py

@@ -58,7 +58,7 @@ class EuropeanaRecordBuilder:
     This small class contains the record building functionality and simplifies testing.
     """
 
-    def get_record_data(self, data: dict) -> dict | None:
+    def get_record_data(self, data: dict, item_data: dict = {}) -> dict | None:
         try:
             record = {
                 "foreign_landing_url": self._get_foreign_landing_url(data),
@@ -67,7 +67,9 @@ def get_record_data(self, data: dict) -> dict | None:
                 "meta_data": self._get_meta_data_dict(data),
                 "title": self._get_title(data),
                 "license_info": self._get_license_info(data),
-            }
+                "filetype": self._get_filetype(item_data),
+                "filesize": self._get_filesize(item_data),
+            } | self._get_image_dimensions(item_data)
 
             data_providers = set(record["meta_data"]["dataProvider"])
             eligible_sub_providers = {
@@ -81,13 +83,12 @@ def get_record_data(self, data: dict) -> dict | None:
                     f"image with foreign ID {record['foreign_identifier']}"
                 )
 
-            return record | {
-                "source": (
-                    eligible_sub_providers.pop()
-                    if len(eligible_sub_providers) == 1
-                    else EuropeanaDataIngester.providers["image"]
-                )
-            }
+            record["source"] = (
+                eligible_sub_providers.pop()
+                if len(eligible_sub_providers) == 1
+                else EuropeanaDataIngester.providers["image"]
+            )
+            return {k: v for k, v in record.items() if v is not None}
         except EmptyRequiredFieldException as exc:
             logger.warning("A required field was empty", exc_info=exc)
             return None
@@ -129,6 +130,22 @@ def _get_foreign_landing_url(self, data: dict) -> str:
 
         return europeana_url
 
+    def _get_image_dimensions(self, item_data: dict) -> dict:
+        width = item_data.get("ebucoreWidth")
+        height = item_data.get("ebucoreHeight")
+        if width and height:
+            return {"width": width, "height": height}
+        return {}
+
+    def _get_filetype(self, item_data: dict) -> str:
+        if filetype := item_data.get("ebucoreHasMimeType"):
+            if "/" in filetype:
+                return item_data.get("ebucoreHasMimeType").split("/")[1]
+        return filetype
+
+    def _get_filesize(self, item_data: dict) -> int:
+        return item_data.get("ebucoreFileByteSize")
+
     def _get_meta_data_dict(self, data: dict) -> dict:
         meta_data = {
             "country": data.get("country"),
@@ -159,7 +176,7 @@ class EuropeanaDataIngester(ProviderDataIngester):
     providers = {"image": prov.EUROPEANA_DEFAULT_PROVIDER}
     sub_providers = prov.EUROPEANA_SUB_PROVIDERS
     endpoint = "https://api.europeana.eu/record/v2/search.json?"
-    delay = 30
+    delay = 3
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -188,6 +205,9 @@ def __init__(self, *args, **kwargs):
             "cursor": "*",
         }
 
+        self.item_params = {
+            "wskey": Variable.get("API_KEY_EUROPEANA", default_var=None)
+        }
         self.record_builder = EuropeanaRecordBuilder()
 
     def _get_timestamp_query_param(self, date):
@@ -223,7 +243,52 @@ def get_batch_data(self, response_json: dict) -> None | list[dict]:
         return response_json.get("items")
 
     def get_record_data(self, data: dict) -> dict:
-        return self.record_builder.get_record_data(data)
+        return self.record_builder.get_record_data(
+            data,
+            self._get_additional_item_data(data),
+        )
+
+    def _get_additional_item_data(self, data) -> dict:
+        # Delay of 30 seconds is fine for 100 items at a time, but not for each item.
+        # Occasionally getting this error on the item request when the delay is 3 secs:
+        # ConnectionError: ('Connection aborted.', RemoteDisconnected('Remote end closed
+        # connection without response'))
+        # But it always works on the next try so maybe that's ok?
+        # Options:
+        # - Switch to 3 second delay across the board and leave everything else alone,
+        #   or maybe add a max number of this kind of failure per batch or per dag run.
+        # - Separate delayed requesters 30 seconds for batch, 1 second for items, same
+        #   default batch size = 100.
+        # - Smaller batches (35), but default delay = 1 sec, like Brooklyn Museum.
+        # - Just go with defaults across the board, on the assumption that the batch
+        #   query is the expensive one, and there will be at least 30 seconds between,
+        #   given the 100 individual look-ups.
+        # Seems like might be best to reach out to Europeana and get their preference
+        # for the best way for us to proceed.
+        if not (item_id := data.get("id")):
+            logger.warning(f"No id, cannot request additional info on {data}")
+            return {}
+        item_response = self.get_response_json(
+            query_params=self.item_params,
+            endpoint=f"https://api.europeana.eu/record/v2{item_id}.json",
+        )
+        if not item_response or not item_response.get("success"):
+            logger.warning("Item request failed no response or ``success != True``")
+            return {}
+        # Assume that we just want the first info available in the item response,
+        # but consider adding checks, e.g. on landing url.
+        # Testing with the first webresource from the first aggregation, got dimensions
+        # for 1424 / 1589 images; so not too worried about performance implications of
+        # the loops. Limiting factor was much more the delay between requests.
+        if item_object := item_response.get("object"):
+            if aggregations := item_object.get("aggregations"):
+                for aggregation in aggregations:
+                    if webresources := aggregation.get("webResources"):
+                        for webresource in webresources:
+                            if filetype := webresource.get("ebucoreHasMimeType"):
+                                if filetype.startswith("image"):
+                                    return webresource
+        return {}
 
 
 def main(date):

catalog/tests/dags/providers/provider_api_scripts/resources/europeana/item_full.json

@@ -0,0 +1,202 @@
+{
+  "apikey": "test",
+  "success": true,
+  "statsDuration": 170,
+  "requestNumber": 999,
+  "object": {
+    "about": "/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+    "aggregations": [
+      {
+        "about": "/aggregation/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "edmDataProvider": {
+          "def": ["http://data.europeana.eu/organization/1482250000004511854"]
+        },
+        "edmIsShownBy": "https://images.memorix.nl/nda/thumb/fullsize/010a31d7-9316-54d7-6ad0-83b9914688d9.jpg",
+        "edmIsShownAt": "http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6",
+        "edmObject": "https://images.memorix.nl/nda/thumb/640x480/010a31d7-9316-54d7-6ad0-83b9914688d9.jpg",
+        "edmProvider": {
+          "def": ["http://data.europeana.eu/organization/1482250000004671093"]
+        },
+        "edmRights": {
+          "def": ["http://creativecommons.org/publicdomain/zero/1.0/"]
+        },
+        "edmUgc": "false",
+        "aggregatedCHO": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "webResources": [
+          {
+            "about": "https://images.memorix.nl/nda/thumb/640x480/010a31d7-9316-54d7-6ad0-83b9914688d9.jpg",
+            "textAttributionSnippet": " - https://www.europeana.eu/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6. Fotovlucht Vliegbasis Soesterberg. Nederlands Instituut voor Militaire Historie - http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6. CC0 - http://creativecommons.org/publicdomain/zero/1.0/",
+            "htmlAttributionSnippet": "<link rel='stylesheet' type='text/css' href='https://api.europeana.eu/attribution/style.css'/><dl class='europeana-attribution' lang='en'><dt>Creator</dt><dd lang=''>Fotovlucht Vliegbasis Soesterberg</dd><dt>Institution</dt><dd lang=''><a href='http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6' target='_blank' rel='noopener'>Nederlands Instituut voor Militaire Historie</a></dd><dt>Country</dt><dd lang=''>Netherlands</dd><dt>Rights</dt><dd><a href='http://creativecommons.org/publicdomain/zero/1.0/' target='_blank' rel='noopener'><span class='icon-cc'/><span class='icon-zero'/>CC0</a></dd></dl>",
+            "ebucoreHasMimeType": "image/jpeg",
+            "ebucoreFileByteSize": 36272,
+            "ebucoreWidth": 381,
+            "ebucoreHeight": 480,
+            "edmHasColorSpace": "sRGB",
+            "edmComponentColor": [
+              "#FF6347",
+              "#556B2F",
+              "#E9967A",
+              "#A0522D",
+              "#FFEBCD",
+              "#DAA520"
+            ],
+            "ebucoreOrientation": "portrait"
+          },
+          {
+            "about": "http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6",
+            "textAttributionSnippet": " - https://www.europeana.eu/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6. Fotovlucht Vliegbasis Soesterberg. Nederlands Instituut voor Militaire Historie - http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6. CC0 - http://creativecommons.org/publicdomain/zero/1.0/",
+            "htmlAttributionSnippet": "<link rel='stylesheet' type='text/css' href='https://api.europeana.eu/attribution/style.css'/><dl class='europeana-attribution' lang='en'><dt>Creator</dt><dd lang=''>Fotovlucht Vliegbasis Soesterberg</dd><dt>Institution</dt><dd lang=''><a href='http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6' target='_blank' rel='noopener'>Nederlands Instituut voor Militaire Historie</a></dd><dt>Country</dt><dd lang=''>Netherlands</dd><dt>Rights</dt><dd><a href='http://creativecommons.org/publicdomain/zero/1.0/' target='_blank' rel='noopener'><span class='icon-cc'/><span class='icon-zero'/>CC0</a></dd></dl>",
+            "ebucoreHasMimeType": "text/html",
+            "ebucoreFileByteSize": 0
+          },
+          {
+            "about": "https://images.memorix.nl/nda/thumb/fullsize/010a31d7-9316-54d7-6ad0-83b9914688d9.jpg",
+            "textAttributionSnippet": " - https://www.europeana.eu/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6. Fotovlucht Vliegbasis Soesterberg. Nederlands Instituut voor Militaire Historie - http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6. CC0 - http://creativecommons.org/publicdomain/zero/1.0/",
+            "htmlAttributionSnippet": "<link rel='stylesheet' type='text/css' href='https://api.europeana.eu/attribution/style.css'/><dl class='europeana-attribution' lang='en'><dt>Creator</dt><dd lang=''>Fotovlucht Vliegbasis Soesterberg</dd><dt>Institution</dt><dd lang=''><a href='http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6' target='_blank' rel='noopener'>Nederlands Instituut voor Militaire Historie</a></dd><dt>Country</dt><dd lang=''>Netherlands</dd><dt>Rights</dt><dd><a href='http://creativecommons.org/publicdomain/zero/1.0/' target='_blank' rel='noopener'><span class='icon-cc'/><span class='icon-zero'/>CC0</a></dd></dl>",
+            "dctermsIsReferencedBy": [
+              "https://iiif.europeana.eu/presentation/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6/manifest"
+            ],
+            "ebucoreHasMimeType": "image/jpeg",
+            "ebucoreFileByteSize": 157858,
+            "ebucoreWidth": 795,
+            "ebucoreHeight": 1000,
+            "edmHasColorSpace": "sRGB",
+            "edmComponentColor": [
+              "#FFEBCD",
+              "#8B0000",
+              "#FFFAFA",
+              "#FFEFD5",
+              "#FFD700",
+              "#E9967A"
+            ],
+            "ebucoreOrientation": "portrait"
+          },
+          {
+            "about": "https://iiif.europeana.eu/presentation/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6/manifest",
+            "rdfType": "http://iiif.io/api/presentation/3#Manifest"
+          }
+        ]
+      }
+    ],
+    "edmDatasetName": ["2021650_Ag_NL_DigitaleCollectie_nimh"],
+    "europeanaAggregation": {
+      "about": "/aggregation/europeana/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+      "aggregatedCHO": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+      "edmCountry": {
+        "def": ["Netherlands"]
+      },
+      "edmLanguage": {
+        "def": ["nl"]
+      },
+      "edmPreview": "https://api.europeana.eu/thumbnail/v2/url.json?uri=https%3A%2F%2Fimages.memorix.nl%2Fnda%2Fthumb%2F640x480%2F010a31d7-9316-54d7-6ad0-83b9914688d9.jpg&type=IMAGE",
+      "edmLandingPage": "https://www.europeana.eu/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+      "dqvHasQualityAnnotation": [
+        "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6#contentTier",
+        "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6#metadataTier"
+      ]
+    },
+    "europeanaCollectionName": ["2021650_Ag_NL_DigitaleCollectie_nimh"],
+    "europeanaCompleteness": 10,
+    "organizations": [
+      {
+        "about": "http://data.europeana.eu/organization/1482250000004671093",
+        "prefLabel": {
+          "en": ["Dutch Collections for Europe"]
+        }
+      },
+      {
+        "about": "http://data.europeana.eu/organization/1482250000004511854",
+        "prefLabel": {
+          "en": ["Netherlands Institute for Military History"],
+          "nl": ["Nederlands Instituut voor Militaire Historie"]
+        }
+      }
+    ],
+    "providedCHOs": [
+      {
+        "about": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+      }
+    ],
+    "proxies": [
+      {
+        "about": "/proxy/europeana/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "dcIdentifier": {
+          "def": [
+            "http://nimh-beeldbank.defensie.nl/memorix/0000ee69-1b9e-6823-478f-c88af61736c6"
+          ]
+        },
+        "proxyIn": [
+          "/aggregation/europeana/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+        ],
+        "proxyFor": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "lineage": [
+          "/proxy/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+        ],
+        "europeanaProxy": true
+      },
+      {
+        "about": "/proxy/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "dcCreator": {
+          "def": ["Fotovlucht Vliegbasis Soesterberg"]
+        },
+        "dcDescription": {
+          "def": [
+            "Een Agusta Bell AB-412SP van 303 Squadron boven het betonningsvaartuig Terschelling (1988-) van Rijkswaterstaat, ingedeeld bij de Kustwacht, tijdens de\n          reddingsoefening 'Get Wet'.&nbsp;",
+            "Een Agusta Bell AB-412SP van het 303 squadron van de Koninklijke Luchtmacht hangt boven het schip de 'Terschelling' van de kustwacht, tijdens de oefening 'Get wet' boven de\n          Noordzee."
+          ]
+        },
+        "dcIdentifier": {
+          "def": ["2156_018660"]
+        },
+        "dcSubject": {
+          "def": [
+            "R-02",
+            "Koninklijke Luchtmacht, squadrons Koninklijke Luchtmacht, 303 Squadron (KLu)",
+            "kustwacht"
+          ]
+        },
+        "dcType": {
+          "def": ["Digitaal fotobestand"]
+        },
+        "dctermsCreated": {
+          "def": ["2003-09-03 /"]
+        },
+        "dctermsIsPartOf": {
+          "def": ["Luchtfotoarchief Vliegbasis Soesterberg"]
+        },
+        "dctermsSpatial": {
+          "def": ["Noordzee, Nederland"]
+        },
+        "proxyIn": [
+          "/aggregation/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+        ],
+        "proxyFor": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6",
+        "edmType": "IMAGE",
+        "europeanaProxy": false
+      }
+    ],
+    "qualityAnnotations": [
+      {
+        "about": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6#contentTier",
+        "created": "2023-08-01T14:07:27.421851Z",
+        "target": [
+          "/aggregation/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+        ],
+        "body": "http://www.europeana.eu/schemas/epf/contentTier2"
+      },
+      {
+        "about": "/item/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6#metadataTier",
+        "created": "2023-08-01T14:07:27.421873Z",
+        "target": [
+          "/aggregation/provider/2021650/memorix_0000ee69_1b9e_6823_478f_c88af61736c6"
+        ],
+        "body": "http://www.europeana.eu/schemas/epf/metadataTier0"
+      }
+    ],
+    "timestamp_created": "2022-03-02T15:35:41.563Z",
+    "timestamp_created_epoch": 1646235341563,
+    "timestamp_update": "2023-08-01T14:02:32.057Z",
+    "timestamp_update_epoch": 1690898552057,
+    "type": "IMAGE"
+  }
+}