/*

* Copyright (c) 2007 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:  IF implementation class for connection method plugins.

*

*/

#ifndef CMPLUGINBASE_H

#define CMPLUGINBASE_H

// INCLUDES

#include <cmpluginbaseeng.h>

/**

 *  This class wraps the CCmPluginBaseEng class and is used instead of that 

 *  in the framework and the 'R' classes. This way the CCmPluginBaseEng

 *  class could remain in the object pool after the CCmPluginBase object is

 *  deleted.

 *

 *  @lib cmmanager.lib

 *  @since S60 v3.2

 */

class CCmPluginBase : public CBase

    {

    public:

        /** Constructor */

        IMPORT_C CCmPluginBase( CCmPluginBaseEng* plugin );

        /** Destructor. */

        IMPORT_C ~CCmPluginBase();

        /**

        * Create a new instance of the given bearer type plugin.

        * Used from framework to avoid using slow ECom framework.

        * @param aInitParam initialization data

        */

        CCmPluginBase* 

                CreateInstanceL( TCmPluginInitParam& aInitParam );

    public: // Attribute handlers

        /**

        * Gets the value for a TInt attribute.

        * @param aAttribute Identifies the attribute to be retrived.

        * @return contains the requested TInt attribute.

        */

        IMPORT_C TUint32 

                        GetIntAttributeL( const TUint32 aAttribute ) const;

        /**

        * Gets the value for a TBool attribute.

        * @param aAttribute Identifies the attribute to be retrived.

        * @return contains the requested TBool attribute.

        */

        IMPORT_C TBool 

                        GetBoolAttributeL( const TUint32 aAttribute ) const;

        /**

        * Gets the value for a String16 attribute.

        * @param aAttribute Identifies the attribute to be retrived.

        * @return copy of the requested attribute. Ownership is passed.

        */

        IMPORT_C HBufC* 

                        GetStringAttributeL( const TUint32 aAttribute ) const;

        /**

        * Gets the value for a String8 attribute.

        * @param aAttribute Identifies the attribute to be retrived.

        * @return copy of the requested attribute. Ownership is passed.

        */

        IMPORT_C HBufC8* 

                        GetString8AttributeL( const TUint32 aAttribute ) const;

        /**

        * Sets the value for a TInt attribute.

        * @param aAttribute Identifies the attribute to be set.

        * @param aValue The value to be set.

        * @return None.

        */

        IMPORT_C void SetIntAttributeL( 

                             const TUint32 aAttribute, TUint32 aValue );

        /**

        * Sets the value for a TBool attribute.

        * @param aAttribute Identifies the attribute to be set.

        * @param aValue The value to be set.

        * @return None.

        */

        IMPORT_C void SetBoolAttributeL( 

                             const TUint32 aAttribute, TBool aValue );

        /**

        * Sets the value for a String16 attribute.

        * @param aAttribute Identifies the attribute to be set.

        * @param aValue The value to be set.

        * @return None.

        */

        IMPORT_C void SetStringAttributeL( 

                             const TUint32 aAttribute, const TDesC16& aValue );

        /**

        * Sets the value for a String8 attribute.

        * @param aAttribute Identifies the attribute to be set.

        * @param aValue The value to be set.

        * @return None.

        */

        IMPORT_C void SetString8AttributeL( 

                             const TUint32 aAttribute, const TDesC8& aValue );

        /**

        * Restore the original value of the attribute from commsdat field.

        * Base implementation can be used only with attributes 

        * stored directly in commsdat.

        * @param aAttribute attribute to be restored

        */

        IMPORT_C void RestoreAttributeL( const TUint32 aAttribute );

        /**

        * Returns the CCmDestinationImpl* if this is an 

        * embedded destination CM. Otherwise returns NULL.

        * @return embedded destination object or NULL

        */

        IMPORT_C CCmDestinationImpl* Destination() const;

        /**

        * Update or if this is a new CM, creates CM in CommsDat. 

        * - OpenTransactionLC()

        * - PrepareToUpdateRecordsL()

        * - UpdateChargeCardRecordL()

        * - UpdateServiceRecordL()

        * - UpdateIAPRecordL()

        *   - UpdateLocationRecordL()

        *   - BearerRecordIdLC()

        *   - UpdateNetworkRecordL()

        *   - UpdateWapRecordL()

        *   - UpdateProxyRecordL()

        *   - UpdateConnPrefSettingL()

        * - UpdateAdditionalRecordsL()

        * - CommitTransactionL()

        * @return None.

        */        

        IMPORT_C void UpdateL();     

        /*

        * Delete from the database if this CM has no more reference

        * from the DN_IAP table.

        * - IsMultipleReferencedL()

        * - OpenTransactionLC()

        * - PrepareToDeleteL()

        * - Delete records (in this order)

        *   - IAP

        *   - Proxy

        *   - Service

        *   - ChargeCard

        *   - Network

        *   - Location

        *   - WapAP

        *   - WapBearer

        * - DeleteAdditionalRecordsL()

        * - CommitTransactionL()

        * @param aForced forced delete doesn't check referencies

        * @param aOneRefsAllowed ETrue if one reference from a destination is 

        *           acceptable to delete this connection method.

        */    

        IMPORT_C TBool DeleteL( TBool aForced,

                                        TBool aOneRefAllowed = ETrue );

        /**

        * Performs the basic loading of records related

        * to this connection method:

        * - OpenTransactionLC();

        * - PrepareToLoadRecordsL()

        * - LoadIAPRecordL();

        *       - load IAP

        *       - load WAP (AP & IP Bearer)

        *       - load proxy

        *       - load charge card

        *       - load network

        *       - load location

        * - LoadServiceSettingL();

        * - LoadAdditionalRecordsL();

        */

        IMPORT_C void LoadL( TUint32 aIapId );

        /**

        * Reloads CM

        */

        void ReLoadL();

        /**

        * Create a new connection method in memory.

        * Call UpdateL() to store it in CommsDat.

        * No transaction operation is performed.

        * - Creates new WAP, IAP, Network records

        * - CreateNewServiceRecordL()

        * - CreateAdditionalRecordsL()

        * - Loads default AP name from resource 

        *       (R_CMMANAGERENG_DEFAULT_AP_NAME)

        */

        IMPORT_C void CreateNewL();

        /**

        * Create a copy of the connection method:

        * - CreateInstanceL()

        * - CreateNewL()

        * - PrepareToCopyDataL()

        * - Copies data:

        *   - name

        *   - bearer type

        *   - records added to the convertion table

        * - Calls CopyAdditionalDataL().

        */

        IMPORT_C CCmPluginBase* CreateCopyL() const;

        /*

        * Returns true if the CM has more than one parent destination

        */        

        IMPORT_C TInt NumOfConnMethodReferencesL();

    public:

        /**

        * Returns a pointer to the cmmanager

        * @return a pointer to the cmmanager

        */

        IMPORT_C CCmManagerImpl& CmMgr() const ;

        IMPORT_C CCmPluginBaseEng* Plugin() const ;

        IMPORT_C CommsDat::CMDBSession& Session() const;

        /**

        * Launches the settings dialog of the plugin

        *

        * @since S60 3.2

        * @return soft key selection

        */

        TInt RunSettingsL();

        /**

        * Called on a newly created connection method to initialize it properly

        * with user interaction (e.g. APN setting for a packet data-, WEP-key

        * setting for a WLAN connection method, etc.).

        * Note: each plug-in should set its name (i.e. ECmName) in this

        * function call.

        *

        * @since S60 3.2

        * @param aManuallyConfigure let's the plugin know if a plugin should 

        *                           be configured manually or automatically

        * @return ETrue if initialization was successful and wasn't cancelled.

        * EFalse, if initialization process was cancelled (i.e. user pressed

        * Cancel button).

        */

        TBool InitializeWithUiL( TBool aManuallyConfigure );

        /**

        * Checks if the plug-in can handle the given AP.

        * @param aIapId IAPId of the AP to be checked

        * @return ETrue if plug-in can handle the IAP

        */

        TBool CanHandleIapIdL( TUint32 aIapId ) const;

        /**

        * Checks if the plug-in can handle the given AP.

        * @param aIapRecord IAP record to be checked

        * @return ETrue if plug-in can handle the IAP

        */

        TBool CanHandleIapIdL( CommsDat::CCDIAPRecord* aIapRecord ) const;

        /**

        * Return the parent destination of this connection method.

        * @return parent destination of this connection method

        */

        IMPORT_C CCmDestinationImpl* ParentDestination() const ;

        /**

        * Calls FeatureManager::FeatureSupported directly.

        * @param aFeature feature ID

        * @return feature support status

        * @since 3.2

        */

        IMPORT_C static TBool FeatureSupported( TInt aFeature );

        /**

        * Function should be overriden by bearer type plugins.

        * Returns if the passed IAP id is linked to that connection method.

        * @param aIapId IAP id to be checked

        * @return ETrue if the passed IAP id is linked to that connection method.

        */

        IMPORT_C TBool IsLinkedToIap( TUint32 aIapId );

        /**

        * Function should be overriden by bearer type plugins.

        * Returns if the passed SNAP id is linked to that connection method.

        * @param aSnapId SNAP id to be checked

        * @return ETrue if the passed SNAP id is linked to that connection method.

        */

        IMPORT_C TBool IsLinkedToSnap( TUint32 aSnapId );

        /**

        * 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();

        /**

        * Appends uids of connection methods - which were also created during connection method

        * creation - to the array given as parameter 

        * @param aIapIds the array the additonal cm uids are appended to

        */        

        IMPORT_C void GetAdditionalUids( RArray<TUint32>& aIapIds );

    protected: // Conversion table API

        IMPORT_C void AddConverstionTableL( 

                            CommsDat::CCDRecordBase* *aRecord,

                            TBool* aEnabled,

                            const TCmAttribConvTable* aConvTable );

        IMPORT_C void AddCommonConversionTableL( 

                                const TCmCommonAttrConvArrayItem* aConvTable );

        IMPORT_C void RemoveConversionTable( 

                                        const TCmAttribConvTable* aConvTable );

        IMPORT_C void RemoveCommonConversionTable( 

                                const TCmCommonAttrConvArrayItem* aConvTable );

    protected: // Resource handling

        /**

        * Add file name to the resource file array.

        * Open it and/or increment reference count.

        * @param aName resource file name

        */

        IMPORT_C void AddResourceFileL( const TDesC& aName );

        /**

        * Remove file name from the resource file name array.

        * Close the resource file and/or decrement the reference count.

        * @param aName resource file name

        */

        IMPORT_C void RemoveResourceFile( const TDesC& aName );

        /**

        * Read string from resource file. Resource file has to be

        * opened prior this by calling AddResourceFileL().

        */

        IMPORT_C HBufC* AllocReadL( TInt aResourceId ) const;

    protected:

        /** Second phase constructor */

        IMPORT_C void ConstructL();

        /** Open transaction */

        void OpenTransactionLC();

        /**

        * Commit transaction.

        * @param aError - error id

        */

        void CommitTransactionL( TInt aError );

        /** Make a reset on this class. */

        IMPORT_C void Reset();

        /**

        * Plug-in implementation can make its on

        * cleanup in this function. 

        * Always called from LoadL() and 

        * should be called from plugin's destructor.

        */

        void AdditionalReset();

        /**

        * Check if there's connection established with

        * this connection method (IAP id).

        */

        IMPORT_C TBool CheckIfAlreadyConnected() const;

    protected:  // loader function

        /**

        * Inherited class can make some preraration

        * before CCmPluginBaseEng would start loading

        * records from tables.

        */

        IMPORT_C void PrepareToLoadRecordsL();

        /**

        * Inherited class can load any additional

        * records after CCmPluginBaseEng finished.

        */

        void LoadAdditionalRecordsL();

        /**

        * Load service record. Default implementation can

        * create only factory supported record instances.

        */

        IMPORT_C void LoadServiceSettingL();

    protected:  // update functions

        /**

        * Check if connection method data is valid, before

        * it would be persisted to commsdat.

        * If invalid data found, set its attribute id in

        * iInvalidAttribute.

        * Base class implementation must be called from

        * overridden one.

        */

        IMPORT_C void PrepareToUpdateRecordsL();

        /**

        * Inherited class can update its additional

        * records here.

        */

        void UpdateAdditionalRecordsL();

        /**

        * Update service record.

        */

        IMPORT_C void UpdateServiceRecordL();

        /**

        * Return the service table name and record id 

        * of this connection in the service table.

        * @param - aServiceName name of the service table

        *           this connection method points to.

        * @param - aRecordId record id in the service table.

        */

        void ServiceRecordIdLC( HBufC* &aServiceName, 

                                       TUint32& aRecordId );

        /**

        * Return the bearer table name and record id 

        * of this connection in the bearer table.

        * @param - aBearerName name of the bearer table

        *           this connection method points to.

        * @param - aRecordId record id in the bearer table.

        */

        void BearerRecordIdLC( HBufC* &aBearerName, 

                                       TUint32& aRecordId );

    protected:  // delete function

        /**

        * Plugin can prepare to delete the connection method

        * with this function. Called from DeleteL() before

        * any record would be deleted. Do NOT delete any

        * record here.

        */

        void PrepareToDeleteRecordsL();

        /**

        * Plugin can delete additional, bearer specific record

        * with this function. Called from DeleteL().

        */

        void DeleteAdditionalRecordsL();

    protected:  // create function

        /**

        * Plugin has to create and initialize its bearer specific object

        * that points to the service record here. Pointer has to be stored in 

        * iServiceRecord data member.

        * Do NOT store service record in CommsDat yet.

        */

        void CreateNewServiceRecordL();

        /**

        * Plugin can create and initialize its bearer specific record(s) here.

        * Do NOT store them in CommsDat yet.

        */

        void CreateAdditionalRecordsL();

    protected:

        /**

        * Called from CreateCopyL().

        * Plugin can prepare for copying every records

        * added to the conversion tables.

        *

        * @param aDestInst copy attributes into this plugin instance

        */

        void PrepareToCopyDataL( CCmPluginBaseEng& aDestInst ) const;

        /**

        * Copy data of the connection method that is not 

        * added to the conversion table. (e.g. bearer specific

        * flags)

        *

        * @param aDestInst copy attributes into this plugin instance

        */    

        void CopyAdditionalDataL( CCmPluginBaseEng& aDestInst ) const;

    private:

        void EnableProxyL( TBool aEnable );

        void EnableChargeCardL( TBool aEnable );

        void EnableLocationL( TBool aEnable );

        // Loader functions

        void DoLoadL( TUint32 aIapId );

        void LoadIAPRecordL( TUint32 aIapId );

        void LoadChargeCardSettingL( TUint32 aChargeCardId );