/*

* 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:  Database (content) specific data and functionality

*

*/

#ifndef __NSMLDSCONTENT_H__

#define __NSMLDSCONTENT_H__

// INCLUDES

#include <e32hashtab.h>

#include <e32base.h>

#include <SyncMLDef.h>

#include <SmlDataSyncDefs.h>

#include <SyncMLDataFilter.h>

#include "NSmlDSAgent.h"

// CONSTANTS

const TUint KNSmlTwoWayFlag = 1 << 0;

const TUint KNSmlSlowTwoWayFlag = 1 << 1;

const TUint KNSmlOneWayFromClientFlag = 1 << 2;

const TUint KNSmlRefreshFromClientFlag = 1 << 3;

const TUint KNSmlOneWayFromServerFlag = 1 << 4;

const TUint KNSmlRefreshFromServerFlag = 1 << 5;

const TUint KNSmlServerAlertedFlag = 1 << 6;

// <MAPINFO_RESEND_MOD_BEGIN>

const TInt KNSmlDefaultMapStreamUID = 0x101F6DF4;

// <MAPINFO_RESEND_MOD_END>

// FORWARD DECLARATIONS

class CNSmlDbCaps;

class CNSmlURI;

class CNSmlFilter;

class CNSmlDSHostClient;

class CNSmlDSContentItem;

/**

* Class that handles content (datastore) specific data processing.

*

* @lib nsmldsagent.lib

*/

class CNSmlDSContent : public CBase 

	{

	public: // constructors and destructor

		/**

		* Symbian two-phased constructor.

		*/

		static CNSmlDSContent* NewL();

		/**

		* Destructor.

		*/

		~CNSmlDSContent();

	public: // new functions

		/**

		* Creates DSHostClient

		* @return -

		*/

		void InitContentDataL();

		/**

		* Returns the index of the current content.

		* @return The index of the current content.

		*/

		TInt CurrentIndex() const;

		/**

		* Checks if the content index is set.

		* @return ETrue if the content index is set.

		*/

		TBool ContentIndexIsSet() const;

		/**

		* Returns the number of contents.

		* @return The number of contents.

		*/

		TInt Count() const;

		/**

		* Returns the implementation UID at the current content index.

		* @return UID of the current data provider.

		*/

		TInt ImplementationUID() const;

		/**

		* Returns the local database URI at the current content index.

		* @return URI of the current local database.

		*/

		CNSmlURI* LocalDatabase() const;

		/**

		* Returns the remote database URI at the current content index.

		* @return URI of the current remote database.

		*/

		CNSmlURI* RemoteDatabase() const;

		/**

		* Returns the synchronization type at the current content index.

		* @return Synchronization type.

		*/

		TPtrC8 SyncType() const;

		//RD_SUSPEND_RESUME

		/**

		* Returns the Synchronization Type proposed by the client in the Current Sync session

		*@return Synchronization type.

		*/

	    TPtrC8 	PrevClientSyncType();

	    /**

		* Returns the Synchronization Type proposed by the client in the Current Sync session

		*@return Synchronization type.

		*/

	    TPtrC8  ClientSyncType();

	    //RD_SUSPEND_RESUME

	    /**

		* Gets the UID of the current data item at the current content index.

		* @param aLocalUID On returns contains the current local UID.

		*/

		void CurrentUID( TSmlDbItemUid& aLocalUID ) const;

		/**

		* Gets the DevInfo structure at the current content index.

		* @param aDbCaps On return contains the current DevInfo structure.

		* @return KErrNone if successful, otherwise one of the system wide error codes.

		*/

		TInt DbCapabilitiesL(CNSmlDbCaps*& aDbCaps) const;

		/**

		* Checks if the given Rx element type is supported by the current data 

		* store.

		* @param aType The Rx type to be checked against.

		* @return ETrue if the given Rx type is supported.

		*/

		TBool IsSupportedRxL( const TDesC8& aType ) const;

		/**

		* Checks if the given Tx element type is supported by the current data 

		* store.

		* @param aType The Tx type to be checked against.

		* @return ETrue if the given Tx type is supported.

		*/

		TBool IsSupportedTxL( const TDesC8& aType ) const;

		/**

		* Checks if the given synchronization type is supported by the current

		* data store.

		* @param aSyncType The synchronization type to be checked.

		* @return ETrue if the given sync type is supported.

		*/

		TBool IsSupportedSyncTypeL( CNSmlDbCaps::ENSmlSyncTypes aSyncType ) const;

		/**

		* Checks if the given synchronization type is supported by the current

		* data store.

		* @param aSyncType The synchronization type to be checked.

		* @return ETrue if the given sync type is supported.

		*/

		TBool IsSupportedSyncTypeL( const TDesC8& aSyncType ) const;

		/**

		* Checks if the current data store supports hierarchical sync with the

		* given media type.

		* @param aMediaType Media type used during check.

		* @return ETrue if hierarchical sync is supported.

		*/

		TBool IsHierarchicalSyncSupportedL( const TPtr8 aMediaType ) ;

		/**

		* Checks if server supports the synchronization type used in the sync

		* session at the current content index.

		@ return ETrue if the sync type is supported.

		*/

		TBool IsSupportedSyncTypeByServerL() const;

		/**

		* Checks if synchronization session with the current data store has 

		* been interrupted.

		* @return ETrue if the sync session has been interrupted.

		*/

		TBool Interrupted() const;

		/**

		* Checks if an error due to a Status code received from the server has

		* been written to the history log at the current content index.

		* @return ETrue if an error has been written.

		*/

		TBool ServerStatusError() const;

		/**

		* Checks if the initialization Alert command is not yet received for

		* the current data store.

		* @return ETrue if initialization Alert is not received.

		*/

		TBool WaitingInitAlert() const;

		/**

		* Checks if slow sync request has been stored for the current data store.

		* @return ETrue if slow sync request has been stored.

		*/

		TBool SlowSyncRequestL() const;

		/**

		* Checks if synchronization of any content has been interrupted.

		* @return ETrue if some content is interrupted.

		*/

		TBool AnyDatabaseIsInterrupted() const;

		/**

		* Checks if synchronization of all data stores has been interrupted.

		* @ETrue if all contents are interrupted.

		*/

		TBool AllDatabasesAreInterrupted() const;

		/**

		* Checks if synchronization of all data stores has been interrupted

		* immediately. In that case no Status commands are sent.

		* @return ETrue if interrupted immediately.

		*/

		TBool AllDatabasesAreInterruptedImmediately() const;

		/**

		* Checks if synchronization type is one-way sync from client for all

		* data stores.

		* @ETrue if one-way sync from client is used for all data stores.

		*/

		TBool AllDatabasesOneWayFromClient() const;

		/**

		* Checks if there are map items to be sent at the current content index.

		* @ETrue if map items exist.

		*/

		TBool MapExists() const;

		/**

		* Checks if the number of synchronized items at the current content index

		* was asked previously.

		* @return ETrue if the count was asked already.

		*/

		TBool ClientItemCountAsked() const;

		/**

		* Checks if the number of synchronized items on the server at the current

		* content index was asked already.

		* @return ETrue if the count was asked.

		*/		

		TBool ServerItemCountAsked() const;

		/**

		* Returns the number of synchronized items in the client for the current

		* data store.

		* @return The number of synchronized items.

		*/

		TInt ClientItemCount() const;

		/**

		* Returns the number of synchronized items in the server for the current

		* data store.

		* @return The number of synchronized items.

		*/

		TInt ServerItemCount() const;

		/**

		* Returns the map item list at the current content index.

		* @return Map item list.

		*/

		SmlMapItemList_t* MapItemListL() const;

		/**

		* Returns the maximum object size in the server at the current content

		* index. The size is returned in bytes.

		* @return The maximum object size.

		*/

		TInt MaxObjSizeInServer() const;

		/**

		* Returns the maximum object size in content.

		* @return The maximum object size in content.

		*/

		TInt MaxObjSizeL() const;

		/**

		* Returns the sync anchor the client has sent to the server during the

		* previous synchronization session.

		* @return Sync anchor of the previous session.

		*/

		TTime LastSyncAnchorL() const;

		/**

		* Initializes interruption flags for all contents.

		*/

		void InitInterruptionFlags() const;

		/**

		* Creates a new map item to the current content's map item container.

		* @param aLUID Local UID.

		* @param aGUID Global UID.

		* @param aAtomicId Atomic command id associated with the item (0 = none).

		*/

		void CreateNewMapItemL( const TSmlDbItemUid aLUID, const TDesC8& aGUID, const TInt aAtomicId ) const;

// <MAPINFO_RESEND_MOD_BEGIN>

		/**

		* Sets the stream uid to be used for the map information streaming.

		* @param aMapStreamUid Uid of the stream.

		*/

		void SetMapStreamUID(TInt aMapStreamUid = KNSmlDefaultMapStreamUID);

		/**

		* Calls map loader function.

		* @param aStatus Request status.

		* @return If error occurs, system wide error code is returned. 

		*/

		TInt ScanMapContentL( TRequestStatus &aStatus );

		/**

		* Loads the map information form the physical storage to the cache.

		*/	

		void LoadMapInfoL();

		/**

		* Saves the map information to the physical storage and update the sync flags required for next sync to continue properly but not the last sync anchor

		* @param aAnchor Time anchor.

		*/

		void SaveMapInfoL( const TTime& aAnchor );

		/**

		*  Cleans up the map information from the cache as well as from physical storage for current database

		*/

		void CleanMapInfo();

		/**

		* Cleans up the map information in the cash and physical storage for all the databases.

		*/	

		void CleanAllMapInfo();	

		/**

		* Saves the map information to the physical storage.

		* @param aAnchor Time anchor.

		*/

		void PackupRequestL( const TTime& aAnchor );

		/**

		* Checks if a given index is a valid index of a database in a sync

		* @param TInt Index of a database.

		* @return Boolean value indicating if given index is valid.

		*/

		TBool CheckDbIndex(TInt aIndex);

		/**

		* To Delay the removal of map information from the cache to be removed at a later stage

		* @aRemoveMap Boolean value indicating if map is removable.

		*/

		void SetRemoveMap(TBool aRemoveMap = ETrue);

		/**

		* Checks if map information can be removed. 

		* @return Boolean value indicating if map information can be removed..

		*/

		TBool isMapRemovable();

		/**

		* Removes the map information form the cache for only set removable map for all the databases.

		*/

		void RemoveAllRemovableMap() const;

		/**

		* Removes the map information form the cache for only set removable map and corresponding to the current database under consideration.

		*/

		void RemoveRemovableMap() const;

		/**

		* Sets resend to be used. 

		* @param aResendUsed Boolean value indicating if mapinfo resend is used.

		*/

		void SetResendUsed( TBool aResendUsed = EFalse );

		/**

		* Checks if resend is used. 

		* @return Boolean value indicating if resend is used.

		*/

		TBool ResendUsed() const;

// <MAPINFO_RESEND_MOD_END>

		/**

		* Sets a list of map items to the current content.

		* @param aMapItemList List of map items. Ownership is changed for this class.

		*/

		void SetMapItemList( SmlMapItemList_t* aMapItemList ) const;

		/**

		* Resets the current content's map item container.

		*/

		void RemoveMap() const;

		//RD_SUSPEND_RESUME

		/**

		* Sets the synchronization type of the current data store.

		* @param aSyncType Synchronization type.

		*/		

		void SetSyncTypeL( const TDesC8& aSyncType ) const;

		/**

		* Sets the synchronization type of the current data store.

		* This Sync Type is proposed by the Client for each content and will be stored into the Agent Log db.

		* Helps in the Resumed session to check if the Sync Type proposed by client is different than the Suspened session.

		* @param aSyncType Synchronization type.

		*/	

		void SetClientSyncTypeL( const TDesC8& aSyncType ) const;

		//RD_SUSPEND_RESUME

		/**

		* Sets the synchronization type of the current data store.

		* @param aSyncType Synchronization type.

		*/		

    	void SetSyncTypeL( CNSmlDbCaps::ENSmlSyncTypes aSyncCap ) const;

		/**

    	* Changes the initializations of the current data store during the sync

    	* session. If data store's sync type is slow sync or refresh sync from 

    	* client then ResetChangeInfoL is called. If the given sync type is

    	* refresh from server then also DeleteAllItemsL is called in addition 

    	* to ResetChangeInfoL.

    	* @param aEndOfInits EFalse on return if all data stores are processed.

    	* @param aResultCode On return contains the result code of the operation.

    	* @param aStartOfInits Should be set to ETrue if this is the first time 

    	* this function is called.

    	*/

		void SetDbAndTimeInitsL( TBool& aEndOfInits, TInt& aResultCode, TBool aStartOfInits);

		/**

		* Initializes History Log event of the current content.

		* @param aSyncLog Reference to the History Log.

		*/

		void InitSyncLogEventL( CSyncMLHistoryJob& aSyncLog );

		/**

		* Initializes History log events of all contents.

		* @param aSyncLog Reference to the History Log.

		*/

		void InitAllSyncLogEventsL( CSyncMLHistoryJob& aSyncLog );

		/**

		* Both the number of synchronized items and synchronization statuses of

		* all contents are written to the History Log.

		*/

		void FinalizeSyncLogEvents() const;

		/**

		* Adds a new content (data store) instance.

		*/

		void AddNewContentL();

		/**

		* Sets the implementation UID of the current content.

		* @param aImplUID Current content's implementation UID.

		*/

		void SetImplementationUID( TInt aImplUID ) const;

		/**

		* Sets the local database URI of the current content.

		* @param aLocalDatabase Local database URI.

		*/		

		void SetLocalDatabaseL( CNSmlURI& aLocalDatabase ) const;

		/**

		* Sets the remote database URI of the current content.

		* @param aRemoteDatabase Remote database URI.

		*/

		void SetRemoteDatabaseL( const CNSmlURI& aRemoteDatabase ) const;

		/**

		* Initializes the current content (data store).

		* @param aServerId ServerId of the current content.

		* @return ETrue if the operation succeeded.

		*/

		TBool InitContentInstanceL( TDesC& aServerId );

		/**

		* Opens the current data store.

		* @param aResultCode On return contains the return code of the operation.

		*/

		void OpenContentInstanceL( TInt& aResultCode ) const;

		/**

		* Creates local UID buffer for the current content.

		* @param aResultCode On return contains the return code of the operation.

		*/

		void CreateLUIDBufferL( TInt& aResultCode ) const;

		/**

		* Cancels an ongoing asynchronous operation.

		*/

		void CancelRequestL() const;

		/**

		* The current content is marked as waiting for the initialization Alert

		* command from the server.

		*/

		void SetInitAlertWaiting() const;

		/**

		* The current content is marked as not waiting for the initialization

		* Alert command from the server.

		*/

		void SetInitAlertReceived() const;

		/**

		* A slow synchronization request for the current content is passed 

		* on/off for the current content. This value is used in the next

		* synchronization session.

		* @param aRequest ETrue if slow sync flag should be turned on.

		*/