1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Copyright 2001-2004 The Apache Software Foundation. 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * you may not use this file except in compliance with the License. 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * You may obtain a copy of the License at 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.commons.codec.net; 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.UnsupportedEncodingException; 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.codec.DecoderException; 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.codec.EncoderException; 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Implements methods common to all codecs defined in RFC 1522. 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <a href="http://www.ietf.org/rfc/rfc1522.txt">RFC 1522</a> 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * describes techniques to allow the encoding of non-ASCII text in 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * various portions of a RFC 822 [2] message header, in a manner which 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is unlikely to confuse existing message handling software. 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see <a href="http://www.ietf.org/rfc/rfc1522.txt"> 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * MIME (Multipurpose Internet Mail Extensions) Part Two: 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Message Header Extensions for Non-ASCII Text</a> 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Apache Software Foundation 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 1.3 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Id: RFC1522Codec.java,v 1.2 2004/04/09 22:21:43 ggregory Exp $ 44d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 45d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 46d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 47d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 49d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectabstract class RFC1522Codec { 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Applies an RFC 1522 compliant encoding scheme to the given string of text with the 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * given charset. This method constructs the "encoded-word" header common to all the 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * RFC 1522 codecs and then invokes {@link #doEncoding(byte [])} method of a concrete 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * class to perform the specific enconding. 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param text a string to encode 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset a charset to be used 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return RFC 1522 compliant "encoded-word" 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws EncoderException thrown if there is an error conidition during the Encoding 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * process. 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws UnsupportedEncodingException thrown if charset is not supported 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * encoding names</a> 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected String encodeText(final String text, final String charset) 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws EncoderException, UnsupportedEncodingException 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project { 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (text == null) { 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return null; 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project StringBuffer buffer = new StringBuffer(); 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append("=?"); 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(charset); 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append('?'); 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(getEncoding()); 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append('?'); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project byte [] rawdata = doEncoding(text.getBytes(charset)); 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append(new String(rawdata, StringEncodings.US_ASCII)); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project buffer.append("?="); 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return buffer.toString(); 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Applies an RFC 1522 compliant decoding scheme to the given string of text. This method 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #doEncoding(byte [])} method of a concrete class to perform the specific deconding. 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param text a string to decode 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws DecoderException thrown if there is an error conidition during the Decoding 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * process. 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws UnsupportedEncodingException thrown if charset specified in the "encoded-word" 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * header is not supported 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected String decodeText(final String text) 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws DecoderException, UnsupportedEncodingException 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project { 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (text == null) { 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return null; 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if ((!text.startsWith("=?")) || (!text.endsWith("?="))) { 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new DecoderException("RFC 1522 violation: malformed encoded content"); 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int termnator = text.length() - 2; 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int from = 2; 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int to = text.indexOf("?", from); 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if ((to == -1) || (to == termnator)) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new DecoderException("RFC 1522 violation: charset token not found"); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String charset = text.substring(from, to); 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (charset.equals("")) { 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new DecoderException("RFC 1522 violation: charset not specified"); 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project from = to + 1; 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project to = text.indexOf("?", from); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if ((to == -1) || (to == termnator)) { 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new DecoderException("RFC 1522 violation: encoding token not found"); 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String encoding = text.substring(from, to); 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!getEncoding().equalsIgnoreCase(encoding)) { 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new DecoderException("This codec cannot decode " + 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project encoding + " encoded content"); 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project from = to + 1; 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project to = text.indexOf("?", from); 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project byte[] data = text.substring(from, to).getBytes(StringEncodings.US_ASCII); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project data = doDecoding(data); 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new String(data, charset); 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the codec name (referred to as encoding in the RFC 1522) 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return name of the codec 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected abstract String getEncoding(); 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Encodes an array of bytes using the defined encoding scheme 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param bytes Data to be encoded 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return A byte array containing the encoded data 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws EncoderException thrown if the Encoder encounters a failure condition 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * during the encoding process. 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected abstract byte[] doEncoding(byte[] bytes) throws EncoderException; 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Decodes an array of bytes using the defined encoding scheme 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param bytes Data to be decoded 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a byte array that contains decoded data 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws DecoderException A decoder exception is thrown if a Decoder encounters a 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * failure condition during the decode process. 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected abstract byte[] doDecoding(byte[] bytes) throws DecoderException; 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 167