// JakartaCommonsHttpResponse.java
// (C) 2008 by Daniel Raap; danielr@users.berlios.de
// first published 2.4.2008 on http://yacy.net
//
// This is a part of YaCy, a peer-to-peer based web search engine
//
// $LastChangedDate: 2008-03-14 01:16:04 +0100 (Fr, 14 Mrz 2008) $
// $LastChangedRevision: 4558 $
// $LastChangedBy: orbiter $
//
// LICENSE
// 
// This program 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 of the License, or
// (at your option) any later version.
//
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package de.anomic.http;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.zip.GZIPInputStream;

import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpMethod;

/**
 * container for http-response data
 * 
 * @author daniel
 * @since 21.03.2008
 */
public class JakartaCommonsHttpResponse implements HttpResponse {
    private final HttpMethod method;
    private String incomingAccountingName = null;

    /**
     * cache of body-data
     */
    private byte[] responseBody;

    /**
     * constructor
     * 
     * @param method
     * @throws IOException
     */
    public JakartaCommonsHttpResponse(final HttpMethod method) {
        super();

        this.method = method;
    }

    /*
     * (non-Javadoc)
     * 
     * @see de.anomic.http.HttpResponse#getResponseHeader()
     */
    public httpHeader getResponseHeader() {
        final httpHeader responseHeader = new httpHeader();
        for (final Header header : getHeaders()) {
            responseHeader.add(header.getName(), header.getValue());
        }
        return responseHeader;
    }

    /**
     * @see org.apache.commons.httpclient.HttpMethod#getResponseHeaders()
     * @return the headers
     */
    private Header[] getHeaders() {
        return method.getResponseHeaders();
    }

    /**
     * @see org.apache.commons.httpclient.HttpMethod#getResponseBody()
     * @return
     * @throws IOException
     */
    public byte[] getData() throws IOException {
        if (this.responseBody == null) {
            InputStream instream = null;
            try {
                instream = getDataAsStream();
                if (instream != null) {
                    ByteArrayOutputStream outstream = new ByteArrayOutputStream();
                    byte[] buffer = new byte[4096];
                    int len;
                    while ((len = instream.read(buffer)) > 0) {
                        outstream.write(buffer, 0, len);
                    }
                    outstream.close();
                    this.responseBody = outstream.toByteArray();
                }
            } finally {
                if (instream != null) {
                    closeStream();
                }
            }
        }
        return this.responseBody;
    }

    /**
     * @see org.apache.commons.httpclient.HttpMethod#getResponseBodyAsStream()
     * @return
     * @throws IOException
     */
    public InputStream getDataAsStream() throws IOException {
        InputStream inStream = method.getResponseBodyAsStream();
        if(getResponseHeader().gzip()) {
            inStream = new GZIPInputStream(inStream);
        }
        // count bytes for overall http-statistics
        return new httpdByteCountInputStream(inStream, incomingAccountingName);
    }

    /*
     * (non-Javadoc)
     * 
     * @see de.anomic.http.HttpResponse#closeStream()
     */
    public void closeStream() {
        method.releaseConnection();
    }

    /*
     * (non-Javadoc)
     * 
     * @see de.anomic.http.HttpResponse#getStatusLine()
     */
    public String getStatusLine() {
        return getStatusCode() + " " + method.getStatusText();
    }

    /*
     * (non-Javadoc)
     * 
     * @see de.anomic.http.HttpResponse#getStatusCode()
     */
    public int getStatusCode() {
        final int code = method.getStatusCode();
        assert code >= 100 && code <= 999 : "postcondition violated: StatusCode (" + code + ") has not 3 digits!";
        return code;
    }

    /*
     * (non-Javadoc)
     * 
     * @see de.anomic.http.HttpResponse#getHttpVer()
     */
    public String getHttpVer() {
        return method.getStatusLine().getHttpVersion();
    }

    /**
     * sets the name for accounting incoming (loaded) bytes
     * 
     * @param accName
     */
    public void setAccountingName(final String accName) {
        incomingAccountingName = accName;
    }
}