Merge pull request #1207 from tomcrane/check-compliance-for-thumbnail

If canvas.thumbnail is level 0, don't use
ProjectMirador · Jan 4, 2017 · 128b479 · 128b479
2 parents a06570c + fd07b24
commit 128b479
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 12 deletions.
diff --git a/js/src/manifests/manifest.js b/js/src/manifests/manifest.js
@@ -81,6 +81,7 @@
     },
     getThumbnailForCanvas : function(canvas, width) {
       var version = "1.1",
+      compliance = -1,
       service,
       thumbnailUrl;
 
@@ -93,12 +94,20 @@
         if (typeof(canvas.thumbnail) == 'string') {
           thumbnailUrl = canvas.thumbnail;
         } else if (canvas.thumbnail.hasOwnProperty('service')) {
-          // Get the IIIF Image API via the @context
-          service = canvas.thumbnail.service;
-          if (service.hasOwnProperty('@context')) {
-            version = $.Iiif.getVersionFromContext(service['@context']);
-          }
-          thumbnailUrl = $.Iiif.makeUriWithWidth(service['@id'], width, version);
+            service = canvas.thumbnail.service;
+            if(service.hasOwnProperty('profile')) {
+               compliance = $.Iiif.getComplianceLevelFromProfile(service.profile);    
+            }
+            if(compliance === 0){
+                // don't change existing behaviour unless compliance is explicitly 0            
+                thumbnailUrl = canvas.thumbnail['@id'];
+            } else {
+                // Get the IIIF Image API via the @context
+                if (service.hasOwnProperty('@context')) {
+                    version = $.Iiif.getVersionFromContext(service['@context']);
+                }
+                thumbnailUrl = $.Iiif.makeUriWithWidth(service['@id'], width, version);
+            }
         } else {
           thumbnailUrl = canvas.thumbnail['@id'];
         }

diff --git a/js/src/utils/iiif.js b/js/src/utils/iiif.js
@@ -24,6 +24,32 @@
       }
     },
 
+    getComplianceLevelFromProfile: function(profile) {
+        // what to return if we can't determine profile? 0 is not a good idea
+        // would be better to have $.Iiif.supports(profile, feature) but that needs a lot more! 
+        var compliance = -1;
+        var complianceString = null;
+        if(profile) {
+            if(typeof(profile) === 'string'){
+                complianceString = profile;    
+            } else if (typeof(profile) === 'object'){
+               complianceString = profile[0];
+            }   
+            switch(complianceString){
+                case "http://iiif.io/api/image/2/level0.json":
+                    compliance = 0;
+                    break;
+                case "http://iiif.io/api/image/2/level1.json":
+                    compliance = 1;
+                    break;
+                case "http://iiif.io/api/image/2/level2.json":
+                    compliance = 2;
+                    break;
+            }
+        }
+        return compliance;
+    },
+
     makeUriWithWidth: function(uri, width, version) {
       uri = uri.replace(/\/$/, '');
       if (version[0] == '1') {

diff --git a/js/src/utils/utils.js b/js/src/utils/utils.js
@@ -22,6 +22,7 @@
 
   $.getThumbnailForCanvas = function(canvas, width) {
     var version = "1.1",
+    compliance = -1,
     service,
     thumbnailUrl;
 
@@ -34,13 +35,20 @@
       if (typeof(canvas.thumbnail) == 'string') {
         thumbnailUrl = canvas.thumbnail;
       } else if (canvas.thumbnail.hasOwnProperty('service')) {
-        // Get the IIIF Image API via the @context
         service = canvas.thumbnail.service;
-        if (service.hasOwnProperty('@context')) {
-          version = $.Iiif.getVersionFromContext(service['@context']);
-          console.log('version');
+        if(service.hasOwnProperty('profile')) {
+            compliance = $.Iiif.getComplianceLevelFromProfile(service.profile);    
+        }
+        if(compliance === 0){
+            // don't change existing behaviour unless compliance is explicitly 0            
+            thumbnailUrl = canvas.thumbnail['@id'];
+        } else {
+            // Get the IIIF Image API via the @context
+            if (service.hasOwnProperty('@context')) {
+                version = $.Iiif.getVersionFromContext(service['@context']);
+            }
+            thumbnailUrl = $.Iiif.makeUriWithWidth(service['@id'], width, version);
         }
-        thumbnailUrl = $.Iiif.makeUriWithWidth(service['@id'], width, version);
       } else {
         thumbnailUrl = canvas.thumbnail['@id'];
       }

diff --git a/spec/manifests/manifest.test.js b/spec/manifests/manifest.test.js
@@ -140,7 +140,25 @@ describe('Manifest', function() {
         expect(thumbnail).toEqual(thumbnailUrl);
       });
 
-      it('when canvas.thumbnail has a service', function () {
+
+      it('when canvas.thumbnail has a level 0 service', function () {
+        var thumbnailUrl = 'http://www.example.org/iiif/book1/thumbnail/p1.jpg';
+        var canvas = {
+          thumbnail: {
+            '@id': thumbnailUrl,
+            service: {
+              '@id': 'http://example.org/images/book1-page1',
+              profile: 'http://iiif.io/api/image/2/level0.json'
+            }
+          }
+        };
+        var manifestInstance = new Mirador.Manifest(null, null, {});
+        var thumbnail = manifestInstance.getThumbnailForCanvas(canvas);
+        expect(thumbnail).toEqual(thumbnailUrl);
+      });
+
+
+      it('when canvas.thumbnail has a level 1 or level 2 service', function () {
         var canvas = {
           thumbnail: {
             '@id': 'http://example.org/images/book1-page1/full/80,100/0/default.jpg',

diff --git a/spec/utils/iiif.test.js b/spec/utils/iiif.test.js
@@ -76,6 +76,35 @@ describe('Iiif', function () {
     });
   });
 
+  describe('getComplianceLevelFromProfile', function () {
+    it('should identify 0 from string', function() {
+      var profile = 'http://iiif.io/api/image/2/level0.json';
+      expect(Mirador.Iiif.getComplianceLevelFromProfile(profile)).toEqual(0);
+    });
+    it('should identify 2 from array', function() {
+      var profile = [
+        "http://iiif.io/api/image/2/level2.json",
+        {
+        "formats" : [ "gif", "pdf" ],
+        "qualities" : [ "color", "gray" ],
+        "supports" : [
+            "canonicalLinkHeader", "rotationArbitrary", "profileLinkHeader", "http://example.com/feature/"
+        ]
+        }
+      ];
+      expect(Mirador.Iiif.getComplianceLevelFromProfile(profile)).toEqual(2);
+    });
+    it('should return -1 for empty profile', function() {
+      var profile = null;
+      expect(Mirador.Iiif.getComplianceLevelFromProfile(profile)).toEqual(-1);
+    });
+    it('should return -1 for unrecognised profile', function() {
+      var profile = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0";
+      expect(Mirador.Iiif.getComplianceLevelFromProfile(profile)).toEqual(-1);
+    });
+  });
+
+
   describe('makeUriWithWidth', function () {
     it('should return native.jpg URL for IIIF v1.x', function() {
       expect(Mirador.Iiif.makeUriWithWidth('http://images.waahoo.com/iiif/MYTEST', 512, '1.1')).toEqual('http://images.waahoo.com/iiif/MYTEST/full/512,/0/native.jpg');