Remove the deprecated CookieDecoder

- Remove the unused methods in CookieEncoderUtil as well

codec-http/src/main/java/io/netty/handler/codec/http/CookieDecoder.java

@@ -1,296 +0,0 @@
-/*
- * Copyright 2012 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.util.internal.StringUtil;
-
-import java.text.ParseException;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.Set;
-import java.util.TreeSet;
-
-/**
- * @deprecated Use {@link ClientCookieDecoder} or {@link ServerCookieDecoder} instead.
- *
- * Decodes an HTTP header value into {@link Cookie}s.  This decoder can decode
- * the HTTP cookie version 0, 1, and 2.
- *
- * <pre>
- * {@link HttpRequest} req = ...;
- * String value = req.getHeader("Cookie");
- * Set&lt;{@link Cookie}&gt; cookies = new {@link CookieDecoder}().decode(value);
- * </pre>
- *
- * @see ClientCookieEncoder
- * @see ServerCookieEncoder
- */
-@Deprecated
-public final class CookieDecoder {
-
-    private static final char COMMA = ',';
-
-    /**
-     * Decodes the specified HTTP header value into {@link Cookie}s.
-     *
-     * @return the decoded {@link Cookie}s
-     */
-    public static Set<Cookie> decode(String header) {
-        List<String> names = new ArrayList<String>(8);
-        List<String> values = new ArrayList<String>(8);
-        extractKeyValuePairs(header, names, values);
-
-        if (names.isEmpty()) {
-            return Collections.emptySet();
-        }
-
-        int i;
-        int version = 0;
-
-        // $Version is the only attribute that can appear before the actual
-        // cookie name-value pair.
-        if (names.get(0).equalsIgnoreCase(CookieHeaderNames.VERSION)) {
-            try {
-                version = Integer.parseInt(values.get(0));
-            } catch (NumberFormatException e) {
-                // Ignore.
-            }
-            i = 1;
-        } else {
-            i = 0;
-        }
-
-        if (names.size() <= i) {
-            // There's a version attribute, but nothing more.
-            return Collections.emptySet();
-        }
-
-        Set<Cookie> cookies = new TreeSet<Cookie>();
-        for (; i < names.size(); i ++) {
-            String name = names.get(i);
-            String value = values.get(i);
-            if (value == null) {
-                value = "";
-            }
-
-            Cookie c = new DefaultCookie(name, value);
-
-            boolean discard = false;
-            boolean secure = false;
-            boolean httpOnly = false;
-            String comment = null;
-            String commentURL = null;
-            String domain = null;
-            String path = null;
-            long maxAge = Long.MIN_VALUE;
-            List<Integer> ports = new ArrayList<Integer>(2);
-
-            for (int j = i + 1; j < names.size(); j++, i++) {
-                name = names.get(j);
-                value = values.get(j);
-
-                if (CookieHeaderNames.DISCARD.equalsIgnoreCase(name)) {
-                    discard = true;
-                } else if (CookieHeaderNames.SECURE.equalsIgnoreCase(name)) {
-                    secure = true;
-                } else if (CookieHeaderNames.HTTPONLY.equalsIgnoreCase(name)) {
-                   httpOnly = true;
-                } else if (CookieHeaderNames.COMMENT.equalsIgnoreCase(name)) {
-                    comment = value;
-                } else if (CookieHeaderNames.COMMENTURL.equalsIgnoreCase(name)) {
-                    commentURL = value;
-                } else if (CookieHeaderNames.DOMAIN.equalsIgnoreCase(name)) {
-                    domain = value;
-                } else if (CookieHeaderNames.PATH.equalsIgnoreCase(name)) {
-                    path = value;
-                } else if (CookieHeaderNames.EXPIRES.equalsIgnoreCase(name)) {
-                    try {
-                        long maxAgeMillis =
-                            HttpHeaderDateFormat.get().parse(value).getTime() -
-                            System.currentTimeMillis();
-
-                        maxAge = maxAgeMillis / 1000 + (maxAgeMillis % 1000 != 0? 1 : 0);
-                    } catch (ParseException e) {
-                        // Ignore.
-                    }
-                } else if (CookieHeaderNames.MAX_AGE.equalsIgnoreCase(name)) {
-                    maxAge = Integer.parseInt(value);
-                } else if (CookieHeaderNames.VERSION.equalsIgnoreCase(name)) {
-                    version = Integer.parseInt(value);
-                } else if (CookieHeaderNames.PORT.equalsIgnoreCase(name)) {
-                    String[] portList = StringUtil.split(value, COMMA);
-                    for (String s1: portList) {
-                        try {
-                            ports.add(Integer.valueOf(s1));
-                        } catch (NumberFormatException e) {
-                            // Ignore.
-                        }
-                    }
-                } else {
-                    break;
-                }
-            }
-
-            c.setVersion(version);
-            c.setMaxAge(maxAge);
-            c.setPath(path);
-            c.setDomain(domain);
-            c.setSecure(secure);
-            c.setHttpOnly(httpOnly);
-            if (version > 0) {
-                c.setComment(comment);
-            }
-            if (version > 1) {
-                c.setCommentUrl(commentURL);
-                c.setPorts(ports);
-                c.setDiscard(discard);
-            }
-
-            cookies.add(c);
-        }
-
-        return cookies;
-    }
-
-    private static void extractKeyValuePairs(
-            final String header, final List<String> names, final List<String> values) {
-
-        final int headerLen  = header.length();
-        loop: for (int i = 0;;) {
-
-            // Skip spaces and separators.
-            for (;;) {
-                if (i == headerLen) {
-                    break loop;
-                }
-                switch (header.charAt(i)) {
-                case '\t': case '\n': case 0x0b: case '\f': case '\r':
-                case ' ':  case ',':  case ';':
-                    i ++;
-                    continue;
-                }
-                break;
-            }
-
-            // Skip '$'.
-            for (;;) {
-                if (i == headerLen) {
-                    break loop;
-                }
-                if (header.charAt(i) == '$') {
-                    i ++;
-                    continue;
-                }
-                break;
-            }
-
-            String name;
-            String value;
-
-            if (i == headerLen) {
-                name = null;
-                value = null;
-            } else {
-                int newNameStart = i;
-                keyValLoop: for (;;) {
-                    switch (header.charAt(i)) {
-                    case ';':
-                        // NAME; (no value till ';')
-                        name = header.substring(newNameStart, i);
-                        value = null;
-                        break keyValLoop;
-                    case '=':
-                        // NAME=VALUE
-                        name = header.substring(newNameStart, i);
-                        i ++;
-                        if (i == headerLen) {
-                            // NAME= (empty value, i.e. nothing after '=')
-                            value = "";
-                            break keyValLoop;
-                        }
-
-                        int newValueStart = i;
-                        char c = header.charAt(i);
-                        if (c == '"' || c == '\'') {
-                            // NAME="VALUE" or NAME='VALUE'
-                            StringBuilder newValueBuf = new StringBuilder(header.length() - i);
-                            final char q = c;
-                            boolean hadBackslash = false;
-                            i ++;
-                            for (;;) {
-                                if (i == headerLen) {
-                                    value = newValueBuf.toString();
-                                    break keyValLoop;
-                                }
-                                if (hadBackslash) {
-                                    hadBackslash = false;
-                                    c = header.charAt(i ++);
-                                    switch (c) {
-                                    case '\\': case '"': case '\'':
-                                        // Escape last backslash.
-                                        newValueBuf.setCharAt(newValueBuf.length() - 1, c);
-                                        break;
-                                    default:
-                                        // Do not escape last backslash.
-                                        newValueBuf.append(c);
-                                    }
-                                } else {
-                                    c = header.charAt(i ++);
-                                    if (c == q) {
-                                        value = newValueBuf.toString();
-                                        break keyValLoop;
-                                    }
-                                    newValueBuf.append(c);
-                                    if (c == '\\') {
-                                        hadBackslash = true;
-                                    }
-                                }
-                            }
-                        } else {
-                            // NAME=VALUE;
-                            int semiPos = header.indexOf(';', i);
-                            if (semiPos > 0) {
-                                value = header.substring(newValueStart, semiPos);
-                                i = semiPos;
-                            } else {
-                                value = header.substring(newValueStart);
-                                i = headerLen;
-                            }
-                        }
-                        break keyValLoop;
-                    default:
-                        i ++;
-                    }
-
-                    if (i == headerLen) {
-                        // NAME (no value till the end of string)
-                        name = header.substring(newNameStart);
-                        value = null;
-                        break;
-                    }
-                }
-            }
-
-            names.add(name);
-            values.add(value);
-        }
-    }
-
-    private CookieDecoder() {
-        // Unused
-    }
-}

codec-http/src/main/java/io/netty/handler/codec/http/CookieEncoderUtil.java

@@ -39,27 +39,6 @@ final class CookieEncoderUtil {
         return buf.toString();
     }
 
-    static void add(StringBuilder sb, String name, String val) {
-        if (val == null) {
-            addQuoted(sb, name, "");
-            return;
-        }
-
-        for (int i = 0; i < val.length(); i ++) {
-            char c = val.charAt(i);
-            switch (c) {
-            case '\t': case ' ': case '"': case '(':  case ')': case ',':
-            case '/':  case ':': case ';': case '<':  case '=': case '>':
-            case '?':  case '@': case '[': case '\\': case ']':
-            case '{':  case '}':
-                addQuoted(sb, name, val);
-                return;
-            }
-        }
-
-        addUnquoted(sb, name, val);
-    }
-
     static void addUnquoted(StringBuilder sb, String name, String val) {
         sb.append(name);
         sb.append((char) HttpConstants.EQUALS);
@@ -68,20 +47,6 @@ final class CookieEncoderUtil {
         sb.append((char) HttpConstants.SP);
     }
 
-    static void addQuoted(StringBuilder sb, String name, String val) {
-        if (val == null) {
-            val = "";
-        }
-
-        sb.append(name);
-        sb.append((char) HttpConstants.EQUALS);
-        sb.append((char) HttpConstants.DOUBLE_QUOTE);
-        sb.append(val.replace("\\", "\\\\").replace("\"", "\\\""));
-        sb.append((char) HttpConstants.DOUBLE_QUOTE);
-        sb.append((char) HttpConstants.SEMICOLON);
-        sb.append((char) HttpConstants.SP);
-    }
-
     static void add(StringBuilder sb, String name, long val) {
         sb.append(name);
         sb.append((char) HttpConstants.EQUALS);

codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java

@@ -23,13 +23,14 @@ package io.netty.handler.codec.http;
  * <p>
  * Unlike the Servlet API, a query string is constructed and decomposed by
  * {@link QueryStringEncoder} and {@link QueryStringDecoder}.  {@link Cookie}
- * support is also provided separately via {@link CookieDecoder}, {@link ClientCookieEncoder},
+ * support is also provided separately via {@link ClientCookieDecoder}, {@link ServerCookieDecoder},
- * and {@link @ServerCookieEncoder}.
+ * {@link ClientCookieEncoder}, and {@link @ServerCookieEncoder}.
  *
  * @see HttpResponse
  * @see ClientCookieEncoder
  * @see ServerCookieEncoder
- * @see CookieDecoder
+ * @see ClientCookieDecoder
+ * @see ServerCookieDecoder
  */
 public interface HttpRequest extends HttpMessage {
 

codec-http/src/main/java/io/netty/handler/codec/http/HttpResponse.java

@@ -21,13 +21,14 @@ package io.netty.handler.codec.http;
  *
  * <h3>Accessing Cookies</h3>
  * <p>
- * Unlike the Servlet API, {@link Cookie} support is provided separately via {@link CookieDecoder},
+ * Unlike the Servlet API, {@link Cookie} support is provided separately via {@link ClientCookieDecoder},
- * {@link ClientCookieEncoder}, and {@link ServerCookieEncoder}.
+ * {@link ServerCookieDecoder}, {@link ClientCookieEncoder}, and {@link @ServerCookieEncoder}.
  *
  * @see HttpRequest
- * @see CookieDecoder
  * @see ClientCookieEncoder
  * @see ServerCookieEncoder
+ * @see ClientCookieDecoder
+ * @see ServerCookieDecoder
  */
 public interface HttpResponse extends HttpMessage {
 

example/src/main/java/io/netty/example/http/snoop/HttpSnoopServerHandler.java

@@ -22,7 +22,6 @@ import io.netty.channel.ChannelHandlerContext;
 import io.netty.channel.SimpleChannelInboundHandler;
 import io.netty.handler.codec.DecoderResult;
 import io.netty.handler.codec.http.Cookie;
-import io.netty.handler.codec.http.CookieDecoder;
 import io.netty.handler.codec.http.DefaultFullHttpResponse;
 import io.netty.handler.codec.http.FullHttpResponse;
 import io.netty.handler.codec.http.HttpContent;
@@ -33,6 +32,7 @@ import io.netty.handler.codec.http.HttpObject;
 import io.netty.handler.codec.http.HttpRequest;
 import io.netty.handler.codec.http.LastHttpContent;
 import io.netty.handler.codec.http.QueryStringDecoder;
+import io.netty.handler.codec.http.ServerCookieDecoder;
 import io.netty.handler.codec.http.ServerCookieEncoder;
 import io.netty.util.CharsetUtil;
 
@@ -165,7 +165,7 @@ public class HttpSnoopServerHandler extends SimpleChannelInboundHandler<Object>
         // Encode the cookie.
         String cookieString = request.headers().getAndConvert(COOKIE);
         if (cookieString != null) {
-            Set<Cookie> cookies = CookieDecoder.decode(cookieString);
+            Set<Cookie> cookies = ServerCookieDecoder.decode(cookieString);
             if (!cookies.isEmpty()) {
                 // Reset the cookies if necessary.
                 for (Cookie cookie: cookies) {

example/src/main/java/io/netty/example/http/upload/HttpUploadServerHandler.java

@@ -22,7 +22,6 @@ import io.netty.channel.ChannelFutureListener;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.channel.SimpleChannelInboundHandler;
 import io.netty.handler.codec.http.Cookie;
-import io.netty.handler.codec.http.CookieDecoder;
 import io.netty.handler.codec.http.DefaultFullHttpResponse;
 import io.netty.handler.codec.http.FullHttpResponse;
 import io.netty.handler.codec.http.HttpContent;
@@ -36,6 +35,7 @@ import io.netty.handler.codec.http.HttpResponseStatus;
 import io.netty.handler.codec.http.HttpVersion;
 import io.netty.handler.codec.http.LastHttpContent;
 import io.netty.handler.codec.http.QueryStringDecoder;
+import io.netty.handler.codec.http.ServerCookieDecoder;
 import io.netty.handler.codec.http.ServerCookieEncoder;
 import io.netty.handler.codec.http.multipart.Attribute;
 import io.netty.handler.codec.http.multipart.DefaultHttpDataFactory;
@@ -124,7 +124,7 @@ public class HttpUploadServerHandler extends SimpleChannelInboundHandler<HttpObj
             if (value == null) {
                 cookies = Collections.emptySet();
             } else {
-                cookies = CookieDecoder.decode(value);
+                cookies = ServerCookieDecoder.decode(value);
             }
             for (Cookie cookie : cookies) {
                 responseContent.append("COOKIE: " + cookie + "\r\n");
@@ -307,7 +307,7 @@ public class HttpUploadServerHandler extends SimpleChannelInboundHandler<HttpObj
         if (value == null) {
             cookies = Collections.emptySet();
         } else {
-            cookies = CookieDecoder.decode(value);
+            cookies = ServerCookieDecoder.decode(value);
         }
         if (!cookies.isEmpty()) {
             // Reset the cookies if necessary.