/*

* Copyright (c) 2005 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:    Device Management DS Settings adapter header file

*

*/

#ifndef __NSMLDSSETTINGSADAPTER_H__

#define __NSMLDSSETTINGSADAPTER_H__

// INCLUDES

#include <smldmadapter.h>   //adapter interface

#include <SyncMLClientDS.h> //DS Client API

// CONSTANTS

const TInt KNSmlDSGranularity = 4;

const TUint8 KNSmlDMColon = ':';

const TUint8 KNSmlDMUriSeparator = '/';

//DDF accepted DS-fieldnames for DS-profile

_LIT8( KNSmlDdfRoot,            "SyncML");

_LIT8( KNSmlDdfAddr,				"Addr" );

_LIT8( KNSmlDdfAddrType,			"AddrType" );

_LIT8( KNSmlDdfPortNbr,			"PortNbr" );

_LIT8( KNSmlDdfName,				"Name" );

_LIT8( KNSmlDdfDB,				"DB" );

_LIT8( KNSmlDdfCTType,			"CTType" );

_LIT( KNSmlDdfCTVer,			"CTVer" );

_LIT8( KNSmlDdfCTVerL,			"CTVerL" );

_LIT8( KNSmlDdfRDBURI,			"RDBURI" );

_LIT8( KNSmlDdfLDBURI,			"LDBURI" );

_LIT8( KNSmlDdfClientUserName,	"ClientUserName" );

_LIT8( KNSmlDdfClientPW,			"ClientPW" );

_LIT( KNSmlDdfClientNonce,		"ClientNonce" );

_LIT8( KNSmlDdfServerId,			"ServerId" );

_LIT8( KNSmlDdfHidden,			"Hidden" );

_LIT( KNSmlADdfAdapterId,		"AdapterId" );

_LIT8( KNSmlDdfToNAPID,			"ToNapID" );

_LIT( KNSmlDdfAdapterType,		"/DB/" );

//DDF DS-field descriptions

_LIT8( KNSmlDdfRootDescription,     "DS-Settings DDF description");

_LIT8( KNSmlDdfAddrDescription,	    "DS server address" );

_LIT8( KNSmlDdfAddrTypeDescription,	"Type of used DS server address" );

_LIT8( KNSmlDdfPortNbrDescription,	"DS Server port number" );

_LIT8( KNSmlDdfNameDescription,		"Displayable name for the management account" );

_LIT8( KNSmlDdfDBDescription,		"DB node is parent to all Database objects" );

_LIT( KNSmlDdfCTDescription,		"CT node is parent to all Content objects" );

_LIT8( KNSmlDdfCTTypeDescription,	"CTType define supported media content of database" );

_LIT( KNSmlDdfCTVerDescription,		"CTVer node is a parent to all Content Version objects" );

_LIT( KNSmlDdfCTVerLDescription,	"CTVerL define version of supported contenttype" );

_LIT8( KNSmlDdfRDBURIDescription,	"The relative or absolute URI of remote database" );

_LIT8( KNSmlDdfLDBURIDescription,	"The relative or absolute URI of local database" );

_LIT8( KNSmlDdfClientUserNameDescription,	"DS username" );

_LIT8( KNSmlDdfServerIdDescription,     	"Server identifier" );

_LIT8( KNSmlDdfClientPWDescription,			"A password or secret to authenticate to the server" );

_LIT8( KNSmlDdfToNAPIDDescription,			"Logical reference to connectivity information" );

_LIT8( KNSmlDdfHiddenDescription,			"Hidden profile (not shown on UI)" );

_LIT8( KNSmlBufExe,				"BufExe" );

//Default data values

_LIT( KNSmlDefName,				"DSAdapterIns" );

_LIT8( KNSmlDefDSAcc,			"DSAcc" );

_LIT8( KNSmlDSStart,			"SyncML/DSAcc/DSId" );

_LIT( KNSmlDSStartDB,			"/DB/" );

_LIT( KNSmlDefDSIAP,			"AP" );

_LIT8( KNSmlIAPId,			    "NSmlIapId" );

_LIT8( KSegmDSAcc2,              "CTType/RDBURI/LDBURI" );

_LIT8( KNSmlDSSettingsHTTP,  "http://" );

_LIT8( KNSmlDSSettingsHTTPS, "https://" );

const TInt KNSmlDSSettingsHTTPPort = 80;

const TInt KNSmlDSSettingsHTTPSPort = 443;

_LIT8( KNSmlDSUriDotSlash, "./");

_LIT8( KNSmlDSSlash, "/");

_LIT8(KVersion, "1.1");

_LIT8( KMimeType, "text/plain" );

_LIT8( KDSSettingsTitle, "DS-settings title" );

_LIT8( KDBUri1, "SyncML/DSAcc/*/DB/*" );

_LIT8( KDSAccMatch, "SyncML/DSAcc/*" );

_LIT8( KDSAccMatch2, "SyncML/DSAcc/*/*" );

_LIT8( KDSDBMatch, "SyncML/DSAcc/*/DB/*" );

_LIT8( KDSDBMatch2, "SyncML/DSAcc/*/DB" );

_LIT8( KSegmDSAcc,"Addr/AddrType/PortNbr/Name/DB/ClientUserName/ClientPW/ToNapID/ServerId" );

_LIT8( KDSDBAddMatch, "*DSAcc/*/DB/*" );

_LIT8( KDSDBAddMatch2, "*DSAcc/*/DB/*/*" );

_LIT8( KDSDBAddMatch3, "*DSAcc/*/DB" );

_LIT8( KCTTypeMatch, "*/CTType*" );

_LIT8( KRDBUriMatch, "*/RDBURI*" );

_LIT8( KLDBUriMatch, "*/LDBURI*" );

_LIT8( KDummyTxt, "/Dummy" );

_LIT8( KFormat, "%d" );

_LIT8( KDSAcc1, "SyncML/DSAcc" );

_LIT8( Kprev,"CTId" );

_LIT8( Kprev2, "/CTId" );

_LIT8( KDSprev,"DSId" );

// DATA TYPES

enum TNSmlDSFieldType

	{

	EStr,

	EInt,

	EParam,

	EWrong

	};

enum TNSmlDSLeafType

	{

	EDSDelete,

	EDSUnset

	};

enum TNSmlDSProfileDataID

	{

	EProfileName,

	EProfileIAPId,

	EProfileMediumType,

	EProfileSyncServerUsername,

	EProfileSyncServerPassword,

	EProfileURL,

	EProfilePort,

	EProfileServerId,

	EHiddenProfile,

	ESyncAccepted

	};

enum TNSmlDSMediumType

	{

	ENone,

    EHttp,

	EWsp,

    EObex

	};

struct TNSmlDSAddElement

	{

	HBufC8  *iUri;

	HBufC8 *iData;

	TInt iStatusRef;

	TBool iLeaf;

	TBool iDone;

	};

struct TNSmlDSBufferElement

	{

	CArrayFixFlat<TNSmlDSAddElement> *iNodeBuf;

	HBufC8* iMappingName;

	HBufC8* iName;

	TBool iExecuted;

	TInt  iLuid;

	};

// FORWARD DECLARATIONS

class CNSmlDSSettingsAdapter;

/**

*  CNSmlDSSettingsAdapter class 

*  Contains the whole implementation of the Device Management DS settings adapter.

*

*  @lib nsmldssettingsadapter.dll

*/

class CNSmlDSSettingsAdapter : public CSmlDmAdapter

	{

    public: // Constructors and destructor

	    /**

        * Two-phased constructor.

        */

        static CNSmlDSSettingsAdapter* NewL(MSmlDmCallback* aDmCallback );

	    static CNSmlDSSettingsAdapter* NewLC(MSmlDmCallback* aDmCallback );

	    void ConstructL();

        /**

        * Destructor.

        */

	    virtual ~CNSmlDSSettingsAdapter();

    public: // Functions from base classes

        /**

        * From      CSmlDmAdapter   DDFVersionL returns current version of the DDF.

        * @since    Series60_3.0

        * @param    aVersion        DDF version of the adapter.

        * @return   none

        */

	    void DDFVersionL( CBufBase& aVersion );

        /**

        * From      CSmlDmAdapter   DDFStructureL for filling the DDF structure of the adapter.

        * @since    Series60_3.0

        * @param    aDDF            Reference to root object.

        * @return   none

        */

	    void DDFStructureL( MSmlDmDDFObject& aDDF );

        /**

        * From      CSmlDmAdapter   UpdateLeafObjectL creates new leaf objects, or replaces 

        *                           data in existing leaf objects.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aObject         Data of the object

        * @param    aType           MIME type of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void UpdateLeafObjectL( const TDesC8& aURI, const TDesC8& aLUID, 

                                const TDesC8& aObject, const TDesC8& aType, 

                                const TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   DeleteObjectL deletes an object and its child objects.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void DeleteObjectL( const TDesC8& aURI, const TDesC8& aLUID, 

                            const TInt aStatusRef ); 

        /**

        * From      CSmlDmAdapter   FetchLeafObjectL fetches data of a leaf object.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aType           MIME type of the object

        * @param    aResultsRef    	Reference to correct results

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void FetchLeafObjectL( const TDesC8& aURI, const TDesC8& aLUID, 

                                const TDesC8& aType, const TInt aResultsRef, 

                                const TInt aStatusRef ); 

        /**

        * From      CSmlDmAdapter   ChildURIListL fetches URI list.

        * @since    Series60_3.0

        * @param    aURI                    URI of the object

        * @param    aLUID                   LUID of the object

        * @param    aPreviousURISegmentList URI list with mapping LUID information

        * @param    aResultsRef    	        Reference to correct results

        * @param    aStatusRef              Reference to correct command

        * @return   none

        */

	    void ChildURIListL( const TDesC8& aURI, const TDesC8& aLUID, 

                            const CArrayFix<TSmlDmMappingInfo>& aPreviousURISegmentList, 

                            const TInt aResultsRef, const TInt aStatusRef );  

        /**

        * From      CSmlDmAdapter   AddNodeObjectL adds node object.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aParentLUID     LUID of the parent object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void AddNodeObjectL( const TDesC8& aURI, const TDesC8& aParentLUID, 

                                const TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   UpdateLeafObjectL creates new leaf objects, or replaces 

        *                           data in existing leaf objects.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aStream         Data of the object

        * @param    aType           MIME type of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void UpdateLeafObjectL( const TDesC8& aURI, const TDesC8& aLUID, 

                                RWriteStream*& aStream, const TDesC8& aType, 

                                const TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   FetchLeafObjectSizeL fetches the size of a leaf object.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aType           MIME type of the object

        * @param    aResultsRef    	Reference to correct results

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void FetchLeafObjectSizeL( const TDesC8& aURI, const TDesC8& aLUID, 

                                    const TDesC8& aType, const TInt aResultsRef, 

                                    const TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   The function implements execute command.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aArgument       Argument for the command

        * @param    aType       	MIME type of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void ExecuteCommandL( const TDesC8& aURI, const TDesC8& aLUID, 

                                const TDesC8& aArgument, const TDesC8& aType, 

                                const TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   The function implements execute command.

        * @since    Series60_3.0

        * @param    aURI            URI of the object

        * @param    aLUID           LUID of the object

        * @param    aStream         Argument for the command

        * @param    aType       	MIME type of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void ExecuteCommandL( const TDesC8& aURI, const TDesC8& aLUID, 

                                RWriteStream*& aStream, const TDesC8& aType, 

                                const TInt aStatusRef );

         /**

        * From      CSmlDmAdapter   The function implements execute command.

        * @since    Series60_3.0

        * @param    aTargetURI      Target URI for the command

        * @param    aTargetLUID     LUID of the target object

        * @param    aSourceURI      Source URI for the command

        * @param    aSourceLUID    	LUID of the source object

        * @param    aType           MIME type of the object

        * @param    aStatusRef      Reference to correct command

        * @return   none

        */

	    void CopyCommandL( const TDesC8& aTargetURI, const TDesC8& aTargetLUID, 

                                const TDesC8& aSourceURI, const TDesC8& aSourceLUID, 

                                const TDesC8& aType, TInt aStatusRef );

        /**

        * From      CSmlDmAdapter   The function indicates start of Atomic command.

        * @since    Series60_3.0

        * @param    none

        * @return   none

        */

	    void StartAtomicL();

        /**

        * From      CSmlDmAdapter   The function indicates successful end of Atomic command.

        * @since    Series60_3.0

        * @param    none

        * @return   none

        */

	    void CommitAtomicL();

        /**

        * From      CSmlDmAdapter   The function indicates unsuccessful end of Atomic command.

        * @since    Series60_3.0

        * @param    none

        * @return   none

        */

	    void RollbackAtomicL();

        /**

        * From      CSmlDmAdapter   Returns ETrue if adapter supports streaming otherwise EFalse.

        * @since    Series60_3.0

        * @param    aItemSize       Size limit for stream usage.

        * @return   ETrue or EFalse

        */

	    TBool StreamingSupport( TInt& aItemSize );

        /**

        * From      CSmlDmAdapter   Called when stream returned from UpdateLeafObjectL or 

        *                           ExecuteCommandL has been written to and committed.

        * @since    Series60_3.0

        * @param    none

        * @return   none

        */

	    void StreamCommittedL();

        /**

        * From      CSmlDmAdapter   The function tells the adapter that all the commands of the message that

	    *                           can be passed to the adapter have now been passed.

        * @since    Series60_3.0

        * @param    none

        * @return   none

        */

	    void CompleteOutstandingCmdsL();

    private:

        /**

        * C++ default constructor.

        */

        CNSmlDSSettingsAdapter();

	    CNSmlDSSettingsAdapter( TAny* aEcomArguments );

        /**

        * The function checks if field to be handled is valid.

        * @param    none

        * @return   ETrue if valid field otherwise EFalse.

        */   

	    TBool AcceptDSField();

        /**

        * The function returns enum value for a field to be handled.

        * @param    none

        * @return   enum value for a field to be handled.

        */ 

        TInt GetDSField() const;

        /**

        * The function checks if field type to be handled is valid.

        * @param    none

        * @return   enum value for a field type.

        */ 

        TInt GetDSFieldTypeL() const;

        /**

        * The function converts LUID to integer.

        * @param    aLUID     LUID data to be converted.

        * @return   Integer value for a LUID.

        */    

        TInt IntLUID(const TDesC8& aLUID);

         /**

        * The function converts data to integer and returns it.

        * @param    aObject     Data object to be converted.

        * @return   Integer value for an object.

        */

        TInt GetIntObject( const TDesC8& aObject );

        /**

        * The function converts data to integer and returns it.

        * @param    aObject     Data object to be converted.

        * @return   16-bit integer value for an object.

        */

	    TInt GetIntObject16( const TDesC& aObject );

        /**

        * The function stores integer value to buffer and returns reference to it.

        * @param    aObject     data to be stored to buffer.

        * @return   reference to data buffer.

        */

        TDesC8& SetIntObjectLC( const TInt& aObject );

        /**

        * The function checks if data length is valid.

        * @param    aProfileItem    Field / Leaf ID to be handled.

        * @param    aSource         Data to be handled.

        * @return   ETrue if data length is not valid otherwise EFalse.

        */ 

        TBool NotValidStrLenght( const TInt& aProfileItem, const TDesC8& aSource );

        /**

        * The function finds out the last element of the uri.

        * @param    aSource     Uri object that contains all elements.

        * @return   KErrNone if successful.

        */

        TInt    SetField( const TDesC8& aSource );

        /**

        * The function converts 16-bit data to 8-bit and returns reference to it.

        * @param    aSource    Reference data to be converted.

        * @return   Reference to 8-bit data buffer.

        */ 

        TDesC8&  ConvertTo8LC( const TDesC& aSource );

        /**

        * The function converts 8-bit data to 16-bit and returns reference to it.

        * @param    aSource    Reference data to be converted.

        * @return   Reference to 16-bit data buffer.

        */ 

	    TDesC16& ConvertTo16LC( const TDesC8& aSource );

        /**

        * The function adds new dataprovider for a profile.

        * @param    aIntLUID        Profile integer LUID.

        * @param    aMIMEType       Requested MIME type of the data provider.

        * @param    aDataProviderId Reference to object where new data provider id to be saved.

        * @return   KErrNone if successful otherwise error code.

        */ 

        TInt AddNewDataProviderL( TInt aIntLUID, const TDesC8& aMIMEType, TInt& aDataProviderId );

        /**

        * The function gets the uri for profile IAP ID.

        * @param    aLUID       Profile integer LUID.

        * @param    aObject     Reference to object where URI to be stored.

        * @return   KErrNone if successful otherwise error code.

        */ 

        TInt GetToNAPIDL( const TInt aLUID, CBufBase& aObject );

        /**

        * The function sets the profile IAP id based on URI.

        * @param    aLUID       Profile integer LUID.

        * @param    aObject     Access point URI.

        * @return   KErrNone if successful otherwise error code.

        */ 

        TInt SetToNAPIDL( const TInt aLUID, const TDesC8& aObject );

        /**

        * The function sets the new node to buffer (in case of content type).

        * @param    aURI            URI of the node.

        * @param    aParentLUID     LUID for the parent object.

        * @param    aStatusRef      Command status reply reference.

        * @return   none

        */ 

        void AddNodeBufferL( const TDesC8& aURI, const TDesC8& aParentLUID,