/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Cactus", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.cactus.client;

import java.io.*;
import java.net.*;
import java.security.*;

import org.apache.cactus.util.log.*;

/**
 * Wrapper class for the real <code>HttpURLConnection</code> to the test servlet
 * that reads the complete input stream into an internal buffer on
 * the first call to getInputStream(). This is to ensure that the test servlet
 * is not blocked on i/o when the test caller asks for the results.
 * <p>
 * The wrapper returns the buffered input stream from getInputStream and
 * delegates the rest of the calls.
 * <p>
 * This class is final so we don't have to provide access to protected instance
 * variables and methods of the wrapped connection.
 *
 * @author <a href="mailto:Bob.Davison@reuters.com">Bob Davison</a>
 * @author <a href="mailto:vmassol@apache.org">Vincent Massol</a>
 *
 * @version $Id: AutoReadHttpURLConnection.java,v 1.9 2001/12/21 11:48:20 vmassol Exp $
 */
final class AutoReadHttpURLConnection extends HttpURLConnection
{
    /**
     * The logger
     */
    private final static Log logger =
        LogService.getInstance().
        getLog(AutoReadHttpURLConnection.class.getName());

    /**
     * Default size of array for copying data.
     */
    private static final int DEFAULT_CHUNK_SIZE = 16384;

    /**
     * The wrapped connection.
     */
    private HttpURLConnection delegate;

    /**
     * The read input stream.
     */
    private InputStream streamBuffer;

    AutoReadHttpURLConnection(HttpURLConnection theConnection)
    {
        super(null);
        this.delegate = theConnection;
    }

    /**
     * Returns an input stream containing the fully read contents of
     * the wrapped connection's input stream
     *
     * @return the input stream
     */
    public synchronized InputStream getInputStream() throws IOException
    {
        if (this.streamBuffer == null) {
            logger.debug("Original connection = " + this.delegate);
            InputStream is = this.delegate.getInputStream();
            this.streamBuffer = bufferInputStream(is);
        }

        return this.streamBuffer;
    }

    private InputStream bufferInputStream(InputStream is) throws IOException
    {
        ByteArrayOutputStream os = new ByteArrayOutputStream(DEFAULT_CHUNK_SIZE);
        copy(is, os);
        ByteArrayInputStream bais =
                new ByteArrayInputStream(os.toByteArray());

        return bais;
    }

    private void copy(InputStream is, OutputStream os) throws IOException
    {
        // Only copy if there are data to copy ... The problem is that not
        // all servers return a content-length header. If there is no header
        // getContentLength() returns -1. It seems to work and it seems
        // that all servers that return no content-length header also do
        // not block on read() operations !

        logger.debug("Content-Length : [" +
            this.delegate.getContentLength() + "]");

        if (this.delegate.getContentLength() != 0) {

            byte[] buf = new byte[DEFAULT_CHUNK_SIZE];
            int count;

            while(-1 != (count = is.read(buf))) {

                // log read data
                printReadLogs(count, buf);
                os.write(buf, 0, count);
            }

        }
    }

    /**
     * Format log data read from socket for pretty printing (replaces
     * asc char 10 by "\r", asc char 13 by "\n" and only print the first
     * 50 characters and the last 50.
     *
     * @param count the number of bytes read in the buffer
     * @param buffer the buffer containing the data to print
     */
    private void printReadLogs(int count, byte[] buffer)
    {
        // Log portion of read data and replace asc 10 by \r and asc
        // 13 by /n
        StringBuffer prefix = new StringBuffer();
        for (int i = 0; i < count && i < 50; i++) {
            if (buffer[i] == 10) {
                prefix.append("\\r");
            } else if (buffer[i] == 13) {
                prefix.append("\\n");
            } else {
                prefix.append((char)buffer[i]);
            }
        }

        StringBuffer suffix = new StringBuffer();
        for (int i = count - 50; i > 0 && i < count; i++) {
            if (buffer[i] == 10) {
                suffix.append("\\r");
            } else if (buffer[i] == 13) {
                suffix.append("\\n");
            } else {
                suffix.append((char)buffer[i]);
            }
        }

        if (suffix.length() > 0) {
            prefix.append(" ...] [... ");
        }

        logger.debug("Read [" + count + "]: [" + prefix + suffix + "]");
    }

    // Delegated methods

    public void connect() throws IOException
    {
        this.delegate.connect();
    }

    public boolean getAllowUserInteraction()
    {
        return this.delegate.getAllowUserInteraction();
    }

    public Object getContent() throws IOException
    {
        return this.delegate.getContent();
    }

    public String getContentEncoding()
    {
        return this.delegate.getContentEncoding();
    }

    public int getContentLength()
    {
        return this.delegate.getContentLength();
    }

    public String getContentType()
    {
        return this.delegate.getContentType();
    }

    public long getDate()
    {
        return this.delegate.getDate();
    }

    public boolean getDefaultUseCaches()
    {
      return this.delegate.getDefaultUseCaches();
    }

    public boolean getDoInput()
    {
        return this.delegate.getDoInput();
    }

    public boolean getDoOutput()
    {
        return this.delegate.getDoOutput();
    }

    public long getExpiration()
    {
        return this.delegate.getExpiration();
    }

    public String getHeaderField(int a0)
    {
        return this.delegate.getHeaderField(a0);
    }

    public String getHeaderField(String a0)
    {
        return this.delegate.getHeaderField(a0);
    }

    public long getHeaderFieldDate(String a0, long a1)
    {
        return this.delegate.getHeaderFieldDate(a0, a1);
    }

    public int getHeaderFieldInt(String a0, int a1)
    {
        return this.delegate.getHeaderFieldInt(a0, a1);
    }

    public String getHeaderFieldKey(int a0)
    {
        return this.delegate.getHeaderFieldKey(a0);
    }

    public long getIfModifiedSince()
    {
        return this.delegate.getIfModifiedSince();
    }

    public long getLastModified()
    {
        return this.delegate.getLastModified();
    }

    public OutputStream getOutputStream() throws IOException
    {
        return this.delegate.getOutputStream();
    }

    public Permission getPermission() throws IOException
    {
        return this.delegate.getPermission();
    }

    public String getRequestProperty(String a0)
    {
        return this.delegate.getRequestProperty(a0);
    }

    public URL getURL()
    {
        return this.delegate.getURL();
    }

    public boolean getUseCaches()
    {
        return this.delegate.getUseCaches();
    }

    public void setAllowUserInteraction(boolean a0)
    {
        this.delegate.setAllowUserInteraction(a0);
    }

    public void setDefaultUseCaches(boolean a0)
    {
        this.delegate.setDefaultUseCaches(a0);
    }

    public void setDoInput(boolean a0)
    {
        this.delegate.setDoInput(a0);
    }

    public void setDoOutput(boolean a0)
    {
        this.delegate.setDoOutput(a0);
    }

    public void setIfModifiedSince(long a0)
    {
        this.delegate.setIfModifiedSince(a0);
    }

    public void setRequestProperty(String a0, String a1)
    {
        this.delegate.setRequestProperty(a0, a1);
    }

    public void setUseCaches(boolean a0)
    {
        this.delegate.setUseCaches(a0);
    }

    public String toString()
    {
        return this.delegate.toString();
    }

    public void disconnect()
    {
        this.delegate.disconnect();
    }

    public InputStream getErrorStream()
    {
        return this.delegate.getErrorStream();
    }

    public String getRequestMethod()
    {
        return this.delegate.getRequestMethod();
    }

    public int getResponseCode() throws IOException
    {
        return this.delegate.getResponseCode();
    }

    public String getResponseMessage() throws IOException
    {
        return this.delegate.getResponseMessage();
    }

    public void setRequestMethod(String a0) throws ProtocolException
    {
        this.delegate.setRequestMethod(a0);
    }

    public boolean usingProxy()
    {
        return this.delegate.usingProxy();
    }

}