Improved support for Link header handling (#1129)

acoburn · web-flow · commit 7e1eb491e601 · 2020-10-28T12:47:18.000-04:00
Resolves #1125 This makes it possible for clients to send multiple Link headers while not having to worry about ordering. All irrelevant header values will be filtered out.
diff --git a/core/common/src/main/java/org/trellisldp/common/TrellisRequest.java b/core/common/src/main/java/org/trellisldp/common/TrellisRequest.java
@@ -15,6 +15,7 @@
  */
 package org.trellisldp.common;
 
+import static java.util.Collections.emptyList;
 import static javax.ws.rs.core.HttpHeaders.CONTENT_TYPE;
 import static javax.ws.rs.core.HttpHeaders.LINK;
 import static org.trellisldp.common.HttpConstants.ACCEPT_DATETIME;
@@ -34,6 +35,8 @@
 import javax.ws.rs.core.UriBuilder;
 import javax.ws.rs.core.UriInfo;
 
+import org.trellisldp.vocabulary.LDP;
+
 /**
  * A class representing an HTTP request with various LDP-related headers and query parameters.
  *
@@ -110,14 +113,19 @@ public String getSlug() {
     }
 
     /**
-     * Get the Link header.
+     * Get the first LDP Link header.
      *
-     * @return the Link header
+     * @return the first LDP Link header
      */
     public Link getLink() {
-        final String link = headers.getFirst(LINK);
-        if (link != null) {
-            return Link.valueOf(link);
+        for (final String header : headers.getOrDefault(LINK, emptyList())) {
+            final Link link = Link.valueOf(header);
+            if (Link.TYPE.equals(link.getRel())) {
+                final String uri = link.getUri().toString();
+                if (uri.startsWith(LDP.getNamespace()) && !uri.equals(LDP.Resource.getIRIString())) {
+                    return link;
+                }
+            }
         }
         return null;
     }
diff --git a/core/common/src/test/java/org/trellisldp/common/TrellisRequestTest.java b/core/common/src/test/java/org/trellisldp/common/TrellisRequestTest.java
@@ -208,6 +208,9 @@ void testLinkHeader() {
         final URI uri = create("http://example.com/");
         final MultivaluedMap<String, String> queryParams = new MultivaluedHashMap<>();
         final MultivaluedMap<String, String> headers = new MultivaluedHashMap<>();
+        headers.add("Link", "<http://www.w3.org/ns/ldp#Resource>; rel=\"type\"");
+        headers.add("Link", "<http://example.com/SomeType>; rel=\"type\"");
+        headers.add("Link", "<http://www.w3.org/ns/ldp#BasicContainer>; rel=\"about\"");
         final String rawLink = "<http://www.w3.org/ns/ldp#BasicContainer>; rel=\"type\"";
         headers.add("Link", rawLink);
         final MultivaluedMap<String, String> pathParams = new MultivaluedHashMap<>();
@@ -224,4 +227,27 @@ void testLinkHeader() {
         final TrellisRequest req = new TrellisRequest(mockRequest, mockUriInfo, mockHeaders);
         assertEquals(Link.valueOf(rawLink), req.getLink());
     }
+
+    @Test
+    void testSkippedLinkHeaders() {
+        final URI uri = create("http://example.com/");
+        final MultivaluedMap<String, String> queryParams = new MultivaluedHashMap<>();
+        final MultivaluedMap<String, String> headers = new MultivaluedHashMap<>();
+        headers.add("Link", "<http://www.w3.org/ns/ldp#Resource>; rel=\"type\"");
+        headers.add("Link", "<http://example.com/SomeType>; rel=\"type\"");
+        headers.add("Link", "<http://www.w3.org/ns/ldp#BasicContainer>; rel=\"about\"");
+        final MultivaluedMap<String, String> pathParams = new MultivaluedHashMap<>();
+        pathParams.add("path", "resource");
+
+        when(mockUriInfo.getPath()).thenReturn("resource");
+        when(mockUriInfo.getPathParameters()).thenReturn(pathParams);
+        when(mockUriInfo.getQueryParameters()).thenReturn(queryParams);
+        when(mockUriInfo.getBaseUri()).thenReturn(uri);
+        when(mockHeaders.getRequestHeaders()).thenReturn(headers);
+        when(mockRequest.getMethod()).thenReturn(GET);
+        when(mockHeaders.getAcceptableMediaTypes()).thenReturn(singletonList(RdfMediaType.TEXT_TURTLE_TYPE));
+
+        final TrellisRequest req = new TrellisRequest(mockRequest, mockUriInfo, mockHeaders);
+        assertNull(req.getLink());
+    }
 }
diff --git a/core/http/src/main/java/org/trellisldp/http/impl/PostHandler.java b/core/http/src/main/java/org/trellisldp/http/impl/PostHandler.java
@@ -119,14 +119,8 @@ private static RDFSyntax getRdfSyntax(final String contentType, final List<RDFSy
     }
 
     private static IRI getLdpType(final Link link, final RDFSyntax syntax, final String contentType) {
-        if (link != null && Link.TYPE.equals(link.getRel())) {
-            final String uri = link.getUri().toString();
-            if (uri.startsWith(LDP.getNamespace())) {
-                final IRI iri = rdf.createIRI(uri);
-                if (!LDP.Resource.equals(iri)) {
-                    return iri;
-                }
-            }
+        if (link != null) {
+            return rdf.createIRI(link.getUri().toString());
         }
         return contentType != null && syntax == null ? LDP.NonRDFSource : LDP.RDFSource;
     }
diff --git a/core/http/src/main/java/org/trellisldp/http/impl/PutHandler.java b/core/http/src/main/java/org/trellisldp/http/impl/PutHandler.java
@@ -212,11 +212,8 @@ private IRI getLdpType() {
             return getResource().getInteractionModel();
         }
         final Link link = getRequest().getLink();
-        if (link != null && Link.TYPE.equals(link.getRel())) {
-            final String uri = link.getUri().toString();
-            if (uri.startsWith(LDP.getNamespace()) && !uri.equals(LDP.Resource.getIRIString())) {
-                return rdf.createIRI(uri);
-            }
+        if (link != null) {
+            return rdf.createIRI(link.getUri().toString());
         }
         if (getResource() != null) {
             return getResource().getInteractionModel();
diff --git a/core/http/src/test/java/org/trellisldp/http/impl/PostHandlerTest.java b/core/http/src/test/java/org/trellisldp/http/impl/PostHandlerTest.java
@@ -130,7 +130,7 @@ void testDefaultType2() throws IOException {
 
     @Test
     void testDefaultType3() throws IOException {
-        when(mockTrellisRequest.getLink()).thenReturn(fromUri(LDP.Resource.getIRIString()).rel(TYPE).build());
+        when(mockTrellisRequest.getLink()).thenReturn(null);
 
         final PostHandler handler = buildPostHandler(RESOURCE_EMPTY, NEW_RESOURCE, null);
         try (final Response res = handler.createResource(handler.initialize(mockParent, MISSING_RESOURCE))
@@ -144,7 +144,7 @@ void testDefaultType3() throws IOException {
     @Test
     void testDefaultType4() throws IOException {
         when(mockTrellisRequest.getContentType()).thenReturn(TEXT_PLAIN);
-        when(mockTrellisRequest.getLink()).thenReturn(fromUri(LDP.Resource.getIRIString()).rel(TYPE).build());
+        when(mockTrellisRequest.getLink()).thenReturn(null);
 
         final PostHandler handler = buildPostHandler(RESOURCE_SIMPLE, NEW_RESOURCE, null);
         try (final Response res = handler.createResource(handler.initialize(mockParent, MISSING_RESOURCE))
diff --git a/core/http/src/test/java/org/trellisldp/http/impl/PutHandlerTest.java b/core/http/src/test/java/org/trellisldp/http/impl/PutHandlerTest.java
@@ -145,10 +145,10 @@ void testNoVersioning() {
     }
 
     @Test
-    void testPutLdpResourceDefaultType() {
+    void testPutNoLdpLinkType() {
         when(mockTrellisRequest.getPath()).thenReturn(RESOURCE_NAME);
         when(mockTrellisRequest.getContentType()).thenReturn(TEXT_TURTLE);
-        when(mockTrellisRequest.getLink()).thenReturn(fromUri(LDP.Resource.getIRIString()).rel(TYPE).build());
+        when(mockTrellisRequest.getLink()).thenReturn(null);
 
         final PutHandler handler = buildPutHandler(RESOURCE_TURTLE, null, false);
         try (final Response res = handler.setResource(handler.initialize(mockParent, mockResource))
@@ -214,10 +214,10 @@ void testPutLdpResourceContainerUncontained() throws IOException {
     }
 
     @Test
-    void testPutLdpBinaryResourceWithLdprLink() {
+    void testPutLdpBinaryResourceNoLdpLink() {
         when(mockResource.getInteractionModel()).thenReturn(LDP.NonRDFSource);
         when(mockTrellisRequest.getContentType()).thenReturn(TEXT_PLAIN);
-        when(mockTrellisRequest.getLink()).thenReturn(fromUri(LDP.Resource.getIRIString()).rel(TYPE).build());
+        when(mockTrellisRequest.getLink()).thenReturn(null);
 
         final PutHandler handler = buildPutHandler(RESOURCE_SIMPLE, null);
         try (final Response res = handler.setResource(handler.initialize(mockParent, mockResource))

Original file line number	Diff line number	Diff line change
`@@ -119,14 +119,8 @@ private static RDFSyntax getRdfSyntax(final String contentType, final List<RDFSy`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`private static IRI getLdpType(final Link link, final RDFSyntax syntax, final String contentType) {`
`122`		`- if (link != null && Link.TYPE.equals(link.getRel())) {`
`123`		`- final String uri = link.getUri().toString();`
`124`		`- if (uri.startsWith(LDP.getNamespace())) {`
`125`		`- final IRI iri = rdf.createIRI(uri);`
`126`		`- if (!LDP.Resource.equals(iri)) {`
`127`		`- return iri;`
`128`		`- }`
`129`		`- }`
	`122`	`+ if (link != null) {`
	`123`	`+ return rdf.createIRI(link.getUri().toString());`
`130`	`124`	`}`
`131`	`125`	`return contentType != null && syntax == null ? LDP.NonRDFSource : LDP.RDFSource;`
`132`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -212,11 +212,8 @@ private IRI getLdpType() {`
`212`	`212`	`return getResource().getInteractionModel();`
`213`	`213`	`}`
`214`	`214`	`final Link link = getRequest().getLink();`
`215`		`- if (link != null && Link.TYPE.equals(link.getRel())) {`
`216`		`- final String uri = link.getUri().toString();`
`217`		`- if (uri.startsWith(LDP.getNamespace()) && !uri.equals(LDP.Resource.getIRIString())) {`
`218`		`- return rdf.createIRI(uri);`
`219`		`- }`
	`215`	`+ if (link != null) {`
	`216`	`+ return rdf.createIRI(link.getUri().toString());`
`220`	`217`	`}`
`221`	`218`	`if (getResource() != null) {`
`222`	`219`	`return getResource().getInteractionModel();`