/*

* 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: Profile structure mapped to server side data sync profile 

*

*/

#ifndef ASPPROFILE_H

#define ASPPROFILE_H

// INCLUDES

#include <e32base.h>

#include <ecom.h>

#include <calsession.h>

#include <SyncMLClient.h>    // for RSyncMLSession

#include <SyncMLClientDS.h>  // for RSyncMLDataSyncProfile

#include "AspDefines.h"

#include "AspUtil.h"

//For Error EAZG-7KGAK8. Language definiton not found in elang.h 

const TInt ELangIndon_Apac=327;

const TUid KCRUidDSDefaultProfileInternalKeys  = { 0x20021338 };

const TInt KNsmlDsDefaultProfile = 0x0;

// CONSTANTS

// Visibility settings for operator specific sync profiles on UI

// - Normal = Profile shown without any specific formatting

// - ReadOnly = Profile fields locked (non-editable), deletion not allowed

// - Hidden = Profile not shown in UI

enum TOperatorProfileVisibility

    {

    EProfileVisibilityNormal = 0,

    EProfileVisibilityReadOnly = 1,

    EProfileVisibilityHidden = 2

    };

// FORWARD DECLARATIONS

class CAspProfile;

// CLASS DECLARATION

/**

* TAspProfileItem

*

* TAspProfileItem contains sync profile data.

*/

NONSHARABLE_CLASS (TAspProfileItem)

	{

	public:

		/**

		* Get profile name.

		* @param None.

        * @return Profile name.

        */

		const TDesC& Name();

		/**

		* Get profile name.

		* @param None.

        * @return Profile name.

        */

		HBufC* NameLC();

		/**

		* Set profile name.

		* @param aName.

        * @return None.

        */

		void SetName(const TDesC& aName);

		/**

		* Initalize object data.

		* @param None.

        * @return None.

        */

		void Init();

	public:

		/**

		* Compare two profile items.

		* @param aFirst.

		* @param aSecond.		

        * @return Compare result.

        */

		static TInt CompareItems(const TAspProfileItem& aFirst, const TAspProfileItem& aSecond);

	public:

		// profile name

		TBuf<KBufSize> iProfileName;	

		// profile id 

		TInt iProfileId;

		// is profile synced

		TInt iSynced;

		// last sync time

		TTime iLastSync;

		// bearer type

		TInt iBearer;

		// is server alert sync activated

		TInt iActive;

		// can profile be deleted

		TBool iDeleteAllowed;

		// application id

		TInt iApplicationId;

		// is all mandatory data found 

		TInt iMandatoryCheck;

		// number of sync tasks

		TInt iTaskCount;

		// application specific sync task id

		TInt iTaskId;

		// server id check sum

		TUint16 iServerIdCheckSum;

	};

/**

* TAspTaskItem

* 

* TAspTaskItem contains sync task data.

*/

NONSHARABLE_CLASS (TAspTaskItem)

	{

	public:

	    // task id

    	TInt  iTaskId;

    	// sync direction

		TInt  iSyncDirection;

		// is remote database defined

		TBool iRemoteDatabaseDefined;

		// is local database defined

		TBool iLocalDatabaseDefined;

		// is task included in sync

		TBool iEnabled;

		// id of data provider that this task uses

		TInt  iDataProviderId;

		// last sync time

		TTime	 iLastSync;

		// task display name

	    TBuf<KBufSize> iDisplayName;

	    TBuf<KBufSize> iClientDataSource;

    };

/**

* TAspDataProviderItem

* 

* TAspDataProviderItem contains data provider data.

*/

NONSHARABLE_CLASS (TAspProviderItem)

	{

    enum TProviderListSortOrder

	    {

	    EOrderContact = 4,

	    EOrderCalendar = 3,

	    EOrderNotes = 2,

	    EOrderEmail = 1,

	    EOrderOther = 0

    	};

	public:

		/**

		* Compare two profile items.

		* @param aFirst.

		* @param aSecond.		

        * @return Compare result.

        */

		static TInt CompareItems(const TAspProviderItem& aFirst, const TAspProviderItem& aSecond);

		static TInt SortOrder(TInt aDataProviderId);

	public:

	    // data provider id

		TInt  iDataProviderId;

		// can more than one database be synced 

		TBool iAllowMultipleDataStores;

		// is default data store defined

		TBool iHasDefaultDataStore;

		// sync protocol

		TInt  iSyncProtocol;

        // id of sync task that is using this data provider

		TBool iTaskId;

		// display name

	    TBuf<KBufSize> iDisplayName;

	   	// default data store name

		TBuf<KBufSize> iDefaultDataStore;

		// is this provider included in sync (profile specific)

		TBool iIsIncludedInSync;

	};

/**

* TAspFilterInfo

* 

* TAspFilterInfo contains profile list filtering data.

*/

NONSHARABLE_CLASS (TAspFilterInfo)

	{

	public:

	enum TFilterType

		{

	    EIncludeDeletableProfile,

	    EIncludeRemoteProfile

		};

	public:

	    // filter type

		TInt iFilterType;

		// filter id (eg. application id 

		TBool iFilterId;

		// filter text

		TBuf<KBufSize>  iFilterText;

	};

/**

* CAspContentList 

*

* CAspContentList contains sync task list and data provider list.

*/

NONSHARABLE_CLASS (CAspContentList): public CBase

    {

    public:

	enum TListMode

		{

	    EInitDataProviders,

	    EInitTasks,

	    EInitAll

		};

    public:

        /**

        * Two-phased constructor.

        */

        static CAspContentList* NewLC(const TAspParam& aParam);

        /**

        * Two-phased constructor.

        */

        static CAspContentList* NewL(const TAspParam& aParam);

	    /**

        * Destructor.

        */

        virtual ~CAspContentList();

    private:

        /**

        * C++ default constructor.

        */

	    CAspContentList(const TAspParam& aParam);

        /**

        * By default Symbian 2nd phase constructor is private.

        */

	    void ConstructL();

	public:

		/**

		* Sets sync profile.

		* @param aProfile.

        * @return None.

        */

		void SetProfile(CAspProfile* aProfile);

		/**

		* Find out whether iProfile has been set.

		* @param None.

        * @return TBool.

        */

		TBool IsLocked();

		/**

		* Returns data provider count.

		* @param None.

        * @return Data provider count.

        */

		TInt ProviderCount();

		/**

		* Returns Data provider.

        * @param aIndex List index.

		* @return Data provider.

        */

		TAspProviderItem& ProviderItem(TInt aIndex);

		/**

		* Returns list index.

        * @param aId.

		* @return List index.

        */

        TInt FindProviderIndex(TInt aId);		

		/**

		* Returns list index.

        * @param aId.

		* @return List index.

        */

        TInt FindProviderIndexForTask(TInt aId);		

		/**

		* Returns task count.

        * @return Task count.

        */

		TInt TaskCount();

		/**

		* Returns task item.

        * @param aIndex.

		* @return Task item.

        */

		TAspTaskItem& TaskItem(TInt aIndex);

		/**

		* Returns list index.

        * @param aId.

		* @return List index.

        */

        TInt FindTaskIndex(TInt aId);		

		/**

		* Returns list index.

        * @param aId.

		* @return List index.

        */

        TInt FindTaskIndexForProvider(TInt aId);		

		/**

		* Returns task id.

        * @param aId.

		* @return Task id.

        */

        TInt FindTaskIdForProvider(TInt aId);		

		/**

		* Checks that data provider has default local database.

		* @param aDataProviderId.

		* @return ETrue if database exists, EFalse otherwise.

        */

		//TBool DefaultLocalDatabaseExist(TInt aDataProviderId);

		/**

		* Checks that all content items are valid.

		* @param aContentCount.

		* @return Return code.

        */

		TInt CheckMandatoryDataL(TInt& aContentCount);

	public:

		/**

		* Read sync data providers from RSyncMLSession.

		* @return None.

        */

		void InitDataProvidersL();

		/**

		* Read sync data providers from RSyncMLSession.

		* @return None.

        */

		void DoInitDataProvidersL();

		/**

		* Read all tasks from profile into task list.

		* @return None.

        */

		void InitAllTasksL();

		/**

		* Read one task from profile into task list.

		* @return None.

        */

		void InitTaskL(TInt aTaskId);

		/**

		* Remove task that uses dataprovider aDataProviderId.

		* @param aDataProviderId.

		* @return None.

        */

		void RemoveTask(TInt aDataProviderId);

		/**

		* Remove all tasks from task list.

		* @param None.

		* @return None.

        */

		void RemoveAllTasks();

		/**

		* Remove data provider with id aDataProviderId.

		* @param aDataProviderId.

		* @return None.

        */

		void RemoveDataProvider(TInt aDataProviderId);

		/**

		* Read one task item from profile.

        * @param aProfile.

        * @param aTaskId.

		* @return Task item.

        */

		static TAspTaskItem ReadTaskItemL(RSyncMLDataSyncProfile& aProfile, TInt aTaskId);

		TInt CreateTaskL(TAspProviderItem& aDataProvider);

        void CreateTaskL(TInt aDataProviderId, const TDesC& aLocalDatabase,

                         const TDesC& aRemoteDatabase, TBool aEnabled, TInt aSyncDirection);

        void CreateTask(TInt aDataProviderId, const TDesC& aLocalDatabase,

                         const TDesC& aRemoteDatabase, TBool aEnabled, TInt aSyncDirection);

        void ReadTaskL(TInt aDataProviderId, TDes& aLocalDatabase, TDes& aRemoteDatabase, TBool& aEnable, TInt& aSyncDirection);

		void IncludeTaskL(TAspProviderItem& aDataProvider);

		void IncludeTasks(const CArrayFix<TInt>* aIncludedProviderList);

		void ModifyTaskIncludedL(TInt aDataProviderId, TBool aIsIncluded, const TDesC& aLocalDatabase);

		void ModifyTaskIncludedL(TAspProviderItem& aProvider, TBool aIsIncluded, const TDesC& aLocalDatabase);

		void ModifyTaskDirectionL(TAspProviderItem& aProvider, TInt aDirection);

		void ModifyTaskDirectionsL(TInt aSyncDirection);

		TBool CheckTaskDirectionsL();

		void SetIncludedProviders(const CArrayFix<TInt>* aIncludedProviderList);

		void GetIncludedProviders(CArrayFix<TInt>* aIncludedProviderList);

		void GetLocalDatabaseList(TInt aDataProviderId, CDesCArray* aList);

		void GetLocalDatabaseListL(TInt aDataProviderId, CDesCArray* aList);

		void UpdateLocalDatabaseL();

		TInt SyncDirection();

		TSmlSyncType SmlSyncDirection();

		TBool TaskEnabled(TInt aDataProviderId);

    	void Sort();

    	void UpdateDataProviderL(TInt aDataProviderId);

    	void ReadDataProviderItemL(RSyncMLDataProvider& aProvider, TAspProviderItem& aItem);

    	void CreateCalLocalDatabaseL(TDes& aCalName);

    	void RetrieveCalLocalDatabaseL(TDes& aCalName);

    	TBool IsCalNameAvailableL(CCalSession& aSession ,TDes& aCalName);

    private:

		/**

		* Utility function.

		* @return Sync session.

        */

		RSyncMLSession& Session();

		/**

		* Returns sync profile.

		* @param None.

		* @return Sync profile.

        */

		RSyncMLDataSyncProfile* Profile();

#ifdef _DEBUG

    public:

        void LogL(const TDesC& aText);

    private:

        void LogTasksL();

        void LogDataProvidersL();

        void GetTaskLogText(TDes& aText, TAspTaskItem& aTask);

        void GetDataProviderIdText(TDes& aText, TInt aId);

#endif

    private:

		// id of the calling application

		TInt iApplicationId;

		// sync session

		RSyncMLSession* iSyncSession;

		// sync profile

		CAspProfile* iProfile;