/*

* Copyright (c) 2010 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:

* Wlan Login engine class implementation

* 

*/

// System includes

#include <QObject>

#include <QString>

#include <QUrl>

#include <HbMessagebox>

#include <HbAction>

#include <qnetworkconfigmanager.h>

#include <qnetworkconfiguration.h>

#include <qnetworksession.h>

//User includes

#include "wlanloginengine.h"

#include "wlanloginapplication.h"

#include "wlanloginmainwindow.h"

#include "ictsqtwrapper.h"

#include "wlanloginnetworkaccessmanager.h"

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "wlanloginengineTraces.h"

#endif

/*!

    \class WlanLoginEngine

    \brief WLAN Login engine class implementation.

*/

// External function prototypes

// Local constants

// ======== LOCAL FUNCTIONS ========

// ======== MEMBER FUNCTIONS ========

/*!

    Constructor.

 */

WlanLoginEngine::WlanLoginEngine(QObject *parent): 

    QObject(parent),

    mEngineState(WaitingForStart),

    mServiceRequestCompleted(false),

    mNetConfigurationManager(new QNetworkConfigurationManager(this)),

    mNetworkAccessManager(new WlanLoginNetworkAccessManager(this)),

    mNetworkSession(NULL),

    mIctsWrapper(NULL),

    mIctsFirstRun(true),

    mIap(0),

    mNetId(0),

    mRedirectionUrl(QUrl(""))            

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_WLANLOGINENGINE_ENTRY);

    bool connectStatus = connect(

        mNetConfigurationManager,

        SIGNAL(updateCompleted()),

        this, 

        SLOT(handleUpdateCompleted()));  

    Q_ASSERT(connectStatus == true);

    OstTraceFunctionExit0(WLANLOGINENGINE_WLANLOGINENGINE_EXIT);

}

/*!

    Destructor.

 */

WlanLoginEngine::~WlanLoginEngine()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_DESTRUCTOR_ENTRY);

    mNetworkSession->close();

    OstTraceFunctionExit0(WLANLOGINENGINE_DESTRUCTOR_EXIT);

}

/*!

    Function that returns pointer to network access manager.

    @return Pointer to WlanLoginNetworkAccessManager

 */

WlanLoginNetworkAccessManager* WlanLoginEngine::networkAccessManager() const

{

    return mNetworkAccessManager;

}

/*!

    Function that returns current state of the engine.

    @return engine state

 */

WlanLoginEngine::EngineState WlanLoginEngine::engineState()

{

    return mEngineState;    

}

/*!

    Function that sets the current state of the engine.

    @param [in] newState New state of the engine to be set

 */

void WlanLoginEngine::setEngineState(WlanLoginEngine::EngineState newState)

{

    mEngineState = newState;

}

/*!

    This slot handles startLogin signal from Qt Highway service provider

    @param [in] iapId Internet access point ID for a connection that we should attach to'

    @param [in] netId Network Id for the connection to be used

    @param [in] redirectionUrl The URL that we were redirected to by the first internet connectivity test

 */

void WlanLoginEngine::handleStartLogin(int iapId, int netId, QUrl redirectionUrl)

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESTARTLOGIN_ENTRY);

    mIap = iapId; 

    OstTrace1(

        TRACE_NORMAL,

        WLANLOGINENGINE_HANDLESTARTLOGIN_IAP_TRACE,

        "WlanLoginEngine::handleStartLogin;mIap=%d",

        mIap);

    mNetId = netId;

    OstTrace1(

        TRACE_NORMAL,

        WLANLOGINENGINE_HANDLESTARTLOGIN_NETID_TRACE,

        "WlanLoginEngine::handleStartLogin;mNetId=%d",

        mNetId);

    mRedirectionUrl = redirectionUrl;

#ifdef OST_TRACE_COMPILER_IN_USE

    QString url = mRedirectionUrl.toString();

    TPtrC tmp(url.utf16(),url.length() );

    OstTraceExt1(

        TRACE_NORMAL,

        WLANLOGINENGINE_HANDLESTARTLOGIN_URL_TRACE, 

        "WlanLoginEngine::handleStartLogin;mRedirectionUrl=%S",

        tmp);

#endif

    //Create ICTS instance as we know needed parameters now

    mIctsWrapper = new IctsWrapper(mIap, mNetId, this);

    bool connectStatus = connect(

        mIctsWrapper,

        SIGNAL(connectivityTestResult(IctsWrapper::ConnectivityTestResult, QUrl)), 

        this,

        SLOT(handleConnectivityTestResult(IctsWrapper::ConnectivityTestResult, QUrl)));  

    Q_ASSERT(connectStatus == true);

    //Update network configurations as only states of the cellular IAP's are reliable 

    //after creating network configuration manager

    setEngineState(UpdatingNetworkConfigurations);

    mNetConfigurationManager->updateConfigurations();

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESTARTLOGIN_EXIT);

}

/*!

    This slot handles stopLogin signal from Qt Highway service provider

 */

void WlanLoginEngine::handleStopLogin()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESTOPLOGIN_ENTRY);

    // Exit application

    qApp->quit();

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESTOPLOGIN_EXIT);

}

/*!

    This slot handles updateCompleted signal from QNetworkConfigManager

 */

void WlanLoginEngine::handleUpdateCompleted()

{

   OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLEUPDATECOMPLETED_ENTRY);

   //States of the available configurations are now updated and

   //we can open the network session to provided IAP

   openSession();

   OstTraceFunctionExit0(WLANLOGINENGINE_HANDLEUPDATECOMPLETED_EXIT);

}

/*!

    This function handles opening of the network session to the specified IAP.

    If IAP is not already in connected state, function completes service request

    with connection dropped status and show a message box to user.

 */

void WlanLoginEngine::openSession()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_OPENSESSION_ENTRY);

    setEngineState(WlanLoginEngine::OpeningNetworkSession);

    //Get configuration that matches the provided IAP

    QNetworkConfiguration netConfiguration = mNetConfigurationManager->configurationFromIdentifier(QString::number(mIap));    

    OstTrace1(

        TRACE_NORMAL,

        WLANLOGINENGINE_OPENSESSION_CONFIGURATION_IDENTIFIER_TRACE,

        "WlanLoginEngine::openSession;netConfiguration identifier=%d",

        netConfiguration.identifier().toInt());

    OstTrace1(TRACE_NORMAL,

        WLANLOGINENGINE_OPENSESSION_CONFIGURATION_STATE_TRACE,

        "WlanLoginEngine::openSession;netConfiguration state=%d",

        netConfiguration.state());

#ifdef OST_TRACE_COMPILER_IN_USE

    QString string = netConfiguration.name();

    TPtrC tmp(string.utf16(),string.length() );

    OstTraceExt1(

        TRACE_NORMAL,

        WLANLOGINENGINE_OPENSESSION_CONFIGURATION_NAME_TRACE, 

        "WlanLoginEngine::openSession;netConfiguration name=%S",

        tmp );

    string = netConfiguration.bearerName();

    tmp.Set(string.utf16(),string.length());

    OstTraceExt1(

        TRACE_NORMAL,

        WLANLOGINENGINE_OPENSESSION_CONFIGURATION_BEARER_NAME_TRACE, 

        "WlanLoginEngine::openSession;netConfiguration bearerName=%S",

        tmp );

#endif

    //Check that configuration state is active before opening session

    //Otherwise show disconnected message box

    if (netConfiguration.state() == QNetworkConfiguration::Active)

        {

        //Create network session to IAP that was provided in startup

        mNetworkSession = new QNetworkSession(netConfiguration, this);

        bool connectStatus = connect(

            mNetworkSession,

            SIGNAL(opened()),

            this, 

            SLOT(handleSessionOpened()));

        Q_ASSERT(connectStatus == true);

        connectStatus = connect(

            mNetworkSession,

            SIGNAL(stateChanged(QNetworkSession::State)), 

            this,

            SLOT(handleSessionStateChanged(QNetworkSession::State)));       

        Q_ASSERT(connectStatus == true);

        connectStatus = connect(

            mNetworkSession,

            SIGNAL(error(QNetworkSession::SessionError)), 

            this,

            SLOT(handleSessionError(QNetworkSession::SessionError)));   

        Q_ASSERT(connectStatus == true);

        mNetworkSession->open();

        } else {

            showConnectionDroppedMessageBox();

        }

    OstTraceFunctionExit0(WLANLOGINENGINE_OPENSESSION_EXIT);

}

/*!

    This function handles sessionOpened signal from QNetworkSession. It informs view that

    connection is ready to be used.

 */

void WlanLoginEngine::handleSessionOpened()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESESSIONOPENED_ENTRY);

    setEngineState(NetworkSessionOpened);

    //Send indication to view that connection is ready

    emit connectionReady(mRedirectionUrl);

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESESSIONOPENED_EXIT);

}

/*!

    This function handles sessionStateChanged signal from QNetworkSession.

    @param [in] newState New state of the session  

 */

void WlanLoginEngine::handleSessionStateChanged(QNetworkSession::State newState)

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESESSIONSTATECHANGED_ENTRY);

    OstTrace1(

        TRACE_NORMAL,

        WLANLOGINENGINE_HANDLESESSIONSTATECHANGED_STATE_TRACE,

        "WlanLoginEngine::handleSessionStateChanged;newState=%d",

        newState );

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESESSIONSTATECHANGED_EXIT);

}

/*!

    This function handles sessionError signal from QNetworkSession

    @param [in] error session error     

 */

void WlanLoginEngine::handleSessionError(QNetworkSession::SessionError error)

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESESSIONERROR_ENTRY);

    OstTrace1(

        TRACE_NORMAL,

        WLANLOGINENGINE_SESSION_ERROR_TRACE,

        "WlanLoginEngine::handleSessionError;error=%d",

        error);

    switch (engineState()) {    

    case OpeningNetworkSession:

        showConnectionDroppedMessageBox();

        break;

    case NetworkSessionOpened:

    case IctsRan:

        if (error == QNetworkSession::SessionAbortedError ) {

            showConnectionDroppedMessageBox();

        }

        break;

    case RunningIcts:

        if (error == QNetworkSession::SessionAbortedError ) {

            stopIcts();

            showConnectionDroppedMessageBox();

        }

        break;

    default:

        break;

    }

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESESSIONERROR_EXIT);

}

/*!

    This function handles startIcts signal and starts connectivity test in polling mode

 */

void WlanLoginEngine::handleStartIcts()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLESTARTICTS_ENTRY);

    if (!mIctsWrapper->isPolling()) {

        setEngineState(RunningIcts);

        mIctsWrapper->startPolling(totalPollingTime, pollingInterval);

    }

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLESTARTICTS_EXIT);

}

/*!

    This function stops internet connectivity test

 */

void WlanLoginEngine::stopIcts()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_STOPICTS_ENTRY);

    if (mIctsWrapper->isPolling()) {

        mIctsWrapper->stopPolling();

    }

    OstTraceFunctionExit0(WLANLOGINENGINE_STOPICTS_EXIT);

}

/*!

    This slot handles connectivityTestResult signal from ICTS wrapper

    @param [in] result Result of the internet connectivity test

    @param [in] redirectionUrl The URL that we are being redirected, valid only if result is HttpAuthenticationNeeded

 */

void WlanLoginEngine::handleConnectivityTestResult(IctsWrapper::ConnectivityTestResult result, QUrl redirectUrl)

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLECONNECTIVITYTESTRESULT_ENTRY);

    Q_UNUSED(redirectUrl);

    setEngineState(IctsRan);

    mIctsFirstRun = false;

    if (result == IctsWrapper::ConnectionOk){

        emit ictsOk();

    }

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLECONNECTIVITYTESTRESULT_EXIT);

}

/*!

    This slot handles cancelTriggered signal from the view

 */

void WlanLoginEngine::handleCancelTriggered()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLECANCELTRIGGERED_ENTRY);

    //Stop ICTS if it is running:

    if (engineState() == RunningIcts) {

        stopIcts();

        if (mIctsFirstRun) {

            emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusCancel);

        } else {

            //Previous ICTS must have failed as cancel action can't be selected from UI if

            //it has passed

            emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusFailed);

        }         

    } else if (engineState() == IctsRan) {

        //ICTS must have failed as cancel action can't be selected from UI if

        //it has passed

        emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusFailed);

    } else {

        //ICTS not run yet

        emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusCancel); 

    }

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLECANCELTRIGGERED_EXIT);

}

/*!

    This slot handles nextTriggered signal from the view

 */

void WlanLoginEngine::handleNextTriggered()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLENEXTTRIGGERED_ENTRY);

    emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusNext);

    //put application to background:

    WlanLoginApplication* app = static_cast<WlanLoginApplication *>(this->parent());    

    app->mainWindow()->lower();

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLENEXTTRIGGERED_EXIT);

}

/*!

    This slot handles continueTriggered signal from the view

 */

void WlanLoginEngine::handleContinueTriggered()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLECONTINUETRIGGERED_ENTRY);

    //put application to background:

    WlanLoginApplication* app = static_cast<WlanLoginApplication *>(this->parent());

    app->mainWindow()->lower();

    OstTraceFunctionExit0(WLANLOGINENGINE_HANDLECONTINUETRIGGERED_EXIT);

}

/*!

    This function shows connection dropped message box to the user

 */

void WlanLoginEngine::showConnectionDroppedMessageBox()

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_SHOWCONNECTIONDROPPEDMESSAGEBOX_ENTRY);

    HbMessageBox *messageBox = new HbMessageBox(hbTrId("txt_occ_info_wlan_connection_closed_login_applica"));

    messageBox->setAttribute(Qt::WA_DeleteOnClose);

    messageBox->setTimeout(messageBoxTimeout);

    messageBox->open(this,SLOT(connectionDroppedMessageBoxClosed(HbAction*)));

    OstTraceFunctionExit0(WLANLOGINENGINE_SHOWCONNECTIONDROPPEDMESSAGEBOX_EXIT);

}

void WlanLoginEngine::connectionDroppedMessageBoxClosed(HbAction* action)

{

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLEMESSAGEBOXCLOSED_ENTRY);

    Q_UNUSED(action);

    if (mServiceRequestCompleted == false ) {

        emitCompleteServiceRequest(WlanLoginService::WlanLoginStatusConnectionDropped);

    } else {

        //If Qt Highway service request is already completed when connection drops, we have to make exit by our own

        qApp->exit();

    }               

    OstTraceFunctionEntry0(WLANLOGINENGINE_HANDLEMESSAGEBOXCLOSED_EXIT);    

}

/*!

    This function completes Qt Highway service request

    @param [in] status completeing status of the service request   

 */