/*

* 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:  IF implementation class for connection method plugins.

*

*/

#ifndef CMPLUGINBASEENG_H

#define CMPLUGINBASEENG_H

// INCLUDES

#include <cmconnectionmethoddef.h>

#include <e32std.h>

#include <e32base.h>

#include <ecom/ecom.h>        // For REComSession

#include <metadatabase.h>

#define IAP_ELEMENT_ID( iapRecId )  (KCDTIdIAPRecord | \

                                     KCDMaskShowFieldType | \

                                     (iapRecId << 8))

#define QUERY_HBUFC_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<HBufC*>*, record->GetFieldByIdL( fieldId ))

#define QUERY_UINT32_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<TUint32>*, record->GetFieldByIdL( fieldId ))

#define QUERY_INT_FIELD( record, fieldId ) *STATIC_CAST(CommsDat::CMDBField<TInt>*, record->GetFieldByIdL( fieldId ))

#define SET_HBUFC_FIELD( record, fieldId, stringVal ) STATIC_CAST(CommsDat::CMDBField<TDesC>*, record->GetFieldByIdL( fieldId ))->SetL( stringVal->Des() )

#define SET_INT_FIELD( record, fieldId, intVal ) STATIC_CAST(CommsDat::CMDBField<TInt>*, record->GetFieldByIdL( fieldId ))->SetL( intVal )

#define FIELD_TO_TDESC( field ) ( (const TDesC&)( field ) )

// CONSTANTS

const TInt32 KExtensionBaseLevel = 1;

const TUint32 KDefAttrsArrayGranSize = 32;

const TUint32 KMaxProxyServerNameLength = 1000;

const TUint32 KDummyBearerType = 1;

// DATA TYPES

typedef enum

    {

    ECmBool,

    ECmInt,

    ECmText,

    ECmText8

    }TCMFieldTypes;

// Attributes that are related to bearer plugin creation

enum TBearerCreationCommonAttributes

    {

    ECmBearerCreationCommonAttributes = 9000,   /**<

                                                * Marks the beginning of

                                                * bearer creation related

                                                * attributes

                                                */

    ECmExtensionLevel,          /**<

                                * Return the extension level of the given 

                                * bearer type. 1 means the level 1st.

                                * (TUint32 - default: none - read only)

                                */

    ECmBearerCreationCommonAttributesEnd = 9999 /**<

                                                * Marks the end of bearer

                                                * creation related attributes

                                                */

    };

class CCmPluginBaseEng;

class CCmPluginBase;

/**

* Validation function called before data is stored.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute to be set

* @param aValue value to be checked

* @return ETrue if value is stored.

*/

typedef TBool (*TValidationFunctionL)( CCmPluginBaseEng* aThis,

                                      TUint32 aAttribute,

                                      const TAny* aValue );

/**

* Structure of conversion table between CM attributes and

* CommsDat ids. The first element must indicate the 

* range of the conversion table. iAttribId is the lowest Id, 

* iCommsDatId is the highest one. The last element is a

* terminator. e.g. Proxy table:

* static const TCmAttribConvTable SProxyConvTbl[] = 

*   {

        { ECMProxyUsageEnabled, ECMProxyRangeMax, NULL }

        { ECMProxyUseProxyServer, KCDTIdUseProxyServer, NULL },

        { ECmProxyPortNumber, KCDTIdPortNumber, &CheckPortNumberValidityL },

        ...

        { 0, 0 }

    }

*/

typedef struct

    {

    TInt    iAttribId;

    TInt    iCommsDatId;

    TValidationFunctionL iValidFuncL;

    TInt    iTitleId;

    TInt    iMaxLength;

    TUint32 iAttribFlags;   // see TCmConvAttribFlags

    TInt    iDefSettingResId;

    TInt    iEditorResId;

    TInt    iDefValueResId;

    TAny*   iNotUsed1;

    TAny*   iNotUsed2;

    }TCmAttribConvTable;

enum TCmConvAttribFlags

    {

    EConvNoZeroLength   = 0x00000001,   // Zero length NOT acceptable

    EConvCompulsory     = 0x00000002,

    EConv8Bits          = 0x00000004,

    EConvReadOnly       = 0x00000008,

    EConvNumber         = 0x00000010,

    EConvIPv4           = 0x00000020,

    EConvIPv6           = 0x00000040,

    EConvPassword       = 0x00000080,

    };

typedef struct

    {

    CommsDat::CCDRecordBase*      *iRecord;

    TBool*              iEnabled;

    const TCmAttribConvTable* iConvTable;

    }TCmAttrConvArrayItem;

typedef struct

    {

    TInt                iAttribId;

    TInt                iCommonAttribId;

    }TCmCommonAttrConvArrayItem;

enum TCmMetaDataFields

    {

    EMetaHighlight    = 0x00000001,

    EMetaHiddenAgent  = 0x00000002

    };

// FUNCTION PROTOTYPES

/**

* TValidationFunctionL functions.

*/

/**

* Function should be called if client tries to set attribute that is read-only

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute not used

* @param aValue not used

* @leave KErrNotSupported in every cases

*/

IMPORT_C TBool ReadOnlyAttributeL( CCmPluginBaseEng* aThis, 

                                  TUint32 aAttribute, 

                                  const TAny* aValue );

/**

* Function to check if the passed IPv4 address is valid.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param aValue TDesC* IPv4 address buffer to be checked

*/

IMPORT_C TBool CheckIPv4ValidityL( CCmPluginBaseEng* aThis, 

                                  TUint32 aAttribute, 

                                  const TAny* aValue );

/**

* Function to check if the passed IPv6 address is valid.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param aValue TDesC* IPv6 address buffer to be checked

*/

IMPORT_C TBool CheckIPv6ValidityL( CCmPluginBaseEng* aThis, 

                                  TUint32 aAttribute, 

                                  const TAny* aValue );

/**

* Function to check if the passed port number is valid.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param aValue TUint32 the port number to be check

*/

IMPORT_C TBool CheckPortNumberValidityL( CCmPluginBaseEng* aThis, 

                                        TUint32 aAttribute, 

                                        const TAny* aValue );

/**

* Function to check if the passed record is valid.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param aValue TUint32 the record id to be checked

*/

IMPORT_C TBool CheckRecordIdValidityL( CCmPluginBaseEng* aThis, 

                                      TUint32 aAttribute, 

                                      const TAny* aValue );

/**

* Function to check if the passed WAPWspOption is valid.

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param TUint32 the WPSOption to be checked

*/

IMPORT_C TBool CheckWAPWspOptionValidityL( CCmPluginBaseEng* aThis, 

                                          TUint32 aAttribute, 

                                          const TAny* aValue );

/**

* @param aThis 'this' pointer of the plugin instance

* @param aAttribute attribute client wants to set

* @param TUint32 the WPSOption to be checked

*/

IMPORT_C TBool SetProxyServerNameL( CCmPluginBaseEng* aThis, 

                                   TUint32 aAttribute, 

                                   const TAny* aValue );

/**

* Miscellaneous utility functions.

*/

/**

* Check if the passed IP address is '0.0.0.0' or empty string

* @param aIpAddress IP address to be checked

*/

IMPORT_C TBool IsUnspecifiedIPv4Address( const TDesC& aIpv4Address );

/**

* Check if the passed IP address is one of these:

* - empty string    -   

* - '0:0:0:0:0:0:0:0' 

* - 'fec0:000:0000:ffff::1'

* - 'fec0:000:0000:ffff::2'

* @param aIpAddress IP address to be checked

*/

IMPORT_C CMManager::TIPv6Types ClassifyIPv6Address( const TDesC& aIpv6Address );

// FORWARD DECLARATIONS

class CCmDestinationImpl;

class CCmManagerImpl;

class CCDIAPMetadataRecord;

class CCmTransactionHandler;

class CCmPluginBasePrivate;

// CLASS DECLARATION

NONSHARABLE_CLASS(TCmPluginInitParam)

    {

    public:

        TCmPluginInitParam( CCmManagerImpl& aCmMgr );

    public:

        CCmManagerImpl&     iCmMgr;

        TUint32             iParentDest;// Parent destination

        TAny*               iNotused1;

        TAny*               iNotused2;

    };

/**

 *  CCmPluginBaseEng is base class for every connection method plugin

 *

 *  @lib cmmanager.lib

 *  @since S60 v3.2

 */

class CCmPluginBaseEng : public CBase

    {

    public:

        /** Destructor. */

        IMPORT_C virtual ~CCmPluginBaseEng();

        /**

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

        * Used from framework to avoid using slow ECom framework.

        * @param aInitParam initialization data

        */

        virtual CCmPluginBaseEng* 

                CreateInstanceL( TCmPluginInitParam& aInitParam ) const = 0;

    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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual void LoadL( TUint32 aIapId );

        /**

        * 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 virtual 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 virtual CCmPluginBaseEng* CreateCopyL() const;

        /*

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

        */        

        IMPORT_C virtual TInt NumOfConnMethodReferencesL();

    public:

        /**

        * Returns a pointer to the cmmanager

        * @return a pointer to the cmmanager

        */

        CCmManagerImpl& CmMgr() const { return iCmMgr; };

        IMPORT_C CommsDat::CMDBSession& Session() const;

        /**

        * Launches the settings dialog of the plugin

        *

        * @since S60 3.2

        * @return soft key selection

        */

        virtual TInt RunSettingsL() = 0;

        /**

        * 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).

        */

        virtual TBool InitializeWithUiL( TBool aManuallyConfigure ) = 0;

        /**

        * 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

        */

        virtual TBool CanHandleIapIdL( TUint32 aIapId ) const = 0;

        /**

        * 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

        */

        virtual TBool CanHandleIapIdL( CommsDat::CCDIAPRecord* aIapRecord ) const = 0;

        /**

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