bb5764b631
Motivation: HttpHeadersUtil methods were previously moved to HttpUtils in 4.1. However this class was not removed when merging from 4.1 to master. Modifications: - Remove HttpHeadersUtil Result: Less duplicate code.
325 lines
13 KiB
Java
325 lines
13 KiB
Java
/*
|
|
* Copyright 2015 The Netty Project
|
|
*
|
|
* The Netty Project 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 io.netty.handler.codec.http;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
|
|
import java.net.URI;
|
|
import java.util.Iterator;
|
|
import java.util.List;
|
|
|
|
import static io.netty.util.AsciiString.c2b;
|
|
|
|
/**
|
|
* Utility methods useful in the HTTP context.
|
|
*/
|
|
public final class HttpUtil {
|
|
private HttpUtil() { }
|
|
|
|
/**
|
|
* Determine if a uri is in origin-form according to
|
|
* <a href="https://tools.ietf.org/html/rfc7230#section-5.3">rfc7230, 5.3</a>.
|
|
*/
|
|
public static boolean isOriginForm(URI uri) {
|
|
return uri.getScheme() == null && uri.getSchemeSpecificPart() == null &&
|
|
uri.getHost() == null && uri.getAuthority() == null;
|
|
}
|
|
|
|
/**
|
|
* Determine if a uri is in asteric-form according to
|
|
* <a href="https://tools.ietf.org/html/rfc7230#section-5.3">rfc7230, 5.3</a>.
|
|
*/
|
|
public static boolean isAsteriskForm(URI uri) {
|
|
return "*".equals(uri.getPath()) &&
|
|
uri.getScheme() == null && uri.getSchemeSpecificPart() == null &&
|
|
uri.getHost() == null && uri.getAuthority() == null && uri.getQuery() == null &&
|
|
uri.getFragment() == null;
|
|
}
|
|
|
|
/**
|
|
* Returns {@code true} if and only if the connection can remain open and
|
|
* thus 'kept alive'. This methods respects the value of the.
|
|
* {@code "Connection"} header first and then the return value of
|
|
* {@link HttpVersion#isKeepAliveDefault()}.
|
|
*/
|
|
public static boolean isKeepAlive(HttpMessage message) {
|
|
CharSequence connection = message.headers().get(HttpHeaderNames.CONNECTION);
|
|
if (connection != null && HttpHeaderValues.CLOSE.contentEqualsIgnoreCase(connection)) {
|
|
return false;
|
|
}
|
|
|
|
if (message.protocolVersion().isKeepAliveDefault()) {
|
|
return !HttpHeaderValues.CLOSE.contentEqualsIgnoreCase(connection);
|
|
} else {
|
|
return HttpHeaderValues.KEEP_ALIVE.contentEqualsIgnoreCase(connection);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets the value of the {@code "Connection"} header depending on the
|
|
* protocol version of the specified message. This getMethod sets or removes
|
|
* the {@code "Connection"} header depending on what the default keep alive
|
|
* mode of the message's protocol version is, as specified by
|
|
* {@link HttpVersion#isKeepAliveDefault()}.
|
|
* <ul>
|
|
* <li>If the connection is kept alive by default:
|
|
* <ul>
|
|
* <li>set to {@code "close"} if {@code keepAlive} is {@code false}.</li>
|
|
* <li>remove otherwise.</li>
|
|
* </ul></li>
|
|
* <li>If the connection is closed by default:
|
|
* <ul>
|
|
* <li>set to {@code "keep-alive"} if {@code keepAlive} is {@code true}.</li>
|
|
* <li>remove otherwise.</li>
|
|
* </ul></li>
|
|
* </ul>
|
|
* @see #setKeepAlive(HttpHeaders, HttpVersion, boolean)
|
|
*/
|
|
public static void setKeepAlive(HttpMessage message, boolean keepAlive) {
|
|
setKeepAlive(message.headers(), message.protocolVersion(), keepAlive);
|
|
}
|
|
|
|
/**
|
|
* Sets the value of the {@code "Connection"} header depending on the
|
|
* protocol version of the specified message. This getMethod sets or removes
|
|
* the {@code "Connection"} header depending on what the default keep alive
|
|
* mode of the message's protocol version is, as specified by
|
|
* {@link HttpVersion#isKeepAliveDefault()}.
|
|
* <ul>
|
|
* <li>If the connection is kept alive by default:
|
|
* <ul>
|
|
* <li>set to {@code "close"} if {@code keepAlive} is {@code false}.</li>
|
|
* <li>remove otherwise.</li>
|
|
* </ul></li>
|
|
* <li>If the connection is closed by default:
|
|
* <ul>
|
|
* <li>set to {@code "keep-alive"} if {@code keepAlive} is {@code true}.</li>
|
|
* <li>remove otherwise.</li>
|
|
* </ul></li>
|
|
* </ul>
|
|
*/
|
|
public static void setKeepAlive(HttpHeaders h, HttpVersion httpVersion, boolean keepAlive) {
|
|
if (httpVersion.isKeepAliveDefault()) {
|
|
if (keepAlive) {
|
|
h.remove(HttpHeaderNames.CONNECTION);
|
|
} else {
|
|
h.set(HttpHeaderNames.CONNECTION, HttpHeaderValues.CLOSE);
|
|
}
|
|
} else {
|
|
if (keepAlive) {
|
|
h.set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE);
|
|
} else {
|
|
h.remove(HttpHeaderNames.CONNECTION);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the length of the content. Please note that this value is
|
|
* not retrieved from {@link HttpContent#content()} but from the
|
|
* {@code "Content-Length"} header, and thus they are independent from each
|
|
* other.
|
|
*
|
|
* @return the content length
|
|
*
|
|
* @throws NumberFormatException
|
|
* if the message does not have the {@code "Content-Length"} header
|
|
* or its value is not a number
|
|
*/
|
|
public static long getContentLength(HttpMessage message) {
|
|
Long value = message.headers().getLong(HttpHeaderNames.CONTENT_LENGTH);
|
|
if (value != null) {
|
|
return value;
|
|
}
|
|
|
|
// We know the content length if it's a Web Socket message even if
|
|
// Content-Length header is missing.
|
|
long webSocketContentLength = getWebSocketContentLength(message);
|
|
if (webSocketContentLength >= 0) {
|
|
return webSocketContentLength;
|
|
}
|
|
|
|
// Otherwise we don't.
|
|
throw new NumberFormatException("header not found: " + HttpHeaderNames.CONTENT_LENGTH);
|
|
}
|
|
|
|
/**
|
|
* Returns the length of the content. Please note that this value is
|
|
* not retrieved from {@link HttpContent#content()} but from the
|
|
* {@code "Content-Length"} header, and thus they are independent from each
|
|
* other.
|
|
*
|
|
* @return the content length or {@code defaultValue} if this message does
|
|
* not have the {@code "Content-Length"} header or its value is not
|
|
* a number
|
|
*/
|
|
public static long getContentLength(HttpMessage message, long defaultValue) {
|
|
Long value = message.headers().getLong(HttpHeaderNames.CONTENT_LENGTH);
|
|
if (value != null) {
|
|
return value;
|
|
}
|
|
|
|
// We know the content length if it's a Web Socket message even if
|
|
// Content-Length header is missing.
|
|
long webSocketContentLength = getWebSocketContentLength(message);
|
|
if (webSocketContentLength >= 0) {
|
|
return webSocketContentLength;
|
|
}
|
|
|
|
// Otherwise we don't.
|
|
return defaultValue;
|
|
}
|
|
|
|
/**
|
|
* Get an {@code int} representation of {@link #getContentLength(HttpMessage, long)}.
|
|
* @return the content length or {@code defaultValue} if this message does
|
|
* not have the {@code "Content-Length"} header or its value is not
|
|
* a number. Not to exceed the boundaries of integer.
|
|
*/
|
|
public static int getContentLength(HttpMessage message, int defaultValue) {
|
|
return (int) Math.min(Integer.MAX_VALUE, HttpUtil.getContentLength(message, (long) defaultValue));
|
|
}
|
|
|
|
/**
|
|
* Returns the content length of the specified web socket message. If the
|
|
* specified message is not a web socket message, {@code -1} is returned.
|
|
*/
|
|
private static int getWebSocketContentLength(HttpMessage message) {
|
|
// WebSockset messages have constant content-lengths.
|
|
HttpHeaders h = message.headers();
|
|
if (message instanceof HttpRequest) {
|
|
HttpRequest req = (HttpRequest) message;
|
|
if (HttpMethod.GET.equals(req.method()) &&
|
|
h.contains(HttpHeaderNames.SEC_WEBSOCKET_KEY1) &&
|
|
h.contains(HttpHeaderNames.SEC_WEBSOCKET_KEY2)) {
|
|
return 8;
|
|
}
|
|
} else if (message instanceof HttpResponse) {
|
|
HttpResponse res = (HttpResponse) message;
|
|
if (res.status().code() == 101 &&
|
|
h.contains(HttpHeaderNames.SEC_WEBSOCKET_ORIGIN) &&
|
|
h.contains(HttpHeaderNames.SEC_WEBSOCKET_LOCATION)) {
|
|
return 16;
|
|
}
|
|
}
|
|
|
|
// Not a web socket message
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Sets the {@code "Content-Length"} header.
|
|
*/
|
|
public static void setContentLength(HttpMessage message, long length) {
|
|
message.headers().setLong(HttpHeaderNames.CONTENT_LENGTH, length);
|
|
}
|
|
|
|
public static boolean isContentLengthSet(HttpMessage m) {
|
|
return m.headers().contains(HttpHeaderNames.CONTENT_LENGTH);
|
|
}
|
|
|
|
/**
|
|
* Returns {@code true} if and only if the specified message contains the
|
|
* {@code "Expect: 100-continue"} header.
|
|
*/
|
|
public static boolean is100ContinueExpected(HttpMessage message) {
|
|
// Expect: 100-continue is for requests only.
|
|
if (!(message instanceof HttpRequest)) {
|
|
return false;
|
|
}
|
|
|
|
// It works only on HTTP/1.1 or later.
|
|
if (message.protocolVersion().compareTo(HttpVersion.HTTP_1_1) < 0) {
|
|
return false;
|
|
}
|
|
|
|
// In most cases, there will be one or zero 'Expect' header.
|
|
CharSequence value = message.headers().get(HttpHeaderNames.EXPECT);
|
|
if (value == null) {
|
|
return false;
|
|
}
|
|
if (HttpHeaderValues.CONTINUE.contentEqualsIgnoreCase(value)) {
|
|
return true;
|
|
}
|
|
|
|
// Multiple 'Expect' headers. Search through them.
|
|
return message.headers().contains(HttpHeaderNames.EXPECT, HttpHeaderValues.CONTINUE, true);
|
|
}
|
|
|
|
/**
|
|
* Sets or removes the {@code "Expect: 100-continue"} header to / from the
|
|
* specified message. If the specified {@code value} is {@code true},
|
|
* the {@code "Expect: 100-continue"} header is set and all other previous
|
|
* {@code "Expect"} headers are removed. Otherwise, all {@code "Expect"}
|
|
* headers are removed completely.
|
|
*/
|
|
public static void set100ContinueExpected(HttpMessage message, boolean expected) {
|
|
if (expected) {
|
|
message.headers().set(HttpHeaderNames.EXPECT, HttpHeaderValues.CONTINUE);
|
|
} else {
|
|
message.headers().remove(HttpHeaderNames.EXPECT);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks to see if the transfer encoding in a specified {@link HttpMessage} is chunked
|
|
*
|
|
* @param message The message to check
|
|
* @return True if transfer encoding is chunked, otherwise false
|
|
*/
|
|
public static boolean isTransferEncodingChunked(HttpMessage message) {
|
|
return message.headers().contains(HttpHeaderNames.TRANSFER_ENCODING, HttpHeaderValues.CHUNKED, true);
|
|
}
|
|
|
|
/**
|
|
* Set the {@link HttpHeaderNames#TRANSFER_ENCODING} to either include {@link HttpHeaderValues#CHUNKED} if
|
|
* {@code chunked} is {@code true}, or remove {@link HttpHeaderValues#CHUNKED} if {@code chunked} is {@code false}.
|
|
* @param m The message which contains the headers to modify.
|
|
* @param chunked if {@code true} then include {@link HttpHeaderValues#CHUNKED} in the headers. otherwise remove
|
|
* {@link HttpHeaderValues#CHUNKED} from the headers.
|
|
*/
|
|
public static void setTransferEncodingChunked(HttpMessage m, boolean chunked) {
|
|
if (chunked) {
|
|
m.headers().add(HttpHeaderNames.TRANSFER_ENCODING, HttpHeaderValues.CHUNKED);
|
|
m.headers().remove(HttpHeaderNames.CONTENT_LENGTH);
|
|
} else {
|
|
List<CharSequence> values = m.headers().getAll(HttpHeaderNames.TRANSFER_ENCODING);
|
|
if (values.isEmpty()) {
|
|
return;
|
|
}
|
|
Iterator<CharSequence> valuesIt = values.iterator();
|
|
while (valuesIt.hasNext()) {
|
|
CharSequence value = valuesIt.next();
|
|
if (HttpHeaderValues.CHUNKED.contentEqualsIgnoreCase(value)) {
|
|
valuesIt.remove();
|
|
}
|
|
}
|
|
if (values.isEmpty()) {
|
|
m.headers().remove(HttpHeaderNames.TRANSFER_ENCODING);
|
|
} else {
|
|
m.headers().set(HttpHeaderNames.TRANSFER_ENCODING, values);
|
|
}
|
|
}
|
|
}
|
|
|
|
static void encodeAscii0(CharSequence seq, ByteBuf buf) {
|
|
int length = seq.length();
|
|
for (int i = 0 ; i < length; i++) {
|
|
buf.writeByte(c2b(seq.charAt(i)));
|
|
}
|
|
}
|
|
}
|