From 40c9dd77bfb3d4d11a53172ca62d8ace19c018cc Mon Sep 17 00:00:00 2001 From: Greg Wilkins Date: Thu, 8 Mar 2012 15:23:45 +1100 Subject: [PATCH] jetty-9 javadoc and code cleanups --- .../org/eclipse/jetty/http/HttpFields.java | 1921 ++++++++--------- .../org/eclipse/jetty/util/BufferUtil.java | 4 - 2 files changed, 960 insertions(+), 965 deletions(-) diff --git a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpFields.java b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpFields.java index 9e6cdb0f7a2..d7cb5dbfe52 100644 --- a/jetty-http/src/main/java/org/eclipse/jetty/http/HttpFields.java +++ b/jetty-http/src/main/java/org/eclipse/jetty/http/HttpFields.java @@ -165,986 +165,985 @@ public class HttpFields implements Iterable /* ------------------------------------------------------------ */ private static final ThreadLocal __dateGenerator =new ThreadLocal() - { + { @Override protected DateGenerator initialValue() { return new DateGenerator(); } - }; + }; - /* ------------------------------------------------------------ */ - /** - * Format HTTP date "EEE, dd MMM yyyy HH:mm:ss 'GMT'" - */ - public static String formatDate(long date) + /* ------------------------------------------------------------ */ + /** + * Format HTTP date "EEE, dd MMM yyyy HH:mm:ss 'GMT'" + */ + public static String formatDate(long date) + { + return __dateGenerator.get().formatDate(date); + } + + /* ------------------------------------------------------------ */ + /** + * Format "EEE, dd-MMM-yyyy HH:mm:ss 'GMT'" for cookies + */ + public static void formatCookieDate(StringBuilder buf, long date) + { + __dateGenerator.get().formatCookieDate(buf,date); + } + + /* ------------------------------------------------------------ */ + /** + * Format "EEE, dd-MMM-yyyy HH:mm:ss 'GMT'" for cookies + */ + public static String formatCookieDate(long date) + { + StringBuilder buf = new StringBuilder(28); + formatCookieDate(buf, date); + return buf.toString(); + } + + /* ------------------------------------------------------------ */ + private final static String __dateReceiveFmt[] = + { + "EEE, dd MMM yyyy HH:mm:ss zzz", + "EEE, dd-MMM-yy HH:mm:ss", + "EEE MMM dd HH:mm:ss yyyy", + + "EEE, dd MMM yyyy HH:mm:ss", "EEE dd MMM yyyy HH:mm:ss zzz", + "EEE dd MMM yyyy HH:mm:ss", "EEE MMM dd yyyy HH:mm:ss zzz", "EEE MMM dd yyyy HH:mm:ss", + "EEE MMM-dd-yyyy HH:mm:ss zzz", "EEE MMM-dd-yyyy HH:mm:ss", "dd MMM yyyy HH:mm:ss zzz", + "dd MMM yyyy HH:mm:ss", "dd-MMM-yy HH:mm:ss zzz", "dd-MMM-yy HH:mm:ss", "MMM dd HH:mm:ss yyyy zzz", + "MMM dd HH:mm:ss yyyy", "EEE MMM dd HH:mm:ss yyyy zzz", + "EEE, MMM dd HH:mm:ss yyyy zzz", "EEE, MMM dd HH:mm:ss yyyy", "EEE, dd-MMM-yy HH:mm:ss zzz", + "EEE dd-MMM-yy HH:mm:ss zzz", "EEE dd-MMM-yy HH:mm:ss", + }; + + /* ------------------------------------------------------------ */ + private static class DateParser + { + final SimpleDateFormat _dateReceive[]= new SimpleDateFormat[__dateReceiveFmt.length]; + + long parse(final String dateVal) + { + for (int i = 0; i < _dateReceive.length; i++) { - return __dateGenerator.get().formatDate(date); - } - - /* ------------------------------------------------------------ */ - /** - * Format "EEE, dd-MMM-yyyy HH:mm:ss 'GMT'" for cookies - */ - public static void formatCookieDate(StringBuilder buf, long date) - { - __dateGenerator.get().formatCookieDate(buf,date); - } - - /* ------------------------------------------------------------ */ - /** - * Format "EEE, dd-MMM-yyyy HH:mm:ss 'GMT'" for cookies - */ - public static String formatCookieDate(long date) - { - StringBuilder buf = new StringBuilder(28); - formatCookieDate(buf, date); - return buf.toString(); - } - - /* ------------------------------------------------------------ */ - private final static String __dateReceiveFmt[] = + if (_dateReceive[i] == null) { - "EEE, dd MMM yyyy HH:mm:ss zzz", - "EEE, dd-MMM-yy HH:mm:ss", - "EEE MMM dd HH:mm:ss yyyy", + _dateReceive[i] = new SimpleDateFormat(__dateReceiveFmt[i], Locale.US); + _dateReceive[i].setTimeZone(__GMT); + } - "EEE, dd MMM yyyy HH:mm:ss", "EEE dd MMM yyyy HH:mm:ss zzz", - "EEE dd MMM yyyy HH:mm:ss", "EEE MMM dd yyyy HH:mm:ss zzz", "EEE MMM dd yyyy HH:mm:ss", - "EEE MMM-dd-yyyy HH:mm:ss zzz", "EEE MMM-dd-yyyy HH:mm:ss", "dd MMM yyyy HH:mm:ss zzz", - "dd MMM yyyy HH:mm:ss", "dd-MMM-yy HH:mm:ss zzz", "dd-MMM-yy HH:mm:ss", "MMM dd HH:mm:ss yyyy zzz", - "MMM dd HH:mm:ss yyyy", "EEE MMM dd HH:mm:ss yyyy zzz", - "EEE, MMM dd HH:mm:ss yyyy zzz", "EEE, MMM dd HH:mm:ss yyyy", "EEE, dd-MMM-yy HH:mm:ss zzz", - "EEE dd-MMM-yy HH:mm:ss zzz", "EEE dd-MMM-yy HH:mm:ss", + try + { + Date date = (Date) _dateReceive[i].parseObject(dateVal); + return date.getTime(); + } + catch (java.lang.Exception e) + { + // LOG.ignore(e); + } + } + + if (dateVal.endsWith(" GMT")) + { + final String val = dateVal.substring(0, dateVal.length() - 4); + + for (SimpleDateFormat element : _dateReceive) + { + try + { + Date date = (Date) element.parseObject(val); + return date.getTime(); + } + catch (java.lang.Exception e) + { + // LOG.ignore(e); + } + } + } + return -1; + } + } + + /* ------------------------------------------------------------ */ + public static long parseDate(String date) + { + return __dateParser.get().parse(date); + } + + /* ------------------------------------------------------------ */ + private static final ThreadLocal __dateParser =new ThreadLocal() + { + @Override + protected DateParser initialValue() + { + return new DateParser(); + } + }; + + /* -------------------------------------------------------------- */ + public final static String __01Jan1970=formatDate(0); + public final static ByteBuffer __01Jan1970_BUFFER=BufferUtil.toBuffer(__01Jan1970); + public final static String __01Jan1970_COOKIE = formatCookieDate(0).trim(); + private final static byte[] __colon_space = new byte[] {':',' '}; + /* -------------------------------------------------------------- */ + private final ArrayList _fields = new ArrayList(20); + private final StringMap _names = new StringMap(true); + private final int _maxCookieVersion; + + /* ------------------------------------------------------------ */ + /** + * Constructor. + */ + public HttpFields() + { + _maxCookieVersion=1; + } + + /* ------------------------------------------------------------ */ + /** + * Constructor. + */ + public HttpFields(int maxCookieVersion) + { + _maxCookieVersion=maxCookieVersion; + } + + + /* -------------------------------------------------------------- */ + /** + * Get Collection of header names. + */ + public Collection getFieldNamesCollection() + { + final List list = new ArrayList(_fields.size()); + for (Field f : _fields) + { + if (f!=null) + list.add(f._name); + } + return list; + } + + /* -------------------------------------------------------------- */ + /** + * Get enumeration of header _names. Returns an enumeration of strings representing the header + * _names for this request. + */ + public Enumeration getFieldNames() + { + final Enumeration buffers = Collections.enumeration(_names.keySet()); + return new Enumeration() + { + @Override + public String nextElement() + { + return buffers.nextElement().toString(); + } + + @Override + public boolean hasMoreElements() + { + return buffers.hasMoreElements(); + } }; + } - /* ------------------------------------------------------------ */ - private static class DateParser - { - final SimpleDateFormat _dateReceive[]= new SimpleDateFormat[__dateReceiveFmt.length]; + /* ------------------------------------------------------------ */ + public int size() + { + return _fields.size(); + } - long parse(final String dateVal) + /* ------------------------------------------------------------ */ + /** + * Get a Field by index. + * @return A Field value or null if the Field value has not been set + * + */ + public Field getField(int i) + { + return _fields.get(i); + } + + /* ------------------------------------------------------------ */ + @Override + public Iterator iterator() + { + return _fields.iterator(); + } + + /* ------------------------------------------------------------ */ + public Field getField(HttpHeader header) + { + return _names.get(header.toString()); + } + + /* ------------------------------------------------------------ */ + public Field getField(String name) + { + return _names.get(name); + } + + /* ------------------------------------------------------------ */ + public boolean containsKey(String name) + { + return _names.containsKey(name); + } + + /* -------------------------------------------------------------- */ + public String getStringField(HttpHeader header) + { + return getStringField(header.toString()); + } + + /* -------------------------------------------------------------- */ + /** + * @return the value of a field, or null if not found. For multiple fields of the same name, + * only the first is returned. + * @param name the case-insensitive field name + */ + public String getStringField(String name) + { + Field field = getField(name); + return field==null?null:field.getValue(); + } + + + /* -------------------------------------------------------------- */ + /** + * Get multi headers + * + * @return Enumeration of the values, or null if no such header. + * @param name the case-insensitive field name + */ + public Collection getValuesCollection(String name) + { + Field field = getField(name); + if (field==null) + return null; + + final List list = new ArrayList(); + + while(field!=null) + { + list.add(field.getValue()); + field=field._next; + } + return list; + } + + /* -------------------------------------------------------------- */ + /** + * Get multi headers + * + * @return Enumeration of the values + * @param name the case-insensitive field name + */ + public Enumeration getValues(String name) + { + final Field field = getField(name); + if (field == null) + { + List empty=Collections.emptyList(); + return Collections.enumeration(empty); + } + + return new Enumeration() { - for (int i = 0; i < _dateReceive.length; i++) - { - if (_dateReceive[i] == null) - { - _dateReceive[i] = new SimpleDateFormat(__dateReceiveFmt[i], Locale.US); - _dateReceive[i].setTimeZone(__GMT); - } + Field f = field; - try - { - Date date = (Date) _dateReceive[i].parseObject(dateVal); - return date.getTime(); - } - catch (java.lang.Exception e) - { - // LOG.ignore(e); - } - } - - if (dateVal.endsWith(" GMT")) - { - final String val = dateVal.substring(0, dateVal.length() - 4); - - for (SimpleDateFormat element : _dateReceive) - { - try - { - Date date = (Date) element.parseObject(val); - return date.getTime(); - } - catch (java.lang.Exception e) - { - // LOG.ignore(e); - } - } - } - return -1; - } + @Override + public boolean hasMoreElements() + { + return f != null; } - /* ------------------------------------------------------------ */ - public static long parseDate(String date) + @Override + public String nextElement() throws NoSuchElementException { - return __dateParser.get().parse(date); + if (f == null) throw new NoSuchElementException(); + Field n = f; + f = f._next; + return n.getValue(); + } + }; + } + + /* -------------------------------------------------------------- */ + /** + * Get multi field values with separator. The multiple values can be represented as separate + * headers of the same name, or by a single header using the separator(s), or a combination of + * both. Separators may be quoted. + * + * @param name the case-insensitive field name + * @param separators String of separators. + * @return Enumeration of the values, or null if no such header. + */ + public Enumeration getValues(String name, final String separators) + { + final Enumeration e = getValues(name); + if (e == null) + return null; + return new Enumeration() + { + QuotedStringTokenizer tok = null; + + @Override + public boolean hasMoreElements() + { + if (tok != null && tok.hasMoreElements()) return true; + while (e.hasMoreElements()) + { + String value = e.nextElement(); + tok = new QuotedStringTokenizer(value, separators, false, false); + if (tok.hasMoreElements()) return true; + } + tok = null; + return false; } - /* ------------------------------------------------------------ */ - private static final ThreadLocal __dateParser =new ThreadLocal() - { - @Override - protected DateParser initialValue() + @Override + public String nextElement() throws NoSuchElementException + { + if (!hasMoreElements()) throw new NoSuchElementException(); + String next = (String) tok.nextElement(); + if (next != null) next = next.trim(); + return next; + } + }; + } + + + /* -------------------------------------------------------------- */ + /** + * Set a field. + * + * @param name the name of the field + * @param value the value of the field. If null the field is cleared. + */ + public void put(String name, String value) + { + remove(name); + if (value == null) + return; + + // new value; + Field field = new Field(name, value); + _fields.add(field); + _names.put(name, field); + } + + /* -------------------------------------------------------------- */ + /** + * Set a field. + * + * @param name the name of the field + * @param list the List value of the field. If null the field is cleared. + */ + public void put(String name, List list) + { + remove(name); + for (String v : list) + if (v!=null) + add(name,v); + } + + /* -------------------------------------------------------------- */ + /** + * Add to or set a field. If the field is allowed to have multiple values, add will add multiple + * headers of the same name. + * + * @param name the name of the field + * @param value the value of the field. + * @exception IllegalArgumentException If the name is a single valued field and already has a + * value. + */ + public void add(String name, String value) throws IllegalArgumentException + { + if (value == null) throw new IllegalArgumentException("null value"); + + Field field = _names.get(name); + Field last = null; + while (field != null) + { + last = field; + field = field._next; + } + + // create the field + field = new Field(name, value); + _fields.add(field); + + // look for chain to add too + if (last != null) + last._next = field; + else + _names.put(name, field); + } + + + /* ------------------------------------------------------------ */ + /** + * Remove a field. + * + * @param name + */ + public void remove(String name) + { + Field field = _names.remove(name); + while (field != null) + { + _fields.remove(field); + field = field._next; + } + } + + /* -------------------------------------------------------------- */ + /** + * Get a header as an long value. Returns the value of an integer field or -1 if not found. The + * case of the field name is ignored. + * + * @param name the case-insensitive field name + * @exception NumberFormatException If bad long found + */ + public long getLongField(String name) throws NumberFormatException + { + Field field = getField(name); + return field==null?-1L:field.getLongValue(); + } + + /* -------------------------------------------------------------- */ + /** + * Get a header as a date value. Returns the value of a date field, or -1 if not found. The case + * of the field name is ignored. + * + * @param name the case-insensitive field name + */ + public long getDateField(String name) + { + Field field = getField(name); + if (field == null) + return -1; + + String val = valueParameters(field._value, null); + if (val == null) + return -1; + + final long date = __dateParser.get().parse(val); + if (date==-1) + throw new IllegalArgumentException("Cannot convert date: " + val); + return date; + } + + + /* -------------------------------------------------------------- */ + /** + * Sets the value of an long field. + * + * @param name the field name + * @param value the field long value + */ + public void putLongField(String name, long value) + { + String v = Long.toString(value); + put(name, v); + } + + + /* -------------------------------------------------------------- */ + /** + * Sets the value of a date field. + * + * @param name the field name + * @param date the field date value + */ + public void putDateField(String name, long date) + { + String d=formatDate(date); + put(name, d); + } + + /* -------------------------------------------------------------- */ + /** + * Sets the value of a date field. + * + * @param name the field name + * @param date the field date value + */ + public void addDateField(String name, long date) + { + String d=formatDate(date); + add(name,d); + } + + /* ------------------------------------------------------------ */ + /** + * Format a set cookie value + * + * @param cookie The cookie. + */ + public void addSetCookie(HttpCookie cookie) + { + addSetCookie( + cookie.getName(), + cookie.getValue(), + cookie.getDomain(), + cookie.getPath(), + cookie.getMaxAge(), + cookie.getComment(), + cookie.isSecure(), + cookie.isHttpOnly(), + cookie.getVersion()); + } + + /** + * Format a set cookie value + * + * @param name the name + * @param value the value + * @param domain the domain + * @param path the path + * @param maxAge the maximum age + * @param comment the comment (only present on versions > 0) + * @param isSecure true if secure cookie + * @param isHttpOnly true if for http only + * @param version version of cookie logic to use (0 == default behavior) + */ + public void addSetCookie( + final String name, + final String value, + final String domain, + final String path, + final long maxAge, + final String comment, + final boolean isSecure, + final boolean isHttpOnly, + int version) + { + String delim=_maxCookieVersion==0?"":__COOKIE_DELIM; + + // Check arguments + if (name == null || name.length() == 0) + throw new IllegalArgumentException("Bad cookie name"); + + // Format value and params + StringBuilder buf = new StringBuilder(128); + String name_value_params; + boolean quoted = QuotedStringTokenizer.quoteIfNeeded(buf, name, delim); + buf.append('='); + String start=buf.toString(); + if (value != null && value.length() > 0) + quoted|=QuotedStringTokenizer.quoteIfNeeded(buf, value, delim); + + // upgrade to version 1 cookies if quoted. + if (quoted&&version==0 && _maxCookieVersion>=1) + version=1; + + if (version>_maxCookieVersion) + version=_maxCookieVersion; + + if (version > 0) + { + buf.append(";Version="); + buf.append(version); + if (comment != null && comment.length() > 0) + { + buf.append(";Comment="); + QuotedStringTokenizer.quoteIfNeeded(buf, comment, delim); + } + } + if (path != null && path.length() > 0) + { + buf.append(";Path="); + if (path.trim().startsWith("\"")) + buf.append(path); + else + QuotedStringTokenizer.quoteIfNeeded(buf,path,delim); + } + if (domain != null && domain.length() > 0) + { + buf.append(";Domain="); + QuotedStringTokenizer.quoteIfNeeded(buf,domain.toLowerCase(),delim); + } + + if (maxAge >= 0) + { + // Always add the expires param as some browsers still don't handle max-age + buf.append(";Expires="); + if (maxAge == 0) + buf.append(__01Jan1970_COOKIE); + else + formatCookieDate(buf, System.currentTimeMillis() + 1000L * maxAge); + + if (version >0) + { + buf.append(";Max-Age="); + buf.append(maxAge); + } + } + else if (version > 0) + { + buf.append(";Discard"); + } + + if (isSecure) + buf.append(";Secure"); + if (isHttpOnly) + buf.append(";HttpOnly"); + + name_value_params = buf.toString(); + + // remove existing set-cookie of same name + Field field = getField(HttpHeader.SET_COOKIE); + Field last=null; + while (field!=null) + { + if (field._value!=null && field._value.toString().startsWith(start)) + { + _fields.remove(field); + if (last==null) + _names.put(HttpHeader.SET_COOKIE.toString(),field._next); + else + last._next=field._next; + break; + } + last=field; + field=field._next; + } + + add(HttpHeader.SET_COOKIE.toString(), name_value_params); + + // Expire responses with set-cookie headers so they do not get cached. + put(HttpHeader.EXPIRES.toString(), __01Jan1970); + } + + /* -------------------------------------------------------------- */ + public void putTo(ByteBuffer buffer) throws IOException + { + for (int i = 0; i < _fields.size(); i++) + { + Field field = _fields.get(i); + if (field != null) + field.putTo(buffer); + } + BufferUtil.putCRLF(buffer); + } + + /* -------------------------------------------------------------- */ + @Override + public String toString() + { + try + { + StringBuffer buffer = new StringBuffer(); + for (int i = 0; i < _fields.size(); i++) + { + Field field = _fields.get(i); + if (field != null) { - return new DateParser(); + String tmp = field.getName(); + if (tmp != null) buffer.append(tmp); + buffer.append(": "); + tmp = field.getValue(); + if (tmp != null) buffer.append(tmp); + buffer.append("\r\n"); } - }; - - /* -------------------------------------------------------------- */ - public final static String __01Jan1970=formatDate(0); - public final static ByteBuffer __01Jan1970_BUFFER=BufferUtil.toBuffer(__01Jan1970); - public final static String __01Jan1970_COOKIE = formatCookieDate(0).trim(); - private final static byte[] __colon_space = new byte[] {':',' '}; - /* -------------------------------------------------------------- */ - private final ArrayList _fields = new ArrayList(20); - private final StringMap _names = new StringMap(true); - private final int _maxCookieVersion; - - /* ------------------------------------------------------------ */ - /** - * Constructor. - */ - public HttpFields() - { - _maxCookieVersion=1; - } - - /* ------------------------------------------------------------ */ - /** - * Constructor. - */ - public HttpFields(int maxCookieVersion) - { - _maxCookieVersion=maxCookieVersion; - } - - - /* -------------------------------------------------------------- */ - /** - * Get Collection of header names. - */ - public Collection getFieldNamesCollection() - { - final List list = new ArrayList(_fields.size()); - for (Field f : _fields) - { - if (f!=null) - list.add(f._name); - } - return list; - } - - /* -------------------------------------------------------------- */ - /** - * Get enumeration of header _names. Returns an enumeration of strings representing the header - * _names for this request. - */ - public Enumeration getFieldNames() - { - final Enumeration buffers = Collections.enumeration(_names.keySet()); - return new Enumeration() - { - @Override - public String nextElement() - { - return buffers.nextElement().toString(); - } - - @Override - public boolean hasMoreElements() - { - return buffers.hasMoreElements(); - } - }; - } - - /* ------------------------------------------------------------ */ - public int size() - { - return _fields.size(); - } - - /* ------------------------------------------------------------ */ - /** - * Get a Field by index. - * @return A Field value or null if the Field value has not been set - * - */ - public Field getField(int i) - { - return _fields.get(i); - } - - /* ------------------------------------------------------------ */ - @Override - public Iterator iterator() - { - return _fields.iterator(); - } - - /* ------------------------------------------------------------ */ - public Field getField(HttpHeader header) - { - return _names.get(header.toString()); - } - - /* ------------------------------------------------------------ */ - public Field getField(String name) - { - return _names.get(name); - } - - /* ------------------------------------------------------------ */ - public boolean containsKey(String name) - { - return _names.containsKey(name); - } - - /* -------------------------------------------------------------- */ - public String getStringField(HttpHeader header) - { - return getStringField(header.toString()); - } - - /* -------------------------------------------------------------- */ - /** - * @return the value of a field, or null if not found. For multiple fields of the same name, - * only the first is returned. - * @param name the case-insensitive field name - */ - public String getStringField(String name) - { - Field field = getField(name); - return field==null?null:field.getValue(); - } - - - /* -------------------------------------------------------------- */ - /** - * Get multi headers - * - * @return Enumeration of the values, or null if no such header. - * @param name the case-insensitive field name - */ - public Collection getValuesCollection(String name) - { - Field field = getField(name); - if (field==null) - return null; - - final List list = new ArrayList(); - - while(field!=null) - { - list.add(field.getValue()); - field=field._next; - } - return list; - } - - /* -------------------------------------------------------------- */ - /** - * Get multi headers - * - * @return Enumeration of the values - * @param name the case-insensitive field name - */ - public Enumeration getValues(String name) - { - final Field field = getField(name); - if (field == null) - { - List empty=Collections.emptyList(); - return Collections.enumeration(empty); - } - - return new Enumeration() - { - Field f = field; - - @Override - public boolean hasMoreElements() - { - return f != null; - } - - @Override - public String nextElement() throws NoSuchElementException - { - if (f == null) throw new NoSuchElementException(); - Field n = f; - f = f._next; - return n.getValue(); - } - }; - } - - /* -------------------------------------------------------------- */ - /** - * Get multi field values with separator. The multiple values can be represented as separate - * headers of the same name, or by a single header using the separator(s), or a combination of - * both. Separators may be quoted. - * - * @param name the case-insensitive field name - * @param separators String of separators. - * @return Enumeration of the values, or null if no such header. - */ - public Enumeration getValues(String name, final String separators) - { - final Enumeration e = getValues(name); - if (e == null) - return null; - return new Enumeration() - { - QuotedStringTokenizer tok = null; - - @Override - public boolean hasMoreElements() - { - if (tok != null && tok.hasMoreElements()) return true; - while (e.hasMoreElements()) - { - String value = e.nextElement(); - tok = new QuotedStringTokenizer(value, separators, false, false); - if (tok.hasMoreElements()) return true; - } - tok = null; - return false; - } - - @Override - public String nextElement() throws NoSuchElementException - { - if (!hasMoreElements()) throw new NoSuchElementException(); - String next = (String) tok.nextElement(); - if (next != null) next = next.trim(); - return next; - } - }; - } - - - /* -------------------------------------------------------------- */ - /** - * Set a field. - * - * @param name the name of the field - * @param value the value of the field. If null the field is cleared. - */ - public void put(String name, String value) - { - remove(name); - if (value == null) - return; - - // new value; - Field field = new Field(name, value); - _fields.add(field); - _names.put(name, field); - } - - /* -------------------------------------------------------------- */ - /** - * Set a field. - * - * @param name the name of the field - * @param list the List value of the field. If null the field is cleared. - */ - public void put(String name, List list) - { - remove(name); - for (String v : list) - if (v!=null) - add(name,v); - } - - /* -------------------------------------------------------------- */ - /** - * Add to or set a field. If the field is allowed to have multiple values, add will add multiple - * headers of the same name. - * - * @param name the name of the field - * @param value the value of the field. - * @exception IllegalArgumentException If the name is a single valued field and already has a - * value. - */ - public void add(String name, String value) throws IllegalArgumentException - { - if (value == null) throw new IllegalArgumentException("null value"); - - Field field = _names.get(name); - Field last = null; - while (field != null) - { - last = field; - field = field._next; - } - - // create the field - field = new Field(name, value); - _fields.add(field); - - // look for chain to add too - if (last != null) - last._next = field; - else - _names.put(name, field); - } - - - /* ------------------------------------------------------------ */ - /** - * Remove a field. - * - * @param name - */ - public void remove(String name) - { - Field field = _names.remove(name); - while (field != null) - { - _fields.remove(field); - field = field._next; - } - } - - /* -------------------------------------------------------------- */ - /** - * Get a header as an long value. Returns the value of an integer field or -1 if not found. The - * case of the field name is ignored. - * - * @param name the case-insensitive field name - * @exception NumberFormatException If bad long found - */ - public long getLongField(String name) throws NumberFormatException - { - Field field = getField(name); - return field==null?-1L:field.getLongValue(); - } - - /* -------------------------------------------------------------- */ - /** - * Get a header as a date value. Returns the value of a date field, or -1 if not found. The case - * of the field name is ignored. - * - * @param name the case-insensitive field name - */ - public long getDateField(String name) - { - Field field = getField(name); - if (field == null) - return -1; - - String val = valueParameters(field._value, null); - if (val == null) - return -1; - - final long date = __dateParser.get().parse(val); - if (date==-1) - throw new IllegalArgumentException("Cannot convert date: " + val); - return date; - } - - - /* -------------------------------------------------------------- */ - /** - * Sets the value of an long field. - * - * @param name the field name - * @param value the field long value - */ - public void putLongField(String name, long value) - { - String v = Long.toString(value); - put(name, v); - } - - - /* -------------------------------------------------------------- */ - /** - * Sets the value of a date field. - * - * @param name the field name - * @param date the field date value - */ - public void putDateField(String name, long date) - { - String d=formatDate(date); - put(name, d); - } - - /* -------------------------------------------------------------- */ - /** - * Sets the value of a date field. - * - * @param name the field name - * @param date the field date value - */ - public void addDateField(String name, long date) - { - String d=formatDate(date); - add(name,d); - } - - /* ------------------------------------------------------------ */ - /** - * Format a set cookie value - * - * @param cookie The cookie. - */ - public void addSetCookie(HttpCookie cookie) - { - addSetCookie( - cookie.getName(), - cookie.getValue(), - cookie.getDomain(), - cookie.getPath(), - cookie.getMaxAge(), - cookie.getComment(), - cookie.isSecure(), - cookie.isHttpOnly(), - cookie.getVersion()); - } - - /** - * Format a set cookie value - * - * @param name the name - * @param value the value - * @param domain the domain - * @param path the path - * @param maxAge the maximum age - * @param comment the comment (only present on versions > 0) - * @param isSecure true if secure cookie - * @param isHttpOnly true if for http only - * @param version version of cookie logic to use (0 == default behavior) - */ - public void addSetCookie( - final String name, - final String value, - final String domain, - final String path, - final long maxAge, - final String comment, - final boolean isSecure, - final boolean isHttpOnly, - int version) - { - String delim=_maxCookieVersion==0?"":__COOKIE_DELIM; - - // Check arguments - if (name == null || name.length() == 0) - throw new IllegalArgumentException("Bad cookie name"); - - // Format value and params - StringBuilder buf = new StringBuilder(128); - String name_value_params; - boolean quoted = QuotedStringTokenizer.quoteIfNeeded(buf, name, delim); - buf.append('='); - String start=buf.toString(); - if (value != null && value.length() > 0) - quoted|=QuotedStringTokenizer.quoteIfNeeded(buf, value, delim); - - // upgrade to version 1 cookies if quoted. - if (quoted&&version==0 && _maxCookieVersion>=1) - version=1; - - if (version>_maxCookieVersion) - version=_maxCookieVersion; - - if (version > 0) - { - buf.append(";Version="); - buf.append(version); - if (comment != null && comment.length() > 0) - { - buf.append(";Comment="); - QuotedStringTokenizer.quoteIfNeeded(buf, comment, delim); - } - } - if (path != null && path.length() > 0) - { - buf.append(";Path="); - if (path.trim().startsWith("\"")) - buf.append(path); - else - QuotedStringTokenizer.quoteIfNeeded(buf,path,delim); - } - if (domain != null && domain.length() > 0) - { - buf.append(";Domain="); - QuotedStringTokenizer.quoteIfNeeded(buf,domain.toLowerCase(),delim); - } - - if (maxAge >= 0) - { - // Always add the expires param as some browsers still don't handle max-age - buf.append(";Expires="); - if (maxAge == 0) - buf.append(__01Jan1970_COOKIE); - else - formatCookieDate(buf, System.currentTimeMillis() + 1000L * maxAge); - - if (version >0) - { - buf.append(";Max-Age="); - buf.append(maxAge); - } - } - else if (version > 0) - { - buf.append(";Discard"); - } - - if (isSecure) - buf.append(";Secure"); - if (isHttpOnly) - buf.append(";HttpOnly"); - - name_value_params = buf.toString(); - - // remove existing set-cookie of same name - Field field = getField(HttpHeader.SET_COOKIE); - Field last=null; - while (field!=null) - { - if (field._value!=null && field._value.toString().startsWith(start)) - { - _fields.remove(field); - if (last==null) - _names.put(HttpHeader.SET_COOKIE.toString(),field._next); - else - last._next=field._next; - break; - } - last=field; - field=field._next; - } - - add(HttpHeader.SET_COOKIE.toString(), name_value_params); - - // Expire responses with set-cookie headers so they do not get cached. - put(HttpHeader.EXPIRES.toString(), __01Jan1970); - } - - /* -------------------------------------------------------------- */ - public void putTo(ByteBuffer buffer) throws IOException - { - for (int i = 0; i < _fields.size(); i++) - { - Field field = _fields.get(i); - if (field != null) - field.putTo(buffer); - } - BufferUtil.putCRLF(buffer); - } - - /* -------------------------------------------------------------- */ - @Override - public String toString() - { - try - { - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < _fields.size(); i++) - { - Field field = _fields.get(i); - if (field != null) - { - String tmp = field.getName(); - if (tmp != null) buffer.append(tmp); - buffer.append(": "); - tmp = field.getValue(); - if (tmp != null) buffer.append(tmp); - buffer.append("\r\n"); - } - } - buffer.append("\r\n"); - return buffer.toString(); - } - catch (Exception e) - { - LOG.warn(e); - return e.toString(); - } - } - - /* ------------------------------------------------------------ */ - /** - * Clear the header. - */ - public void clear() - { - _fields.clear(); - _names.clear(); - } - - /* ------------------------------------------------------------ */ - /** - * Add fields from another HttpFields instance. Single valued fields are replaced, while all - * others are added. - * - * @param fields - */ - public void add(HttpFields fields) - { - if (fields == null) return; - - Enumeration e = fields.getFieldNames(); - while (e.hasMoreElements()) - { - String name = e.nextElement(); - Enumeration values = fields.getValues(name); - while (values.hasMoreElements()) - add(name, values.nextElement()); - } - } - - /* ------------------------------------------------------------ */ - /** - * Get field value parameters. Some field values can have parameters. This method separates the - * value from the parameters and optionally populates a map with the parameters. For example: - * - * 
-                     * 
-                     * FieldName : Value ; param1=val1 ; param2=val2
-                     * 
-                     *
- * - * @param value The Field value, possibly with parameteres. - * @param parameters A map to populate with the parameters, or null - * @return The value. - */ - public static String valueParameters(String value, Map parameters) - { - if (value == null) return null; - - int i = value.indexOf(';'); - if (i < 0) return value; - if (parameters == null) return value.substring(0, i).trim(); - - StringTokenizer tok1 = new QuotedStringTokenizer(value.substring(i), ";", false, true); - while (tok1.hasMoreTokens()) - { - String token = tok1.nextToken(); - StringTokenizer tok2 = new QuotedStringTokenizer(token, "= "); - if (tok2.hasMoreTokens()) - { - String paramName = tok2.nextToken(); - String paramVal = null; - if (tok2.hasMoreTokens()) paramVal = tok2.nextToken(); - parameters.put(paramName, paramVal); - } - } - - return value.substring(0, i).trim(); - } - - /* ------------------------------------------------------------ */ - private static final Float __one = new Float("1.0"); - private static final Float __zero = new Float("0.0"); - private static final StringMap __qualities = new StringMap<>(); - static - { - __qualities.put("*", __one); - __qualities.put("1.0", __one); - __qualities.put("1", __one); - __qualities.put("0.9", new Float("0.9")); - __qualities.put("0.8", new Float("0.8")); - __qualities.put("0.7", new Float("0.7")); - __qualities.put("0.66", new Float("0.66")); - __qualities.put("0.6", new Float("0.6")); - __qualities.put("0.5", new Float("0.5")); - __qualities.put("0.4", new Float("0.4")); - __qualities.put("0.33", new Float("0.33")); - __qualities.put("0.3", new Float("0.3")); - __qualities.put("0.2", new Float("0.2")); - __qualities.put("0.1", new Float("0.1")); - __qualities.put("0", __zero); - __qualities.put("0.0", __zero); - } - - /* ------------------------------------------------------------ */ - public static Float getQuality(String value) - { - if (value == null) return __zero; - - int qe = value.indexOf(";"); - if (qe++ < 0 || qe == value.length()) return __one; - - if (value.charAt(qe++) == 'q') - { - qe++; - Float q = __qualities.get(value, qe, value.length() - qe); - if (q != null) - return q; - } - - Map params = new HashMap(4); - valueParameters(value, params); - String qs = params.get("q"); - if (qs==null) - qs="*"; - Float q = __qualities.get(qs); - if (q == null) - { - try - { - q = new Float(qs); - } - catch (Exception e) - { - q = __one; - } - } - return q; - } - - /* ------------------------------------------------------------ */ - /** - * List values in quality order. - * - * @param e Enumeration of values with quality parameters - * @return values in quality order. - */ - public static List qualityList(Enumeration e) - { - if (e == null || !e.hasMoreElements()) - return Collections.emptyList(); - - Object list = null; - Object qual = null; - - // Assume list will be well ordered and just add nonzero - while (e.hasMoreElements()) - { - String v = e.nextElement().toString(); - Float q = getQuality(v); - - if (q.floatValue() >= 0.001) - { - list = LazyList.add(list, v); - qual = LazyList.add(qual, q); - } - } - - List vl = LazyList.getList(list, false); - if (vl.size() < 2) return vl; - - List ql = LazyList.getList(qual, false); - - // sort list with swaps - Float last = __zero; - for (int i = vl.size(); i-- > 0;) - { - Float q = (Float) ql.get(i); - if (last.compareTo(q) > 0) - { - Object tmp = vl.get(i); - vl.set(i, vl.get(i + 1)); - vl.set(i + 1, tmp); - ql.set(i, ql.get(i + 1)); - ql.set(i + 1, q); - last = __zero; - i = vl.size(); - continue; - } - last = q; - } - ql.clear(); - return vl; - } - - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ - public static final class Field - { - private final String _name; - private final String _value; - private Field _next; - - /* ------------------------------------------------------------ */ - private Field(String name, String value) - { - _name = name; - _value = value; - _next = null; - } - - /* ------------------------------------------------------------ */ - private byte[] toSanitisedBytes(String s) - { - byte[] bytes = s.getBytes(StringUtil.__ISO_8859_1_CHARSET); - for (int i=bytes.length;i-->0;) - { - switch(bytes[i]) - { - case '\r': - case '\n': - case ':' : - bytes[i]=(byte)'?'; - } - } - return bytes; - } - - /* ------------------------------------------------------------ */ - public void putTo(ByteBuffer buffer) - { - HttpHeader header = HttpHeader.CACHE.get(_name); - if (header!=null) - { - buffer.put(header.toBytesColonSpace()); - - if (HttpHeaderValue.hasKnownValues(header)) - { - HttpHeaderValue value=HttpHeaderValue.CACHE.get(_value); - if (value!=null) - buffer.put(value.toBuffer()); - else - buffer.put(toSanitisedBytes(_value)); - } - else - buffer.put(toSanitisedBytes(_value)); - } - else - { - buffer.put(toSanitisedBytes(_name)); - buffer.put(__colon_space); - buffer.put(toSanitisedBytes(_value)); - } - - BufferUtil.putCRLF(buffer); - } - - /* ------------------------------------------------------------ */ - public void putValueTo(ByteBuffer buffer) - { - buffer.put(toSanitisedBytes(_value)); - } - - /* ------------------------------------------------------------ */ - public String getName() - { - return _name; - } - - /* ------------------------------------------------------------ */ - public String getValue() - { - return _value; - } - - /* ------------------------------------------------------------ */ - public int getIntValue() - { - return StringUtil.toInt(_value); - } - - /* ------------------------------------------------------------ */ - public long getLongValue() - { - return StringUtil.toLong(_value); - } - - - /* ------------------------------------------------------------ */ - @Override - public String toString() - { - return ("[" + getName() + "=" + _value + (_next == null ? "" : "->") + "]"); - } - } + } + buffer.append("\r\n"); + return buffer.toString(); + } + catch (Exception e) + { + LOG.warn(e); + return e.toString(); + } + } + + /* ------------------------------------------------------------ */ + /** + * Clear the header. + */ + public void clear() + { + _fields.clear(); + _names.clear(); + } + + /* ------------------------------------------------------------ */ + /** + * Add fields from another HttpFields instance. Single valued fields are replaced, while all + * others are added. + * + * @param fields + */ + public void add(HttpFields fields) + { + if (fields == null) return; + + Enumeration e = fields.getFieldNames(); + while (e.hasMoreElements()) + { + String name = e.nextElement(); + Enumeration values = fields.getValues(name); + while (values.hasMoreElements()) + add(name, values.nextElement()); + } + } + + /* ------------------------------------------------------------ */ + /** + * Get field value parameters. Some field values can have parameters. This method separates the + * value from the parameters and optionally populates a map with the parameters. For example: + * + * 
+     * 
+     * FieldName : Value ; param1=val1 ; param2=val2
+     * 
+     *
+ * + * @param value The Field value, possibly with parameteres. + * @param parameters A map to populate with the parameters, or null + * @return The value. + */ + public static String valueParameters(String value, Map parameters) + { + if (value == null) return null; + + int i = value.indexOf(';'); + if (i < 0) return value; + if (parameters == null) return value.substring(0, i).trim(); + + StringTokenizer tok1 = new QuotedStringTokenizer(value.substring(i), ";", false, true); + while (tok1.hasMoreTokens()) + { + String token = tok1.nextToken(); + StringTokenizer tok2 = new QuotedStringTokenizer(token, "= "); + if (tok2.hasMoreTokens()) + { + String paramName = tok2.nextToken(); + String paramVal = null; + if (tok2.hasMoreTokens()) paramVal = tok2.nextToken(); + parameters.put(paramName, paramVal); + } + } + + return value.substring(0, i).trim(); + } + + /* ------------------------------------------------------------ */ + private static final Float __one = new Float("1.0"); + private static final Float __zero = new Float("0.0"); + private static final StringMap __qualities = new StringMap<>(); + static + { + __qualities.put("*", __one); + __qualities.put("1.0", __one); + __qualities.put("1", __one); + __qualities.put("0.9", new Float("0.9")); + __qualities.put("0.8", new Float("0.8")); + __qualities.put("0.7", new Float("0.7")); + __qualities.put("0.66", new Float("0.66")); + __qualities.put("0.6", new Float("0.6")); + __qualities.put("0.5", new Float("0.5")); + __qualities.put("0.4", new Float("0.4")); + __qualities.put("0.33", new Float("0.33")); + __qualities.put("0.3", new Float("0.3")); + __qualities.put("0.2", new Float("0.2")); + __qualities.put("0.1", new Float("0.1")); + __qualities.put("0", __zero); + __qualities.put("0.0", __zero); + } + + /* ------------------------------------------------------------ */ + public static Float getQuality(String value) + { + if (value == null) return __zero; + + int qe = value.indexOf(";"); + if (qe++ < 0 || qe == value.length()) return __one; + + if (value.charAt(qe++) == 'q') + { + qe++; + Float q = __qualities.get(value, qe, value.length() - qe); + if (q != null) + return q; + } + + Map params = new HashMap(4); + valueParameters(value, params); + String qs = params.get("q"); + if (qs==null) + qs="*"; + Float q = __qualities.get(qs); + if (q == null) + { + try + { + q = new Float(qs); + } + catch (Exception e) + { + q = __one; + } + } + return q; + } + + /* ------------------------------------------------------------ */ + /** + * List values in quality order. + * + * @param e Enumeration of values with quality parameters + * @return values in quality order. + */ + public static List qualityList(Enumeration e) + { + if (e == null || !e.hasMoreElements()) + return Collections.emptyList(); + + Object list = null; + Object qual = null; + + // Assume list will be well ordered and just add nonzero + while (e.hasMoreElements()) + { + String v = e.nextElement().toString(); + Float q = getQuality(v); + + if (q.floatValue() >= 0.001) + { + list = LazyList.add(list, v); + qual = LazyList.add(qual, q); + } + } + + List vl = LazyList.getList(list, false); + if (vl.size() < 2) return vl; + + List ql = LazyList.getList(qual, false); + + // sort list with swaps + Float last = __zero; + for (int i = vl.size(); i-- > 0;) + { + Float q = (Float) ql.get(i); + if (last.compareTo(q) > 0) + { + Object tmp = vl.get(i); + vl.set(i, vl.get(i + 1)); + vl.set(i + 1, tmp); + ql.set(i, ql.get(i + 1)); + ql.set(i + 1, q); + last = __zero; + i = vl.size(); + continue; + } + last = q; + } + ql.clear(); + return vl; + } + + /* ------------------------------------------------------------ */ + /* ------------------------------------------------------------ */ + /* ------------------------------------------------------------ */ + public static final class Field + { + private final String _name; + private final String _value; + private Field _next; + + /* ------------------------------------------------------------ */ + private Field(String name, String value) + { + _name = name; + _value = value; + _next = null; + } + + /* ------------------------------------------------------------ */ + private byte[] toSanitisedBytes(String s) + { + byte[] bytes = s.getBytes(StringUtil.__ISO_8859_1_CHARSET); + for (int i=bytes.length;i-->0;) + { + switch(bytes[i]) + { + case '\r': + case '\n': + case ':' : + bytes[i]=(byte)'?'; + } + } + return bytes; + } + + /* ------------------------------------------------------------ */ + public void putTo(ByteBuffer buffer) + { + HttpHeader header = HttpHeader.CACHE.get(_name); + if (header!=null) + { + buffer.put(header.toBytesColonSpace()); + + if (HttpHeaderValue.hasKnownValues(header)) + { + HttpHeaderValue value=HttpHeaderValue.CACHE.get(_value); + if (value!=null) + buffer.put(value.toBuffer()); + else + buffer.put(toSanitisedBytes(_value)); + } + else + buffer.put(toSanitisedBytes(_value)); + } + else + { + buffer.put(toSanitisedBytes(_name)); + buffer.put(__colon_space); + buffer.put(toSanitisedBytes(_value)); + } + + BufferUtil.putCRLF(buffer); + } + + /* ------------------------------------------------------------ */ + public void putValueTo(ByteBuffer buffer) + { + buffer.put(toSanitisedBytes(_value)); + } + + /* ------------------------------------------------------------ */ + public String getName() + { + return _name; + } + + /* ------------------------------------------------------------ */ + public String getValue() + { + return _value; + } + + /* ------------------------------------------------------------ */ + public int getIntValue() + { + return StringUtil.toInt(_value); + } + + /* ------------------------------------------------------------ */ + public long getLongValue() + { + return StringUtil.toLong(_value); + } + + /* ------------------------------------------------------------ */ + @Override + public String toString() + { + return ("[" + getName() + "=" + _value + (_next == null ? "" : "->") + "]"); + } + } } diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/BufferUtil.java b/jetty-util/src/main/java/org/eclipse/jetty/util/BufferUtil.java index 88ac3dae17d..5a973387db2 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/BufferUtil.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/BufferUtil.java @@ -692,8 +692,4 @@ public class BufferUtil return false; return true; } - - - - }