001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/util/CookieTools.java,v 1.7 2002/02/21 22:51:55 remm Exp $
003: * $Revision: 1.7 $
004: * $Date: 2002/02/21 22:51:55 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.util;
065:
066: import java.text.*;
067: import java.util.*;
068:
069: import javax.servlet.http.Cookie;
070:
071: // XXX use only one Date instance/request, reuse it.
072:
073: /**
074: * Cookie utils - generate cookie header, etc
075: *
076: * @author Original Author Unknown
077: * @author duncan@eng.sun.com
078: */
079: public class CookieTools {
080:
081: /** Return the header name to set the cookie, based on cookie
082: * version
083: */
084: public static String getCookieHeaderName(Cookie cookie) {
085: int version = cookie.getVersion();
086:
087: if (version == 1) {
088: return "Set-Cookie2";
089: } else {
090: return "Set-Cookie";
091: }
092: }
093:
094: /** Return the header value used to set this cookie
095: * @deprecated Use StringBuffer version
096: */
097: public static String getCookieHeaderValue(Cookie cookie) {
098: StringBuffer buf = new StringBuffer();
099: getCookieHeaderValue(cookie, buf);
100: return buf.toString();
101: }
102:
103: /** Return the header value used to set this cookie
104: */
105: public static void getCookieHeaderValue(Cookie cookie,
106: StringBuffer buf) {
107: int version = cookie.getVersion();
108:
109: // this part is the same for all cookies
110:
111: String name = cookie.getName(); // Avoid NPE on malformed cookies
112: if (name == null)
113: name = "";
114: String value = cookie.getValue();
115: if (value == null)
116: value = "";
117:
118: buf.append(name);
119: buf.append("=");
120: maybeQuote(version, buf, value);
121:
122: // add version 1 specific information
123: if (version == 1) {
124: // Version=1 ... required
125: buf.append(";Version=1");
126:
127: // Comment=comment
128: if (cookie.getComment() != null) {
129: buf.append(";Comment=");
130: maybeQuote(version, buf, cookie.getComment());
131: }
132: }
133:
134: // add domain information, if present
135:
136: if (cookie.getDomain() != null) {
137: buf.append(";Domain=");
138: maybeQuote(version, buf, cookie.getDomain());
139: }
140:
141: // Max-Age=secs/Discard ... or use old "Expires" format
142: if (cookie.getMaxAge() >= 0) {
143: if (version == 0) {
144: buf.append(";Expires=");
145: if (cookie.getMaxAge() == 0)
146: DateTool.oldCookieFormat.format(new Date(10000),
147: buf, new FieldPosition(0));
148: else
149: DateTool.oldCookieFormat.format(new Date(System
150: .currentTimeMillis()
151: + cookie.getMaxAge() * 1000L), buf,
152: new FieldPosition(0));
153: } else {
154: buf.append(";Max-Age=");
155: buf.append(cookie.getMaxAge());
156: }
157: } else if (version == 1)
158: buf.append(";Discard");
159:
160: // Path=path
161: if (cookie.getPath() != null) {
162: buf.append(";Path=");
163: maybeQuote(version, buf, cookie.getPath());
164: }
165:
166: // Secure
167: if (cookie.getSecure()) {
168: buf.append(";Secure");
169: }
170: }
171:
172: static void maybeQuote(int version, StringBuffer buf, String value) {
173: if (version == 0 || isToken(value))
174: buf.append(value);
175: else {
176: buf.append('"');
177: buf.append(value);
178: buf.append('"');
179: }
180: }
181:
182: //
183: // from RFC 2068, token special case characters
184: //
185: private static final String tspecials = "()<>@,;:\\\"/[]?={} \t";
186:
187: /*
188: * Return true iff the string counts as an HTTP/1.1 "token".
189: */
190: private static boolean isToken(String value) {
191: int len = value.length();
192:
193: for (int i = 0; i < len; i++) {
194: char c = value.charAt(i);
195:
196: if (c < 0x20 || c >= 0x7f || tspecials.indexOf(c) != -1)
197: return false;
198: }
199: return true;
200: }
201:
202: }
|