/*

* Copyright (c) 2004-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: MPM Server class definition

*

*/

/**

@file mpmserver.h

Mobility Policy Manager server class definitions.

*/

#ifndef MPMSERVER_H

#define MPMSERVER_H

//  INCLUDES

#include <e32base.h>

#include <rconnmon.h>

#include <etel.h>           // RTelServer

#include <etelmm.h>         // RMobilePhone

#include <etelpckt.h>       // RPacketService

#include "mpmcommon.h"

#include "rmpm.h"

#include "mpmroamingwatcher.h"

#include "mpmdatausagewatcher.h"

class CMPMCommsDatAccess;

class CMpmCsIdWatcher;

class CMpmDataUsageWatcher;

class CMpmOfflineWatcher;

// CONSTANTS

_LIT( KMPMPanicCategory, "Mobility Policy Manager Server" );

const TInt    KPhoneRetryCount   = 7;

// 0.1 seconds

//

const TInt    KPhoneRetryTimeout = 100000;

const TUint32 KMaxOpenTransAttempts = 5;

const TUint32 KRetryAfter = 200000;

// The granularity with which iDisconnectQueue will allocate memory chunks. 

// If set to two there will be space for two instances of CMPMDisconnectDlg

// before new memory will be allocated.

const TInt    KGranularity       = 2;

// Security policy definitions

//Total number of ranges

const TUint KMPMPolicyRangeCount = 2;

// roaming to connected wlan wait interval

// in micro seconds (10 sec)

const TInt KRoamingToWlanUpdateInterval = 10000000; 

// roaming to connected hotspot wlan wait interval

// in micro seconds (120 sec)                    

const TInt KRoamingToHotspotWlanUpdateInterval = 120000000; 

//Definition of the ranges of IPC numbers

const TInt KMPMPolicyRanges[KMPMPolicyRangeCount] = 

    {

    0, // 0 -> 19 ; EMPMServerChooseIap,

       //           EMPMServerCancelRequest,

       //           EMPMServerApplicationLeavesConnection,

       //           EMPMServerIapConnectionStopped,

       //           EMPMServerProcessError,

       //           EMPMServerRegisterPrefIAPNotif,

       //           EMPMServerUnregisterPrefIAPNotif,

       //           EMPMServerWaitNotification, 

       //           EMPMServerSortSNAP, 

       //           EMPMServerApplicationJoinsConnection,

       //           EMPMServerIapConnectionActivated,

       //           EMPMServerIapConnectionStarted, 

       //           EMPMServerApplicationConnectionEnds,

       //           EMPMServerApplicationMigratesToCarrier, 

       //           EMPMServerApplicationIgnoredTheCarrier, 

       //           EMPMServerApplicationAcceptedTheCarrier, 

       //           EMPMServerApplicationRejectedTheCarrier, 

       //           EMPMServerEasyWlanSsid,

       //           EMPMServerReselectIap

#ifndef _DEBUG

    19 // 19 up ; non implemented function end of range check ; ENotSupported

#else

    600 // 20 up ; non implemented function end of range check ; ENotSupported

#endif

    };

//Policy to implement for each of the above ranges        

const TUint8 KMPMPolicyElementsIndex[KMPMPolicyRangeCount] = 

    {

    0, //applies to 0th range

    CPolicyServer::ENotSupported //applies to 1st range (out of range IPC)

    };

//Specific capability checks

const CPolicyServer::TPolicyElement KMPMPolicyElements[] = 

    {

    //policy "0"; fail call if NetworkControl not present

    {_INIT_SECURITY_POLICY_C1(ECapabilityNetworkControl),

      CPolicyServer::EFailClient

    }

    };

//Package all the above together into a policy

const CPolicyServer::TPolicy KMPMPolicy =

    {

    0, //specifies policy "0" for connect attempts

    KMPMPolicyRangeCount, //number of ranges

    KMPMPolicyRanges, //ranges array

    KMPMPolicyElementsIndex, //elements<->ranges index

    KMPMPolicyElements, //array of elements

    };

// DATA TYPES 

// Connection state types

enum TConnectionState

    {

    EIdle = 0, 

    EStarting, 

    EStarted, 

    ERoaming 

    };

// Which component initiated sending preferred IAP notifications

enum TPrefIAPNotifCaller

    {

    EConnMon = 0,

    EConnMonEvent,

    EBearerMan, 

    EConfirmDlgRoaming, 

    EConfirmDlgStarting

    };

// Blacklisting expires when connection is terminated (user/application) 

// or when connection error is no longer a problem (IapConnectionStarted). 

// 

enum TBlacklistCategory

    {

    EConnectionLifetime = 0, 

    ETemporary

    };

//  Types of callback to be used after wlan scan has been completed

enum TWlanScanCallback

    {

    EWlanScanCallbackNone,

    EWlanScanCallbackChooseIap,

    EWlanScanCallbackProcessErr,

    EWlanScanCallbackCarrierRejected,

    EWlanScanCallbackSortSnap,

    EWlanScanCallbackGenerateEvent

    };

// Enums used with active connection selection

enum TMPMBearerType

    {

    // Set to none when there are no active connections

    EMPMBearerTypeNone,

    // VPN bearer

    EMPMBearerTypeVpn,

    // WLAN bearer

    EMPMBearerTypeWlan,

    // Packet data bearer

    EMPMBearerTypePacketData,

    // Something else than previous ones

    EMPMBearerTypeOther

    };

enum TOfflineWlanQueryResponse

    {

    EOfflineResponseUndefined,

    EOfflineResponseYes,

    EOfflineResponseNo

    };

// FUNCTION PROTOTYPES

void PanicServer( TInt aPanic );

// FORWARD DECLARATIONS

class CMPMConnMonEvents;

class CMPMServerSession;

class CMPMDtmWatcher;

class CMPMDisconnectDlg;

class CMPMConfirmDlgRoaming;

class CMPMConfirmDlgStarting;

class CMPMDefaultConnection;

class CMPMWlanQueryDialog;

class CMPMDialog;

class CMPMConnPermQueryTimer;

// CLASS DECLARATION

/**

*  Class structure to associate Connection Id 

*  and the list of blacklisted IAPs 

* 

*  @since 3.1

*/

class TMPMBlackListConnId

    {

    public:

        void Append( TUint32 aIap, TBlacklistCategory aCategory );

        void Remove( TInt index );

        void Close();

        TInt Count() const;

        inline TUint32 Iap( TInt aIndex) const;

        inline TBlacklistCategory Category( TInt aIndex) const;

    public:

        TConnectionId               iConnId;

    private:

        RArray<TUint32>             iBlackListIap;

        RArray<TBlacklistCategory>  iCategory;

    };

// CLASS DECLARATION

/**

*  Class structure containing application information.

*

*  @since 3.1

*/

class TConnectionInfo

    {

    public:

        TConnectionInfo();

        static TBool MatchId( const TConnectionInfo& aFirst,

                              const TConnectionInfo& aSecond );

        static TBool MatchIdSnap( const TConnectionInfo& aFirst,

                                  const TConnectionInfo& aSecond );        

    public:

        TConnectionId       iConnId;

        TUint32             iSnap; 

        TUint32             iIapId;

        TConnectionState    iState;

        TUint32             iAppUid;

    };

// CLASS DECLARATION

/**

*  Class structure to associate IAP with 

*  the list of application information.

*  Used for book-keeping of active BM connections.

*

*  @since 3.1

*/

class TActiveBMConn

    {

    public:

        TActiveBMConn();

        static TBool MatchIapId( const TActiveBMConn& aFirst,

                                 const TActiveBMConn& aSecond );

        static TBool MatchConnInfo( const TActiveBMConn& aFirst,

                                    const TActiveBMConn& aSecond );

    public:

        TConnectionInfo     iConnInfo;

    };

// CLASS DECLARATION

/**

*  MPM Server class definition.

*

*  @lib MPMServer.exe

*  @since 3.0

*/

class CMPMServer : public CPolicyServer

    {

    public: // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CMPMServer* NewL();

        /**

        * Destructor.

        */

        virtual ~CMPMServer();

    public: // New functions

        /**

        * Panics the client thread in case of a wrong client request.

        * @since 3.0

        * @param aPanic Panic code

        */

        void PanicClient( const TInt aPanic ) const;

        /**

        * Adding info about active BM connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @param aSnap Snap Id of the connection

        * @param aIapId IAP Id of the connection

        * @param aState State of the connection

        * @param aSession Handle to session class

        */

        void AppendBMConnection( const TConnectionId aConnId,

                                 const TUint32       aSnap,

                                 const TUint32       aIapId, 

                                 TConnectionState    aState,

                                 CMPMServerSession&  aSession );

        /**

        * Reset the Iap Id as zero and update connection state as EIdle.

        * @since 3.2

        * @param aConnId Connection Id

        * @param aIapId IAP Id of the connection

        * @param aSession Handle to session class        

        */

        void ResetBMConnection( const TConnectionId aConnId, 

                                const TUint32       aIapId,

                                CMPMServerSession&  aSession );

        /**

        * Removing info about an active BM connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @param aSession Handle to session class        

        */

        void RemoveBMConnection( const TConnectionId aConnId,

                                 CMPMServerSession&  aSession );

        /**

        * Getting Iap Id of an active BM connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @return Iap Id if connection found, else 0

        */

        TUint32 GetBMIap( const TConnectionId aConnId );

        /**

        * Getting SNAP of an active BM connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @return SNAP if connection found, else 0

        */

        TUint32 GetBMSnap( const TConnectionId aConnId );

        /**

        * Getting the connection state for the Connection Id.

        * @since 3.2

        * @param aConnId Connection Id

        * @param aState State of the connection

        */

        void GetConnectionState( const TConnectionId aConnId,

                                 TConnectionState&   aState );

        /**

        * Checks if the connection is started for the Iap Id,

        * returning the state.

        * @since 3.2

        * @param aIapId IAP Id of the connection

        * @param aConnId Connection Id

        * @return Connection State, EIdle if not found

        */

        TConnectionState CheckUsageOfIap( const TUint32 aIapId, 

                              const TConnectionId aConnId );

        /**

        * Checks if any WLAN connection is started.

        * @since 3.2

        * @param aCdbAccess

		* @return IAP ID of the started WLAN connection, zero if not found

        */

        TUint32 IsWlanConnectionStartedL( const CMPMCommsDatAccess* aCdbAccess );

        /**

        * Appending the whole IAP info about an active BM connection.

        * @since 3.2 

        * @param aIapId IAP Id of the connection 

        * @param aConnId Connection Id

        * @param aSession Handle to session class        

        */

        void AppendBMIAPConnectionL( const TUint32       aIapId, 

                                     const TConnectionId aConnId,

                                     CMPMServerSession&  aSession );

        /**

        * Removing the whole IAP info about an active BM connection.

        * @since 3.1 

        * @param aIapId IAP Id of the connection

        * @param aConnId Connection Id

        * @param aSession Handle to session class        

        */

        void RemoveBMIAPConnection( const TUint32       aIapId, 

                                    const TConnectionId aConnId,

                                    CMPMServerSession&  aSession );

        /**

        * Adding info about active BM preferred IAP notification registration.

        * @since 3.1

        * @param aConnId Connection Id

        * @param aSnap Snap Id of the connection

        * @param aCurrentIapId IAP Id of the connection

        */

        void AppendBMPrefIAP( const TConnectionId aConnId,

                              const TUint32       aSnap,

                              const TUint32       aCurrentIapId );

        /**

        * Removing info about active BM preferred IAP notification 

        * registration.

        * @since 3.1

        * @param aConnId Connection Id

        */

        void RemoveBMPrefIAP( const TConnectionId aConnId );

        /**

        * Resets current IAP Id info of an active BM preferred IAP 

        * notification registration.

        * @since 3.2

        * @param aConnId Connection Id

        */

        void ResetBMPrefIAP( const TConnectionId aConnId );

        /**

        * Checks whether given connection has registered for 

        * preferred IAP notifications.

        * @since 3.2

        * @param aConnId Connection Id

        * @return ETrue if registered

        */

        TBool RegisteredForBMPrefIAP( const TConnectionId aConnId );

        /**

        * Sets last notified IAP for BMPrefIAPNotif related to a connection

        * 

        * @since 3.2

        * @param aConnId Connection Id

        * @param aIapId Last notified IAP id.

        * @return KErrNone if successfull. otherwise one of the system wide error

        * codes

        */

        TInt SetConnectionBMPrefLastNotifedIap( TConnectionId aConnId, TUint32 aIapId );

        /**

        * Adding session pointer.

        * @since 3.2

        * @param aSession Pointer to session

        */

        void AppendSessionL(const CMPMServerSession* aSession);

        /**

        * Removing session pointer.

        * @since 3.2

        * @param aSession Pointer to session

        */

        void RemoveSession( const CMPMServerSession* aSession );

        /**

        * Notify each session about IAP availability change.

        * @since 3.1

        * @param aIapInfo Info about available IAPs

        * @param aCaller Identifies the calling context 

        */

        void NotifyBMPrefIapL( const TConnMonIapInfo& aIapInfo,

                               const TPrefIAPNotifCaller aCaller );

        /**

        * Update Connection dialog of each session

        * @since 3.2

        */

        void UpdateSessionConnectionDlgL();

        /**

        * Completes pending messages

        * @since 5.2

        * @param aIapId IAP Id of the connection.

        * @param aError Message status

        * @param aErrorReturned Error value to be returned, NULL if no 

        * value should be passed

        * @param aNeededAction Needed action to be returned, NULL if no 

        * value should be passed

        */

        void HandlePendingMsgs( TUint aIapId,

                                TInt aError,

                                TInt* aErrorReturned,

                                TBMNeededAction* aNeededAction );

        /**

        * Handling of blacklisting certain IAP and the presumed IAP for 

        * the certain connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @param aIapId IAP Id of the connection.

        * @param aCategory Either connection lifetime or temporary. 

        * @return KErrNone if successful, otherwise one of the

        * system-wide error codes 

        */

        TInt HandleServerBlackListIap( const TConnectionId   aConnId, 

                                       TUint32               aIapId, 

                                       TBlacklistCategory    aCategory );

        /**

        * Handling of blacklisting certain IAP for the certain connection.

        * @since 3.1

        * @param aConnId Connection Id

        * @param aIapId IAP Id of the connection.

        * @param aCategory Either connection lifetime or temporary. 

        * @return KErrNone if successful, otherwise one of the

        * system-wide error codes 

        */

        TInt BlackListIap( const TConnectionId   aConnId, 

                           TUint32               aIapId, 

                           TBlacklistCategory    aCategory );