org.apache.xmlrpc.util.HttpUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlrpc-common Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.xmlrpc.util;

import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.Enumeration;
import java.util.StringTokenizer;

import org.apache.ws.commons.util.Base64;
import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl;
import org.apache.xmlrpc.common.XmlRpcStreamConfig;


/** Provides utility functions useful in HTTP communications
 */
public class HttpUtil {
	/** Creates the Base64 encoded credentials for HTTP Basic Authentication.
	 * @param pUser User name, or null, if no Basic Authentication is being used.
	 * @param pPassword Users password, or null, if no Basic Authentication is being used.
	 * @param pEncoding Encoding being used for conversion of the credential string into a byte array.
	 * @return Base64 encoded credentials, for use in the HTTP header 
	 * @throws UnsupportedEncodingException The encoding pEncoding is invalid.
	 */
	public static String encodeBasicAuthentication(String pUser, String pPassword, String pEncoding) throws UnsupportedEncodingException {
        if (pUser == null) {
			return null;
        }
        final String s = pUser + ':' + pPassword;
		if (pEncoding == null) {
			pEncoding = XmlRpcStreamConfig.UTF8_ENCODING;
		}
        final byte[] bytes = s.getBytes(pEncoding);
		return Base64.encode(s.getBytes(pEncoding), 0, bytes.length, 0, null);
    }

	/** Returns, whether the HTTP header value pHeaderValue
	 * indicates, that GZIP encoding is used or may be used.
	 * @param pHeaderValue The HTTP header value being parsed. This is typically
	 * the value of "Content-Encoding", or "Accept-Encoding".
	 * @return True, if the header value suggests that GZIP encoding is or may
	 * be used.
	 */
	public static boolean isUsingGzipEncoding(String pHeaderValue) {
		if (pHeaderValue == null) {
			return false;
        }
        for (StringTokenizer st = new StringTokenizer(pHeaderValue, ",");  st.hasMoreTokens();  ) {
            String encoding = st.nextToken();
            int offset = encoding.indexOf(';');
            if (offset >= 0) {
                encoding = encoding.substring(0, offset);
            }
            if ("gzip".equalsIgnoreCase(encoding.trim())) {
            	return true;
            }
        }
        return false;
    }

    /**
     * Returns, whether the HTTP header value pHeaderValue
     * indicates, that another encoding than "identity" is used.
     * This is typically the value of "Transfer-Encoding", or "TE".
     * @return Null, if the transfer encoding in use is "identity".
     *   Otherwise, another transfer encoding. 
     */
    public static String getNonIdentityTransferEncoding(String pHeaderValue) {
        if (pHeaderValue == null) {
            return null;
        }
        for (StringTokenizer st = new StringTokenizer(pHeaderValue, ",");  st.hasMoreTokens();  ) {
            String encoding = st.nextToken();
            int offset = encoding.indexOf(';');
            if (offset >= 0) {
                encoding = encoding.substring(0, offset);
            }
            if (!"identity".equalsIgnoreCase(encoding.trim())) {
                return encoding.trim();
            }
        }
        return null;
    }

	/** Returns, whether the HTTP header values in pValues
	 * indicate, that GZIP encoding is used or may be used.
	 * @param pValues The HTTP header values being parsed. These are typically
	 * the values of "Content-Encoding", or "Accept-Encoding".
	 * @return True, if the header values suggests that GZIP encoding is or may
	 * be used.
	 */
	public static boolean isUsingGzipEncoding(Enumeration pValues) {
		if (pValues != null) {
			while (pValues.hasMoreElements()) {
				if (isUsingGzipEncoding((String) pValues.nextElement())) {
					return true;
				}
			}
		}
		return false;
    }

	/** Reads a header line from the input stream pIn
	 * and converts it into a string.
	 * @param pIn The input stream being read.
	 * @param pBuffer A buffer being used for temporary storage.
	 * The buffers length is a limit of the header lines length.
	 * @return Next header line or null, if no more header lines
	 * are available.
	 * @throws IOException Reading the header line failed.
	 */
	public static String readLine(InputStream pIn, byte[] pBuffer) throws IOException {
        int next;
        int count = 0;
        while (true) {
            next = pIn.read();
            if (next < 0 || next == '\n') {
                break;
            }
            if (next != '\r') {
                pBuffer[count++] = (byte) next;
            }
            if (count >= pBuffer.length) {
                throw new IOException ("HTTP Header too long");
            }
        }
        return new String(pBuffer, 0, count, "US-ASCII");
    }

	/** Parses an "Authorization" header and adds the username and password
	 * to pConfig.
	 * @param pConfig The request configuration being created.
	 * @param pLine The header being parsed, including the "basic" part.
	 */
	public static void parseAuthorization(XmlRpcHttpRequestConfigImpl pConfig, String pLine) {
		if (pLine == null) {
			return;
		}
		pLine = pLine.trim();
		StringTokenizer st = new StringTokenizer(pLine);
		if (!st.hasMoreTokens()) {
			return;
		}
		String type = st.nextToken();
		if (!"basic".equalsIgnoreCase(type)) {
			return;
		}
		if (!st.hasMoreTokens()) {
			return;
		}
		String auth = st.nextToken();
	    try {
	        byte[] c = Base64.decode(auth.toCharArray(), 0, auth.length());
	        String enc = pConfig.getBasicEncoding();
            if (enc == null) {
                enc = XmlRpcStreamConfig.UTF8_ENCODING;
            }
            String str = new String(c, enc);
	        int col = str.indexOf(':');
			if (col >= 0) {
				pConfig.setBasicUserName(str.substring(0, col));
				pConfig.setBasicPassword(str.substring(col+1));
			}
	    } catch (Throwable ignore) {
	    }
	}
}