FileDocCategorySizeDatePackage
RequestUtil.javaAPI DocApache Tomcat 6.0.1413164Fri Jul 20 04:20:32 BST 2007org.apache.catalina.util

RequestUtil

public final class RequestUtil extends Object
General purpose request parsing and encoding utility methods.
author
Craig R. McClanahan
author
Tim Tye
version
$Revision: 528897 $ $Date: 2007-04-15 02:24:49 +0200 (dim., 15 avr. 2007) $

Fields Summary
private static SimpleDateFormat
format
The DateFormat to use for generating readable dates in cookies.
Constructors Summary
Methods Summary
public static java.lang.StringURLDecode(java.lang.String str)
Decode and return the specified URL-encoded String. When the byte array is converted to a string, the system default character encoding is used... This may be different than some other servers.

param
str The url-encoded string
exception
IllegalArgumentException if a '%' character is not followed by a valid 2-digit hexadecimal number


        return URLDecode(str, null);

    
public static java.lang.StringURLDecode(java.lang.String str, java.lang.String enc)
Decode and return the specified URL-encoded String.

param
str The url-encoded string
param
enc The encoding to use; if null, the default encoding is used
exception
IllegalArgumentException if a '%' character is not followed by a valid 2-digit hexadecimal number


        if (str == null)
            return (null);

        // use the specified encoding to extract bytes out of the
        // given string so that the encoding is not lost. If an
        // encoding is not specified, let it use platform default
        byte[] bytes = null;
        try {
            if (enc == null) {
                bytes = str.getBytes();
            } else {
                bytes = str.getBytes(enc);
            }
        } catch (UnsupportedEncodingException uee) {}

        return URLDecode(bytes, enc);

    
public static java.lang.StringURLDecode(byte[] bytes)
Decode and return the specified URL-encoded byte array.

param
bytes The url-encoded byte array
exception
IllegalArgumentException if a '%' character is not followed by a valid 2-digit hexadecimal number

        return URLDecode(bytes, null);
    
public static java.lang.StringURLDecode(byte[] bytes, java.lang.String enc)
Decode and return the specified URL-encoded byte array.

param
bytes The url-encoded byte array
param
enc The encoding to use; if null, the default encoding is used
exception
IllegalArgumentException if a '%' character is not followed by a valid 2-digit hexadecimal number


        if (bytes == null)
            return (null);

        int len = bytes.length;
        int ix = 0;
        int ox = 0;
        while (ix < len) {
            byte b = bytes[ix++];     // Get byte to test
            if (b == '+") {
                b = (byte)' ";
            } else if (b == '%") {
                b = (byte) ((convertHexDigit(bytes[ix++]) << 4)
                            + convertHexDigit(bytes[ix++]));
            }
            bytes[ox++] = b;
        }
        if (enc != null) {
            try {
                return new String(bytes, 0, ox, enc);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return new String(bytes, 0, ox);

    
private static byteconvertHexDigit(byte b)
Convert a byte character value to hexidecimal digit value.

param
b the character value byte

        if ((b >= '0") && (b <= '9")) return (byte)(b - '0");
        if ((b >= 'a") && (b <= 'f")) return (byte)(b - 'a" + 10);
        if ((b >= 'A") && (b <= 'F")) return (byte)(b - 'A" + 10);
        return 0;
    
public static java.lang.Stringfilter(java.lang.String message)
Filter the specified message string for characters that are sensitive in HTML. This avoids potential attacks caused by including JavaScript codes in the request URL that is often reported in error messages.

param
message The message string to be filtered


     
        format.setTimeZone(TimeZone.getTimeZone("GMT"));
    

        if (message == null)
            return (null);

        char content[] = new char[message.length()];
        message.getChars(0, message.length(), content, 0);
        StringBuffer result = new StringBuffer(content.length + 50);
        for (int i = 0; i < content.length; i++) {
            switch (content[i]) {
            case '<":
                result.append("<");
                break;
            case '>":
                result.append(">");
                break;
            case '&":
                result.append("&");
                break;
            case '"":
                result.append(""");
                break;
            default:
                result.append(content[i]);
            }
        }
        return (result.toString());

    
public static java.lang.Stringnormalize(java.lang.String path)
Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it. WARNING - This method is useful only for normalizing application-generated paths. It does not try to perform security checks for malicious input.

param
path Relative path to be normalized


        if (path == null)
            return null;

        // Create a place for the normalized path
        String normalized = path;

        if (normalized.equals("/."))
            return "/";

        // Add a leading "/" if necessary
        if (!normalized.startsWith("/"))
            normalized = "/" + normalized;

        // Resolve occurrences of "//" in the normalized path
        while (true) {
            int index = normalized.indexOf("//");
            if (index < 0)
                break;
            normalized = normalized.substring(0, index) +
                normalized.substring(index + 1);
        }

        // Resolve occurrences of "/./" in the normalized path
        while (true) {
            int index = normalized.indexOf("/./");
            if (index < 0)
                break;
            normalized = normalized.substring(0, index) +
                normalized.substring(index + 2);
        }

        // Resolve occurrences of "/../" in the normalized path
        while (true) {
            int index = normalized.indexOf("/../");
            if (index < 0)
                break;
            if (index == 0)
                return (null);  // Trying to go outside our context
            int index2 = normalized.lastIndexOf('/", index - 1);
            normalized = normalized.substring(0, index2) +
                normalized.substring(index + 3);
        }

        // Return the normalized path that we have completed
        return (normalized);

    
public static voidparseParameters(java.util.Map map, byte[] data, java.lang.String encoding)
Append request parameters from the specified String to the specified Map. It is presumed that the specified Map is not accessed from any other thread, so no synchronization is performed.

IMPLEMENTATION NOTE: URL decoding is performed individually on the parsed name and value elements, rather than on the entire query string ahead of time, to properly deal with the case where the name or value includes an encoded "=" or "&" character that would otherwise be interpreted as a delimiter. NOTE: byte array data is modified by this method. Caller beware.

param
map Map that accumulates the resulting parameters
param
data Input string containing request parameters
param
encoding Encoding to use for converting hex
exception
UnsupportedEncodingException if the data is malformed


        if (data != null && data.length > 0) {
            int    ix = 0;
            int    ox = 0;
            String key = null;
            String value = null;
            while (ix < data.length) {
                byte c = data[ix++];
                switch ((char) c) {
                case '&":
                    value = new String(data, 0, ox, encoding);
                    if (key != null) {
                        putMapEntry(map, key, value);
                        key = null;
                    }
                    ox = 0;
                    break;
                case '=":
                    if (key == null) {
                        key = new String(data, 0, ox, encoding);
                        ox = 0;
                    } else {
                        data[ox++] = c;
                    }                   
                    break;  
                case '+":
                    data[ox++] = (byte)' ";
                    break;
                case '%":
                    data[ox++] = (byte)((convertHexDigit(data[ix++]) << 4)
                                    + convertHexDigit(data[ix++]));
                    break;
                default:
                    data[ox++] = c;
                }
            }
            //The last value does not end in '&'.  So save it now.
            if (key != null) {
                value = new String(data, 0, ox, encoding);
                putMapEntry(map, key, value);
            }
        }

    
public static voidparseParameters(java.util.Map map, java.lang.String data, java.lang.String encoding)
Append request parameters from the specified String to the specified Map. It is presumed that the specified Map is not accessed from any other thread, so no synchronization is performed.

IMPLEMENTATION NOTE: URL decoding is performed individually on the parsed name and value elements, rather than on the entire query string ahead of time, to properly deal with the case where the name or value includes an encoded "=" or "&" character that would otherwise be interpreted as a delimiter.

param
map Map that accumulates the resulting parameters
param
data Input string containing request parameters
exception
IllegalArgumentException if the data is malformed


        if ((data != null) && (data.length() > 0)) {

            // use the specified encoding to extract bytes out of the
            // given string so that the encoding is not lost. If an
            // encoding is not specified, let it use platform default
            byte[] bytes = null;
            try {
                if (encoding == null) {
                    bytes = data.getBytes();
                } else {
                    bytes = data.getBytes(encoding);
                }
            } catch (UnsupportedEncodingException uee) {
            }

            parseParameters(map, bytes, encoding);
        }

    
private static voidputMapEntry(java.util.Map map, java.lang.String name, java.lang.String value)
Put name and value pair in map. When name already exist, add value to array of values.

param
map The map to populate
param
name The parameter name
param
value The parameter value

        String[] newValues = null;
        String[] oldValues = (String[]) map.get(name);
        if (oldValues == null) {
            newValues = new String[1];
            newValues[0] = value;
        } else {
            newValues = new String[oldValues.length + 1];
            System.arraycopy(oldValues, 0, newValues, 0, oldValues.length);
            newValues[oldValues.length] = value;
        }
        map.put(name, newValues);