/*

* 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 Wizard: Private implementation.

*/

// System includes

#include <QLocale>

#include <QApplication>

#include <QGraphicsWidget>

#include <QTimer>

#include <QDebug>

#include <HbTranslator>

#include <HbDocumentLoader>

#include <HbMainWindow>

#include <HbDialog>

#include <HbStackedWidget>

#include <HbLabel>

#include <HbAction>

#include <HbStyleLoader>

// User includes

#include "eapwizard.h"

#include "wpswizard.h"

#include "wlanqtutils.h"

#include "wlanqtutilsap.h"

#include "wlanwizardplugin.h"

#include "wlanwizard.h"

#include "wlanwizard_p.h"

#include "wlanwizardutils.h"

#include "wlanwizardpagekeyquery.h"

#include "wlanwizardpagesummary.h"

#include "wlanwizardpageprocessingsettings.h"

#include "wlanwizardpagegenericerror.h"

#include "wlanwizardpagessid.h"

#include "wlanwizardpagenetworkmode.h"

#include "wlanwizardpagescanning.h"

#include "wlanwizardpagesecuritymode.h"

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "wlanwizard_pTraces.h"

#endif

/*!

   \class WlanWizardPrivate

   \brief Private implementation of WlanWizard. Implements the interface

   WlanWizardHelper to the wizard plugins. 

 */

// External function prototypes

// Local constants

/*!

   \var PageTimeout Timeout for timer protected pages. 1.5sec

 */

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

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

/*!

   Constructor of private implementation.

   @param [in] wizard Pointer to the API class.

   @param [in] mainWindow pointer to mainwindow.

 */

WlanWizardPrivate::WlanWizardPrivate(

    WlanWizard* wizard, 

    HbMainWindow *mainWindow) :

    QObject(wizard),

    q_ptr(wizard), 

    mMainWindow(mainWindow), 

    mPageTimer(new QTimer(this)),

    mTitle(NULL),

    mActionNext(NULL),

    mActionPrevious(NULL),

    mActionFinish(NULL),

    mActionCancel(NULL),

    mStackedWidget(NULL),

    mDialog(NULL),

    mTranslator(new HbTranslator("wlanwizard")),

    mWlanQtUtils(new WlanQtUtils()),

    mDocLoader(new HbDocumentLoader(mainWindow)),

    mEapWizard(NULL), 

    mWpsWizard(NULL), 

    mFirstPageId(WlanWizardPageInternal::PageNone),

    mPageFinished(false),

    mClosed(false)

{

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_WLANWIZARDPRIVATE,

        "WlanWizardPrivate::WlanWizardPrivate;this=%x", 

        this );

    // Set initial values for configurations

    setConfiguration(ConfIapId, WlanQtUtils::IapIdNone);

    setConfiguration(ConfConnected, false);

    setConfiguration(ConfHiddenWlan, false);

    setConfiguration(ConfProcessSettings, false);

    setConfiguration(ConfIctStatus, false);

    // Initialize timer for timer protected pages

    mPageTimer->setSingleShot(true);

    // Load the wizard frame (title, content, actions) from docml 

    loadDocml();

    // Creates the control object of the wlan wizard pages. 

    createPages();

    // EAP Wizard will add wizard pages at construction phase using

    // WlanWizardHelper::addPage()

    mEapWizard.reset(new EapWizard(this) );

    // WPS Wizard will add wizard pages at construction phase using

    // WlanWizardHelper::addPage()

    mWpsWizard.reset(new WpsWizard(this));

    // First page is SSID query, unless client sets configurations via

    // setParameters(), which decides the first page..

    mFirstPageId = WlanWizardPageInternal::PageSsid;

    OstTraceExt2( TRACE_BORDER, WLANWIZARDPRIVATE_WLANWIZARDPRIVATE_DONE,

        "WlanWizardPrivate::WlanWizardPrivate - done;"

        "this=%x;mFirstPageId=%{PageIds}",

        ( unsigned )this, mFirstPageId );

}

/*!

   Destructor.

 */

WlanWizardPrivate::~WlanWizardPrivate()

{

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_DWLANWIZARDPRIVATE,

        "WlanWizardPrivate::~WlanWizardPrivate;this=%x",

        this );

    // Remove wizard pages from stackedwidgets, since stackedwidget owns the

    // objects and all pages are deleted below. 

    while (mStackedWidget->count()) {

        mStackedWidget->removeAt(0);

    }

    // Delete UI instances (HbWidget) of pages

    QHashIterator<HbWidget*, WlanWizardPage*> i(mPageMapper);

    while (i.hasNext()) {

        i.next();

        delete i.key();

    }

    mPageMapper.clear();

    // WlanWizardPage objects are automatically deleted since this is the

    // parent of the objects.

    mPages.clear();

    // timer is cancelled/deleted automatically when the parent (this) is deleted 

    // TODO: See TSW Error: MTAA-854DK8 and loadDocml()

    HbStyleLoader::unregisterFilePath(":/css/custom.css");

    mDialog->setAttribute( Qt::WA_DeleteOnClose, true );

    mDialog->close();

    // Remove the pointer from QScopedPointer to prevent double deallocation

    mDialog.take();

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_DWLANWIZARDPRIVATE_DONE,

        "WlanWizardPrivate::~WlanWizardPrivate-Done;this=%x",

        this );

}

/*!

   See WlanWizard::setParameters().

 */

void WlanWizardPrivate::setParameters(

    const QString &ssid, 

    int networkMode, 

    int securityMode, 

    bool usePsk,

    bool hidden, 

    bool wps)

{

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_SETPARAMETERS, 

        "WlanWizardPrivate::setParameters;this=%x", 

        this );

    mFirstPageId = getNextPageId(

        ssid, networkMode, securityMode, usePsk, hidden, wps);

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_SETPARAMETERS_DONE, 

        "WlanWizardPrivate::setParameters - Done;this=%x", 

        this );

}

/*!

   See WlanWizard::show().

 */

void WlanWizardPrivate::show()

{

    OstTraceExt2( TRACE_BORDER, WLANWIZARDPRIVATE_SHOW,

        "WlanWizardPrivate::show;this=%x;mFirstPageId=%{PageIds}", 

        ( unsigned )this, mFirstPageId );

    Q_ASSERT(mClosed == false);

    showPage(mFirstPageId, false);

    mDialog->show();

    OstTrace1( TRACE_BORDER, WLANWIZARDPRIVATE_SHOW_DONE,

        "WlanWizardPrivate::show - Done;this=%x;",

        (unsigned)this );

}

/*!

   See WlanWizard::setParameters() for descriptions of parameters.

   Based on the provided parameters next page id is returned.

   @return next page id based on provided configurations.

 */

int WlanWizardPrivate::getNextPageId(

    const QString &ssid, 

    int networkMode, 

    int securityMode, 

    bool usePsk,

    bool hidden, 

    bool wps)

{

    setConfiguration(ConfProcessSettings, true);

    setConfiguration(ConfSsid, ssid);

    setConfiguration(ConfNetworkMode, networkMode);

    setConfiguration(ConfSecurityMode, securityMode);

    setConfiguration(ConfUsePsk, usePsk);

    setConfiguration(ConfHiddenWlan, hidden);

    OstTrace1( TRACE_NORMAL, WLANWIZARDPRIVATE_GETNEXTPAGEID, 

        "WlanWizardPrivate::getNextPageId;wps=%u", 

        wps );

    return nextPageId(wps);

}

/*!

   Utility method for WLAN Wizard pages to query the wlanqtutils class.

   @return a valid pointer to WlanQtUtils class.

 */

WlanQtUtils* WlanWizardPrivate::wlanQtUtils() const

{

    return mWlanQtUtils.data();

}

/*!

   Utility method for WLAN Wizard pages to query active wizard plugin object

   @return NULL in case plugin is not active.

 */ 

WlanWizardPlugin* WlanWizardPrivate::wlanWizardPlugin() const

{

    WlanWizardPlugin* plugin = NULL;

    if (isEapEnabled()) {

        plugin = mEapWizard.data();

        Q_ASSERT(plugin);

    }

    OstTrace1( TRACE_NORMAL, WLANWIZARDPRIVATE_WLANWIZARDPLUGIN, 

        "WlanWizardPrivate::wlanWizardPlugin;plugin=%x", 

        plugin );

    return plugin;

}

/*!

   Utility method for WLAN Wizard pages to query if EAP mode is active at the

   moment

   @return true in case EAP is currently activated.

 */

bool WlanWizardPrivate::isEapEnabled() const

{

    bool ret = false;

    int secMode = configuration(ConfSecurityMode).toInt();

    if (((secMode == CMManagerShim::WlanSecModeWpa || 

          secMode == CMManagerShim::WlanSecModeWpa2) && 

          !configuration(ConfUsePsk).toBool()) || 

        secMode == CMManagerShim::WlanSecMode802_1x) {

        ret = true;

    }

    OstTrace1( TRACE_NORMAL, WLANWIZARDPRIVATE_ISEAPENABLED, 

        "WlanWizardPrivate::isEapEnabled;ret=%u", 

        ret );

    return ret;

}

/*!

   Creates new iap or updates existing iap.

   @return false in case IAP creation/update failed.

 */

bool WlanWizardPrivate::handleIap()

{

    OstTrace0( TRACE_FLOW, WLANWIZARDPRIVATE_HANDLEIAP,

        "WlanWizardPrivate::handleIap" );

    bool ret = true;

    bool usePsk = true;

    int securityMode = configuration(ConfSecurityMode).toInt();

    WlanQtUtilsAp wlanAp;

    // Set default values

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWpaPsk, QString());

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWpaPskUse, true );

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWepDefaultIndex, CMManagerShim::WepKeyIndex1 );

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey1, QString());

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey2, QString());

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey3, QString());

    wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey4, QString());

    // Set configuration

    wlanAp.setValue(WlanQtUtilsAp::ConfIdSsid, configuration(ConfSsid));

    wlanAp.setValue(WlanQtUtilsAp::ConfIdConnectionMode, 

        configuration(ConfNetworkMode));

    wlanAp.setValue(WlanQtUtilsAp::ConfIdSecurityMode, securityMode );

    wlanAp.setValue(WlanQtUtilsAp::ConfIdHidden, configuration(ConfHiddenWlan));

    switch (securityMode) {

    case CMManagerShim::WlanSecModeWep:

        wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey1, configuration(ConfKeyWep1));

        wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey2, configuration(ConfKeyWep2));

        wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey3, configuration(ConfKeyWep3));

        wlanAp.setValue(WlanQtUtilsAp::ConfIdWepKey4, configuration(ConfKeyWep4));

        wlanAp.setValue(

            WlanQtUtilsAp::ConfIdWepDefaultIndex,

            configuration(ConfKeyWepDefault));

        break;

    case CMManagerShim::WlanSecModeWpa:

    case CMManagerShim::WlanSecModeWpa2:

        usePsk = configuration(ConfUsePsk).toBool();

        wlanAp.setValue(WlanQtUtilsAp::ConfIdWpaPskUse, usePsk);

        if (usePsk){

            wlanAp.setValue(WlanQtUtilsAp::ConfIdWpaPsk, configuration(ConfKeyWpa));

        }

        break;

    default:

        Q_ASSERT(securityMode == CMManagerShim::WlanSecModeOpen ||

            securityMode == CMManagerShim::WlanSecMode802_1x);

        // No WLAN Specific configuration

        break;

    }

    // Create IAP if does not exists or update the existing IAP

    int referenceId = configuration(ConfIapId).toInt();

    if (referenceId == WlanQtUtils::IapIdNone) {

        OstTrace0( TRACE_FLOW, WLANWIZARDPRIVATE_HANDLEIAP_CREATE, 

            "WlanWizardPrivate::handleIap: Create IAP" );

        referenceId = mWlanQtUtils->createIap(&wlanAp);

        setConfiguration(ConfIapId, referenceId);

        if (referenceId == WlanQtUtils::IapIdNone) {

            ret = false;

        }

    } else {

        OstTrace0( TRACE_FLOW, WLANWIZARDPRIVATE_HANDLEIAP_UPDATE, 

            "WlanWizardPrivate::handleIap: Update IAP" );

        ret = mWlanQtUtils->updateIap(referenceId, &wlanAp);

    }

    if (ret) {

        // Store Wizard plugin specific settings here.

        WlanWizardPlugin* plugin = wlanWizardPlugin();

        if (plugin) {

            OstTrace0( TRACE_FLOW, WLANWIZARDPRIVATE_HANDLEIAP_PLUGIN, 

                "WlanWizardPrivate::handleIap: Plugin" );

            // Plugin gets the IAP ID from configuration

            ret = plugin->storeSettings();

        }

    }

    OstTrace1( TRACE_FLOW, WLANWIZARDPRIVATE_HANDLEIAP_DONE,

        "WlanWizardPrivate::handleIap: Done;ret=%d",

        ret );

    return ret;

}

/*!

   See WlanWizardHelper::configuration().

 */

QVariant WlanWizardPrivate::configuration(ConfigurationId confId) const

{

    Q_ASSERT(mConfigurations.contains(confId));

#ifdef OST_TRACE_COMPILER_IN_USE

    QString tmp;

    QDebug tmpStream(&tmp);

    tmpStream << mConfigurations[confId];

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

    OstTraceExt2( TRACE_NORMAL, WLANWIZARDPRIVATE_CONFIGURATIONS, 

        "WlanWizardPrivate::configuration;confId=%{ConfigurationId};string=%S", 

        (uint)confId, string );

#endif

    return mConfigurations[confId];

}

/*!

   See WlanWizardHelper::setConfiguration().

 */

void WlanWizardPrivate::setConfiguration(

    ConfigurationId confId, 

    const QVariant &value)

{

#ifdef OST_TRACE_COMPILER_IN_USE

    QString tmp;

    QDebug tmpStream(&tmp);

    tmpStream << value;

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

    OstTraceExt2( TRACE_NORMAL, WLANWIZARDPRIVATE_SETCONFIGURATION, 

        "WlanWizardPrivate::setConfiguration;"

        "confId=%{ConfigurationId};string=%S", 

        (uint)confId, string );

#endif

    mConfigurations[confId] = value;

}

/*!

 * See WlanWizardHelper::clearConfiguration().

 */

void WlanWizardPrivate::clearConfiguration(ConfigurationId confId)

{

    OstTrace1( TRACE_FLOW, WLANWIZARDPRIVATE_CLEARCONFIGURATION,

        "WlanWizardPrivate::clearConfiguration;confId=%{ConfigurationId}",

        (uint)confId );

    mConfigurations.remove(confId);

}

/*!

 * See WlanWizardHelper::configurationExists().

 */

bool WlanWizardPrivate::configurationExists(ConfigurationId confId)

{

    OstTrace1( TRACE_DUMP, WLANWIZARDPRIVATE_CONFIGURATIONEXISTS,

        "WlanWizardPrivate::configurationExists;confId=%{ConfigurationId}",

        (uint)confId );

    return mConfigurations[confId].isValid();

}

/*!

   See WlanWizardHelper::enableNextButton().

 */

void WlanWizardPrivate::enableNextButton(bool enable)

{

    OstTraceExt2( TRACE_FLOW, WLANWIZARDPRIVATE_ENABLENEXTBUTTON,

        "WlanWizardPrivate::enableNextButton;this=%x;enable=%x",

        (unsigned)this, (uint)enable );

    mActionNext->setEnabled(enable);

}

/*!

   See WlanWizardHelper::addPage().

 */

void WlanWizardPrivate::addPage(int pageId, WlanWizardPage *page)

{

    OstTraceExt3( TRACE_FLOW, WLANWIZARDPRIVATE_ADDPAGE, 

        "WlanWizardPrivate::addPage;this=%x;pageId=%{PageIds};page=%x",

        (unsigned)this, pageId, (uint)(page) );

    Q_ASSERT(!mPages.contains(pageId));