1600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/* 2600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Conditions Of Use 3600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 4600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software was developed by employees of the National Institute of 5600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Standards and Technology (NIST), an agency of the Federal Government. 6600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Pursuant to title 15 Untied States Code Section 105, works of NIST 7600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* employees are not subject to copyright protection in the United States 8600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* and are considered to be in the public domain. As a result, a formal 9600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* license is not needed to use the software. 10600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 11600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software is provided by NIST as a service and is expressly 12600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED 13600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF 14600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT 15600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* AND DATA ACCURACY. NIST does not warrant or make any representations 16600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* regarding the use of the software or the results thereof, including but 17600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* not limited to the correctness, accuracy, reliability or usefulness of 18600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* the software. 19600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 20600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Permission to use this software is contingent upon your acceptance 21600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* of the terms of this agreement 22600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 23600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* . 24600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 25600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*/ 26600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpackage gov.nist.javax.sip.address; 27600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 28600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.io.UnsupportedEncodingException; 29600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 30600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 31600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Copied from Apache Excalibur project. 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Source code available at http://www.google.com/codesearch?hl=en&q=+excalibur+decodePath+show:sK_gDY0W5Rw:OTjCHAiSuF0:th3BdHtpX20&sa=N&cd=1&ct=rc&cs_p=http://apache.edgescape.com/excalibur/excalibur-sourceresolve/source/excalibur-sourceresolve-1.1-src.zip&cs_f=excalibur-sourceresolve-1.1/src/java/org/apache/excalibur/source/SourceUtil.java 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author <A HREF="mailto:jean.deruelle@gmail.com">Jean Deruelle</A> 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic class RFC2396UrlDecoder { 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Decode a path. 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * <p>Interprets %XX (where XX is hexadecimal number) as UTF-8 encoded bytes. 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * <p>The validity of the input path is not checked (i.e. characters that 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * were not encoded will not be reported as errors). 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * <p>This method differs from URLDecoder.decode in that it always uses UTF-8 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * (while URLDecoder uses the platform default encoding, often ISO-8859-1), 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * and doesn't translate + characters to spaces. 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param uri the path to decode 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the decoded path 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public static String decode(String uri) { 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang StringBuffer translatedUri = new StringBuffer(uri.length()); 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang byte[] encodedchars = new byte[uri.length() / 3]; 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang int i = 0; 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang int length = uri.length(); 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang int encodedcharsLength = 0; 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang while (i < length) { 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (uri.charAt(i) == '%') { 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang //we must process all consecutive %-encoded characters in one go, because they represent 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang //an UTF-8 encoded string, and in UTF-8 one character can be encoded as multiple bytes 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang while (i < length && uri.charAt(i) == '%') { 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (i + 2 < length) { 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang try { 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang byte x = (byte)Integer.parseInt(uri.substring(i + 1, i + 3), 16); 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang encodedchars[encodedcharsLength] = x; 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } catch (NumberFormatException e) { 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new IllegalArgumentException("Illegal hex characters in pattern %" + uri.substring(i + 1, i + 3)); 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang encodedcharsLength++; 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang i += 3; 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } else { 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new IllegalArgumentException("% character should be followed by 2 hexadecimal characters."); 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang try { 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang String translatedPart = new String(encodedchars, 0, encodedcharsLength, "UTF-8"); 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang translatedUri.append(translatedPart); 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } catch (UnsupportedEncodingException e) { 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang //the situation that UTF-8 is not supported is quite theoretical, so throw a runtime exception 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new RuntimeException("Problem in decodePath: UTF-8 encoding not supported."); 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang encodedcharsLength = 0; 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } else { 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang //a normal character 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang translatedUri.append(uri.charAt(i)); 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang i++; 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return translatedUri.toString(); 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang}