/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

package com.nokia.mj.impl.http;

import java.io.ByteArrayOutputStream;

import java.io.DataInputStream;

import java.io.DataOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Vector;

import javax.microedition.io.HttpConnection;

import com.nokia.mj.impl.gcf.utils.URI;

import com.nokia.mj.impl.rt.support.Jvm;

import com.nokia.mj.impl.utils.Logger;

import com.nokia.mj.impl.gcf.utils.DateUtil;

import com.nokia.mj.impl.gcf.utils.NativeError;

import com.nokia.mj.impl.http.BlockingOperation;

import com.nokia.mj.impl.rt.support.Finalizer;

import com.nokia.mj.impl.connectionmanager.ConnectionManager;

import com.nokia.mj.impl.connectionmanager.AccessPoint;

import com.nokia.mj.impl.rt.support.ApplicationUtils;

import com.nokia.mj.impl.rt.support.ApplicationInfo;

import com.nokia.mj.impl.rt.support.ShutdownListener;

/**

 * An HttpConection class implementing an HTTP 1.1 client connection using the

 * native symbian http client ap

 *

 */

public class HttpConnectionNative implements HttpConnection,

        NativeHttpByteSource

{

    protected int iMode;

    protected int iState;

    protected boolean iClosed;

    protected URI iUri;

    protected String iRef;

    protected String iRequestMethod;

    protected Hashtable iRequestProperties;

    protected int iResponseCode;

    protected String iResponseMessage;

    protected Hashtable iReplyHeaders;

    protected Vector iReplyHeaderKeys;

    protected long iLength;

    protected DataInputStream iInputStream;

    protected boolean iInputStreamOpened = false;

    protected NativeHttpInputStream iNativeHttpInputStream;

    protected ByteArrayOutputStream iPostedDataStream;

    protected DataOutputStream iOutputStream;

    protected boolean iOutputStreamOpened = false;

    protected char[] iLineBuffer;

    protected int iLineBufferLength;

    protected int iLineLength;

    // States

    protected final static int INVALID_STATE = 0;

    protected final static int SETUP = 1;

    protected final static int CONNECTED = 2;

    protected final static int REQUEST_HEADERS_SENT = 3;

    protected final static int REQUEST_SENT = 4;

    protected final static int REPLY_RECEIVED = 5;

    // Character constants

    protected final static char HASH = '#';

    protected final static int QUESTION_MARK = 63;

    protected final static int CR = 13;

    protected final static int LF = 10;

    protected final static int SP = 32;

    protected final static int EOF = -1;

    // Misc. Constants

    protected final static byte[] CRLF = { CR, LF };

    protected final static int DEFAULT_LINE_BUFFER_SIZE = 128;

    protected final static String VERSION_1_1 = "1.1";

    protected final static String VERSION_1_0 = "1.0";

    protected final static String NATIVESEPERATOR = ";;";

    protected final static String DEFAULT_PATH = "/"; // NOI8N

    protected final static int DEFAULT_PORT = 80;

    protected final static String PROTOCOL_SUFFIX = "://";

    // 'Well-known' Header names

    protected final static String CONNECTION = "Connection"; // NOI8N

    protected final static String CONTENT_ENCODING = "Content-Encoding"; // NOI8N

    protected final static String CONTENT_LENGTH = "Content-Length"; // NOI8N

    protected final static String CONTENT_TYPE = "Content-Type"; // NOI8N

    protected final static String DATE = "Date"; // NOI8N

    protected final static String HOST = "Host"; // NOI8N

    protected final static String LAST_MODIFIED = "Last-Modified"; // NOI8N

    protected final static String EXPIRES = "Expires"; // NOI8N

    protected final static String TRANSFER_ENCODING = "Transfer-Encoding"; // NOI8N

    protected final static String USER_AGENT = "User-Agent";

    // 'Well-known' Header values

    protected final static String UNTRUSTED_1_0 = "UNTRUSTED/1.0";

    // Connection value

    protected final static String CLOSE = "close"; // NOI8N

    // Http-native handle

    private static int iNativeHttpSessionHandle = 0;

    protected int iNativeTransactionHande = 0;

    final BlockingOperation iTransactionBlock;

    // Custom lock for synchronizing all read operations.

    protected final BlockingOperation iNativeDataReadyForRead;

    private Finalizer iFinalizer;

    protected ConnectionManager iCmInstance = null;

    protected AccessPoint iApn = null;

    private static boolean iIsSessionDeleted = false;

    private boolean iTrustedSuite = true;

    private int iRespTimeOut = -1;

    private int iRetries = 0;

    static

    {

        try

        {

            Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                       "loading http from HttpConnectionNative.java");

            Jvm.loadSystemLibrary("javahttp");

            Logger.LOG(Logger.ESOCKET, Logger.EInfo, "javahttp loaded");

        }

        catch (Exception e)

        {

            Logger.ELOG(Logger.ESOCKET, e.toString());

        }

    }

    public HttpConnectionNative(int aNativeHttpSessionHandle, String aName,

                                int aMode, boolean aTimeouts, ConnectionManager cm,

                                AccessPoint apnInfo, int aResponseTimeout) throws IOException

    {

        Logger.PLOG(Logger.ESOCKET, "New HTTP connection to URL: " + aName);

        Logger.ILOG(Logger.ESOCKET, "+++++ HttpConnectionNative new, this ="

                    + this);

        int index;

        iCmInstance = cm;

        iApn = apnInfo;

        index = aName.indexOf(HASH);

        iRespTimeOut = aResponseTimeout; // setting of timeout value for http response.

        // specific scenario identified in case of java installer.

        // Handle to shared native RHttpSession

        if (iNativeHttpSessionHandle == 0)

        {

            // only one session per application

            creatHttpSession();

        }

        if (index != -1)

        {

            iRef = aName.substring(index + 1);

            aName = aName.substring(0, index);

        }

        iUri = new URI(aName);

        final String host = iUri.getHost();

        if (host == null || host.equals(""))

        {

            throw new IllegalArgumentException("Invalid url: " + aName);

        }

        iMode = aMode;

        iState = SETUP;

        iRequestMethod = GET;

        iRequestProperties = new Hashtable();

        iReplyHeaders = new Hashtable();

        iReplyHeaderKeys = new Vector();

        iLength = -1;

        // Blocking operations to allow async native transactions

        iTransactionBlock = new BlockingOperation();

        iNativeDataReadyForRead = new BlockingOperation();

        iNativeDataReadyForRead.setResult(BlockingOperation.BLOCKED);

        iFinalizer = registerForFinalization();        

        Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- HttpConnectionNative new ");

        ApplicationInfo appInfo = ApplicationInfo.getInstance();

        String runtime = appInfo.getRuntimeType();

        boolean  midpRuntime = true;

        if (runtime == ApplicationInfo.RUNTIME_INSTALLER)

        {

            midpRuntime = false;

        }

        else

        {

            // add the untrusted header for untrusted midlet suite

            if ((ApplicationInfo.getInstance().getProtectionDomain()

                    .equals(ApplicationInfo.UNIDENTIFIED_THIRD_PARTY_DOMAIN)) == true)

            {

                iTrustedSuite = false;

                iRequestProperties.put(USER_AGENT, UNTRUSTED_1_0);

            }

        }

        // get the default User-Agent headers and add to hashtable

        final String agent = _getUserAgentHeaderValue(midpRuntime);

        if (agent != null)

        {

            if (iTrustedSuite == false)

            {

                String result = agent + ' ' + UNTRUSTED_1_0;

                iRequestProperties.put(USER_AGENT, result);

            }

            else

            {

                iRequestProperties.put(USER_AGENT, agent);

            }

        }

    }

    Finalizer registerForFinalization()

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                   "++HttpConnectionNative::registerForFinalization ");

        return new Finalizer()

        {

            public void finalizeImpl()

            {

                doFinalize();

            }

        };

    }

    public void doFinalize()

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                   "++HttpConnectionNative::doFinalize ");

        try

        {

            close();

        }

        catch(Exception e)

        {

        }

        Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                   "--HttpConnectionNative::doFinalize ");

    }

    public void creatHttpSession() throws IOException

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                   "++HttpConnectionNative::creatHttpSession()");

        int[] retval = new int[2];

        int handle;

        int err;

        if (iApn != null)

        {

            handle = _createHttpSession(0, iApn.getType(), iApn.getNapId(),

                                        retval);

        }

        else

        {

            handle = _createHttpSession(0, -1, -1, retval);

        }

        iNativeHttpSessionHandle = NativeError.check(handle);

        if (retval[0] < 0)

        {

            throw new IOException(

                "Unable to open http connection.Creation of Native peer failed.");

        }

        if (retval[1] < 0)

        {

            // reset connection manager

            iCmInstance.reset();

        }

        Logger.LOG(Logger.ESOCKET, Logger.EInfo,

                   "--HttpConnectionNative::creatHttpSession()");

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized void close() throws IOException

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo, "++++++++++ close()");

        if (iClosed)

        {

            return;

        }

        iClosed = true;

        if ((iInputStream == null) && (iOutputStream == null)

                && (iState != SETUP))

        {

            if (iNativeHttpInputStream != null)

            {

                iNativeHttpInputStream.close();

                iNativeHttpInputStream = null;

            }

            closeConnection();

        }

        Logger.LOG(Logger.ESOCKET, Logger.EInfo, "------- close()");

        return;

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized DataInputStream openDataInputStream()

    throws IOException

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ openDataInputStream()");

        // prevents multiple read

        synchronized (iNativeDataReadyForRead.getLock())

        {

            ensureOpen("openDataInputStream");

            if (iInputStreamOpened)

            {

                throwIOException("Input stream is already opened");

            }

            ensureResponse();

            iInputStream = makeDataInputStream();

            iInputStreamOpened = true;

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "-

            // openDataInputStream()" );

            return iInputStream;

        }

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized InputStream openInputStream() throws IOException

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ openInputStream()" );

        final InputStream result = openDataInputStream();

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- openInputStream()" );

        return result;

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized DataOutputStream openDataOutputStream()

    throws IOException

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ openDataOutputStream()"

        // );

        ensureOpen("openDataOutputStream");

        if (iOutputStreamOpened)

        {

            throwIOException("Output stream is already opened");

        }

        makeDataOutputStream();

        iOutputStreamOpened = true;

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- openDataOutputStream()"

        // );

        return iOutputStream;

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized OutputStream openOutputStream() throws IOException

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ openOutputStream()" );

        final OutputStream result = openDataOutputStream();

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- openOutputStream()" );

        return result;

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized String getEncoding()

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getEncoding()" );

        String result = null;

        try

        {

            result = getHeaderField(CONTENT_ENCODING);

        }

        catch (IOException ex)

        {

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getEncoding() returns

            // null" );

            return null;

        }

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getEncoding()" );

        return result;

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized long getLength()

    {

        Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getLength()");

        try

        {

            ensureOpen("getLength");

            ensureResponse();

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getLength() : " +

            // iLength);

            return iLength;

        }

        catch (IOException ex)

        {

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getLength() set -1

            // IOException: "+ ex.toString() );

            return -1;

        }

    }

    /**

     * Please refer to Jsr 118

     */

    public synchronized String getType()

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getType()" );

        String result = null;

        try

        {

            result = getHeaderField(CONTENT_TYPE);

        }

        catch (IOException ex)

        {

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getType() returns

            // null" );

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getType() NULL");

            return null;

        }

        //Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getType()" + result);

        return result;

    }

    // HttpConnection interface implementation

    public synchronized long getDate() throws IOException

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getDate()" );

        final long result = getHeaderFieldDate(DATE, 0);

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getDate()" );

        return result;

    }

    public synchronized long getExpiration() throws IOException

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getExpiration()" );

        final long result = getHeaderFieldDate(EXPIRES, 0);

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getExpiration()" );

        return result;

    }

    public String getFile()

    {

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getFile()" );

        String result = iUri.getPath();

        if (result.length() == 0)

            result = null;

        else

            result = "/" + result;

        // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getFile: " + result );

        return result;

    }

    public synchronized String getHeaderField(int aIndex) throws IOException

    {

        ensureOpen("getHeaderField");

        ensureResponse();

        if (aIndex >= iReplyHeaderKeys.size() || aIndex < 0)

        {

            // Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getHeaderField(int)

            // returns null" );

            return null;

        }

        final String result = (String) iReplyHeaders.get(iReplyHeaderKeys

                              .elementAt(aIndex));

        if (result != null)

        {

            int length = result.length();

            String keys = (String) iReplyHeaderKeys.elementAt(aIndex);

            if (keys.equalsIgnoreCase("Set-Cookie") == true)

            {

                // first cookie is discarded

                if ((result.charAt(0)) == ',')

                {

                    throw new IOException(

                        "cookie size too large - hence discarded");

                }

                // last cookie is discarded

                if ((result.charAt(length - 2)) == ',')

                {

                    throw new IOException(

                        "cookie size too large - hence discarded");

                }

                int index = result.indexOf(", ,", 0);

                if (index != -1)

                {

                    throw new IOException(

                        "cookie size too large - hence discarded");

                }

            }

        }

        //Logger.LOG(Logger.ESOCKET, Logger.EInfo, "- getHeaderField(int)" );

        //Logger.LOG(Logger.ESOCKET, Logger.EInfo, "+ getHeaderField(int): "  + result);

        return result;

    }