/*

* Copyright (c) 2008 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: Handles IAP selection logic

*

*/

#ifndef MPMIAPSELECTION_H

#define MPMIAPSELECTION_H

#include <e32base.h>

#include "mpmserversession.h"

#include "mpmcommsdataccess.h"

#include "mpmwlanavailability.h"

class CMPMDialog;

class CMPMWlanQueryDialog;

class CMPMConfirmDlgStarting;

class MWlanAvailability;

class TMpmConnPref;

enum TOfflineNoteResponse

    {

    EOfflineResponseUndefined,

    EOfflineResponseYes,

    EOfflineResponseNo

    };

/**

 * Handles IAP selection. MPM Server session

 * uses the class to select the best available 

 * IAP.

 *

 *  @lib mpmserver.exe

 *  @since S60 v3.2

 */

class CMPMIapSelection : public CBase,

                         public MWlanAvailability

    {

public:

    // Enumeration describes session state at choosing best IAP.

    // Choosing best IAP may use asyncrous services and once 

    // and these states define at which point the choosing iap is

    // proceeding.

    // 

    enum TChooseIapState

        {

        ENoConnection,

        EExplicitConnection,

        EImplicitConnection

        };

    enum TImplicitConnectionState

        {

        EImplicitStart,

        EImplicitWlanScan,

        EImplicitUserSelection,

        EImplicitWlanQuery

        };

public: // CMPMServerSession interface    

    /**

     * Two-phased constructor.

     */

    static CMPMIapSelection* NewL( CMPMCommsDatAccess*  aCommsDatAccess,

                                   CMPMServerSession*   aSession );

    /**

     * Destructor.

     */

    virtual ~CMPMIapSelection();

    /**

     * Chooses best available IAP when connection is starting.

     * @param aChooseIapPref Connection preferences.

     *

     * @since S60 v3.2

     */

    void ChooseIapL( const TMpmConnPref& aChooseIapPref );

    /**

     * Handles IAP selection for explicit connection.

     * If necessary performs Wlan scan. 

     *

     * @since S60 v3.2

     */

    void ExplicitConnectionL();

    /**

     * Updates connection dialog contents if 

     * the dilog is shown

     *

     * @since S60 v3.2

     */

    void UpdateConnectionDialogL();

public:

    /**

     * Starts Wlan query if Iap is wlan iap.

     *

     * @param aIapId Id of Iap

     * @param aIsRoaming True if wlan query is for roaming

     * @return ETrue if wlan query was started

     * @since S60 v3.2

     */

    TBool StartWlanQueryIfNeededL(

        TUint32 aIapId,

        TBool aIsRoaming = EFalse );

    /**

     * Part of selecting best IAP at connection start. Called when WLAN scan

     * is completed. Continues IAP selection according to the iChooseIapState.

     *

     * @since 3.1

     * @param aStatus Error code of completing the request.

     */

    void ChooseIapWLANScanCompletedL( TInt aStatus );

    /**

     * Completing choose iap request. Uses corresponding function

     * of CMPMServerSession

     *

     * @since 3.2

     * @param aError Message status

     * @param aPolicyPref Policy preference to be returned, NULL if no 

     * preference should be passed

     */

    void ChooseIapComplete( TInt aError, const TMpmConnPref* aPolicyPref );

    /**

     * Callback function used after Wlan network has been selected. 

     * Uses HandleUserIapSelectionL to complete IAP selection.

     *

     * @since 3.2

     * @param aError Error code from selection

     * @param aIapId Element id of IAP record if different than reported before. 

     * May be 0, when error occurred in selection or when no new Iap id is set.

     *

     */

    void UserWlanSelectionDoneL( TInt aError, TUint32 aIapId );

    /**

     * Stops displaying the starting dialog.

     *

     * @since 3.2

     */

    void StopDisplayingStartingDlg();

    /**

     * Selects the best IAP for the connection.

     *

     * @since 3.0

     * @param aMpmConnPref Connection preferences

     * @param aAvailableIAPs Array of available IAPs

     * @return KErrNone if successful, otherwise one of the

     * system-wide error codes

     */

    void ChooseBestIAPL( TMpmConnPref&          aMpmConnPref,

                         const RArray<TUint32>& aAvailableIAPs);

    /**

     * Selects the best IAP for the connection.

     * @since 3.2

     * @param aMpmConnPref Connection preferences.

     * @param aAvailableIAPs Array of available IAPs.

     * @param aNextBestExists ETrue if there is another available 

     * IAP inside the destination that could be used.

     * @return KErrNone if successful, otherwise one of the

     * system-wide error codes.

     */

    void ChooseBestIAPL( TMpmConnPref&           aMpmConnPref,

                         const RArray<TUint32>&  aAvailableIAPs, 

                         TBool&                  aNextBestExists );

    /**

     * Sets confirmation dialog ponter to NULL.

     *

     * @since 3.0

     */

    void SetConfirmDlgStartingPtrNull();

    /**

     * Returns reference to CMPMServerSession

     *

     * @since S60 3.2

     */

    CMPMServerSession* Session();

    /**

     * Handles user IAP/SNAP selection error and completes the request.

     *

     * @since 3.2

     * @param aError Error value 

     *

     */

    void HandleUserSelectionError( TInt aError );

    /**

     * Handles user IAP/SNAP selection and completes the request.

     *

     * @since 3.2

     * @param aIsIap ETrue if selection is iap

     * @param aId Id of IAP or SNAP record. May be 0, when error

     * occurred in selection

     * @param aError Error value 

     *

     */

    void HandleUserSelectionL( TBool aIsIap, TUint32 aId, TInt aError  );

    /**

     * Returns the stored user response to the offline note

     * @since 3.2

     */

    TOfflineNoteResponse OfflineNoteResponse();

    /**

     * Stores the user response to the offline note

     * @since 3.2

     * @param aResponse Offline note response

     */

    void SetOfflineNoteResponse( TOfflineNoteResponse aResponse );

    /**

     * Iap selection is notified that conenction is started. 

     * Offline note response is reseted.

     *

     * @since 3.2

     */

    void ConnectionStarted();

    /**

     * Triggers an information note. Note disappears automatically. 

     *

     * @since 5.2

     */

    void TriggerInformationNoteL();

    /**

     * Get original MPM connection preferences

     * @since 5.2

     */

     TMpmConnPref MpmConnPref();

     /**

      * Completing implicit connection.

      * @since 3.2

      */

     void CompleteImplicitConnectionL();

    // internal functions

private:

    /**

     * Handles IAP selection for implicit connection.

     * If necessary performs Wlan scan. 

     *

     * @since 3.2

     *

     */

    void ImplicitConnectionCheckWlanScanNeededL();

    /**

     * Completes IAP selection with explicit 

     * SNAP connection. If necessary, displays 

     * confirmation query.

     *

     * @since S60 v3.2

     */

    void CompleteExplicitSnapConnectionL();

    /**

     * Check whether GPRS services are allowed or not.

     * @since 3.2

     * @param aIapLanOrWlan IAP service type is either LANService or not 

     * @return ETrue if GPRS services are allowed

     */

    TBool CheckGprsServicesAllowedL( TBool aIapLanOrWlan );

    /**

     * Handles implicit connection IAP selection

     * @since 3.2

     */

    void ImplicitConnectionIapSelectionL();

    /**

     * Handles implicit connection start

     * @since 3.2

     */

    void ImplicitConnectionL();

    /**

     * Handles implicit connection wlan note displaying

     * @since 3.2

     */

    void ImplicitConnectionWlanNoteL();

private: // from MWlanAvailability

       /**

       * WLAN availability check response

       * @since 3.2

       * @param aError generic Symbian error response code

       * @param aResult Result of WLAN availability check

       * @return void

       */

       void WlanAvailabilityResponse( const TInt  aError, 

                                      const TBool aResult );

private:

    /**

     * C++ default constructor.

     */

    CMPMIapSelection( CMPMCommsDatAccess*   aCommsDatAccess,

                      CMPMServerSession*    aSession );

    /**

     * ConstructL

     */

    void ConstructL();

private:

    // Connection preferences used for connection selection.

    // This is stored when ChooseIapL() is called and is used by methods 

    // selecting the best iap. This member variable is also used 

    // to store selection before writing it back to client message.

    TMpmConnPref iChooseIapPref;

    // Keeps state of choosing iap

    TChooseIapState iChooseIapState;

    // Used for commsdat related functionalities

    CMPMCommsDatAccess* iCommsDatAccess;

    // Contains state info whether PrefIapnotifs can be sent 

    // and saved IAP info structure.

    TStoredIapInfo iStoredIapInfo;

    // Stored available Iaps

    RAvailableIAPList iStoredAvailableIaps;

    // pointer to Session

    CMPMServerSession* iSession;

    // Pointer to Confirmation dialog.

    CMPMConfirmDlgStarting* iConfirmDlgStarting;

    // Pointer to the dialog active object.

    CMPMDialog* iDialog;

    // Pointer to Wlan query dialog.

    CMPMWlanQueryDialog* iWlanDialog;

    // Stores the boolean value whether next best iaps 

    // exists in explicit connection start.

    TBool iNextBestExists;

    // Iap selected by user.

    TUint32 iUserSelectionIapId;

    // Snap selected by user.

    TUint32 iUserSelectionSnapId;

    // State of impilict connection start

    TImplicitConnectionState iImplicitState;

    // Offline note response for the connection. 

    // Offline note must be displayed only once 

    // during the connection (not for each wlan iap of a snap).

    TOfflineNoteResponse iOfflineNoteResponse;

    // True if connection is roaming (set when displaying offline note)

    TBool iIsRoaming;

    // True if user has selected "Known and new" for join wlan networks

	// setting in Connectivity settings plugin.

    TBool iNewWlansAllowed;

    };

#endif // MPMIAPSELECTION_H