Merge branch 'spring-2024' into issue-26

Author: glenrobson

.gitignore

@@ -58,3 +58,12 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# Cache dir
+cache/
+
+# PyCharm
+.idea/
+
+# Old folder from v2?
+media/

iiify/app.py

@@ -8,7 +8,7 @@
 from flask_caching import Cache
 from iiif2 import iiif, web
 from .resolver import ia_resolver, create_manifest, create_manifest3, getids, collection, \
-    purify_domain, cantaloupe_resolver, create_collection3, IsCollection
+    purify_domain, cantaloupe_resolver, create_collection3, IsCollection, create_annotations
 from .configs import options, cors, approot, cache_root, media_root, \
     cache_expr, version, image_server, cache_timeouts
 from urllib.parse import quote
@@ -17,7 +17,7 @@
 app = Flask(__name__)
 # disabling sorting of the output json
 app.config['JSON_SORT_KEYS'] = False
-app.config['CACHE_TYPE'] = "FileSystemCache"
+app.config['CACHE_TYPE'] = "FileSystemCache" if os.environ.get("FLASK_CACHE_DISABLE", None) != "true" else "NullCache"
 app.config['CACHE_DIR'] = "cache"
 cors = CORS(app) if cors else None
 cache = Cache(app)
@@ -191,6 +191,11 @@ def manifest3(identifier):
         raise excpt
         # abort(404)
 
+@app.route('/iiif/<version>/annotations/<identifier>/<fileName>/<canvas_no>.json')
+@cache.cached(timeout=cache_timeouts["long"], forced_update=cache_bust)
+def annnotations(version, identifier, fileName, canvas_no):
+    domain = purify_domain(request.args.get('domain', request.url_root))
+    return ldjsonify(create_annotations(version, identifier, fileName, canvas_no, domain=domain))
 
 @app.route('/iiif/<identifier>/manifest.json')
 @cache.cached(timeout=cache_timeouts["long"], forced_update=cache_bust)

iiify/resolver.py

@@ -6,6 +6,7 @@
 
 from .configs import options, cors, approot, cache_root, media_root, apiurl, LINKS
 from iiif_prezi3 import Manifest, config, Annotation, AnnotationPage,AnnotationPageRef, Canvas, Manifest, ResourceItem, ServiceItem, Choice, Collection, ManifestRef, CollectionRef
+
 from urllib.parse import urlparse, parse_qs, quote
 import json
 import math 
@@ -751,16 +752,27 @@ def create_annotations(version, identifier, fileName, canvas_no, domain=None):
         words = page.findall(".//WORD")
         count = 1
         for word in words:
+            # <WORD coords="444,1353,635,1294" x-confidence="10">[David </WORD>
+            # <WORD coords="lx,by,rx,ty" x-confidence="10">[David </WORD>
+            # x = lx
+            # y = ty
+            # w = rx - lx
+            # h = by - ty
+            (left_x, bottom_y, right_x, top_y) = word.attrib['coords'].split(',')
+            x = left_x
+            y = top_y
+            width = int(right_x) - int(left_x)
+            height = int(bottom_y) - int(top_y)
             annotationPage.items.append({
                 "id": f"https://iiif.archive.org/iiif/{identifier}/canvas/{index}/anno/{count}",
                 "type": "Annotation",
-                "motivation": "commenting",
+                "motivation": "supplementing",
                 "body": {
                     "type": "TextualBody",
                     "format": "text/plain",
                     "value": word.text
                 },
-                "target": f"https://iiif.archive.org/iiif/{identifier}${index}/canvas#xywh={word.attrib['coords']}"
+                "target": f"https://iiif.archive.org/iiif/{identifier}${index}/canvas#xywh={x},{y},{width},{height}"
             })
             count += 1
 
@@ -911,7 +923,6 @@ def cantaloupe_resolver(identifier):
 
         #filename = next(f for f in files if f['source'].lower() == 'derivative' \
         #                and f['name'].endswith('_jp2.zip'))['name']
-        print("end of logic - filename:", filename)
         if filename:
             dirpath = filename[:-4]
             filepath = f"{fileIdentifier}_{leaf.zfill(4)}{extension}"

tests/test_annotations.py

@@ -0,0 +1,57 @@
+import unittest
+from flask.testing import FlaskClient
+from iiify.app import app
+
+class TestAnnotations(unittest.TestCase):
+
+    def setUp(self) -> None:
+        self.test_app = FlaskClient(app)
+
+    def test_v3_manifest_has_annotations(self):
+        resp = self.test_app.get("/iiif/3/journalofexpedit00ford/manifest.json?recache=true")
+        self.assertEqual(resp.status_code, 200)
+        manifest = resp.json    
+
+        count = 1
+        for canvas in manifest['items']:
+            self.assertTrue('annotations' in canvas, f"Expected annotations in canvas {canvas['id']}")
+            annotations_url = f"https://localhost/iiif/3/annotations/journalofexpedit00ford/journalofexpedit00ford_djvu.xml/{count}.json"
+            found=False
+            for anno in canvas['annotations']:
+                if anno['id'] == annotations_url:
+                    found=True
+                self.assertFalse('items' in anno, "As a referenced AnnotationPage it shouldn't contain items.")     
+                self.assertTrue('type' in anno and anno['type'] == "AnnotationPage",f"Expected annotation page to have a type {anno}")
+
+            self.assertTrue(found, f"Expected to find {annotations_url} in {canvas['annotations']}")   
+            count += 1
+
+    def test_v3_annotations(self):
+        resp = self.test_app.get("/iiif/3/annotations/journalofexpedit00ford/journalofexpedit00ford_djvu.xml/1.json?recache=true")
+        self.assertEqual(resp.status_code, 200)
+        annotations = resp.json   
+
+        self.assertEqual(annotations['id'], "https://localhost/iiif/3/annotations/journalofexpedit00ford/journalofexpedit00ford_djvu.xml/1.json", "Unexpected id")
+        self.assertEqual(annotations['@context'], "http://iiif.io/api/presentation/3/context.json", "Unexpected context")
+        self.assertEqual(annotations['type'], "AnnotationPage", "Unexpected type, expected AnnotationPage")
+        annotationList = annotations['items']
+        self.assertEqual(len(annotationList), 6, "Unexpected number of annotations")
+
+        ids = []
+        first=True
+        for anno in annotationList:
+            self.assertTrue(anno['id'] not in ids,"Duplicate ID: {anno['id']}")
+            ids.append(anno['id'])
+            self.assertEqual(anno['type'], "Annotation", "Expected type of Annotation")
+            self.assertTrue("body" in anno and "target" in anno, "Body or target missing from annotation {anno}")
+            self.assertEqual(anno['body']['type'], "TextualBody", "Expected body to be a TextualBody")
+            self.assertEqual(anno['body']['format'], "text/plain", "Expected format to be a text/plain")
+            self.assertEqual(anno['target'].split('#')[0], "https://iiif.archive.org/iiif/journalofexpedit00ford$0/canvas")
+            if first:
+                self.assertEqual(anno['target'].split('#')[1],"xywh=592,1742,460,118")
+                self.assertEqual(anno['body']['value'],"JOURNAL ")
+
+            self.assertEqual(anno['motivation'], "supplementing", "Expected motivation of supplementing")
+            first=False
+
+            

tests/test_basic.py

@@ -1,3 +1,6 @@
+import os
+os.environ["FLASK_CACHE_DISABLE"] = "true"
+
 import unittest
 from flask.testing import FlaskClient
 from iiify.app import app
@@ -8,6 +11,7 @@ class TestBasic(unittest.TestCase):
     def setUp(self) -> None:
         self.test_app = FlaskClient(app)
 
+
     def test_documentation(self):
         resp = self.test_app.get("/iiif/documentation")
         self.assertEqual(resp.status_code, 200)

tests/test_cantaloupe_resolver.py

@@ -1,3 +1,6 @@
+import os
+os.environ["FLASK_CACHE_DISABLE"] = "true"
+
 import unittest
 from iiify.resolver import cantaloupe_resolver
 

tests/test_collections.py

@@ -1,7 +1,9 @@
+import os
+os.environ["FLASK_ENV"] = "testing"
+
 import unittest
 from flask.testing import FlaskClient
 from iiify.app import app
-
 class TestCollections(unittest.TestCase):
 
     def setUp(self) -> None:

tests/test_linking.py

@@ -1,3 +1,6 @@
+import os
+os.environ["FLASK_CACHE_DISABLE"] = "true"
+
 import unittest
 from flask.testing import FlaskClient
 from iiify.app import app

tests/test_manifests.py

@@ -1,3 +1,6 @@
+import os
+os.environ["FLASK_CACHE_DISABLE"] = "true"
+
 import unittest
 from flask.testing import FlaskClient
 from iiify.app import app

tests/test_manifests_v2.py

@@ -1,3 +1,6 @@
+import os
+os.environ["FLASK_CACHE_DISABLE"] = "true"
+
 import unittest
 from flask.testing import FlaskClient
 from iiify.app import app