You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2021/01/14 10:48:20 UTC
[sling-org-apache-sling-servlets-post] branch issue/SLING-10031
created (now 76964c8)
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a change to branch issue/SLING-10031
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-post.git.
at 76964c8 SLING-10031 Move MediaRangeList from Servlets POST to Sling API
This branch includes the following new commits:
new 76964c8 SLING-10031 Move MediaRangeList from Servlets POST to Sling API
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[sling-org-apache-sling-servlets-post] 01/01: SLING-10031 Move
MediaRangeList from Servlets POST to Sling API
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch issue/SLING-10031
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-post.git
commit 76964c8c9e616a98968a7a6517b1cbfeaeb4298d
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Thu Jan 14 11:47:20 2021 +0100
SLING-10031 Move MediaRangeList from Servlets POST to Sling API
This reverts commit dc05de78c8cf6eafa72b2d929b26f9bf7c260789, getting the changes back to the
current release.
---
pom.xml | 2 +-
.../sling/servlets/post/impl/SlingPostServlet.java | 2 +-
.../servlets/post/impl/helper/MediaRangeList.java | 335 ---------------------
.../servlets/post/impl/SlingPostServletTest.java | 2 +-
.../post/impl/helper/MediaRangeListTest.java | 92 ------
5 files changed, 3 insertions(+), 430 deletions(-)
diff --git a/pom.xml b/pom.xml
index 6e06607..07c5936 100644
--- a/pom.xml
+++ b/pom.xml
@@ -142,7 +142,7 @@
<dependency>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.api</artifactId>
- <version>2.9.0</version>
+ <version>2.23.2</version>
<scope>provided</scope>
</dependency>
<dependency>
diff --git a/src/main/java/org/apache/sling/servlets/post/impl/SlingPostServlet.java b/src/main/java/org/apache/sling/servlets/post/impl/SlingPostServlet.java
index 795b014..4f378a0 100644
--- a/src/main/java/org/apache/sling/servlets/post/impl/SlingPostServlet.java
+++ b/src/main/java/org/apache/sling/servlets/post/impl/SlingPostServlet.java
@@ -35,6 +35,7 @@ import javax.servlet.http.HttpServletResponse;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.PersistenceException;
+import org.apache.sling.api.request.header.MediaRangeList;
import org.apache.sling.api.resource.ResourceNotFoundException;
import org.apache.sling.api.resource.ResourceUtil;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
@@ -53,7 +54,6 @@ import org.apache.sling.servlets.post.exceptions.TemporaryPersistenceException;
import org.apache.sling.servlets.post.impl.helper.DateParser;
import org.apache.sling.servlets.post.impl.helper.DefaultNodeNameGenerator;
import org.apache.sling.servlets.post.impl.helper.JCRSupport;
-import org.apache.sling.servlets.post.impl.helper.MediaRangeList;
import org.apache.sling.servlets.post.impl.operations.CheckinOperation;
import org.apache.sling.servlets.post.impl.operations.CheckoutOperation;
import org.apache.sling.servlets.post.impl.operations.CopyOperation;
diff --git a/src/main/java/org/apache/sling/servlets/post/impl/helper/MediaRangeList.java b/src/main/java/org/apache/sling/servlets/post/impl/helper/MediaRangeList.java
deleted file mode 100644
index eedaa90..0000000
--- a/src/main/java/org/apache/sling/servlets/post/impl/helper/MediaRangeList.java
+++ /dev/null
@@ -1,335 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.sling.servlets.post.impl.helper;
-
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-import java.util.TreeSet;
-
-import javax.servlet.http.HttpServletRequest;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Facilitates parsing of the Accept HTTP request header.
- * See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC 2616 section 14.1</a>
- */
-public class MediaRangeList extends TreeSet<MediaRangeList.MediaRange> {
- public static final String HEADER_ACCEPT = "Accept";
- public static final String PARAM_ACCEPT = ":http-equiv-accept";
- public static final String WILDCARD = "*";
- boolean matchesAll = false;
-
- private static final Logger log = LoggerFactory.getLogger(MediaRangeList.class);
-
- /**
- * Constructs a <code>MediaRangeList</code> using information from the supplied <code>HttpServletRequest</code>.
- * if the request contains a {@link #PARAM_ACCEPT} query parameter, the query parameter value overrides any
- * {@link #HEADER_ACCEPT} header value.
- * If the request contains no {@link #PARAM_ACCEPT} parameter, or the parameter value is empty, the value of the
- * {@link #HEADER_ACCEPT} is used. If both values are missing, it is assumed that the client accepts all media types,
- * as per the RFC. See also {@link MediaRangeList#MediaRangeList(java.lang.String)}
- * @param request The <code>HttpServletRequest</code> to extract a <code>MediaRangeList</code> from
- */
- public MediaRangeList(HttpServletRequest request) {
- String queryParam = request.getParameter(PARAM_ACCEPT);
- if (queryParam != null && queryParam.trim().length() != 0) {
- init(queryParam);
- } else {
- init(request.getHeader(HEADER_ACCEPT));
- }
- }
-
- /**
- * Constructs a <code>MediaRangeList</code> using a list of media ranges specified in a <code>java.lang.String</code>.
- * The string is a comma-separated list of media ranges, as specified by the RFC.<br />
- * Examples:
- * <ul>
- * <li><code>text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5</code></li>
- * <li><code>text/html;q=0.8, application/json</code></li>
- * </ul>
- *
- * @param listStr The list of media range specifications
- */
- public MediaRangeList(String listStr) {
- try {
- init(listStr);
- } catch (Throwable t) {
- log.error("Error building MediaRangeList from '" + listStr + "' - will assume client accepts all media types", t);
- init(null);
- }
- }
-
- private void init(String headerValue) {
- if (headerValue == null || headerValue.trim().length() == 0) {
- // RFC 2616: "If no Accept header field is present,
- // then it is assumed that the client accepts all media types."
- this.matchesAll = true;
- this.add(new MediaRange(WILDCARD + "/" + WILDCARD));
- } else {
- String[] mediaTypes = headerValue.split(",");
- for (String type : mediaTypes) {
- try {
- MediaRange range = new MediaRange(type);
- this.add(range);
- if (range.matchesAll()) {
- this.matchesAll = true;
- }
- } catch (Throwable throwable) {
- log.warn("Error registering media type " + type, throwable);
- }
- }
- }
- }
-
- /**
- * Determines if this MediaRangeList contains a given media type.
- * @param mediaType A string on the form <code>type/subtype</code>. Neither <code>type</code>
- * or <code>subtype</code> should be wildcard (<code>*</code>).
- * @return <code>true</code> if this <code>MediaRangeList</code> contains a media type that matches
- * <code>mediaType</code>, <code>false</code> otherwise
- * @throws IllegalArgumentException if <code>mediaType</code> is not on an accepted form
- * @throws NullPointerException if <code>mediaType</code> is <code>null</code>
- */
- public boolean contains(String mediaType) {
- //noinspection SuspiciousMethodCalls
- MediaRange comp = new MediaRange(mediaType);
- return this.matchesAll || this.contains(comp);
- }
-
- /**
- * Given a list of media types, returns the one is preferred by this <code>MediaRangeList</code>.
- * @param mediaRanges An array of possible {@link org.apache.sling.servlets.post.impl.helper.MediaRangeList.MediaRange}s
- * @return One of the <code>mediaRanges</code> that this <code>MediaRangeList</code> prefers;
- * or <code>null</code> if this <code>MediaRangeList</code> does not contain any of the <code>mediaRanges</code>
- * @throws NullPointerException if <code>mediaRanges</code> is <code>null</code> or contains a <code>null</code> value
- */
- public MediaRange prefer(Set<MediaRange> mediaRanges) {
- for (MediaRange range : this) {
- for (MediaRange mediaType : mediaRanges) {
- if (range.equals(mediaType)) {
- return mediaType;
- }
- }
- }
- return null;
- }
-
- /**
- * Determines which of the <code>mediaRanges</code> specifiactions is prefered by this <code>MediaRangeList</code>.
- * @param mediaRanges String representations of <code>MediaRange</code>s. The strings must be
- * on the form required by {@link MediaRange#MediaRange(String)}
- * @see #prefer(java.util.Set)
- * @return the <code>toString</code> representation of the prefered <code>MediaRange</code>, or <code>null</code>
- * if this <code>MediaRangeList</code> does not contain any of the <code>mediaRanges</code>
- */
- public String prefer(String... mediaRanges) {
- Set<MediaRange> ranges = new HashSet<MediaRange>();
- for (String mediaRange : mediaRanges) {
- ranges.add(new MediaRange(mediaRange));
- }
- final MediaRange preferred = prefer(ranges);
- return(preferred == null ? null : preferred.toString());
- }
-
- /**
- * A code <code>MediaRange</code> represents an entry in a <code>MediaRangeList</code>.
- * The <code>MediaRange</code> consists of a <code>supertype</code> and a <code>subtype</code>,
- * optionally a quality factor parameter <code>q</code> and other arbitrary parameters.
- */
- public class MediaRange implements Comparable<MediaRange> {
- private String supertype;
- private double q = 1;
- private Map<String, String> parameters;
- private String subtype;
-
- /**
- * Constructs a <code>MediaRange</code> from a <code>String</code> expression.
- * @param exp The <code>String</code> to constuct the <code>MediaRange</code> from. The string is
- * expected to be on the form ( "*/*"
- * | ( type "/" "*" )
- * | ( type "/" subtype )
- * ) *( ";" parameter )<br/>
- * as specified by RFC 2616, section 14.1. <br/>
- * Examples:
- * <ul>
- * <li><code>text/html;q=0.8</code></li>
- * <li><code>text/html</code></li>
- * <li><code>text/html;level=3</code></li>
- * <li><code>text/html;level=3;q=0.7</code></li>
- * <li><code>text/*</code></li>
- * <li><code>*/*</code></li>
- * </ul>
- * Note that if the supertype component is wildcard (<code>*</code>), then the subtype component
- * must also be wildcard.<br />
- * The quality factor parameter must be between <code>0</code> and <code>1</code>, inclusive
- * (see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9">RFC 2616 section 3.9</a>).
- * If the expression does not contain a <code>q</code> parameter, the <code>MediaRange</code> is given
- * a default quality factor of <code>1</code>.
- * @throws IllegalArgumentException if <code>exp</code> can not be parsed to a valid media range
- * @throws NullPointerException if <code>exp</code> is <code>null</code>
- */
- public MediaRange(String exp) {
- String[] parts = exp.split(";");
- this.setType(parts[0].trim());
- if (parts.length > 1) {
- this.parameters = new HashMap<String, String>(parts.length - 1);
- }
- for (int i = 1, partsLength = parts.length; i < partsLength; i++) {
- String parameter = parts[i];
- String[] keyValue = parameter.split("=");
- if (keyValue[0].equals("q")) {
- this.q = Double.parseDouble(keyValue[1]);
- if (this.q < 0 || this.q > 1) {
- throw new IllegalArgumentException("Quality factor out of bounds: " + exp);
- }
- }
- this.parameters.put(keyValue[0], keyValue[1]);
- }
- }
-
- /**
- * Constructs a <code>MediaRange</code> of the given <code>supertype</code> and <code>subtype</code>.
- * The quality factor is given the default value of <code>1</code>.
- * @param supertype The super type of the media range
- * @param subtype The sub type of the media range
- */
- MediaRange(String supertype, String subtype) {
- this.setType(supertype, subtype);
- }
-
-
- /**
- * Returns <code>true</code> if this is a catch-all media range (<code>*/*</code>).
- * @return <code>true</code> if this range is a catch-all media range, <code>false</code> otherwise
- */
- public boolean matchesAll() {
- return this.supertype.equals(WILDCARD) && this.subtype.equals(WILDCARD);
- }
-
- private void setType(String supertype, String subtype) {
- this.supertype = supertype == null ? WILDCARD : supertype;
- this.subtype = subtype == null ? WILDCARD : subtype;
- if (this.supertype.equals(WILDCARD) && !this.subtype.equals(WILDCARD)) {
- throw new IllegalArgumentException("Supertype cannot be wildcard if subtype is not");
- }
- }
-
- private void setType(String typeDef) {
- String[] parts = typeDef.split("/");
- String superType = parts[0];
- String subType = WILDCARD;
- if(parts.length > 1){
- subType = parts[1];
- }
- this.setType(superType,subType);
- }
-
- MediaRange(String supertype, String subtype, double q) {
- this(supertype, subtype);
- this.q = q;
- }
-
-
- public String getParameter(String key) {
- if (parameters != null) {
- return parameters.get(key);
- } else {
- return null;
- }
- }
-
- public String getSupertype() {
- return supertype;
- }
-
- public String getSubtype() {
- return subtype;
- }
-
- /**
- * Get the value of the quality factor parameter (<code>q</code>).
- * @return the quality factor
- */
- public double getQ() {
- return q;
- }
-
- public Map<String, String> getParameters() {
- return parameters != null ? parameters : new HashMap<String, String>(0);
- }
-
- /* -- Comparable implementation -- */
- public int compareTo(MediaRange o) {
- double diff = this.q - o.getQ();
- if (diff == 0) {
- // Compare parameters
- int paramDiff = o.getParameters().size() - this.getParameters().size();
- if (paramDiff != 0) {
- return paramDiff;
- }
- // Compare wildcards
- if (this.supertype.equals(WILDCARD) && !o.getSupertype().equals(WILDCARD)) {
- return 1;
- } else if (!this.supertype.equals(WILDCARD) && o.getSupertype().equals(WILDCARD)) {
- return -1;
- }
- if (this.subtype.equals(WILDCARD) && !o.getSubtype().equals(WILDCARD)) {
- return 1;
- } else if (!this.subtype.equals(WILDCARD) && o.getSubtype().equals(WILDCARD)) {
- return -1;
- }
- // Compare names
- return this.toString().compareTo(o.toString());
- } else {
- return diff > 0 ? -1 : 1;
- }
- }
-
- @Override
- public boolean equals(Object obj) {
- if (obj instanceof MediaRange) {
- MediaRange mr = (MediaRange) obj;
- return mr.getSupertype().equals(this.supertype) && mr.getSubtype().equals(this.subtype);
- }
- return super.equals(obj);
- }
-
- public boolean equals(String s) {
- return (this.supertype + "/" + this.subtype).equals(s);
- }
-
- @Override
- public String toString() {
- final StringBuilder buf = new StringBuilder(this.supertype);
- buf.append('/');
- buf.append(this.subtype);
- if (parameters != null) {
- String delimiter = ";";
- for (String key : parameters.keySet()) {
- buf.append(delimiter);
- buf.append(key).append("=").append(parameters.get(key));
- }
- }
- return buf.toString();
- }
- }
-}
diff --git a/src/test/java/org/apache/sling/servlets/post/impl/SlingPostServletTest.java b/src/test/java/org/apache/sling/servlets/post/impl/SlingPostServletTest.java
index 0c46035..2b9d4ed 100644
--- a/src/test/java/org/apache/sling/servlets/post/impl/SlingPostServletTest.java
+++ b/src/test/java/org/apache/sling/servlets/post/impl/SlingPostServletTest.java
@@ -24,12 +24,12 @@ import java.net.URLEncoder;
import java.util.StringTokenizer;
import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.request.header.MediaRangeList;
import org.apache.sling.commons.testing.sling.MockSlingHttpServletRequest;
import org.apache.sling.servlets.post.HtmlResponse;
import org.apache.sling.servlets.post.JSONResponse;
import org.apache.sling.servlets.post.PostResponse;
import org.apache.sling.servlets.post.SlingPostConstants;
-import org.apache.sling.servlets.post.impl.helper.MediaRangeList;
import org.apache.sling.servlets.post.impl.helper.MockSlingHttpServlet3Request;
import org.apache.sling.servlets.post.impl.helper.MockSlingHttpServlet3Response;
diff --git a/src/test/java/org/apache/sling/servlets/post/impl/helper/MediaRangeListTest.java b/src/test/java/org/apache/sling/servlets/post/impl/helper/MediaRangeListTest.java
deleted file mode 100644
index 0bc9177..0000000
--- a/src/test/java/org/apache/sling/servlets/post/impl/helper/MediaRangeListTest.java
+++ /dev/null
@@ -1,92 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.sling.servlets.post.impl.helper;
-
-import junit.framework.TestCase;
-import org.apache.sling.commons.testing.sling.MockSlingHttpServletRequest;
-
-import java.util.Enumeration;
-
-public class MediaRangeListTest extends TestCase {
- protected MediaRangeList rangeList;
-
- public void setUp() throws Exception {
- super.setUp();
- rangeList = new MediaRangeList("text/*;q=0.3, text/html;q=0.7, text/html;level=1,\n" +
- " text/html;level=2;q=0.4, */*;q=0.5");
- }
-
- public void testContains() throws Exception {
- assertTrue(rangeList.contains("text/html"));
- assertTrue(rangeList.contains("application/json")); // Since rangeList contains */*
- assertTrue(rangeList.contains("text/plain"));
- }
-
- public void testPrefer() throws Exception {
- assertEquals("text/html;level=1", rangeList.prefer("text/html;level=1", "*/*"));
- }
-
- public void testPreferJson() {
- MediaRangeList rangeList = new MediaRangeList("text/html;q=0.8, application/json");
- assertEquals("application/json", rangeList.prefer("text/html", "application/json"));
- }
-
- public void testHttpEquivParam() {
- MockSlingHttpServletRequest req = new MockSlingHttpServlet3Request(null, null, null, null, null) {
- @Override
- public String getHeader(String name) {
- return name.equals(MediaRangeList.HEADER_ACCEPT) ? "text/plain" : super.getHeader(name);
- }
-
- @Override
- public String getParameter(String name) {
- return name.equals(MediaRangeList.PARAM_ACCEPT) ? "text/html" : super.getParameter(name);
- }
-
- @Override
- public Enumeration<String> getHeaderNames() {
- return null;
- }
-
- public <AdapterType> AdapterType adaptTo(Class<AdapterType> type) {
- return null;
- }
- };
- MediaRangeList rangeList = new MediaRangeList(req);
- assertTrue("Did not contain media type from query param", rangeList.contains("text/html"));
- assertFalse("Contained media type from overridden Accept header", rangeList.contains("text/plain"));
- }
-
- public void testInvalidJdkAcceptHeader() {
- //This header is sent by Java client which make use of URLConnection on Oracle JDK
- //See acceptHeader at http://hg.openjdk.java.net/jdk6/jdk6-gate/jdk/file/tip/src/share/classes/sun/net/www/protocol/http/HttpURLConnection.java
- //To support such case the MediaRange parser has to be made bit linient
- final String invalidHeader = "text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2";
- MockSlingHttpServletRequest req = new MockSlingHttpServlet3Request(null, null, null, null, null) {
- @Override
- public String getHeader(String name) {
- return name.equals(MediaRangeList.HEADER_ACCEPT) ? invalidHeader : super.getHeader(name);
- }
-
- public <AdapterType> AdapterType adaptTo(Class<AdapterType> type) {
- return null;
- }
- };
- MediaRangeList rangeList = new MediaRangeList(req);
- assertTrue("Did not contain media type from query param", rangeList.contains("text/html"));
- }
-}