/*

* Copyright (c) 2006 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:  Implementation of connection method manager

*

*/

#ifndef CMMANAGERIMPL_H

#define CMMANAGERIMPL_H

// User Includes

#include "cmmanager.hrh"

#include "cmobjectpool.h"

#include "cmconnectionmethodinfo.h"

#include <datamobilitycommsdattypes.h>

#include <cmmanagerdef.h>

#include <cmdefconnvalues.h>

#include <cmgenconnsettings.h>

// System Includes

#include <e32std.h>

#include <e32base.h>

#include <e32cmn.h>

#include <f32file.h>    // RFs

#include <barsc.h>      // RResourceFile

#include <metadatabase.h>

#include <commsdattypesv1_1.h>

// Forward Declarations

class CCmTransactionHandler;

class CCmDestination;

class CCmDestinationExt;

class CCmDestinationImpl;

class CCmPluginBaseEng;

class CCmPluginBase;

class CImplementationInformation;

class TBearerPriority;

class RConeResourceLoader;

class CCmConnectionMethodInfo;

class CGulIcon;

class CCDGlobalBearerTypePriorizationRecord;

class CCDDataMobilitySelectionPolicyRecord;

class TCmPluginInitParam;

class CCmDestinationData;

class RCmManagerExt;

class MCmCommsDatWatcher;

class CCmCommsDatNotifier;

// DATA TYPES

typedef RPointerArray<CImplementationInformation>   RImplInfoPtrArray;

typedef CCDGlobalBearerTypePriorizationRecord       CCmBearerPriRec;

typedef CCDDataMobilitySelectionPolicyRecord        CCDSnapRecord;

typedef struct

    {

    RResourceFile       iFile;  // resource file handler

    TFileName           iFName; // resource filename

    TInt                iRefs;  // number of references to this res file

    }TResourceFiles;

/*#ifdef _DEBUG

void DumIapTableL( CommsDat::CMDBSession& aSession );

#define DUMP_IAP_TBL( session )  DumIapTableL( (session) );

#else   // _DEBUG

#define DUMP_IAP_TBL( session )

#endif  // _DEBUG*/

/**

 *  Implementation of connection method manager

 *

 *  @lib cmmanager.lib

 *  @since S60 v3.2

 */

NONSHARABLE_CLASS( CCmManagerImpl ) : public CBase

      {          

    // Construction/Destruction

    public:

        /** Epoc constructor */

        static CCmManagerImpl* NewL( TBool aCreateTables = ETrue );

        /** Destructor */

        virtual ~CCmManagerImpl();

    protected:

        /** First stage constructor */

        CCmManagerImpl();

        /** Epoc constructor */

        void ConstructL(); // second-phase constructor

    public: // Transaction handling API

        void OpenTransactionLC( TBool aSetAttribs = ETrue );

        void CommitTransactionL( TInt aError );

        void RollbackTransaction();

        // This will be called when the first UI view is on

        void StartCommsDatNotifierL();

    public: // Basic CM attribute query API

        /**

        * GetBearerInfoXXX function can be used to query

        * bearer informantion that doesn't belong

        * to a specific connection method, such as 

        * ECmCoverage or ECmDefaultPriority etc.

        * HBuf ownership is passed to the caller

        */

        IMPORT_C TUint32 GetBearerInfoIntL( TUint32 aBearerType,

                                            TUint32 aAttribute ) const;

        IMPORT_C TBool GetBearerInfoBoolL( TUint32 aBearerType,

                                           TUint32 aAttribute ) const;

        IMPORT_C HBufC* GetBearerInfoStringL( TUint32 aBearerType,

                                              TUint32 aAttribute ) const;

        IMPORT_C HBufC8* GetBearerInfoString8L( TUint32 aBearerType,

                                                TUint32 aAttribute ) const;

        /**

        * GetConnectionMethodInfoXXX function can be used to 

        * query any, non-bearer specific information about

        * a given connection method. This can be e.g. ECmBearerType,

        * ECmName, ECmStartPage etc.

        * HBuf ownership is passed to the caller

        */

        IMPORT_C TUint32 GetConnectionMethodInfoIntL( 

                                                TUint32 aCmId,

                                                TUint32 aAttribute ) const;

        IMPORT_C TBool GetConnectionMethodInfoBoolL( 

                                                TUint32 aCmId,

                                                TUint32 aAttribute ) const;

        IMPORT_C HBufC* GetConnectionMethodInfoStringL( 

                                                TUint32 aCmId,

                                                TUint32 aAttribute ) const;

        IMPORT_C HBufC8* GetConnectionMethodInfoString8L( 

                                                TUint32 aCmId,

                                                TUint32 aAttribute ) const;

    //=========================================================================

    // Creation/Destruction API

    //

    public:

        /**

        * Creates a Destination by the given name

        *

        * @since 3.2

        * @param aName the name of the new destination

        * @return CCmDestination*, ownership is passed to the caller

        */

        CCmDestinationImpl* CreateDestinationL( const TDesC& aName );

        /**

        * Creates a Destination by the given name

        *

        * @since 3.2

        * @param aName the name of the new destination

        * @param aDestId Predefined id for the destination

        * @return CCmDestination*, ownership is passed to the caller

        */

        CCmDestinationImpl* CreateDestinationL( const TDesC& aName,

                                                TUint32      aDestId );

        /**

        * Creates a connection method does not belong to any destination

        *

        * @since 3.2

        * @param aImplementationUid - implementation uid of the connection 

        * method

        * @param aParentDestination - the destination which holds the 

        *                             connection method, NULL means there is

        *                             no parent

        * @return CCmPluginBase*

        */

        CCmPluginBase* CreateConnectionMethodL( TUint32 aBearerType,

                            CCmDestinationImpl* aParentDestination = NULL );

        /**

        * Creates a connection method does not belong to any destination

        *

        * @since 3.2

        * @param aImplementationUid - implementation uid of the connection 

        * method

        * @param aConnMethodId Predefined id for the connection method

        * @param aParentDestination - the destination which holds the 

        *                             connection method, NULL means there is

        *                             no parent

        * @return CCmPluginBase*

        */

        CCmPluginBase* CreateConnectionMethodL( TUint32 aBearerType,

        		            TUint32 aConnMethodId,             

                            CCmDestinationImpl* aParentDestination = NULL );

        /**

        * Creates a connection method does not belong to any destination

        *

        * @since 3.2

        * @param pluginBaseEng - Object to put in the pool

        * @return CCmPluginBase*

        */

        CCmPluginBase* CreateConnectionMethodL( 

                            CCmPluginBaseEng* pluginBaseEng );

        /**

        * Insert a connection method does not belong to any destination

        * API doesn't use CCmPluginBase. So, nothing returns

        *

        * @param pluginBaseEng - Object to put in the pool

        */

        void InsertConnectionMethodL( 

                            CCmPluginBaseEng* pluginBaseEng );

        /**

        * Creates a connection method does not belong to any destination

        *

        * @since 3.2

        * @param aBearerType - implementation uid of the connection 

        * method

        * @param aParams - the destination which holds the 

        *                             connection method, NULL means there is

        *                             no parent

        * @return CCmPluginBaseEng*

        */

        CCmPluginBaseEng* DoCreateConnectionMethodL( TUint32 aBearerType,

                                       TCmPluginInitParam& aParams );

        /**

        * Creates a connection method does not belong to any destination

        *

        * @since 3.2

        * @param aBearerType Implementation uid of the connection 

        * method

        * @param aParams Initialization params for the plugin.

        * @param aConnMethodId Predefined id for the connection method.

        * @return CCmPluginBaseEng*

        */

        CCmPluginBaseEng* DoCreateConnectionMethodL( TUint32 aBearerType,

            TCmPluginInitParam& aParams, TUint32 aConnMethodId );

    //=========================================================================

    // Getter-Setter API

    //

    public:    

        /**

        * Calls FeatureManager::FeatureSupported directly.

        *

        * @since 3.2

        * @param aFeature feature ID

        * @return feature support status

        * @since 3.2

        */

        static TBool FeatureSupported( TInt aFeature );

        /**

        * Obsolete

        */

        IMPORT_C CCmPluginBaseEng* ConnectionMethodL( TUint32 aCmId );

        /**

        * Return the connection method queried by it's ID

        *

        * @since 3.2

        * @param aCmId

        * @return CCmPluginBase*

        */

        IMPORT_C CCmPluginBase* GetConnectionMethodL( TUint32 aCmId );

        /**

        * Return the list of connection methods do not belongs to any 

        * destination

        *

        * @since 3.2

        * @param aCMArray on return it is the array of IAP ids.

        * @param aCheckBearerType If ETrue only connection methods with 

        *                         supported bearer types are returned

        * @param aLegacyOnly when set to ETrue only Legacy IAP ids will

        *                         be returned

        * @param aEasyWlan when set to ETrue EasyWlan id is returned, too

        * @param aSortByBearer if ETrue the CMs will be ordered according

        *                      to global bearer priority

        */        

        IMPORT_C void ConnectionMethodL( RArray<TUint32>& aCMArray,

                                         TBool aCheckBearerType = ETrue,

                                         TBool aLegacyOnly = ETrue,

                                         TBool aEasyWlan = EFalse,

                                         TBool aSortByBearer = EFalse );

        /**

        * Return an array of all destinations

        *

        * @since 3.2

        * @param aDestArray on return it returns an array of destination ids

        */

        IMPORT_C void AllDestinationsL( RArray<TUint32>& aDestArray );

        /**

        * Return the number of destinations

        *

        * @since 3.2

        * @return the number of destinations

        */

        inline TUint DestinationCountL() { return iDestinationCount; }

        /**

        * Return the destination implementation to which a specified 

        * connection method belongs, search is by destination ID ( the

        * id which is made by RECORD_FROM_ELEMENT_ID from the elementID)

        * If the  destination implementation is allready in the  object

        * pool returns it. If it is not in the pool than puts it in the

        * pool using the GetDestinationL funciton.

        *

        * @since 3.2

        * @param aId

        * @return a pointer to a destination

        */

        IMPORT_C CCmDestinationImpl* DestinationL( TUint32 aId );

        /**

        * Removes the destination implementation 

        * from the object pool

        *

        * @since 3.2

        * @param aId

        */

        IMPORT_C void RemoveDestFromPool( CCmDestinationImpl* aDestination );

        /**

        * Removes the destination implementation 

        * from the object pool

        *

        * @since 3.2

        * @param aId

        */

        void RemoveDestFromPool( CCmDestinationData* aDestination );

        /**

        * Removes the cm 

        * from the object pool

        *

        * @since 3.2

        */

        void RemoveCMFromPoolL( CCmPluginBaseEng* aCM );

        /**

        * Removes the cm 

        * from the object pool

        *

        * @since 3.2

        */

        void RemoveCMFromPoolL( CCmPluginBase* aCM );

        /**

        * The destination have been updated if it was a new destination

        * than the zero id must be changed to the new one 

        *

        * @param aDestination - the destination to change

        */         

        void DestinationUpdated( CCmDestinationImpl* aDestination );

        /**

        * Copie a connection method belonging to one destination to 

        * another. The connection method becomes shared.

        *

        * @since 3.2

        * @param aTargetDestination target destination

        * @param aConnectionMethodId connection method to be copied

        * @return index in the Connection Method list

        */

        TInt CopyConnectionMethodL( CCmDestinationImpl& aTargetDestination,

                                    CCmPluginBase& aConnectionMethod );

        /**

        * Move a connection method belonging to one destination to 

        * another. The connection method is removed from the source destination

        *

        * @since 3.2

        * @param aSourceDestination source destination

        * @param aTargetDestination target destination

        * @param aConnectionMethod connection method to be moved

        * @return index in the Connection Method list which the connection 

        *         method has been moved to

        */

        TInt MoveConnectionMethodL( CCmDestinationImpl& aSourceDestination,

                                    CCmDestinationImpl& aTargetDestination,

                                    CCmPluginBase& aConnectionMethod );

        /**

        * Remove connection method from the destination

        *

        * @since 3.2

        * @param aDestination destination the connection method is attached to

        * @param aConnectionMethod connection method to be removed

        */

        void RemoveConnectionMethodL( CCmDestinationImpl& aDestination,

                                      CCmPluginBase& aConnectionMethod );

        /**

        * Return the copy of the bearer priority array. Ownership is passed.

        *

        * @since 3.2

        * @param aArray bearer priority array

        */          

        void BearerPriorityArrayL( RArray<TBearerPriority>& aArray ) const;

        /*

        * Update bearer priority array

        *

        * @since 3.2

        * @param aArray array with new global bearer priority

        */          

        void UpdateBearerPriorityArrayL( const RArray<TBearerPriority>& aArray );

        /**

        * Clean up passed global bearer priority array. Delete

        * the elements and calls Reset and Close on the array.

        *

        * @since 3.2

        * @param aArray array to be cleaned up

        */

        void CleanupGlobalPriorityArray( RArray<TBearerPriority>& aArray ) const;

        /**

        * Search service type in the global priority table and

        * Return its priority.

        *

        * @since 3.2

        * @param aUiPriority ETrue if UI priority is requested

        * @param aServiceType serched service type 

        * @return priority of the service type or KErrNotFound

        */

        TInt GlobalBearerPriority( TBool aUiPriority, 

                                   const TDesC& aServiceType ) const;

        /*

        * Query all of the supported bearer types.

        *

        * @since 3.2

        * @param aArray list of all supported bearer types.

        */          

        void SupportedBearersL( RArray<TUint32>& aArray ) const;

        /*

        * Return "Uncategorized" icon.

        * This fucton leaves if the client does not have a valid UI context

        *

        * @since 3.2

        * @return CGulIcon icon of uncategorized connection methods.

        */          

        CGulIcon* UncategorizedIconL() const;

        /**

        * Returns the id of the EasyWlan connection method.

        *

        * @since S60 3.2

        * @return id of the EasyWLan connection method. 0 if not found

        */

        IMPORT_C TUint32 EasyWlanIdL();

        /**

        * Create a SNAP record object and load it if record id not 0.

        * @param aRecordId record Id. 0 means create only

        * @return created/loaded SNAP record

        */

        CCDSnapRecord* SNAPRecordL( TUint32 aRecordId ) const;

        CCDSnapRecord* CreateSNAPRecordL( TUint32 aRecordId ) const;

        /**

        * Tells the CmManager that the given default connection is deleted,

        * and it sets Default Connection to Always Ask (default value).

        *

        * @since S60 3.2

        */

        void HandleDefConnDeletedL( TCmDefConnValue& aDCSetting );

        /**

        * Returns the default connection method/SNAP.

        *

        * @since S60 3.2

        */

        void ReadDefConnL( TCmDefConnValue& aDCSetting );   

        /**

        * Stores the default connection method/SNAP.

        *

        * @since S60 3.2

        */

        void WriteDefConnL( const TCmDefConnValue& aDCSetting );  

        /**

        * Returns the default connection method/SNAP.

        *

        * @since S60 3.2

        */

        void ReadDefConnWoTransL( TCmDefConnValue& aDCSetting );   

        /**

        * Stores the default connection method/SNAP.

        *

        * @since S60 3.2

        */

        void WriteDefConnWoTransL( const TCmDefConnValue& aDCSetting );  

        /**

        * Returs ETrue if Default Connection feature is supported.

        *

        * @since S60 3.2

        */        

        TBool IsDefConnSupported();

        /**

        * Check if memory low so that process can continue

        */

        TBool IsMemoryLow(); 

        /**

        * Returns the general connection settings.

        */

        void ReadGenConnSettingsL( TCmGenConnSettings& aGenConnSettings );

        /**

        * Replaces the general connection settings.

        */