sl@0: // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // SCHSTORE
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __SCHSTORE_H__
sl@0: #define __SCHSTORE_H__
sl@0: 
sl@0: // System includes
sl@0: #include <s32file.h>
sl@0: 
sl@0: // Classes referenced
sl@0: class CSchScheduleIndex;
sl@0: class CSchClientIndex;
sl@0: class CClientProxy;
sl@0: class CSchLogManager;
sl@0: class CSchedule;
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class SchBackupManagerUtils
sl@0: 	{
sl@0: public:
sl@0: 	enum TSchStorePanic
sl@0: 		{
sl@0: 		ESchBackupManagerScheduleStreamToReplaceNotFound,
sl@0: 		ESchBackupManagerScheduleStreamToDeleteNotFound,
sl@0: 		//
sl@0: 		ESchBackupManagerLast
sl@0: 		};
sl@0: 
sl@0: public:
sl@0: 	static void Panic(TSchStorePanic aPanic);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: Schedule server backup file name.
sl@0: @internalComponent
sl@0: */
sl@0: _LIT(KSchsvrBackupFileName, "_:\\Private\\10005399\\SchedulesBackup.dat");
sl@0: /**
sl@0: Buffer descriptor to hold complete backup file name.
sl@0: @internalComponent
sl@0: */
sl@0: typedef TBuf<40> TBackupFileName;
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSchBackupManager) : public CActive
sl@0: 	{
sl@0: public:
sl@0: 	enum TSchBackupOperation
sl@0: 		{
sl@0: 		ESchBackupOperationAdd,
sl@0: 		ESchBackupOperationEdit,
sl@0: 		ESchBackupOperationDelete
sl@0: 		};
sl@0: 
sl@0: public:
sl@0: 	CSchBackupManager(RFs& aFsSession);
sl@0: 	~CSchBackupManager();
sl@0: 	void ConstructL();
sl@0: 
sl@0: public:
sl@0: 	void RestoreL(TPriQue<CClientProxy>& aClients, 
sl@0: 				TSglQue<CSchedule>& aTimeSchedules,
sl@0: 				CSchLogManager& aSchLogManager,TBool aBUR=EFalse);
sl@0: 	void CreateEmptyBackupL();
sl@0: 	//
sl@0: 	void PerformStoreOperationL(TSchBackupOperation aAction, const CSchedule& aSchedule);
sl@0: 	void PerformStoreOperationL(TSchBackupOperation aAction, const CClientProxy& aClient);
sl@0: 
sl@0: private:
sl@0: 	// The backup manager need to compact the store every now and then. It does
sl@0: 	// this as an idle operation and therefore needs to be CActive-based.
sl@0: 	void RunL();
sl@0: 	void DoCancel();
sl@0: 	void DoCreateEmptyBackupL();
sl@0: 
sl@0: private:
sl@0: 	void StoreChangedL();
sl@0: 	inline TInt RecordStoreChange() { return ++iStoreChangeCount; }
sl@0: 	inline void ResetStoreChanges() { iStoreChangeCount = 0; }
sl@0: 
sl@0: private:
sl@0: 	CPermanentFileStore* OpenBackupStoreLC();
sl@0: 	CPermanentFileStore* OpenOrCreateBackupStoreLC();
sl@0: 	//
sl@0: 	void CleanupRevertPushLC(CStreamStore& aStore);
sl@0: 	static void RevertStore(TAny* aStore);
sl@0: 	//
sl@0: 	void WriteRootStreamL(CStreamStore& aStore);
sl@0: 
sl@0: private:
sl@0: 
sl@0: 	RFs& iFsSession;
sl@0: 	
sl@0: 	// The number of times the store has changed since it was last
sl@0: 	// compacted.
sl@0: 	TInt iStoreChangeCount;
sl@0: 
sl@0: 	// Used to compact the store.
sl@0: 	RStoreReclaim iStoreReclaimer;
sl@0: 
sl@0: 	// Used internally by the reclaimer to judge how much work is left to do.
sl@0: 	TPckgBuf<TInt> iStoreReclaimerCount;
sl@0: 
sl@0: 	// A pointer to the store that has been opened for compaction purposes.
sl@0: 	// During normal operation of the backup manager, this pointer will
sl@0: 	// be NULL. However, when performing compaction, the store must be
sl@0: 	// open at all times and since processing is carried out as a series of
sl@0: 	// active object steps, we need to anchor it to the class.
sl@0: 	CStreamStore* iStoreOpenForCompaction;
sl@0: 
sl@0: 	// The index to the schedule stream
sl@0: 	TStreamId iIndexStreamSchedules;
sl@0: 
sl@0: 	// The index to the client stream
sl@0: 	TStreamId iIndexStreamClients;
sl@0: 	
sl@0: 	// The two pseudo-dictionary classes that manage mappings between
sl@0: 	// (clients and streams) and (schedules and streams).
sl@0: 	CSchClientIndex* iClientIndex;
sl@0: 	CSchScheduleIndex* iScheduleIndex;
sl@0: 	
sl@0: 	// backup file name
sl@0: 	TBackupFileName iBackupFileName;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CSchScheduleIndex : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static CSchScheduleIndex* NewL();
sl@0: 
sl@0: private:
sl@0: 	CSchScheduleIndex();
sl@0: 
sl@0: public:
sl@0: 	void RestoreSchedulesL(TSglQue<CSchedule>& aTimeSchedules, 
sl@0: 						CStreamStore& aStore, 
sl@0: 						TStreamId aDictionaryStreamId);
sl@0: 	TStreamId CreateEmptyIndexL(CStreamStore& aStore) const;
sl@0: 	//
sl@0: 	void AddL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule);
sl@0: 	void EditL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule);
sl@0: 	void DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule);
sl@0: 
sl@0: public:
sl@0: 	class TSchScheduleMapplet
sl@0: 		{
sl@0: 	public:
sl@0: 		inline TSchScheduleMapplet() { }
sl@0: 		inline TSchScheduleMapplet(TInt aKey, TStreamId aStream) : iKey(aKey), iStream(aStream) { }
sl@0: 
sl@0: 	public:
sl@0: 		void InternalizeL(RReadStream& aStream) { iKey = aStream.ReadInt32L(); aStream >> iStream; }
sl@0: 		void ExternalizeL(RWriteStream& aStream) const { aStream.WriteInt32L(iKey); aStream << iStream; }
sl@0: 
sl@0: 	public:
sl@0: 		inline void SetStream(TStreamId aStream) { iStream = aStream; }
sl@0: 		inline TStreamId Stream() const { return iStream; }
sl@0: 
sl@0: 	public:
sl@0: 		inline static TInt KeyOffset() { return _FOFF(TSchScheduleMapplet, iKey); }
sl@0: 
sl@0: 	private:
sl@0: 		TInt iKey;
sl@0: 		TStreamId iStream;
sl@0: 		};
sl@0: 	
sl@0: private:
sl@0: 
sl@0: 	NONSHARABLE_CLASS(CSchScheduleDictionary) : public CBase
sl@0: 		{
sl@0: 	public:
sl@0: 		static CSchScheduleDictionary* NewLC();
sl@0: 		~CSchScheduleDictionary();
sl@0: 
sl@0: 	private:
sl@0: 		CSchScheduleDictionary();
sl@0: 		void ConstructL();
sl@0: 
sl@0: 	public:
sl@0: 		void AssignL(TInt aKey, TStreamId aId);
sl@0: 		void Remove(TInt aKey);
sl@0: 		TInt Count() const;
sl@0: 		//
sl@0: 		TStreamId At(TInt aKey) const;
sl@0: 		TStreamId AtIndex(TInt aIndex) const;
sl@0: 		//
sl@0: 		void InternalizeL(RReadStream& aStream);
sl@0: 		void ExternalizeL(RWriteStream& aStream) const;
sl@0: 
sl@0: 	private:
sl@0: 		CArrayFix<TSchScheduleMapplet>* iMappings;
sl@0: 		};
sl@0: 
sl@0: private:
sl@0: 	CSchScheduleDictionary* DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream);
sl@0: 	void StoreDictionaryL(CStreamStore& aStore, const CSchScheduleDictionary& aDictionary, TStreamId aStreamToReplace);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CSchClientIndex : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static CSchClientIndex* NewL(RFs& aFsSession);
sl@0: 	
sl@0: private:
sl@0: 	CSchClientIndex(RFs& aFsSession);
sl@0: 
sl@0: public:
sl@0: 	void RestoreClientsL(TPriQue<CClientProxy>& aClients, 
sl@0: 							CStreamStore& aStore, 
sl@0: 							TStreamId aIndexStream,
sl@0: 							CSchLogManager& aSchLogManager,TBool aBUR=EFalse);
sl@0: 	TStreamId CreateEmptyIndexL(CStreamStore& aStore) const;
sl@0: 	void AppendClientToListL(TPriQue<CClientProxy>& aClients, CClientProxy* aClient);
sl@0: public:
sl@0: 	void AddL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient);
sl@0: 	void EditL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient);
sl@0: 	void DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient);
sl@0: 
sl@0: public:
sl@0: 	NONSHARABLE_CLASS(CSchClientMapplet) : public CBase
sl@0: 		{
sl@0: 	public:
sl@0: 		static CSchClientMapplet* NewLC(RReadStream& aStream);
sl@0: 		static CSchClientMapplet* NewLC(const TDesC& aKey, TStreamId aStream);
sl@0: 		~CSchClientMapplet();
sl@0: 
sl@0: 	public:
sl@0: 		void InternalizeL(RReadStream& aStream);
sl@0: 		void ExternalizeL(RWriteStream& aStream) const;
sl@0: 
sl@0: 	public:
sl@0: 		inline const TDesC& Key() const { return *iKey; }
sl@0: 		inline TStreamId Stream() const { return iStream; }
sl@0: 		//
sl@0: 		inline void SetStream(TStreamId aStream) { iStream = aStream; }
sl@0: 		//
sl@0: 		inline static TInt KeyOffset() { return _FOFF(CSchClientMapplet, iStream); }
sl@0: 
sl@0: 	private:
sl@0: 		HBufC* iKey;
sl@0: 		TStreamId iStream;
sl@0: 		};
sl@0: 
sl@0: private:
sl@0: 	NONSHARABLE_CLASS(CSchClientDictionary) : public CBase
sl@0: 		{
sl@0: 	public:
sl@0: 		static CSchClientDictionary* NewLC();
sl@0: 		~CSchClientDictionary();
sl@0: 
sl@0: 	private:
sl@0: 		CSchClientDictionary();
sl@0: 		void ConstructL();
sl@0: 
sl@0: 	public:
sl@0: 		void AssignL(const TDesC& aKey, TStreamId aId);
sl@0: 		void RemoveL(const TDesC& aKey);
sl@0: 		TInt Count() const;
sl@0: 		TStreamId AtL(const TDesC& aKey) const;
sl@0: 		TStreamId AtIndex(TInt aIndex) const;
sl@0: 
sl@0: 	public:
sl@0: 		void InternalizeL(RReadStream& aStream);
sl@0: 		void ExternalizeL(RWriteStream& aStream) const;
sl@0: 
sl@0: 	private:
sl@0: 		CArrayPtr<CSchClientMapplet>* iMappings;
sl@0: 		};
sl@0: 
sl@0: private:
sl@0: 	CSchClientDictionary* DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream);
sl@0: 	void StoreDictionaryL(CStreamStore& aStore, const CSchClientDictionary& aDictionary, TStreamId aStreamToReplace);
sl@0: 
sl@0: private:
sl@0: 	RFs& iFsSession;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #endif