Merge pull request #183 from IIIF/add-accept-header

Add accept header

Author: glenrobson

.github/workflows/deploy.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: docker login
       env:
         DOCKER_USER: ${{secrets.DOCKER_USER}}
@@ -33,15 +33,15 @@ jobs:
       run: docker logout
 
     - name: Configure AWS credentials
-      uses: aws-actions/configure-aws-credentials@v1
+      uses: aws-actions/configure-aws-credentials@v4
       with:
         aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
         aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         aws-region: us-east-1
 
     - name: Login to Amazon ECR
       id: login-ecr
-      uses: aws-actions/amazon-ecr-login@v1  
+      uses: aws-actions/amazon-ecr-login@v2  
 
     - name: Fill in the new image ID in the Amazon ECS task definition
       id: task-def
@@ -52,7 +52,7 @@ jobs:
         image: docker.io/glenrobson/iiif-presentation-validator:${{ github.sha }}
 
     - name: Deploy Amazon ECS task definition
-      uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+      uses: aws-actions/amazon-ecs-deploy-task-definition@v2
       with:
         task-definition: ${{ steps.task-def.outputs.task-definition }}
         service: PreziValidatorService

.github/workflows/test.yml

@@ -14,18 +14,21 @@ jobs:
         python-version: [ '3.9', '3.10', '3.11']
     name: Python ${{ matrix.python-version }} sample
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ${{ env.pythonLocation }}
           key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('dev-requirements.txt') }}
 
+      - name: Install setup tools
+        run: pip install setuptools
+
       - name: Install
         run: python setup.py install
 

iiif-presentation-validator.py

@@ -30,19 +30,24 @@
 from pyld import jsonld
 jsonld.set_document_loader(jsonld.requests_document_loader(timeout=60))
 
+IIIF_HEADER = "application/ld+json;profile=http://iiif.io/api/presentation/{iiif_version}/context.json"
+
 class Validator(object):
     """Validator class that runs with Bottle."""
 
     def __init__(self):
         """Initialize Validator with default_version."""
         self.default_version = "2.1"
 
-    def fetch(self, url):
+    def fetch(self, url, accept_header):
         """Fetch manifest from url."""
         req = Request(url)
         req.add_header('User-Agent', 'IIIF Validation Service')
         req.add_header('Accept-Encoding', 'gzip')
 
+        if accept_header:
+            req.add_header('Accept', accept_header)
+
         try:
             wh = urlopen(req)
         except HTTPError as wh:
@@ -150,13 +155,24 @@ def do_GET_test(self):
         """Implement GET request to test url at version."""
         url = request.query.get('url', '')
         version = request.query.get('version', self.default_version)
+        accept = request.query.get('accept')
+        accept_header = None
         url = url.strip()
         parsed_url = urlparse(url)
+
+        if accept and accept == 'true':
+            if version in ("2.0", "2.1"):
+                accept_header = IIIF_HEADER.format(iiif_version=2)
+            elif version in ("3.0",):
+                accept_header = IIIF_HEADER.format(iiif_version=3)
+            else:
+                accept_header = "application/json"
+
         if (parsed_url.scheme != 'http' and parsed_url.scheme != 'https'):
             return self.return_json({'okay': 0, 'error': 'URLs must use HTTP or HTTPS', 'url': url})
 
         try:
-            (data, webhandle) = self.fetch(url)
+            (data, webhandle) = self.fetch(url, accept_header)
         except Exception as error:
             return self.return_json({'okay': 0, 'error': 'Cannot fetch url. Got "{}"'.format(error), 'url': url})
 
@@ -236,6 +252,7 @@ def main():
     args = parser.parse_args()
 
     v = Validator()
+
     run(host=args.hostname, port=args.port, app=v.get_bottle_app())
 
 

index.html

@@ -53,7 +53,9 @@
 
           <section class="wrapper">
             <div>
-              This service will validate a IIIF Presentation API resource against the specification.  Fill in the URL of your manifest, and it will try to parse it and issue errors for failed requirements, and warnings for recommendations that haven't been followed.
+              This service will validate a IIIF Presentation API resource against the specification.  Fill in the URL
+              of your manifest, and it will try to parse it and issue errors for failed requirements, and warnings for
+              recommendations that haven't been followed.
             </div>
 
             <div style="border: 1px solid black;margin-left: 10px; margin-top: 20px; padding: 10px">
@@ -70,6 +72,8 @@
                   <option value="1.0">1.0</option>
                 </select>
                 <br/>
+                <input type="checkbox" id="accept" name="accept">
+                <label for="accept">Include <code>Accept</code> header in request for specified version</label><br />
 
                 <input type="submit" value="Go!" id="submit-url">
               </form>
@@ -85,13 +89,20 @@ <h3>Validation Results:</h3>
             <hr/>
 
             <div style="margin-top:20px">
-            <b>Technical Note</b>
+            <b>Technical Notes</b>
+              <p>
+                The <code>Accept</code> header option tells the validator to use <a href="https://tools.ietf.org/html/rfc7231#section-5.3.2">content negotiation</a>
+                to retrieve a manifest at a given URL. This may be used to retrieve manifests from service
+                providers that support content negotiation for switching between IIIF versions.
+              </p>
             <p>
             If you would like to use the validator programatically, there are two options:
             </p>
             <ul>
               <li><a href="https://github.com/IIIF/presentation-validator">Download</a> the code from github and run it locally.</li>
-              <li>Use it online with JSON based output, by an HTTP GET to this endpoint:<br/>https://presentation-validator.iiif.io/validate?version=2.1&amp;url=<i>manifest-url-here</i></li>
+              <li>Use it online with JSON based output, by an HTTP GET to this endpoint: <br/>
+                  http://iiif.io/api/presentation/validator/service/validate?version=2.1&amp;url=<i>manifest-url-here</i>&accept=<i>true|false</i>
+              </li>
             </ul>
             </div>
           </section>
@@ -115,25 +126,27 @@ <h3>Validation Results:</h3>
       // Call out to the validation service and get a result
       function handleSubmission(e) {
         e.preventDefault();
+
         var data = {
           url: $("input[name='url']").val(),
-          version: $("select[name='version']").val()
-        }
+          version: $("select[name='version']").val(),
+          accept: $("#accept").is(":checked"),
+        };
         $('#results-content').html('Processing ' + data.version + " validation...");
         $('#results').show();
         var url = $('#manifest-validation-form').attr("action");
-        $.getJSON(url,data,handleValidationResponse);
+        $.getJSON(url, data, handleValidationResponse);
       }
 
       // Handle validation service response, render response block
       function handleValidationResponse(data) {
-        str  = '<div style="margin-left: 20px">'
-        str += '<div>URL Tested: '+ data.url + '</div><br/>'
+        var str  = '<div style="margin-left: 20px">';
+        str += '<div>URL Tested: '+ data.url + '</div><br/>';
         if (data.okay) {
-          str += '<div><h2 style="color:green">Validated successfully</h2></div>'
+          str += '<div><h2 style="color:green">Validated successfully</h2></div>';
         } else {
             if (data.errorList) {
-                for (var i = 0; i < data.errorList.length; i++) {
+                for (var i = 0, len = data.errorList.length; i < len; i++) {
                     var error = data.errorList[i];
                     str+='<div>';
                     str+='<h2 style="color:red">' + error.title + '</h2>';
@@ -148,12 +161,12 @@ <h3>Validation Results:</h3>
                     str+='</div>';
                 }
             } else {
-                str += '<div><h2 style="color:red">Validation Error: '+data.error+'</h2></div>'
+                str += '<div><h2 style="color:red">Validation Error: '+data.error+'</h2></div>';
             }    
         }
         if (data.warnings && data.warnings.length){
           str += '<div style="margin-top: 20px">Warnings:<ul>';
-          for(var i =0; i < data.warnings.length; i++) {
+          for(var i =0, len = data.warnings.length; i < len; i++) {
             str+= '<li>'+data.warnings[i]+'</li>';
           }
           str += '</ul></div>';

tests/test_validator.py

@@ -67,9 +67,9 @@ def test01_get_bottle_app(self):
 
     def test02_fetch(self):
         v = val_mod.Validator()
-        (data, wh) = v.fetch('file:fixtures/1/manifest.json')
+        (data, wh) = v.fetch('file:fixtures/1/manifest.json', 'false')
         self.assertTrue(data.startswith('{'))
-        self.assertRaises(URLError, v.fetch, 'file:DOES_NOT_EXIST')
+        self.assertRaises(URLError, v.fetch, 'file:DOES_NOT_EXIST', 'false')
 
     def test03_check_manifest(self):
         v = val_mod.Validator()
@@ -126,6 +126,21 @@ def test05_do_GET_test(self):
         v.fetch = Mock(return_value=(read_fixture('fixtures/1/manifest.json'), MockWebHandle()))
         j = json.loads(v.do_GET_test())
         self.assertEqual(j['okay'], 0)
+        # Check v3 requests pass
+        request = LocalRequest({'QUERY_STRING': 'version=3.0&url=https://a.b/&accept=true'})
+        v.fetch = Mock(return_value=(read_fixture('fixtures/3/full_example.json'), MockWebHandle()))
+        j = json.loads(v.do_GET_test())
+        self.assertEqual(j['okay'], 1)
+        # Check v3 requests allow accept = false
+        request = LocalRequest({'QUERY_STRING': 'version=3.0&url=https://a.b/&accept=false'})
+        v.fetch = Mock(return_value=(read_fixture('fixtures/3/full_example.json'), MockWebHandle()))
+        j = json.loads(v.do_GET_test())
+        self.assertEqual(j['okay'], 1)
+        # Check v2 requests do not validate v3 manifests
+        request = LocalRequest({'QUERY_STRING': 'version=2.1&url=https://a.b/&accept=false'})
+        v.fetch = Mock(return_value=(read_fixture('fixtures/3/full_example.json'), MockWebHandle()))
+        j = json.loads(v.do_GET_test())
+        self.assertEqual(j['okay'], 0)
 
     def test06_index_route(self):
         """Test index page."""
@@ -181,10 +196,13 @@ def test07_check_manifest3(self):
                 j = json.loads(v.check_manifest(data, '3.0'))
 
                 if j['okay'] == 1:
-                    print ("Expected {} to fail validation but it passed....".format(bad_data))
+                    print("Expected {} to fail validation but it passed....".format(bad_data))
 
                 self.assertEqual(j['okay'], 0)
 
+    def printValidationerror(self, filename, errors):
+        print('Failed to validate: {}'.format(filename))
+        
     def test08_errortrees(self):
         with open('fixtures/3/broken_service.json') as json_file:
             iiif_json = json.load(json_file)
@@ -338,15 +356,15 @@ def helperRunValidation(self, validator, iiifFile, version="3.0"):
             data = fh.read()
             return json.loads(validator.check_manifest(data, '3.0'))
 
-    def printValidationerror(self, filename, errors):                
-        print ('Failed to validate: {}'.format(filename))
         errorCount = 1
+
         for err in errors:
             print(err['title'])
             print(err['detail'])
             print('\n Path for error: {}'.format(err['path']))
             print('\n Context: {}'.format(err['context']))
             errorCount += 1
 
+
 if __name__ == '__main__':
     unittest.main()