Hi,
While trying to merge the URLEncoder/Decoder with libgcj I noticed that the
latest 1.4 spec defines these classes a little bit different then in past
versions. It is now possible to specify which character encoding to use
to en/decode the hex-encoded unsafe characters. And by default UTF-8 is used.
I have reimplemented both classes to actually take the encoding into account.
Older specs did not clearly specify which character encoding would be used
or implied that only the lower 8 bits would be used when encoding (which
works fine if only 'normal' iso-8859-1 characters are used.
This does mean that the default behaviour is now slightly different from the
old one. But since it was never clearly defined in the past I don't think
that is a real problem. And a friend (hi Erwin) told me that the Sun
implementations also didn't do the same thing in different versions or on
different platforms.
2001-10-07 Mark Wielaard <[EMAIL PROTECTED]>
* java/net/URLDecoder.java: Reimplement to take character encoding
into account.
* java/net/URLEncoder.java: Ditto
If nobody objects I will check these in. The new versions are attached.
Even though these version do more things some of my tests were two times
faster when compiled with gcj. I think the use of a StringBuffer in the
URLEncoder made a large difference.
Cheers,
Mark
--
Stuff to read:
<http://www.toad.com/gnu/whatswrong.html>
What's Wrong with Copy Protection, by John Gilmore
/* URLDecoder.java -- Class to decode URL's from encoded form.
Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.net;
import java.io.UnsupportedEncodingException;
/**
* This utility class contains one static method that converts a
* string encoded in the x-www-form-urlencoded format to the original
* text. The x-www-form-urlencoded format
* replaces certain disallowed characters with
* encoded equivalents. All upper case and lower case letters in the
* US alphabet remain as is, the space character (' ') is replaced with
* '+' sign, and all other characters are converted to a "%XX" format
* where XX is the hexadecimal representation of that character. Note
* that since unicode characters are 16 bits, and this method encodes only
* 8 bits of information, the lower 8 bits of the character are used.
* <p>
* This method is very useful for decoding strings sent to CGI scripts
*
* Written using on-line Java Platform 1.2 API Specification.
* Status: Believed complete and correct.
*
* @since 1.2
*
* @author Warren Levy <[EMAIL PROTECTED]>
* @author Aaron M. Renn ([EMAIL PROTECTED]) (documentation comments)
* @author Mark Wielaard ([EMAIL PROTECTED])
*/
public class URLDecoder
{
/**
* This method translates the passed in string from x-www-form-urlencoded
* format using the default encoding "UTF-8" to decode the hex encoded
* unsafe characters.
*
* @param s the String to convert
*
* @return the converted String
*/
public static String decode(String s)
{
try
{
return decode(s, "UTF-8");
}
catch (UnsupportedEncodingException uee)
{
// Should never happen since UTF-8 encoding should always be supported
return s;
}
}
/**
* This method translates the passed in string from x-www-form-urlencoded
* format using the given character encoding to decode the hex encoded
* unsafe characters.
*
* @param s the String to convert
* @param encoding the character encoding to use the decode the hex encoded
* unsafe characters
*
* @return the converted String
*
* @since 1.4
*/
public static String decode(String s, String encoding)
throws UnsupportedEncodingException
{
StringBuffer result = new StringBuffer();
// First convert all '+' characters to spaces.
String str = s.replace('+', ' ');
// Then go through the whole string looking for byte encoded characters
int i;
int start = 0;
byte [] bytes = null;
while ((i = str.indexOf('%', start)) >= 0)
{
// Add all non-encoded characters to the result buffer
result.append(str.substring(start, i));
start = i;
// Get all consecutive encoded bytes
int length = str.length();
while ((i+2 < length) && (str.charAt(i) == '%'))
i += 3;
// Decode all these bytes
if ((bytes == null) || (bytes.length < ((i-start)/3)))
bytes = new byte[((i-start)/3)];
int index = 0;
while (start < i)
{
String sub = str.substring(start + 1, start + 3);
try
{
bytes[index] = (byte)Integer.parseInt(sub, 16);
index++;
}
catch (NumberFormatException nfe)
{
// Ignore badly encoded char
}
start += 3;
}
// Add the bytes as characters according to the given encoding
result.append(new String(bytes, 0, index, encoding));
// Make sure we skip to just after a % sign
start = i+1;
}
// Add any character left
if (start < str.length())
result.append(str.substring(start));
return result.toString();
}
} // class URLDecoder
/* URLEncoder.java -- Class to convert strings to a properly encoded URL
Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.net;
import java.io.UnsupportedEncodingException;
/**
* Written using on-line Java Platform 1.2/1.4 API Specification, as well
* as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
* Status: Believed complete and correct.
*/
/**
* This utility class contains static methods that converts a
* string into a fully encoded URL string in x-www-form-urlencoded
* format. This format replaces certain disallowed characters with
* encoded equivalents. All upper case and lower case letters in the
* US alphabet remain as is, the space character (' ') is replaced with
* '+' sign, and all other characters are converted to a "%XX" format
* where XX is the hexadecimal representation of that character in a
* certain encoding (by default "UTF-8".
* <p>
* This method is very useful for encoding strings to be sent to CGI scripts
*
* @author Aaron M. Renn ([EMAIL PROTECTED])
* @author Warren Levy <[EMAIL PROTECTED]>
* @author Mark Wielaard ([EMAIL PROTECTED])
*/
public class URLEncoder
{
/**
* This method translates the passed in string into x-www-form-urlencoded
* format using the standard "UTF-8" character encoding to hex-encode the
* unsafe characters.
*
* @param s The String to convert
*
* @return The converted String
*/
public static String encode(String s)
{
try
{
return encode(s, "UTF-8");
}
catch (UnsupportedEncodingException uee)
{
// Should never happen since UTF-8 should always be supported
return s;
}
}
/**
* This method translates the passed in string into x-www-form-urlencoded
* format using the character encoding to hex-encode the unsafe characters.
*
* @param s The String to convert
* @param encoding The encoding to use for unsafe characters
*
* @return The converted String
*
* @since 1.4
*/
public static String encode(String s, String encoding)
throws UnsupportedEncodingException
{
StringBuffer result = new StringBuffer();
int length = s.length();
int start = 0;
int i = 0;
while (true)
{
while ( i < length && isSafe(s.charAt(i)) )
i++;
// Safe character can just be added
result.append(s.substring(start, i));
// Are we done?
if (i >= length)
return result.toString();
else if (s.charAt(i) == ' ')
{
result.append('+'); // Replace space char with plus symbol.
i++;
}
else
{
// Get all unsafe characters
start = i;
char c;
while ( i < length && (c = s.charAt(i)) != ' ' && !isSafe(c) )
i++;
// Convert them to %XY encoded strings
String unsafe = s.substring(start,i);
byte bytes[] = unsafe.getBytes(encoding);
for (int j = 0; j < bytes.length; j++)
{
result.append('%');
result.append(Integer.toHexString(((int) bytes[j]) & 0xFF));
}
}
start = i;
}
}
/**
* Private static method that returns true if the given char is either
* a uppercase or lowercase letter from 'a' till 'z', or a digit froim
* '0' till '9', or one of the characters '-', '_', '.' or '*'. Such
* 'safe' character don't have to be url encoded.
*/
private static boolean isSafe(char c)
{
return ((c >= 'a' && c <= 'z') ||
(c >= 'A' && c <= 'Z') ||
(c >= '0' && c <= '9') ||
c == '-' || c == '_' || c == '.' || c == '*');
}
/**
* Private constructor that does nothing. Included to avoid a default
* public constructor being created by the compiler.
*/
private URLEncoder() { }
} // class URLEncoder
