1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
/* * @(#)MimeTypeParameterList.java 1.12 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. * * This software is the proprietary information of Sun Microsystems, Inc. * Use is subject to license terms. * */ package javax.activation; import java.util.Hashtable; import java.util.Enumeration; /** * A parameter list of a MimeType * as defined in RFC 2045 and 2046. The Primary type of the * object must already be stripped off. * * @see javax.activation.MimeType * * @since 1.6 */ public class MimeTypeParameterList { private Hashtable parameters; /** * A string that holds all the special chars. */ private static final String TSPECIALS = "()<>@,;:/[]?=\\\""; /** * Default constructor. */ public MimeTypeParameterList() { parameters = new Hashtable(); } /** * Constructs a new MimeTypeParameterList with the passed in data. * * @param parameterList an RFC 2045, 2046 compliant parameter list. */ public MimeTypeParameterList(String parameterList) throws MimeTypeParseException { parameters = new Hashtable(); // now parse rawdata parse(parameterList); } /** * A routine for parsing the parameter list out of a String. * * @param parameterList an RFC 2045, 2046 compliant parameter list. */ protected void parse(String parameterList) throws MimeTypeParseException { if (parameterList == null) return; int length = parameterList.length(); if (length <= 0) return; int i; char c; for (i = skipWhiteSpace(parameterList, 0); i < length && (c = parameterList.charAt(i)) == ';'; i = skipWhiteSpace(parameterList, i)) { int lastIndex; String name; String value; // eat the ';' i++; // now parse the parameter name // skip whitespace i = skipWhiteSpace(parameterList, i); // tolerate trailing semicolon, even though it violates the spec if (i >= length) return; // find the end of the token char run lastIndex = i; while ((i < length) && isTokenChar(parameterList.charAt(i))) i++; name = parameterList.substring(lastIndex, i).toLowerCase(); // now parse the '=' that separates the name from the value i = skipWhiteSpace(parameterList, i); if (i >= length || parameterList.charAt(i) != '=') throw new MimeTypeParseException( "Couldn't find the '=' that separates a " + "parameter name from its value."); // eat it and parse the parameter value i++; i = skipWhiteSpace(parameterList, i); if (i >= length) throw new MimeTypeParseException( "Couldn't find a value for parameter named " + name); // now find out whether or not we have a quoted value c = parameterList.charAt(i); if (c == '"') { // yup it's quoted so eat it and capture the quoted string i++; if (i >= length) throw new MimeTypeParseException( "Encountered unterminated quoted parameter value."); lastIndex = i; // find the next unescaped quote while (i < length) { c = parameterList.charAt(i); if (c == '"') break; if (c == '\\') { // found an escape sequence // so skip this and the // next character i++; } i++; } if (c != '"') throw new MimeTypeParseException( "Encountered unterminated quoted parameter value."); value = unquote(parameterList.substring(lastIndex, i)); // eat the quote i++; } else if (isTokenChar(c)) { // nope it's an ordinary token so it // ends with a non-token char lastIndex = i; while (i < length && isTokenChar(parameterList.charAt(i))) i++; value = parameterList.substring(lastIndex, i); } else { // it ain't a value throw new MimeTypeParseException( "Unexpected character encountered at index " + i); } // now put the data into the hashtable parameters.put(name, value); } if (i < length) { throw new MimeTypeParseException( "More characters encountered in input than expected."); } } /** * Return the number of name-value pairs in this list. * * @return the number of parameters */ public int size() { return parameters.size(); } /** * Determine whether or not this list is empty. * * @return true if there are no parameters */ public boolean isEmpty() { return parameters.isEmpty(); } /** * Retrieve the value associated with the given name, or null if there * is no current association. * * @param name the parameter name * @return the parameter's value */ public String get(String name) { return (String)parameters.get(name.trim().toLowerCase()); } /** * Set the value to be associated with the given name, replacing * any previous association. * * @param name the parameter name * @param value the parameter's value */ public void set(String name, String value) { parameters.put(name.trim().toLowerCase(), value); } /** * Remove any value associated with the given name. * * @param name the parameter name */ public void remove(String name) { parameters.remove(name.trim().toLowerCase()); } /** * Retrieve an enumeration of all the names in this list. * * @return an enumeration of all parameter names */ public Enumeration getNames() { return parameters.keys(); } /** * Return a string representation of this object. */ public String toString() { StringBuffer buffer = new StringBuffer(); buffer.ensureCapacity(parameters.size() * 16); // heuristic: 8 characters per field Enumeration keys = parameters.keys(); while (keys.hasMoreElements()) { String key = (String)keys.nextElement(); buffer.append("; "); buffer.append(key); buffer.append('='); buffer.append(quote((String)parameters.get(key))); } return buffer.toString(); } // below here be scary parsing related things /** * Determine whether or not a given character belongs to a legal token. */ private static boolean isTokenChar(char c) { return ((c > 040) && (c < 0177)) && (TSPECIALS.indexOf(c) < 0); } /** * return the index of the first non white space character in * rawdata at or after index i. */ private static int skipWhiteSpace(String rawdata, int i) { int length = rawdata.length(); while ((i < length) && Character.isWhitespace(rawdata.charAt(i))) i++; return i; } /** * A routine that knows how and when to quote and escape the given value. */ private static String quote(String value) { boolean needsQuotes = false; // check to see if we actually have to quote this thing int length = value.length(); for (int i = 0; (i < length) && !needsQuotes; i++) { needsQuotes = !isTokenChar(value.charAt(i)); } if (needsQuotes) { StringBuffer buffer = new StringBuffer(); buffer.ensureCapacity((int)(length * 1.5)); // add the initial quote buffer.append('"'); // add the properly escaped text for (int i = 0; i < length; ++i) { char c = value.charAt(i); if ((c == '\\') || (c == '"')) buffer.append('\\'); buffer.append(c); } // add the closing quote buffer.append('"'); return buffer.toString(); } else { return value; } } /** * A routine that knows how to strip the quotes and * escape sequences from the given value. */ private static String unquote(String value) { int valueLength = value.length(); StringBuffer buffer = new StringBuffer(); buffer.ensureCapacity(valueLength); boolean escaped = false; for (int i = 0; i < valueLength; ++i) { char currentChar = value.charAt(i); if (!escaped && (currentChar != '\\')) { buffer.append(currentChar); } else if (escaped) { buffer.append(currentChar); escaped = false; } else { escaped = true; } } return buffer.toString(); } }