/*

* 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 destination class.

*

*/

#ifndef DESTINATIONIMPL_H

#define DESTINATIONIMPL_H

// User includes

#include "cmmanager.hrh"

#include <cmmanagerdef.h>

// System includes

#include <e32def.h>

#include <e32base.h>

#include <metadatabase.h>

#include <commsdattypesv1_1.h>

// CONSTANTS

const TInt KCmInitIndex =  1;

const TInt KNumOfIcons = 12;

#define RECORD_FROM_ELEMENT_ID( elementId ) \

                                    (( elementId & KCDMaskShowRecordId ) >> 8 )

enum TSnapMetadataProtecionLevel

    {

    EProtectionLevel0 = 0x00000000,

    EProtectionLevel1 = 0x10000000,

    EProtectionLevel2 = 0x20000000

    };

#define KSnapMetadataProtecionLevelMask 0xF0000000;

// DATA TYPES    

// FORWARD DECLARATIONS

class CCmManagerImpl;

class CCmPluginBaseEng;

class CCmPluginBase;

class TCmPluginInitParam;

class CPluginItem;

class CCDDataMobilitySelectionPolicyRecord;

class CGulIcon;

class CCmTransactionHandler;

class CCDSNAPMetadataRecord;

typedef CArrayPtrFlat<CPluginItem> CCmArray;

#define KFlagRemove 0x00000001

typedef CCDDataMobilitySelectionPolicyRecord CCDSnapRecord;

const TUint32 KCmDefaultDestinationAPTagId = 0x1000;

// CLASS DECLARATION

NONSHARABLE_CLASS(CPluginItem) : public CBase

    {

    public:

        enum

            {

            ERemoveCm   = 0x00000001

            };

    public:

        CCDSnapRecord*     iDNRecord;

        CCmPluginBase*   iPlugin;

        TUint32             iFlags;

    };        

/**

 * Holds all the destination specific data of the CCmDestinationImpl

 * This class is put in the object pool and may be shared

 * among CCmDestinationImpl objects

 */

NONSHARABLE_CLASS( CCmDestinationData ): public CBase

    {

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

    // Constructors/Destructors

    // 

    public:

        CCmDestinationData( CCmManagerImpl& aCmMgr );

        ~CCmDestinationData();

        /**

        * Increments the reference counter. Used by the object pool.

        */

        void IncrementRefCounter();

        /**

        * Increments the reference counter. Used by the object pool.

        */

        void DecrementRefCounter();

    private:

        /**

        * Reset and, if needed, destroy the passed array.

        * @since S60 3.2

        * @param aArray array to be reseted and deleted

        * @parar aDestroy ETrue if array has to be deleted

        */

        void ResetAndDestroyArray( CCmArray* &aArray, TBool aDestroy );

    public:

        /**

        * Returns the number of connection methods of the destination

        * @param None

        * @return TInt        

        */                  

        TInt ConnectionMethodCount();

        /**

        * Returns the destination's Id attribute

        * @param None

        * @return TUint32        

        */            

        inline TUint32 Id(){return iDestAPRecord->iRecordTag;};

        /**

        * Returns the destination's ElementId attribute

        * @param None

        * @return TUint32        

        */            

        inline TUint32 ElementId() 

        { return iNetworkRecord->ElementId() & KCDMaskShowField;};

        /**

        * Returns that the destination is protected or not.

        * @return protection level   

        */

        CMManager::TProtectionLevel ProtectionLevel();

        /**

        * Returns that the destination is hidden or not.

        * @param None

        * @return TBool   

        */

        TBool IsHiddenL(); 

        /**

        * Indicates if the Id is valid or if this is a new object which sitll

        * haven't been updated. 

        * Used by the object pool.

        * @return TBool

        */

        TBool IdIsValid();

        /**

        * Returns the reference counter. Used by the object pool.

        * @return TInt

        */

        TInt GetRefCounter();

        /** 

        * Returns pointer to the CmManager object

        * Used in 'R' classes

        */

        CCmManagerImpl* Cmmgr();

        /**

        * Returns the Metadata

        * @param None

        * @return TUint32        

        */            

        TUint32 MetadataL( CMManager::TSnapMetadataField aMetaField ) const;

    private:

        CCmManagerImpl&               iCmMgr;         //< Not owned

        CommsDat::CCDNetworkRecord*   iNetworkRecord;

        //To store Connection methods that belong to this destination

        CCmArray* iConnMethodArray;

        CCmArray* iDeleteCmArray;

        // DN_IAP Table has to be update if

        // - new CM is added to the destination

        // - CM is delete from the destination

        // - CM priority modified

        TBool iDNTableChanged;

        //Protection changed

        TBool   iProtectionChanged;

        //The last protection level of the destination

        TUint   iLastProtectionLevel;

        CCDSNAPMetadataRecord* iMetaDataRec;

        //Reference counter for the object pool

        TInt                iRefCounter;

        //indicates if the Id is valid or not (for the object pool)

        TBool               iIdIsValid;                

        CommsDat::CCDAccessPointRecord* iDestAPRecord;

        friend class CCmDestinationImpl;

        friend class CCmManagerImpl;

        TBool               iNewWithId;

    };

/**

 *  RCmDestination is for getting/setting values of a network destination.

 *  @lib cmmanager.lib

 *  @since S60 v3.2

 */

NONSHARABLE_CLASS( CCmDestinationImpl ) : public CBase

    {

    public:

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

    // Constructors/Destructors

    // 

    public:

        /** Destructor. */

        ~CCmDestinationImpl();

        /** Epoc constructor 

        * This should be used only by the object pool

        */

        IMPORT_C static CCmDestinationImpl* NewL( CCmManagerImpl& aCmMgr,

                                                  const TDesC& aName );

        /** Epoc constructor 

        * This should be used only by the object pool

        */

        static CCmDestinationImpl* NewL( CCmManagerImpl& aCmMgr,

                                         CCmDestinationData* aData );

        /** Epoc constructor 

        * This should be used only by the 'R' classes

        */

        static CCmDestinationImpl* NewLC( CCmDestinationData* aData );

        /** Epoc constructor 

        * This should be used only by the object pool

        */

        IMPORT_C static CCmDestinationImpl* NewL( CCmManagerImpl& aCmMgr,

                                                  TUint aDestinationId );

    public:

        /** 

        * Returns pointer to the CmManager object

        * Used in 'R' classes

        */

        CCmManagerImpl* Cmmgr();

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

        // Conn method handling

        /**

        * Create a connection method belonging to the destination

        * @param aImplementationUid - implementation uid of the connection 

        * method

        * @return CCmPluginBaseEng*

        */

        CCmPluginBase* CreateConnectionMethodL( TUint32 aBearerType );

        /**

        * Create a connection method belonging to the destination

        * @param aBearerType - implementation uid of the connection 

        * method

        * @param aConnMethId - Predefined id for the connection method.

        * @return CCmPluginBaseEng*

        */

        CCmPluginBase* CreateConnectionMethodL( TUint32 aBearerType,

                                                TUint32 aConnMethId );

        /*

        * Adds an existing connection method to a destination

        * @param

        * @return TInt - index in the Connection Method list

        */

        TInt AddConnectionMethodL( CCmPluginBase& aConnectionMethod );

        /*

        * Embeds an existing destination to the destination

        * @param CCmDestinationImpl - Destinatio to be embedded

        * @return TInt - index in the Connection Method list

        */

        TInt AddEmbeddedDestinationL( CCmDestinationImpl& aDestination );        

        /**

        * Remove a connection method from a destination and delete it

        * on update. 

        * Exception: conenction method is not deleted  if it's referenced 

        * from any other destination.

        * @param aConnectionMethod the connection method to be deleted

        * @return none.

        */

        void DeleteConnectionMethodL( CCmPluginBase& aConnectionMethod ); 

        /**

        * Remove connection method from the destination

        * @param aConnectionMethod connection method to be removed

        */

        void RemoveConnectionMethodL( const CCmPluginBase& aConnectionMethod );

        /**

        * Remove connection method from the destination

        * @param aConnectionMethod connection method to be removed

        */

        void RemoveConnectionMethodL( const CCmPluginBaseEng& aConnectionMethod );

        /**

        * Notification from child plugin that it was deleted.

        * Remove it from the array and update priorities.

        * @param aConnectionMethod child connection method that was deleted.

        */

        void ConnectionMethodDeletedL( const CCmPluginBase& aConnectionMethod );

        /**

        * Set the CCMItem's priority based on the passed new index

        * @param aCCMItem The connection method item

        * @param aIndex The new index of the item in the list

        */

        void ModifyPriorityL( CCmPluginBase& aCCMItem, TUint aIndex );

        /**

        * Obsolete 

        */

        TUint PriorityL( CCmPluginBaseEng& aCCMItem );

        /**

        * Return the priority of the passed connection method

        * @param aCCMItem queried connection method

        * @return the priority of the queried connection method 

        */

        TUint PriorityL( CCmPluginBase& aCCMItem );

        /**

        * Returns the number of connection methods of the destination

        * @param None

        * @return TInt        

        */                  

        IMPORT_C TInt ConnectionMethodCount();

        //Operator

        /**

        * Obsolete

        */

        IMPORT_C CCmPluginBaseEng* ConnectionMethodL( TInt anIndex );

        /**

        * Returns a reference to the connection method. 

        * The index must be less than the return value of ConnMethodCount()

        * @param anIndex

        * @return plugin instance - ownership NOT passed

        */         

        IMPORT_C CCmPluginBase* GetConnectionMethodL( TInt anIndex );

        /**

        * Returns a reference to the connection method. 

        * The index must be less than the return value of ConnMethodCount()

        * @param anIapId IAP id of the queried connection method

        * @return plugin instance - ownership NOT passed

        */         

        CCmPluginBase* ConnectionMethodByIDL( TUint32 anIapId );

        void ConnectMethodIdArrayL( RArray<TUint32>& aCmIds );

        //Getting attributes

        /**

        * Returns the destination's Name attribute

        * HBuf ownership is passed to the caller

        * @param None

        * @return name of the destination. ownership is passed.

        */      

        IMPORT_C HBufC* NameLC();                        

        /**

        * Returns the destination's Id attribute

        * @param None

        * @return TUint32        

        */

        inline TUint32 Id(){return iData->Id();};

        /**

        * Returns the destination's ElementId attribute

        * @param None

        * @return TUint32

        */            

        inline TUint32 ElementId(){ return iData->ElementId();};

        /**

        * Returns the Icon pointer

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

        * @param None

        * @return TUint32  

        */ 

        IMPORT_C CGulIcon* IconL();

        /**

        * Returns the Metadata

        * @param None

        * @return TUint32        

        */            

        TUint32 MetadataL( CMManager::TSnapMetadataField aMetaField ) const;

        /**

        * Returns if there's connection created with any of the destination's

        * connection method.

        * @return ETrue if there's connection with any of the destination's

        * connection method.

        */

        IMPORT_C TBool IsConnectedL() const;

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

        //Setting Attributes

        /**

        * Set the destination's Name attribute. Leaves if the name already 

        * exists

        * @param aDestinationName value to set

        * @return None   

        */

        IMPORT_C void SetNameL( const TDesC& aName );

        /**

        * Set the destination's Icon index.

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

        * @param aIconIndex value to set

        * @return None   

        */

        IMPORT_C void SetIconL( TUint32 anIndex );

        /**

        * Set the Metadata

        * @param aMetaField field to be modified

        * @param aValue value to be set

        */            

        void SetMetadataL( CMManager::TSnapMetadataField aMetaField, 

                           TUint32 aValue );    

        /**

        * Returns that the destination is protected or not.

        * @return protection level   

        */

        IMPORT_C CMManager::TProtectionLevel ProtectionLevel();

        /**

        * Set the protection of the destination.

        * @param aProtectionLevel

        * @return None   

        */

        IMPORT_C void SetProtectionL( CMManager::TProtectionLevel aProtectionLevel );

        /**

        * Update all the attributes of the Connection Methods and the 

        * Destination.

        * @return None   

        */        

        IMPORT_C void UpdateL();         

        /**

        * Deletes it's connection methods from comms.dat (unless shared)

        * then deletes itself

        */

        IMPORT_C void DeleteLD();

        /**

        * Performs RollbackTransactionL().

        */

        void Close();

        /**

        * Set iPlugin to NULL in plugin array, but not delete it.

        * Next reference to this connection method will load the

        * plugin again.

        */

        void PluginClosed( CCmPluginBase* aPlugin );

        /**

        * Returns that the destination is hidden or not.

        * @param None

        * @return TBool   

        */

        IMPORT_C TBool IsHidden(); 

        /**

        * Set that the destination is hidden or not.

        * @param aHidden - True if it is hidden.

        * @return None   

        */

        IMPORT_C void SetHiddenL( TBool aHidden );         

        /**

        * Check if the destination element id is already embeded.

        * Leaves with KErrNotSupported (multiple levels of embedding is not 

        * supported)

        */

        void CheckIfEmbeddedL( TInt aId );

        static CGulIcon* IconIdL( CCmManagerImpl& aCmMgr,

                                  CommsDat::TMDBElementId aId );

        static CMManager::TProtectionLevel ProtectionLevelL( CCmManagerImpl& aCmMgr,

                                                  CommsDat::TMDBElementId aId );

        /**

        * Removes this destination from the object pool.

        */

        IMPORT_C void RemoveFromPool();

        /**

        * Increments the reference counter. Used by the object pool.

        */

        void IncrementRefCounter();

        /**

        * Increments the reference counter. Used by the object pool.

        */

        void DecrementRefCounter();

        /**

        * Returns the reference counter. Used by the object pool.

        * @return TInt

        */

        TInt GetRefCounter();

        /**

        * Returns iData. Used by the object pool and the API oprators.

        * @return TInt

        */