sl@0: // Copyright (c) 2004-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: //
sl@0: 
sl@0: // User includes
sl@0: #include "SCHSTORE.H"
sl@0: #include "SchLogger.h"
sl@0: #include "SCHEDULE.H"
sl@0: #include "SCHCLI.H"
sl@0: #include "SCHEXEC.H"
sl@0: 
sl@0: #define UNUSED_VAR(a) a = a
sl@0: 
sl@0: // Constants
sl@0: const TInt KMaxChangesBeforeCompact = 5;
sl@0: //
sl@0: 
sl@0: 
sl@0: //
sl@0: // -----> SchBackupManagerUtils (header)
sl@0: //
sl@0: 
sl@0: void SchBackupManagerUtils::Panic(TSchStorePanic aPanic)
sl@0: 	{
sl@0: 	_LIT(KSchStorePanic, "SchStore");
sl@0: 	User::Panic(KSchStorePanic, aPanic);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> CSchBackupManager (header)
sl@0: //
sl@0: 
sl@0: CSchBackupManager::CSchBackupManager(RFs& aFsSession)
sl@0: :	CActive(EPriorityIdle), iFsSession(aFsSession)
sl@0: 	{
sl@0: 	// construct backup filename
sl@0: 	iBackupFileName.Copy(KSchsvrBackupFileName);
sl@0: 	iBackupFileName[0] = 'A' + static_cast<TInt>(RFs::GetSystemDrive()); 
sl@0: 
sl@0: 	CActiveScheduler::Add(this);
sl@0: 	}
sl@0: 
sl@0: CSchBackupManager::~CSchBackupManager()
sl@0: 	{
sl@0: 	// This will delete the store and close the compactor
sl@0: 	Cancel();
sl@0: 	//
sl@0: 	delete iScheduleIndex;
sl@0: 	delete iClientIndex;
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::ConstructL()
sl@0: 	{
sl@0: 	iScheduleIndex = CSchScheduleIndex::NewL();
sl@0: 	iClientIndex = CSchClientIndex::NewL(iFsSession);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: If this is called during a restore, we want to make sure we want to append
sl@0: to existing structure not always create new object and just append to the queue
sl@0: for example we want to append task to existing client if they have the same name
sl@0: and priority not create another one.
sl@0: */
sl@0: void CSchBackupManager::RestoreL(TPriQue<CClientProxy>& aClients, 
sl@0: 								TSglQue<CSchedule>& aTimeSchedules,
sl@0: 								CSchLogManager& aSchLogManager,TBool aBUR)
sl@0: 	{
sl@0: 	LOGSTRING("CSchBackupManager::RestoreL");
sl@0: 
sl@0: 	// Open store
sl@0: 	CPermanentFileStore* store = OpenOrCreateBackupStoreLC();
sl@0: 
sl@0: 	// Restore root stream (two pointers to other streams)
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(*store, store->Root());
sl@0: 	stream >> iIndexStreamSchedules;
sl@0: 	stream >> iIndexStreamClients;
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 
sl@0: 	// Restore clients
sl@0: 	iClientIndex->RestoreClientsL(aClients, *store, iIndexStreamClients, aSchLogManager,aBUR);
sl@0: 
sl@0: 	// Restore schedules
sl@0: 	iScheduleIndex->RestoreSchedulesL(aTimeSchedules, *store, iIndexStreamSchedules);
sl@0: 
sl@0: 	// Cleanup store.
sl@0: 	CleanupStack::PopAndDestroy(store);
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::PerformStoreOperationL(TSchBackupOperation aAction, const CSchedule& aSchedule)
sl@0: //
sl@0: //	Perform an schedule-related operation.
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING3("CSchBackupManager::PerformStoreOperationL - Schedule: %S (%d)", &aSchedule.Name(), aSchedule.Id());
sl@0: 	
sl@0: 	if(aSchedule.Persists())
sl@0: 		{
sl@0: 		// Cancel any compaction that may be going on
sl@0: 		Cancel();
sl@0: 
sl@0: 		// Perform the operation
sl@0: 		CStreamStore* store = OpenOrCreateBackupStoreLC();
sl@0: 		CleanupRevertPushLC(*store);
sl@0: 
sl@0: 		switch(aAction)
sl@0: 			{
sl@0: 		case ESchBackupOperationAdd:
sl@0: 			LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpAdd");
sl@0: 			iScheduleIndex->AddL(iIndexStreamSchedules, *store, aSchedule);
sl@0: 			break;
sl@0: 		case ESchBackupOperationEdit:
sl@0: 			LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpEdit");
sl@0: 			iScheduleIndex->EditL(iIndexStreamSchedules, *store, aSchedule);
sl@0: 			break;
sl@0: 		case ESchBackupOperationDelete:
sl@0: 			LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpDelete");
sl@0: 			iScheduleIndex->DeleteL(iIndexStreamSchedules, *store, aSchedule);
sl@0: 			break;
sl@0: 		default:
sl@0: 			__ASSERT_DEBUG(EFalse, User::Invariant());
sl@0: 			User::Leave(KErrNotSupported);
sl@0: 			}	
sl@0: 		// Save changes to store
sl@0: 		store->CommitL();
sl@0: 
sl@0: 		CleanupStack::Pop(); // Store reversion cleanup item
sl@0: 		CleanupStack::PopAndDestroy(store);
sl@0: 
sl@0: 		// Indicate the store has changed and attempt to compact 
sl@0: 		// the store, but only if the required number of store 
sl@0: 		// changes has been met
sl@0: 		StoreChangedL();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::PerformStoreOperationL(TSchBackupOperation aAction, const CClientProxy& aClient)
sl@0: //
sl@0: //	Perform an schedule-related operation.
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING2("CSchBackupManager::PerformStoreOperationL - Client: %S", &aClient.ExecutorFileName());
sl@0: 
sl@0: 	// Cancel any compaction that may be going on
sl@0: 	Cancel();
sl@0: 
sl@0: 	// Perform the operation
sl@0: 	CStreamStore* store = OpenOrCreateBackupStoreLC();
sl@0: 	CleanupRevertPushLC(*store);
sl@0: 
sl@0: 	switch(aAction)
sl@0: 		{
sl@0: 	case ESchBackupOperationAdd:
sl@0: 		LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpAdd");
sl@0: 		iClientIndex->AddL(iIndexStreamClients, *store, aClient);
sl@0: 		break;
sl@0: 	case ESchBackupOperationEdit:
sl@0: 		LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpEdit");
sl@0: 		iClientIndex->EditL(iIndexStreamClients, *store, aClient);
sl@0: 		break;
sl@0: 	case ESchBackupOperationDelete:
sl@0: 		LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpDelete");
sl@0: 		iClientIndex->DeleteL(iIndexStreamClients, *store, aClient);
sl@0: 		break;
sl@0: 	default:
sl@0: 		__ASSERT_DEBUG(EFalse, User::Invariant());
sl@0: 		User::Leave(KErrNotSupported);
sl@0: 		}
sl@0: 
sl@0: 	// Save changes to store
sl@0: 	store->CommitL();
sl@0: 
sl@0: 	CleanupStack::Pop(); // Store reversion cleanup item
sl@0: 	CleanupStack::PopAndDestroy(store);
sl@0: 
sl@0: 	// Indicate the store has changed and attempt to compact 
sl@0: 	// the store, but only if the required number of store 
sl@0: 	// changes has been met
sl@0: 	StoreChangedL();
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::RunL()
sl@0: //
sl@0: //	Perform a store compaction step
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING("CSchBackupManager::RunL - Performing compaction step");
sl@0: 
sl@0: 	// Is there any more processing required?
sl@0: 	if	(iStoreReclaimerCount() > 0)
sl@0: 		{
sl@0: 		// Yes, so start next step
sl@0: 		iStoreReclaimer.Next(iStoreReclaimerCount, iStatus);
sl@0: 		SetActive();
sl@0: 		LOGSTRING("CSchBackupManager::RunL - Requesting another compaction step");
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// No, we've finised. Clean up previously allocated
sl@0: 		// resources
sl@0: 		iStoreReclaimer.Close();
sl@0: 		//
sl@0: 		TRAPD(errNotRef, iStoreOpenForCompaction->CommitL());
sl@0:         UNUSED_VAR(errNotRef);
sl@0: 		delete iStoreOpenForCompaction;
sl@0: 		iStoreOpenForCompaction = NULL;
sl@0: 
sl@0: 		// Set this to zero again...
sl@0: 		ResetStoreChanges();
sl@0: 		LOGSTRING("CSchBackupManager::RunL - Compaction complete");
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::DoCancel()
sl@0: //
sl@0: //	Cancel's any asynchronous store compaction
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING("CSchBackupManager::RunL - Cancelling compaction");
sl@0: 
sl@0: 	iStoreReclaimer.Release();
sl@0: 	iStoreReclaimer.Close();
sl@0: 	//
sl@0: 	TRAPD(errNotRef, iStoreOpenForCompaction->CommitL());
sl@0:     UNUSED_VAR(errNotRef);
sl@0: 	delete iStoreOpenForCompaction;
sl@0: 	iStoreOpenForCompaction = NULL;
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::StoreChangedL()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!IsActive() && !iStoreOpenForCompaction, User::Invariant());
sl@0: 
sl@0: 	if	(RecordStoreChange() >= KMaxChangesBeforeCompact)
sl@0: 		{
sl@0: 		// Open the store
sl@0: 		CStreamStore* store = OpenBackupStoreLC();
sl@0: 
sl@0: 		// Prepare for compaction
sl@0: 		TInt count;
sl@0: 		iStoreReclaimer.CompactL(*store, count);
sl@0: 		iStoreReclaimerCount = count;
sl@0: 
sl@0: 		// Safe to do this now
sl@0: 		iStoreOpenForCompaction = store;
sl@0: 		CleanupStack::Pop();
sl@0: 
sl@0: 		// Start asynchronous compaction...
sl@0: 		iStoreReclaimer.Next(iStoreReclaimerCount, iStatus);
sl@0: 		SetActive();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: CPermanentFileStore* CSchBackupManager::OpenBackupStoreLC()
sl@0: 	{
sl@0: 	return CPermanentFileStore::OpenLC(iFsSession, iBackupFileName, EFileWrite);
sl@0: 	}
sl@0: 
sl@0: CPermanentFileStore* CSchBackupManager::OpenOrCreateBackupStoreLC()
sl@0: 	{
sl@0: 	CPermanentFileStore* store = NULL;
sl@0: 	TInt error = KErrNone;
sl@0: 	TRAP(error, 
sl@0: 		store = CPermanentFileStore::OpenL(iFsSession, iBackupFileName, EFileWrite);
sl@0: 		);
sl@0: 	if	(error < KErrNone)
sl@0: 		{
sl@0: 		if	(error == KErrNotFound)
sl@0: 			{
sl@0: 			CreateEmptyBackupL();
sl@0: 			store = CPermanentFileStore::OpenL(iFsSession, iBackupFileName, EFileWrite);
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			User::Leave(error);
sl@0: 			}
sl@0: 		}
sl@0: 	LOGSTRING("CSchBackupManager::OpenOrCreateBackupStoreLC - store opened");
sl@0: 	CleanupStack::PushL(store);
sl@0: 	return store;
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::CleanupRevertPushLC(CStreamStore& aStore)
sl@0: 	{
sl@0: 	CleanupStack::PushL(TCleanupItem(RevertStore, &aStore));
sl@0: 	}
sl@0: 
sl@0: void CSchBackupManager::RevertStore(TAny* aStore)
sl@0: //
sl@0: //	The Cleanup Item callback function which is used to rever the store
sl@0: //	should a leave occur.
sl@0: //
sl@0: 	{
sl@0: 	CStreamStore* store = reinterpret_cast<CStreamStore*>(aStore);
sl@0: 	store->Revert();
sl@0: 	LOGSTRING("CSchBackupManager::RevertStore - store reverted");
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates an initialised empty store.
sl@0: The creation process is performed as an atomic operation.
sl@0: If the operation fails somewhere at the middle, CreateEmptyBackupL()
sl@0: will cleanup after itself - the store file will be deleted,
sl@0: iIndexStreamSchedules and iIndexStreamClients stream IDs will be reinitialised
sl@0: with invalid values.
sl@0: */
sl@0: void CSchBackupManager::CreateEmptyBackupL()
sl@0: 	{
sl@0: 	TRAPD(err, DoCreateEmptyBackupL());
sl@0: 	if(err != KErrNone)
sl@0: 		{
sl@0: 		//Cleanup & leave
sl@0: 		// If unable to delete file record the fact
sl@0: 		TInt err2 = iFsSession.Delete(iBackupFileName);
sl@0: 		if (err2 != KErrNone)
sl@0: 			{
sl@0: 			LOGSTRING2("CSchBackupManager::CreateEmptyBackupL - File delete error = %d", err2);
sl@0: 			}
sl@0: 		iIndexStreamSchedules = iIndexStreamClients = KNullStreamId;
sl@0: 		User::Leave(err);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates an initialised empty store.
sl@0: */
sl@0: void CSchBackupManager::DoCreateEmptyBackupL()
sl@0: 	{
sl@0: 	LOGSTRING("CSchBackupManager::CreateEmptyBackupL - trying to create new store");
sl@0: 	CPermanentFileStore* store = CPermanentFileStore::ReplaceLC(iFsSession, iBackupFileName, EFileWrite);
sl@0: 	store->SetTypeL(KPermanentFileStoreLayoutUid);	
sl@0: 
sl@0: 	// Create emtpy schedule index stream
sl@0: 	CSchScheduleIndex* indexSchedule = CSchScheduleIndex::NewL();
sl@0: 	CleanupStack::PushL(indexSchedule);
sl@0: 	iIndexStreamSchedules = indexSchedule->CreateEmptyIndexL(*store);
sl@0: 	CleanupStack::PopAndDestroy(indexSchedule);
sl@0: 
sl@0: 	// Create emtpy client index stream
sl@0: 	CSchClientIndex* indexClient = CSchClientIndex::NewL(iFsSession);
sl@0: 	CleanupStack::PushL(indexClient);
sl@0: 	iIndexStreamClients = indexClient->CreateEmptyIndexL(*store);
sl@0: 	CleanupStack::PopAndDestroy(indexClient);
sl@0: 
sl@0: 	// Write root stream
sl@0: 	WriteRootStreamL(*store);
sl@0: 
sl@0: 	// Finalise
sl@0: 	store->CommitL();							
sl@0: 	CleanupStack::PopAndDestroy(store);
sl@0: 	LOGSTRING("CSchBackupManager::CreateEmptyBackupL - new store created");
sl@0: 	}
sl@0: 	
sl@0: void CSchBackupManager::WriteRootStreamL(CStreamStore& aStore)
sl@0: //
sl@0: //	Write the root stream which contains the two stream id's
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING("CSchBackupManager::WriteRootStreamL - trying to write root stream");
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id = stream.CreateLC(aStore);	
sl@0: 	
sl@0: 	// This writes a stream id - it doesn't write the actual
sl@0: 	// dictionary since this is written after every operation.
sl@0: 	stream << iIndexStreamSchedules;
sl@0: 	stream << iIndexStreamClients;
sl@0: 
sl@0: 	// 
sl@0: 	stream.CommitL();						
sl@0:     CleanupStack::PopAndDestroy();// outstream
sl@0: 	static_cast<CPermanentFileStore&>(aStore).SetRootL(id);
sl@0: 	LOGSTRING("CSchBackupManager::WriteRootStreamL - root stream written");
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> CSchScheduleIndex (header)
sl@0: //
sl@0: 
sl@0: CSchScheduleIndex::CSchScheduleIndex()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CSchScheduleIndex* CSchScheduleIndex::NewL()
sl@0: 	{
sl@0: 	CSchScheduleIndex* self = new(ELeave) CSchScheduleIndex;
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::RestoreSchedulesL(TSglQue<CSchedule>& aTimeSchedules, 
sl@0: 										CStreamStore& aStore, 
sl@0: 										TStreamId aDictionaryStreamId)
sl@0: 	{
sl@0: 	CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aDictionaryStreamId);
sl@0: 
sl@0: 	// Restore every schedule in the dictionary
sl@0: 	const TInt count = dictionary->Count();
sl@0: 	LOGSTRING2("CSchScheduleIndex::RestoreSchedulesL - read %d dictionary entries", count);
sl@0: 
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		{
sl@0: 		// Get stream
sl@0: 		TStreamId stream = dictionary->AtIndex(i);
sl@0: 
sl@0: 		// Restore schedule from stream
sl@0: 		CSchedule* schedule = CSchedule::NewL(static_cast<CFileStore&>(aStore), stream);
sl@0: 
sl@0: 		// Save schedule
sl@0: 		aTimeSchedules.AddLast(*schedule); // takes ownership
sl@0: 
sl@0: 		LOGSTRING3("CSchScheduleIndex::RestoreSchedulesL - restored schedule: %S, %d", &schedule->Name(), schedule->Id());
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchScheduleIndex::CreateEmptyIndexL(CStreamStore& aStore) const
sl@0: 	{
sl@0: 	CSchScheduleDictionary* dictionary = CSchScheduleDictionary::NewLC();
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id = stream.CreateLC(aStore);
sl@0: 	stream << *dictionary;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(2); // stream, dictionary
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::AddL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
sl@0: //
sl@0: //	Saves the specified schedule to the store and adds a new entry to the
sl@0: //	dictionary.
sl@0: //
sl@0: 	{
sl@0: 	LOGSTRING2("CSchScheduleIndex::AddL - adding a new schedule (id is %d)", aSchedule.Id());
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id = stream.CreateLC(aStore);
sl@0: 	stream << aSchedule;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 
sl@0: 	// Read the dictionary and update an entry
sl@0: 	CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	dictionary->AssignL(aSchedule.Id(), id);
sl@0: 
sl@0: 	// Store the dictionary
sl@0: 	StoreDictionaryL(aStore, *dictionary, aIndexStream);
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	LOGSTRING("CSchScheduleIndex::AddL - new schedule added okay");
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::EditL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
sl@0: //
sl@0: //	Replace an existing stream with the contents of aSchedule. 
sl@0: //
sl@0: 	{
sl@0: 	// Locate the existing stream (to be replaced)
sl@0: 	CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	LOGSTRING2("CSchScheduleIndex::EditL - editing schedule with id of %d", aSchedule.Id());
sl@0: 	TStreamId id = dictionary->At(aSchedule.Id());
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	if	(id == KNullStreamId)
sl@0: 		{
sl@0: 		// Wasn't found, add it instead...
sl@0: 		LOGSTRING("CSchScheduleIndex::EditL - schedule wasn't found, adding new entry to the store");
sl@0: 		AddL(aIndexStream, aStore, aSchedule);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// Replace - the original stream is orphaned but the new
sl@0: 		// stream retains the old id.
sl@0: 		LOGSTRING("CSchScheduleIndex::EditL - replacing original stream");
sl@0: 		RStoreWriteStream stream;
sl@0: 		stream.ReplaceLC(aStore, id);
sl@0: 		stream << aSchedule;
sl@0: 		stream.CommitL();
sl@0: 		CleanupStack::PopAndDestroy(); // stream
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
sl@0: //
sl@0: //	Remove an existing schedule from the store.
sl@0: //
sl@0: 	{
sl@0: 	// Locate the existing stream (to be deleted)
sl@0: 	CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	LOGSTRING2("CSchScheduleIndex::DeleteL - deleting schedule with id of %d", aSchedule.Id());
sl@0: 	TStreamId id = dictionary->At(aSchedule.Id());
sl@0: 	if	(id == KNullStreamId)
sl@0: 		{
sl@0: 		LOGSTRING("CSchScheduleIndex::DeleteL - schedule wasn't found! Would panic in debug");
sl@0: 		__ASSERT_DEBUG(EFalse, SchBackupManagerUtils::Panic(SchBackupManagerUtils::ESchBackupManagerScheduleStreamToDeleteNotFound));
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// Remove the stream
sl@0: 		aStore.DeleteL(id);
sl@0: 
sl@0: 		// Save changes to store - we have to do this here since
sl@0: 		// we must assure that the store is fully updated before
sl@0: 		// we remove this stream from the dictionary (in order to 
sl@0: 		// maintain integrity).
sl@0: 		aStore.CommitL();
sl@0: 
sl@0: 		// Remove entry from the stream dictionary
sl@0: 		dictionary->Remove(aSchedule.Id());
sl@0: 		StoreDictionaryL(aStore, *dictionary, aIndexStream);
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	}
sl@0: 
sl@0: CSchScheduleIndex::CSchScheduleDictionary* CSchScheduleIndex::DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream)
sl@0: 	{
sl@0: 	LOGSTRING("CSchScheduleIndex::DictionaryLC - restoring dictionary");
sl@0: 	CSchScheduleDictionary* dictionary = CSchScheduleDictionary::NewLC();
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore, aIndexStream);
sl@0: 	stream >> *dictionary;
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 	LOGSTRING("CSchScheduleIndex::DictionaryLC - dictionary restored");
sl@0: 	return dictionary;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::StoreDictionaryL(CStreamStore& aStore, const CSchScheduleDictionary& aDictionary, TStreamId aStreamToReplace)
sl@0: 	{
sl@0: 	LOGSTRING("CSchScheduleIndex::DictionaryLC - storing dictionary");
sl@0: 	RStoreWriteStream stream;
sl@0: 	stream.ReplaceLC(aStore, aStreamToReplace);
sl@0: 	stream << aDictionary;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 	LOGSTRING("CSchScheduleIndex::DictionaryLC - dictionary stored");
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> CSchScheduleDictionary (header)
sl@0: //
sl@0: 
sl@0: CSchScheduleIndex::CSchScheduleDictionary::CSchScheduleDictionary()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CSchScheduleIndex::CSchScheduleDictionary::~CSchScheduleDictionary()
sl@0: 	{
sl@0: 	delete iMappings;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::CSchScheduleDictionary::ConstructL()
sl@0: 	{
sl@0: 	const TInt KGranularity = 3;
sl@0: 	iMappings = new(ELeave) CArrayFixSeg<TSchScheduleMapplet>(KGranularity);
sl@0: 	}
sl@0: 
sl@0: CSchScheduleIndex::CSchScheduleDictionary* CSchScheduleIndex::CSchScheduleDictionary::NewLC()
sl@0: 	{
sl@0: 	CSchScheduleDictionary* self = new(ELeave) CSchScheduleDictionary();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::CSchScheduleDictionary::AssignL(TInt aKey, TStreamId aId)
sl@0: 	{
sl@0: 	if	(aId == KNullStreamId)
sl@0: 		{
sl@0: 		Remove(aKey); // default associated stream is null
sl@0: 		return;
sl@0: 		}
sl@0: 	//
sl@0: 	TSchScheduleMapplet entry(aKey, KNullStreamId);
sl@0: 	TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
sl@0: 	TInt i;
sl@0: 	if	(iMappings->FindIsq(entry, key, i) == 0)
sl@0: 		{
sl@0: 		iMappings->At(i).SetStream(aId);
sl@0: 		return;
sl@0: 		}
sl@0: 	//
sl@0: 	entry.SetStream(aId);
sl@0: 	iMappings->InsertIsqL(entry, key);
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::CSchScheduleDictionary::Remove(TInt aKey)
sl@0: 	{
sl@0: 	TSchScheduleMapplet entry(aKey, KNullStreamId);
sl@0: 	TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
sl@0: 	TInt i;
sl@0: 	if	(iMappings->FindIsq(entry, key, i) == 0)
sl@0: 		iMappings->Delete(i);
sl@0: 	}
sl@0: 
sl@0: TInt CSchScheduleIndex::CSchScheduleDictionary::Count() const
sl@0: 	{
sl@0: 	return iMappings->Count();
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchScheduleIndex::CSchScheduleDictionary::At(TInt aKey) const
sl@0: 	{
sl@0: 	TSchScheduleMapplet entry(aKey, KNullStreamId);
sl@0: 	TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
sl@0: 	TInt i;
sl@0: 	if	(iMappings->FindIsq(entry, key, i) != 0)
sl@0: 		return KNullStreamId;
sl@0: 	//
sl@0: 	return iMappings->At(i).Stream();
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchScheduleIndex::CSchScheduleDictionary::AtIndex(TInt aIndex) const
sl@0: 	{
sl@0: 	return iMappings->At(aIndex).Stream();
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::CSchScheduleDictionary::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	aStream >> *iMappings;
sl@0: 	}
sl@0: 
sl@0: void CSchScheduleIndex::CSchScheduleDictionary::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream << *iMappings;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> CSchClientIndex (header)
sl@0: //
sl@0: 
sl@0: CSchClientIndex::CSchClientIndex(RFs& aFsSession)
sl@0: :	iFsSession(aFsSession)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex* CSchClientIndex::NewL(RFs& aFsSession)
sl@0: 	{
sl@0: 	return new(ELeave) CSchClientIndex(aFsSession);
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::AppendClientToListL(TPriQue<CClientProxy>& aClients, CClientProxy* aClient)
sl@0: 	{
sl@0: 	CClientProxy* currentClient;
sl@0: 	TDblQueIter<CClientProxy> clientIter(aClients);
sl@0: 	clientIter.SetToFirst();
sl@0: 	while ((currentClient = clientIter++) != NULL)
sl@0: 		{	
sl@0: 		//if match on same client name and priority	
sl@0: 		if (currentClient->IsEqual(aClient->ExecutorFileName(),aClient->Priority()))
sl@0: 			{
sl@0: 			//transfer all the tasks in aClient to this client
sl@0: 			aClient->TransferTasks(*currentClient);
sl@0: 			//now that we have transferred all the task ownership, we can safely delete the source client
sl@0: 			delete aClient;
sl@0: 			return;
sl@0: 			}
sl@0: 		}
sl@0: 	//since that there is no matching one just add the aClient directly
sl@0: 	aClients.Add(*aClient);	
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::RestoreClientsL(TPriQue<CClientProxy>& aClients, 
sl@0: 									CStreamStore& aStore, 
sl@0: 									TStreamId aIndexStream,
sl@0: 									CSchLogManager& aSchLogManager,TBool aBUR)
sl@0: 	{
sl@0: 	CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 
sl@0: 	// Restore every schedule in the dictionary
sl@0: 	const TInt count = dictionary->Count();
sl@0: 	LOGSTRING2("CSchClientIndex::RestoreClientsL - read %d dictionary entries", count);
sl@0: 
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		{
sl@0: 		// Get stream
sl@0: 		TStreamId streamId = dictionary->AtIndex(i);
sl@0: 
sl@0: 		RStoreReadStream stream;
sl@0: 		stream.OpenLC(aStore, streamId);
sl@0: 
sl@0: 		// Restore client
sl@0: 		CClientProxy* client = CClientProxy::NewL(iFsSession,stream,aSchLogManager);
sl@0: 		CleanupStack::PopAndDestroy(); // stream
sl@0: 
sl@0: 		// Save schedule
sl@0: 		// only when this is called through restore we need to append to existing client which
sl@0: 		// might already contain other transient tasks
sl@0: 		if (aBUR)
sl@0: 			{
sl@0: 			AppendClientToListL(aClients,client);
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			aClients.Add(*client); // takes ownership				
sl@0: 			}
sl@0: 		LOGSTRING2("CSchClientIndex::RestoreClientsL - restored client: %S", &client->ExecutorFileName());
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchClientIndex::CreateEmptyIndexL(CStreamStore& aStore) const
sl@0: 	{
sl@0: 	CSchClientDictionary* dictionary = CSchClientDictionary::NewLC();
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id = stream.CreateLC(aStore);
sl@0: 	stream << *dictionary;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(2); // stream, dictionary
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::AddL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
sl@0: 	{
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id = stream.CreateLC(aStore);
sl@0: 	stream << aClient;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 
sl@0: 	// Read the dictionary and update an entry
sl@0: 	CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	dictionary->AssignL(aClient.ExecutorFileName(), id);
sl@0: 
sl@0: 	// Store the dictionary
sl@0: 	StoreDictionaryL(aStore, *dictionary, aIndexStream);
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::EditL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
sl@0: 	{
sl@0: 	// Locate the existing stream (to be replaced)
sl@0: 	CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	TStreamId id = dictionary->AtL(aClient.ExecutorFileName());
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	if	(id == KNullStreamId)
sl@0: 		{
sl@0: 		// Wasn't found, add it instead...
sl@0: 		AddL(aIndexStream, aStore, aClient);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// Replace - the original stream is orphaned but the new
sl@0: 		// stream retains the old id.
sl@0: 		RStoreWriteStream stream;
sl@0: 		stream.ReplaceLC(aStore, id);
sl@0: 		stream << aClient;
sl@0: 		stream.CommitL();
sl@0: 		CleanupStack::PopAndDestroy(); // stream
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
sl@0: 	{
sl@0: 	// Locate the existing stream (to be deleted)
sl@0: 	CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
sl@0: 	TStreamId id = dictionary->AtL(aClient.ExecutorFileName());
sl@0: 	__ASSERT_ALWAYS(id != KNullStreamId, SchBackupManagerUtils::Panic(SchBackupManagerUtils::ESchBackupManagerScheduleStreamToDeleteNotFound));
sl@0: 
sl@0: 	// Remove the stream
sl@0: 	aStore.DeleteL(id);
sl@0: 
sl@0: 	// Save changes to store - we have to do this here since
sl@0: 	// we must assure that the store is fully updated before
sl@0: 	// we remove this stream from the dictionary (in order to 
sl@0: 	// maintain integrity).
sl@0: 	aStore.CommitL();
sl@0: 
sl@0: 	// Remove entry from the stream dictionary
sl@0: 	dictionary->RemoveL(aClient.ExecutorFileName());
sl@0: 	StoreDictionaryL(aStore, *dictionary, aIndexStream);
sl@0: 	CleanupStack::PopAndDestroy(dictionary);
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex::CSchClientDictionary* CSchClientIndex::DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream)
sl@0: 	{
sl@0: 	LOGSTRING("CSchClientIndex::DictionaryLC - restoring dictionary");
sl@0: 	CSchClientDictionary* dictionary = CSchClientDictionary::NewLC();
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore, aIndexStream);
sl@0: 	stream >> *dictionary;
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 	LOGSTRING("CSchClientIndex::DictionaryLC - dictionary restored");
sl@0: 	return dictionary;
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::StoreDictionaryL(CStreamStore& aStore, const CSchClientDictionary& aDictionary, TStreamId aStreamToReplace)
sl@0: 	{
sl@0: 	LOGSTRING("CSchClientIndex::DictionaryLC - storing dictionary");
sl@0: 	RStoreWriteStream stream;
sl@0: 	stream.ReplaceLC(aStore, aStreamToReplace);
sl@0: 	stream << aDictionary;
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(); // stream
sl@0: 	LOGSTRING("CSchClientIndex::DictionaryLC - dictionary stored");
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> TKeyArrayPtr (header)
sl@0: //
sl@0: NONSHARABLE_CLASS(TKeyArrayMapping) : public TKeyArrayFix
sl@0: {
sl@0: public:
sl@0: 	inline TKeyArrayMapping(TInt aOffset) : TKeyArrayFix(aOffset, TKeyCmpText()) {iHBufType=ETrue;}
sl@0: 	//
sl@0: 	virtual TAny* At(TInt aIndex) const;
sl@0: 	virtual TInt Compare(TInt aLeft,TInt aRight) const;	
sl@0: 
sl@0: private:
sl@0: 	TBool iHBufType;
sl@0: 	};
sl@0: 
sl@0: TAny* TKeyArrayMapping::At(TInt aIndex) const
sl@0: 	{
sl@0: 	if	(aIndex==KIndexPtr)
sl@0: 		{
sl@0: 		const CSchClientIndex::CSchClientMapplet** ppItem = (const CSchClientIndex::CSchClientMapplet**) iPtr;
sl@0: 		const CSchClientIndex::CSchClientMapplet* pItem = *ppItem;
sl@0: 		return (TAny*) pItem;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		TInt baseOffset = aIndex * sizeof(const CSchClientIndex::CSchClientMapplet*);
sl@0: 		const TUint8* pItemUncast = iBase->Ptr(baseOffset).Ptr();
sl@0: 		const CSchClientIndex::CSchClientMapplet** ppItem = (const CSchClientIndex::CSchClientMapplet**) pItemUncast;
sl@0: 		const CSchClientIndex::CSchClientMapplet* pItem = *ppItem;
sl@0: 		return (TAny*) pItem;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: TInt TKeyArrayMapping::Compare(TInt aLeft,TInt aRight) const
sl@0: 	{
sl@0: 	if	(iHBufType)
sl@0: 		{
sl@0: 		const CSchClientIndex::CSchClientMapplet* left = (const CSchClientIndex::CSchClientMapplet*) At(aLeft);
sl@0: 		const CSchClientIndex::CSchClientMapplet* right = (const CSchClientIndex::CSchClientMapplet*) At(aRight);
sl@0: 
sl@0: 		return (left->Key().Compare(right->Key()));
sl@0: 		}
sl@0: 	else
sl@0: 		User::Invariant();
sl@0: 	return KErrNotFound;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // -----> CSchClientIndex::CSchClientMapplet (header)
sl@0: //
sl@0: 
sl@0: CSchClientIndex::CSchClientMapplet::~CSchClientMapplet()
sl@0: 	{
sl@0: 	delete iKey;
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex::CSchClientMapplet* CSchClientIndex::CSchClientMapplet::NewLC(RReadStream& aStream)
sl@0: 	{
sl@0: 	CSchClientMapplet* self = new(ELeave) CSchClientMapplet;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	aStream >> *self;
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex::CSchClientMapplet* CSchClientIndex::CSchClientMapplet::NewLC(const TDesC& aKey, TStreamId aStream)
sl@0: 	{
sl@0: 	CSchClientMapplet* self = new(ELeave) CSchClientMapplet;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->iKey = aKey.AllocL();
sl@0: 	self->iStream = aStream;
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientMapplet::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	HBufC* key = HBufC::NewLC(aStream, KMaxTInt);
sl@0: 	delete iKey;
sl@0: 	iKey = key;
sl@0: 	CleanupStack::Pop(); // key
sl@0: 	aStream >> iStream;
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientMapplet::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream << *iKey;
sl@0: 	aStream << iStream;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: //
sl@0: // -----> CSchClientIndex::CSchClientDictionary (header)
sl@0: //
sl@0: 
sl@0: CSchClientIndex::CSchClientDictionary::CSchClientDictionary()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex::CSchClientDictionary::~CSchClientDictionary()
sl@0: 	{	
sl@0: 	if(iMappings)
sl@0: 		{
sl@0: 		for(int index = 0; index < iMappings->Count();index++)
sl@0: 			{
sl@0: 			delete iMappings->At(index);
sl@0: 			}
sl@0: 		delete iMappings;	
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientDictionary::ConstructL()
sl@0: 	{
sl@0: 	const TInt KGranularity = 2;
sl@0: 	iMappings = new(ELeave) CArrayPtrSeg<CSchClientMapplet>(KGranularity);
sl@0: 	}
sl@0: 
sl@0: CSchClientIndex::CSchClientDictionary* CSchClientIndex::CSchClientDictionary::NewLC()
sl@0: 	{
sl@0: 	CSchClientDictionary* self = new(ELeave) CSchClientDictionary();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientDictionary::AssignL(const TDesC& aKey, TStreamId aId)
sl@0: 	{
sl@0: 	if	(aId == KNullStreamId)
sl@0: 		{
sl@0: 		RemoveL(aKey); // default associated stream is null
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
sl@0: 	TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
sl@0: 	TInt i;
sl@0: 	if	(iMappings->FindIsq(entry, key, i) == 0)
sl@0: 		{
sl@0: 		iMappings->At(i)->SetStream(aId);
sl@0: 		CleanupStack::PopAndDestroy(); // entry
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	entry->SetStream(aId);
sl@0: 	iMappings->InsertIsqL(entry, key);
sl@0: 	CleanupStack::Pop(); // entry
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientDictionary::RemoveL(const TDesC& aKey)
sl@0: 	{
sl@0: 	CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
sl@0: 	TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
sl@0: 	TInt i;
sl@0: 	if	(iMappings->FindIsq(entry, key, i) == 0)
sl@0: 		{
sl@0: 		delete iMappings->At(i);
sl@0: 		iMappings->Delete(i);
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(); // entry
sl@0: 	}
sl@0: 
sl@0: TInt CSchClientIndex::CSchClientDictionary::Count() const
sl@0: 	{
sl@0: 	return iMappings->Count();
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchClientIndex::CSchClientDictionary::AtL(const TDesC& aKey) const
sl@0: 	{
sl@0: 	CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
sl@0: 	TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
sl@0: 	TInt i;
sl@0: 	TInt found = iMappings->FindIsq(entry, key, i);
sl@0: 	CleanupStack::PopAndDestroy(); // entry
sl@0: 	if	(found != 0)
sl@0: 		return KNullStreamId;
sl@0: 	return iMappings->At(i)->Stream();
sl@0: 	}
sl@0: 
sl@0: TStreamId CSchClientIndex::CSchClientDictionary::AtIndex(TInt aIndex) const
sl@0: 	{
sl@0: 	return iMappings->At(aIndex)->Stream();
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientDictionary::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	const TInt count = aStream.ReadInt32L();
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		{
sl@0: 		CSchClientMapplet* mapplet = CSchClientMapplet::NewLC(aStream);
sl@0: 		iMappings->AppendL(mapplet);
sl@0: 		CleanupStack::Pop(); // mapplet
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CSchClientIndex::CSchClientDictionary::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	const TInt count = iMappings->Count();
sl@0: 	aStream.WriteInt32L(count);
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		aStream << *iMappings->At(i);
sl@0: 	}