Allow delegate system to produce valid HTTP 401 info.json responses (#…

…580)
cantaloupe-project · Jun 1, 2022 · e60f33c · e60f33c
1 parent 017af48
commit e60f33c
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 7 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,6 +2,7 @@
 
 ## 5.0.6
 
+* IIIF information endpoints return JSON in HTTP 401 responses.
 * Fixed a bug whereby the values of the `operations` and `page_count` keys
   in the delegate context were not set.
 * TurboJpegProcessor is able to generate non-JPEG derivative images, which

diff --git a/src/main/java/edu/illinois/library/cantaloupe/resource/AbstractResource.java b/src/main/java/edu/illinois/library/cantaloupe/resource/AbstractResource.java
@@ -364,6 +364,9 @@ private boolean processAuthInfo(AuthInfo info)
             if (code == 401) {
                 getResponse().setHeader("WWW-Authenticate",
                         info.getChallengeValue());
+                if (getRequestContext().getLocalURI().getPath().endsWith("info.json")) {
+                    return true;
+                }
             }
             throw new ResourceException(new Status(code));
         }

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/ImageAPIResourceTester.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/ImageAPIResourceTester.java
@@ -51,7 +51,7 @@ public void testAuthorizationWhenAuthorized(URI uri) {
         assertStatus(200, uri);
     }
 
-    public void testAuthorizationWhenUnauthorized(URI uri) {
+    public void testAuthorizationWhenUnauthorized(URI uri, String endpointPath) {
         // This may vary depending on the return value of a delegate method,
         // but the way the tests are set up, it's 401.
         assertStatus(401, uri);

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/InformationResourceTester.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/InformationResourceTester.java
@@ -10,6 +10,7 @@
 import edu.illinois.library.cantaloupe.http.Response;
 import edu.illinois.library.cantaloupe.image.Identifier;
 import edu.illinois.library.cantaloupe.resource.AbstractResource;
+import edu.illinois.library.cantaloupe.resource.Route;
 import edu.illinois.library.cantaloupe.test.TestUtil;
 
 import java.io.File;
@@ -27,6 +28,20 @@
  */
 public class InformationResourceTester extends ImageAPIResourceTester {
 
+    @Override
+    public void testAuthorizationWhenUnauthorized(URI uri, String endpointPath) {
+        final String requiredJsonLdContent;
+
+        if (endpointPath.equals(Route.IIIF_1_PATH)) {
+            requiredJsonLdContent = "\"@context\":\"http://library.stanford.edu/iiif/image-api/1.1/context.json\"";
+        } else {
+            requiredJsonLdContent = "\"protocol\":\"http://iiif.io/api/image\"";
+        }
+
+        assertStatus(401, uri);
+        assertRepresentationContains(requiredJsonLdContent, uri);
+    }
+
     public void testCacheWithDerivativeCacheEnabledAndInfoCacheEnabledAndResolveFirstEnabled(
             URI uri, Path sourceFile) throws Exception {
         final Path cacheDir = initializeFilesystemCache();

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v1/ImageResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v1/ImageResourceTest.java
@@ -47,7 +47,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/full/full/0/color.jpg");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v1/InformationResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v1/InformationResourceTest.java
@@ -51,7 +51,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/info.json");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v2/ImageResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v2/ImageResourceTest.java
@@ -47,7 +47,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/full/full/0/color.jpg");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v2/InformationResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v2/InformationResourceTest.java
@@ -51,7 +51,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/info.json");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v3/ImageResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v3/ImageResourceTest.java
@@ -45,7 +45,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/full/max/0/color.jpg");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test

diff --git a/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v3/InformationResourceTest.java b/src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v3/InformationResourceTest.java
@@ -51,7 +51,7 @@ void testGETAuthorizationWhenAuthorized() {
     @Test
     void testGETAuthorizationWhenUnauthorized() {
         URI uri = getHTTPURI("/unauthorized.jpg/info.json");
-        tester.testAuthorizationWhenUnauthorized(uri);
+        tester.testAuthorizationWhenUnauthorized(uri, getEndpointPath());
     }
 
     @Test