1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/taskscheduler/SCHSVR/SCHSTORE.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,1000 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +// User includes
1.20 +#include "SCHSTORE.H"
1.21 +#include "SchLogger.h"
1.22 +#include "SCHEDULE.H"
1.23 +#include "SCHCLI.H"
1.24 +#include "SCHEXEC.H"
1.25 +
1.26 +#define UNUSED_VAR(a) a = a
1.27 +
1.28 +// Constants
1.29 +const TInt KMaxChangesBeforeCompact = 5;
1.30 +//
1.31 +
1.32 +
1.33 +//
1.34 +// -----> SchBackupManagerUtils (header)
1.35 +//
1.36 +
1.37 +void SchBackupManagerUtils::Panic(TSchStorePanic aPanic)
1.38 + {
1.39 + _LIT(KSchStorePanic, "SchStore");
1.40 + User::Panic(KSchStorePanic, aPanic);
1.41 + }
1.42 +
1.43 +//
1.44 +// -----> CSchBackupManager (header)
1.45 +//
1.46 +
1.47 +CSchBackupManager::CSchBackupManager(RFs& aFsSession)
1.48 +: CActive(EPriorityIdle), iFsSession(aFsSession)
1.49 + {
1.50 + // construct backup filename
1.51 + iBackupFileName.Copy(KSchsvrBackupFileName);
1.52 + iBackupFileName[0] = 'A' + static_cast<TInt>(RFs::GetSystemDrive());
1.53 +
1.54 + CActiveScheduler::Add(this);
1.55 + }
1.56 +
1.57 +CSchBackupManager::~CSchBackupManager()
1.58 + {
1.59 + // This will delete the store and close the compactor
1.60 + Cancel();
1.61 + //
1.62 + delete iScheduleIndex;
1.63 + delete iClientIndex;
1.64 + }
1.65 +
1.66 +void CSchBackupManager::ConstructL()
1.67 + {
1.68 + iScheduleIndex = CSchScheduleIndex::NewL();
1.69 + iClientIndex = CSchClientIndex::NewL(iFsSession);
1.70 + }
1.71 +
1.72 +/**
1.73 +If this is called during a restore, we want to make sure we want to append
1.74 +to existing structure not always create new object and just append to the queue
1.75 +for example we want to append task to existing client if they have the same name
1.76 +and priority not create another one.
1.77 +*/
1.78 +void CSchBackupManager::RestoreL(TPriQue<CClientProxy>& aClients,
1.79 + TSglQue<CSchedule>& aTimeSchedules,
1.80 + CSchLogManager& aSchLogManager,TBool aBUR)
1.81 + {
1.82 + LOGSTRING("CSchBackupManager::RestoreL");
1.83 +
1.84 + // Open store
1.85 + CPermanentFileStore* store = OpenOrCreateBackupStoreLC();
1.86 +
1.87 + // Restore root stream (two pointers to other streams)
1.88 + RStoreReadStream stream;
1.89 + stream.OpenLC(*store, store->Root());
1.90 + stream >> iIndexStreamSchedules;
1.91 + stream >> iIndexStreamClients;
1.92 + CleanupStack::PopAndDestroy(); // stream
1.93 +
1.94 + // Restore clients
1.95 + iClientIndex->RestoreClientsL(aClients, *store, iIndexStreamClients, aSchLogManager,aBUR);
1.96 +
1.97 + // Restore schedules
1.98 + iScheduleIndex->RestoreSchedulesL(aTimeSchedules, *store, iIndexStreamSchedules);
1.99 +
1.100 + // Cleanup store.
1.101 + CleanupStack::PopAndDestroy(store);
1.102 + }
1.103 +
1.104 +void CSchBackupManager::PerformStoreOperationL(TSchBackupOperation aAction, const CSchedule& aSchedule)
1.105 +//
1.106 +// Perform an schedule-related operation.
1.107 +//
1.108 + {
1.109 + LOGSTRING3("CSchBackupManager::PerformStoreOperationL - Schedule: %S (%d)", &aSchedule.Name(), aSchedule.Id());
1.110 +
1.111 + if(aSchedule.Persists())
1.112 + {
1.113 + // Cancel any compaction that may be going on
1.114 + Cancel();
1.115 +
1.116 + // Perform the operation
1.117 + CStreamStore* store = OpenOrCreateBackupStoreLC();
1.118 + CleanupRevertPushLC(*store);
1.119 +
1.120 + switch(aAction)
1.121 + {
1.122 + case ESchBackupOperationAdd:
1.123 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpAdd");
1.124 + iScheduleIndex->AddL(iIndexStreamSchedules, *store, aSchedule);
1.125 + break;
1.126 + case ESchBackupOperationEdit:
1.127 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpEdit");
1.128 + iScheduleIndex->EditL(iIndexStreamSchedules, *store, aSchedule);
1.129 + break;
1.130 + case ESchBackupOperationDelete:
1.131 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpDelete");
1.132 + iScheduleIndex->DeleteL(iIndexStreamSchedules, *store, aSchedule);
1.133 + break;
1.134 + default:
1.135 + __ASSERT_DEBUG(EFalse, User::Invariant());
1.136 + User::Leave(KErrNotSupported);
1.137 + }
1.138 + // Save changes to store
1.139 + store->CommitL();
1.140 +
1.141 + CleanupStack::Pop(); // Store reversion cleanup item
1.142 + CleanupStack::PopAndDestroy(store);
1.143 +
1.144 + // Indicate the store has changed and attempt to compact
1.145 + // the store, but only if the required number of store
1.146 + // changes has been met
1.147 + StoreChangedL();
1.148 + }
1.149 + }
1.150 +
1.151 +void CSchBackupManager::PerformStoreOperationL(TSchBackupOperation aAction, const CClientProxy& aClient)
1.152 +//
1.153 +// Perform an schedule-related operation.
1.154 +//
1.155 + {
1.156 + LOGSTRING2("CSchBackupManager::PerformStoreOperationL - Client: %S", &aClient.ExecutorFileName());
1.157 +
1.158 + // Cancel any compaction that may be going on
1.159 + Cancel();
1.160 +
1.161 + // Perform the operation
1.162 + CStreamStore* store = OpenOrCreateBackupStoreLC();
1.163 + CleanupRevertPushLC(*store);
1.164 +
1.165 + switch(aAction)
1.166 + {
1.167 + case ESchBackupOperationAdd:
1.168 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpAdd");
1.169 + iClientIndex->AddL(iIndexStreamClients, *store, aClient);
1.170 + break;
1.171 + case ESchBackupOperationEdit:
1.172 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpEdit");
1.173 + iClientIndex->EditL(iIndexStreamClients, *store, aClient);
1.174 + break;
1.175 + case ESchBackupOperationDelete:
1.176 + LOGSTRING("CSchBackupManager::PerformStoreOperationL - OpDelete");
1.177 + iClientIndex->DeleteL(iIndexStreamClients, *store, aClient);
1.178 + break;
1.179 + default:
1.180 + __ASSERT_DEBUG(EFalse, User::Invariant());
1.181 + User::Leave(KErrNotSupported);
1.182 + }
1.183 +
1.184 + // Save changes to store
1.185 + store->CommitL();
1.186 +
1.187 + CleanupStack::Pop(); // Store reversion cleanup item
1.188 + CleanupStack::PopAndDestroy(store);
1.189 +
1.190 + // Indicate the store has changed and attempt to compact
1.191 + // the store, but only if the required number of store
1.192 + // changes has been met
1.193 + StoreChangedL();
1.194 + }
1.195 +
1.196 +void CSchBackupManager::RunL()
1.197 +//
1.198 +// Perform a store compaction step
1.199 +//
1.200 + {
1.201 + LOGSTRING("CSchBackupManager::RunL - Performing compaction step");
1.202 +
1.203 + // Is there any more processing required?
1.204 + if (iStoreReclaimerCount() > 0)
1.205 + {
1.206 + // Yes, so start next step
1.207 + iStoreReclaimer.Next(iStoreReclaimerCount, iStatus);
1.208 + SetActive();
1.209 + LOGSTRING("CSchBackupManager::RunL - Requesting another compaction step");
1.210 + }
1.211 + else
1.212 + {
1.213 + // No, we've finised. Clean up previously allocated
1.214 + // resources
1.215 + iStoreReclaimer.Close();
1.216 + //
1.217 + TRAPD(errNotRef, iStoreOpenForCompaction->CommitL());
1.218 + UNUSED_VAR(errNotRef);
1.219 + delete iStoreOpenForCompaction;
1.220 + iStoreOpenForCompaction = NULL;
1.221 +
1.222 + // Set this to zero again...
1.223 + ResetStoreChanges();
1.224 + LOGSTRING("CSchBackupManager::RunL - Compaction complete");
1.225 + }
1.226 + }
1.227 +
1.228 +void CSchBackupManager::DoCancel()
1.229 +//
1.230 +// Cancel's any asynchronous store compaction
1.231 +//
1.232 + {
1.233 + LOGSTRING("CSchBackupManager::RunL - Cancelling compaction");
1.234 +
1.235 + iStoreReclaimer.Release();
1.236 + iStoreReclaimer.Close();
1.237 + //
1.238 + TRAPD(errNotRef, iStoreOpenForCompaction->CommitL());
1.239 + UNUSED_VAR(errNotRef);
1.240 + delete iStoreOpenForCompaction;
1.241 + iStoreOpenForCompaction = NULL;
1.242 + }
1.243 +
1.244 +void CSchBackupManager::StoreChangedL()
1.245 + {
1.246 + __ASSERT_DEBUG(!IsActive() && !iStoreOpenForCompaction, User::Invariant());
1.247 +
1.248 + if (RecordStoreChange() >= KMaxChangesBeforeCompact)
1.249 + {
1.250 + // Open the store
1.251 + CStreamStore* store = OpenBackupStoreLC();
1.252 +
1.253 + // Prepare for compaction
1.254 + TInt count;
1.255 + iStoreReclaimer.CompactL(*store, count);
1.256 + iStoreReclaimerCount = count;
1.257 +
1.258 + // Safe to do this now
1.259 + iStoreOpenForCompaction = store;
1.260 + CleanupStack::Pop();
1.261 +
1.262 + // Start asynchronous compaction...
1.263 + iStoreReclaimer.Next(iStoreReclaimerCount, iStatus);
1.264 + SetActive();
1.265 + }
1.266 + }
1.267 +
1.268 +CPermanentFileStore* CSchBackupManager::OpenBackupStoreLC()
1.269 + {
1.270 + return CPermanentFileStore::OpenLC(iFsSession, iBackupFileName, EFileWrite);
1.271 + }
1.272 +
1.273 +CPermanentFileStore* CSchBackupManager::OpenOrCreateBackupStoreLC()
1.274 + {
1.275 + CPermanentFileStore* store = NULL;
1.276 + TInt error = KErrNone;
1.277 + TRAP(error,
1.278 + store = CPermanentFileStore::OpenL(iFsSession, iBackupFileName, EFileWrite);
1.279 + );
1.280 + if (error < KErrNone)
1.281 + {
1.282 + if (error == KErrNotFound)
1.283 + {
1.284 + CreateEmptyBackupL();
1.285 + store = CPermanentFileStore::OpenL(iFsSession, iBackupFileName, EFileWrite);
1.286 + }
1.287 + else
1.288 + {
1.289 + User::Leave(error);
1.290 + }
1.291 + }
1.292 + LOGSTRING("CSchBackupManager::OpenOrCreateBackupStoreLC - store opened");
1.293 + CleanupStack::PushL(store);
1.294 + return store;
1.295 + }
1.296 +
1.297 +void CSchBackupManager::CleanupRevertPushLC(CStreamStore& aStore)
1.298 + {
1.299 + CleanupStack::PushL(TCleanupItem(RevertStore, &aStore));
1.300 + }
1.301 +
1.302 +void CSchBackupManager::RevertStore(TAny* aStore)
1.303 +//
1.304 +// The Cleanup Item callback function which is used to rever the store
1.305 +// should a leave occur.
1.306 +//
1.307 + {
1.308 + CStreamStore* store = reinterpret_cast<CStreamStore*>(aStore);
1.309 + store->Revert();
1.310 + LOGSTRING("CSchBackupManager::RevertStore - store reverted");
1.311 + }
1.312 +
1.313 +/**
1.314 +Creates an initialised empty store.
1.315 +The creation process is performed as an atomic operation.
1.316 +If the operation fails somewhere at the middle, CreateEmptyBackupL()
1.317 +will cleanup after itself - the store file will be deleted,
1.318 +iIndexStreamSchedules and iIndexStreamClients stream IDs will be reinitialised
1.319 +with invalid values.
1.320 +*/
1.321 +void CSchBackupManager::CreateEmptyBackupL()
1.322 + {
1.323 + TRAPD(err, DoCreateEmptyBackupL());
1.324 + if(err != KErrNone)
1.325 + {
1.326 + //Cleanup & leave
1.327 + // If unable to delete file record the fact
1.328 + TInt err2 = iFsSession.Delete(iBackupFileName);
1.329 + if (err2 != KErrNone)
1.330 + {
1.331 + LOGSTRING2("CSchBackupManager::CreateEmptyBackupL - File delete error = %d", err2);
1.332 + }
1.333 + iIndexStreamSchedules = iIndexStreamClients = KNullStreamId;
1.334 + User::Leave(err);
1.335 + }
1.336 + }
1.337 +
1.338 +/**
1.339 +Creates an initialised empty store.
1.340 +*/
1.341 +void CSchBackupManager::DoCreateEmptyBackupL()
1.342 + {
1.343 + LOGSTRING("CSchBackupManager::CreateEmptyBackupL - trying to create new store");
1.344 + CPermanentFileStore* store = CPermanentFileStore::ReplaceLC(iFsSession, iBackupFileName, EFileWrite);
1.345 + store->SetTypeL(KPermanentFileStoreLayoutUid);
1.346 +
1.347 + // Create emtpy schedule index stream
1.348 + CSchScheduleIndex* indexSchedule = CSchScheduleIndex::NewL();
1.349 + CleanupStack::PushL(indexSchedule);
1.350 + iIndexStreamSchedules = indexSchedule->CreateEmptyIndexL(*store);
1.351 + CleanupStack::PopAndDestroy(indexSchedule);
1.352 +
1.353 + // Create emtpy client index stream
1.354 + CSchClientIndex* indexClient = CSchClientIndex::NewL(iFsSession);
1.355 + CleanupStack::PushL(indexClient);
1.356 + iIndexStreamClients = indexClient->CreateEmptyIndexL(*store);
1.357 + CleanupStack::PopAndDestroy(indexClient);
1.358 +
1.359 + // Write root stream
1.360 + WriteRootStreamL(*store);
1.361 +
1.362 + // Finalise
1.363 + store->CommitL();
1.364 + CleanupStack::PopAndDestroy(store);
1.365 + LOGSTRING("CSchBackupManager::CreateEmptyBackupL - new store created");
1.366 + }
1.367 +
1.368 +void CSchBackupManager::WriteRootStreamL(CStreamStore& aStore)
1.369 +//
1.370 +// Write the root stream which contains the two stream id's
1.371 +//
1.372 + {
1.373 + LOGSTRING("CSchBackupManager::WriteRootStreamL - trying to write root stream");
1.374 + RStoreWriteStream stream;
1.375 + TStreamId id = stream.CreateLC(aStore);
1.376 +
1.377 + // This writes a stream id - it doesn't write the actual
1.378 + // dictionary since this is written after every operation.
1.379 + stream << iIndexStreamSchedules;
1.380 + stream << iIndexStreamClients;
1.381 +
1.382 + //
1.383 + stream.CommitL();
1.384 + CleanupStack::PopAndDestroy();// outstream
1.385 + static_cast<CPermanentFileStore&>(aStore).SetRootL(id);
1.386 + LOGSTRING("CSchBackupManager::WriteRootStreamL - root stream written");
1.387 + }
1.388 +
1.389 +//
1.390 +// -----> CSchScheduleIndex (header)
1.391 +//
1.392 +
1.393 +CSchScheduleIndex::CSchScheduleIndex()
1.394 + {
1.395 + }
1.396 +
1.397 +CSchScheduleIndex* CSchScheduleIndex::NewL()
1.398 + {
1.399 + CSchScheduleIndex* self = new(ELeave) CSchScheduleIndex;
1.400 + return self;
1.401 + }
1.402 +
1.403 +void CSchScheduleIndex::RestoreSchedulesL(TSglQue<CSchedule>& aTimeSchedules,
1.404 + CStreamStore& aStore,
1.405 + TStreamId aDictionaryStreamId)
1.406 + {
1.407 + CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aDictionaryStreamId);
1.408 +
1.409 + // Restore every schedule in the dictionary
1.410 + const TInt count = dictionary->Count();
1.411 + LOGSTRING2("CSchScheduleIndex::RestoreSchedulesL - read %d dictionary entries", count);
1.412 +
1.413 + for(TInt i=0; i<count; i++)
1.414 + {
1.415 + // Get stream
1.416 + TStreamId stream = dictionary->AtIndex(i);
1.417 +
1.418 + // Restore schedule from stream
1.419 + CSchedule* schedule = CSchedule::NewL(static_cast<CFileStore&>(aStore), stream);
1.420 +
1.421 + // Save schedule
1.422 + aTimeSchedules.AddLast(*schedule); // takes ownership
1.423 +
1.424 + LOGSTRING3("CSchScheduleIndex::RestoreSchedulesL - restored schedule: %S, %d", &schedule->Name(), schedule->Id());
1.425 + }
1.426 + CleanupStack::PopAndDestroy(dictionary);
1.427 + }
1.428 +
1.429 +TStreamId CSchScheduleIndex::CreateEmptyIndexL(CStreamStore& aStore) const
1.430 + {
1.431 + CSchScheduleDictionary* dictionary = CSchScheduleDictionary::NewLC();
1.432 + RStoreWriteStream stream;
1.433 + TStreamId id = stream.CreateLC(aStore);
1.434 + stream << *dictionary;
1.435 + stream.CommitL();
1.436 + CleanupStack::PopAndDestroy(2); // stream, dictionary
1.437 + return id;
1.438 + }
1.439 +
1.440 +void CSchScheduleIndex::AddL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
1.441 +//
1.442 +// Saves the specified schedule to the store and adds a new entry to the
1.443 +// dictionary.
1.444 +//
1.445 + {
1.446 + LOGSTRING2("CSchScheduleIndex::AddL - adding a new schedule (id is %d)", aSchedule.Id());
1.447 + RStoreWriteStream stream;
1.448 + TStreamId id = stream.CreateLC(aStore);
1.449 + stream << aSchedule;
1.450 + stream.CommitL();
1.451 + CleanupStack::PopAndDestroy(); // stream
1.452 +
1.453 + // Read the dictionary and update an entry
1.454 + CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.455 + dictionary->AssignL(aSchedule.Id(), id);
1.456 +
1.457 + // Store the dictionary
1.458 + StoreDictionaryL(aStore, *dictionary, aIndexStream);
1.459 + CleanupStack::PopAndDestroy(dictionary);
1.460 + LOGSTRING("CSchScheduleIndex::AddL - new schedule added okay");
1.461 + }
1.462 +
1.463 +void CSchScheduleIndex::EditL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
1.464 +//
1.465 +// Replace an existing stream with the contents of aSchedule.
1.466 +//
1.467 + {
1.468 + // Locate the existing stream (to be replaced)
1.469 + CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.470 + LOGSTRING2("CSchScheduleIndex::EditL - editing schedule with id of %d", aSchedule.Id());
1.471 + TStreamId id = dictionary->At(aSchedule.Id());
1.472 + CleanupStack::PopAndDestroy(dictionary);
1.473 + if (id == KNullStreamId)
1.474 + {
1.475 + // Wasn't found, add it instead...
1.476 + LOGSTRING("CSchScheduleIndex::EditL - schedule wasn't found, adding new entry to the store");
1.477 + AddL(aIndexStream, aStore, aSchedule);
1.478 + }
1.479 + else
1.480 + {
1.481 + // Replace - the original stream is orphaned but the new
1.482 + // stream retains the old id.
1.483 + LOGSTRING("CSchScheduleIndex::EditL - replacing original stream");
1.484 + RStoreWriteStream stream;
1.485 + stream.ReplaceLC(aStore, id);
1.486 + stream << aSchedule;
1.487 + stream.CommitL();
1.488 + CleanupStack::PopAndDestroy(); // stream
1.489 + }
1.490 + }
1.491 +
1.492 +void CSchScheduleIndex::DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CSchedule& aSchedule)
1.493 +//
1.494 +// Remove an existing schedule from the store.
1.495 +//
1.496 + {
1.497 + // Locate the existing stream (to be deleted)
1.498 + CSchScheduleDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.499 + LOGSTRING2("CSchScheduleIndex::DeleteL - deleting schedule with id of %d", aSchedule.Id());
1.500 + TStreamId id = dictionary->At(aSchedule.Id());
1.501 + if (id == KNullStreamId)
1.502 + {
1.503 + LOGSTRING("CSchScheduleIndex::DeleteL - schedule wasn't found! Would panic in debug");
1.504 + __ASSERT_DEBUG(EFalse, SchBackupManagerUtils::Panic(SchBackupManagerUtils::ESchBackupManagerScheduleStreamToDeleteNotFound));
1.505 + }
1.506 + else
1.507 + {
1.508 + // Remove the stream
1.509 + aStore.DeleteL(id);
1.510 +
1.511 + // Save changes to store - we have to do this here since
1.512 + // we must assure that the store is fully updated before
1.513 + // we remove this stream from the dictionary (in order to
1.514 + // maintain integrity).
1.515 + aStore.CommitL();
1.516 +
1.517 + // Remove entry from the stream dictionary
1.518 + dictionary->Remove(aSchedule.Id());
1.519 + StoreDictionaryL(aStore, *dictionary, aIndexStream);
1.520 + }
1.521 + CleanupStack::PopAndDestroy(dictionary);
1.522 + }
1.523 +
1.524 +CSchScheduleIndex::CSchScheduleDictionary* CSchScheduleIndex::DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream)
1.525 + {
1.526 + LOGSTRING("CSchScheduleIndex::DictionaryLC - restoring dictionary");
1.527 + CSchScheduleDictionary* dictionary = CSchScheduleDictionary::NewLC();
1.528 + RStoreReadStream stream;
1.529 + stream.OpenLC(aStore, aIndexStream);
1.530 + stream >> *dictionary;
1.531 + CleanupStack::PopAndDestroy(); // stream
1.532 + LOGSTRING("CSchScheduleIndex::DictionaryLC - dictionary restored");
1.533 + return dictionary;
1.534 + }
1.535 +
1.536 +void CSchScheduleIndex::StoreDictionaryL(CStreamStore& aStore, const CSchScheduleDictionary& aDictionary, TStreamId aStreamToReplace)
1.537 + {
1.538 + LOGSTRING("CSchScheduleIndex::DictionaryLC - storing dictionary");
1.539 + RStoreWriteStream stream;
1.540 + stream.ReplaceLC(aStore, aStreamToReplace);
1.541 + stream << aDictionary;
1.542 + stream.CommitL();
1.543 + CleanupStack::PopAndDestroy(); // stream
1.544 + LOGSTRING("CSchScheduleIndex::DictionaryLC - dictionary stored");
1.545 + }
1.546 +
1.547 +//
1.548 +// -----> CSchScheduleDictionary (header)
1.549 +//
1.550 +
1.551 +CSchScheduleIndex::CSchScheduleDictionary::CSchScheduleDictionary()
1.552 + {
1.553 + }
1.554 +
1.555 +CSchScheduleIndex::CSchScheduleDictionary::~CSchScheduleDictionary()
1.556 + {
1.557 + delete iMappings;
1.558 + }
1.559 +
1.560 +void CSchScheduleIndex::CSchScheduleDictionary::ConstructL()
1.561 + {
1.562 + const TInt KGranularity = 3;
1.563 + iMappings = new(ELeave) CArrayFixSeg<TSchScheduleMapplet>(KGranularity);
1.564 + }
1.565 +
1.566 +CSchScheduleIndex::CSchScheduleDictionary* CSchScheduleIndex::CSchScheduleDictionary::NewLC()
1.567 + {
1.568 + CSchScheduleDictionary* self = new(ELeave) CSchScheduleDictionary();
1.569 + CleanupStack::PushL(self);
1.570 + self->ConstructL();
1.571 + return self;
1.572 + }
1.573 +
1.574 +void CSchScheduleIndex::CSchScheduleDictionary::AssignL(TInt aKey, TStreamId aId)
1.575 + {
1.576 + if (aId == KNullStreamId)
1.577 + {
1.578 + Remove(aKey); // default associated stream is null
1.579 + return;
1.580 + }
1.581 + //
1.582 + TSchScheduleMapplet entry(aKey, KNullStreamId);
1.583 + TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
1.584 + TInt i;
1.585 + if (iMappings->FindIsq(entry, key, i) == 0)
1.586 + {
1.587 + iMappings->At(i).SetStream(aId);
1.588 + return;
1.589 + }
1.590 + //
1.591 + entry.SetStream(aId);
1.592 + iMappings->InsertIsqL(entry, key);
1.593 + }
1.594 +
1.595 +void CSchScheduleIndex::CSchScheduleDictionary::Remove(TInt aKey)
1.596 + {
1.597 + TSchScheduleMapplet entry(aKey, KNullStreamId);
1.598 + TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
1.599 + TInt i;
1.600 + if (iMappings->FindIsq(entry, key, i) == 0)
1.601 + iMappings->Delete(i);
1.602 + }
1.603 +
1.604 +TInt CSchScheduleIndex::CSchScheduleDictionary::Count() const
1.605 + {
1.606 + return iMappings->Count();
1.607 + }
1.608 +
1.609 +TStreamId CSchScheduleIndex::CSchScheduleDictionary::At(TInt aKey) const
1.610 + {
1.611 + TSchScheduleMapplet entry(aKey, KNullStreamId);
1.612 + TKeyArrayFix key(TSchScheduleMapplet::KeyOffset(), ECmpTInt32);
1.613 + TInt i;
1.614 + if (iMappings->FindIsq(entry, key, i) != 0)
1.615 + return KNullStreamId;
1.616 + //
1.617 + return iMappings->At(i).Stream();
1.618 + }
1.619 +
1.620 +TStreamId CSchScheduleIndex::CSchScheduleDictionary::AtIndex(TInt aIndex) const
1.621 + {
1.622 + return iMappings->At(aIndex).Stream();
1.623 + }
1.624 +
1.625 +void CSchScheduleIndex::CSchScheduleDictionary::InternalizeL(RReadStream& aStream)
1.626 + {
1.627 + aStream >> *iMappings;
1.628 + }
1.629 +
1.630 +void CSchScheduleIndex::CSchScheduleDictionary::ExternalizeL(RWriteStream& aStream) const
1.631 + {
1.632 + aStream << *iMappings;
1.633 + }
1.634 +
1.635 +//
1.636 +// -----> CSchClientIndex (header)
1.637 +//
1.638 +
1.639 +CSchClientIndex::CSchClientIndex(RFs& aFsSession)
1.640 +: iFsSession(aFsSession)
1.641 + {
1.642 + }
1.643 +
1.644 +CSchClientIndex* CSchClientIndex::NewL(RFs& aFsSession)
1.645 + {
1.646 + return new(ELeave) CSchClientIndex(aFsSession);
1.647 + }
1.648 +
1.649 +void CSchClientIndex::AppendClientToListL(TPriQue<CClientProxy>& aClients, CClientProxy* aClient)
1.650 + {
1.651 + CClientProxy* currentClient;
1.652 + TDblQueIter<CClientProxy> clientIter(aClients);
1.653 + clientIter.SetToFirst();
1.654 + while ((currentClient = clientIter++) != NULL)
1.655 + {
1.656 + //if match on same client name and priority
1.657 + if (currentClient->IsEqual(aClient->ExecutorFileName(),aClient->Priority()))
1.658 + {
1.659 + //transfer all the tasks in aClient to this client
1.660 + aClient->TransferTasks(*currentClient);
1.661 + //now that we have transferred all the task ownership, we can safely delete the source client
1.662 + delete aClient;
1.663 + return;
1.664 + }
1.665 + }
1.666 + //since that there is no matching one just add the aClient directly
1.667 + aClients.Add(*aClient);
1.668 + }
1.669 +
1.670 +void CSchClientIndex::RestoreClientsL(TPriQue<CClientProxy>& aClients,
1.671 + CStreamStore& aStore,
1.672 + TStreamId aIndexStream,
1.673 + CSchLogManager& aSchLogManager,TBool aBUR)
1.674 + {
1.675 + CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.676 +
1.677 + // Restore every schedule in the dictionary
1.678 + const TInt count = dictionary->Count();
1.679 + LOGSTRING2("CSchClientIndex::RestoreClientsL - read %d dictionary entries", count);
1.680 +
1.681 + for(TInt i=0; i<count; i++)
1.682 + {
1.683 + // Get stream
1.684 + TStreamId streamId = dictionary->AtIndex(i);
1.685 +
1.686 + RStoreReadStream stream;
1.687 + stream.OpenLC(aStore, streamId);
1.688 +
1.689 + // Restore client
1.690 + CClientProxy* client = CClientProxy::NewL(iFsSession,stream,aSchLogManager);
1.691 + CleanupStack::PopAndDestroy(); // stream
1.692 +
1.693 + // Save schedule
1.694 + // only when this is called through restore we need to append to existing client which
1.695 + // might already contain other transient tasks
1.696 + if (aBUR)
1.697 + {
1.698 + AppendClientToListL(aClients,client);
1.699 + }
1.700 + else
1.701 + {
1.702 + aClients.Add(*client); // takes ownership
1.703 + }
1.704 + LOGSTRING2("CSchClientIndex::RestoreClientsL - restored client: %S", &client->ExecutorFileName());
1.705 + }
1.706 + CleanupStack::PopAndDestroy(dictionary);
1.707 + }
1.708 +
1.709 +TStreamId CSchClientIndex::CreateEmptyIndexL(CStreamStore& aStore) const
1.710 + {
1.711 + CSchClientDictionary* dictionary = CSchClientDictionary::NewLC();
1.712 + RStoreWriteStream stream;
1.713 + TStreamId id = stream.CreateLC(aStore);
1.714 + stream << *dictionary;
1.715 + stream.CommitL();
1.716 + CleanupStack::PopAndDestroy(2); // stream, dictionary
1.717 + return id;
1.718 + }
1.719 +
1.720 +void CSchClientIndex::AddL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
1.721 + {
1.722 + RStoreWriteStream stream;
1.723 + TStreamId id = stream.CreateLC(aStore);
1.724 + stream << aClient;
1.725 + stream.CommitL();
1.726 + CleanupStack::PopAndDestroy(); // stream
1.727 +
1.728 + // Read the dictionary and update an entry
1.729 + CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.730 + dictionary->AssignL(aClient.ExecutorFileName(), id);
1.731 +
1.732 + // Store the dictionary
1.733 + StoreDictionaryL(aStore, *dictionary, aIndexStream);
1.734 + CleanupStack::PopAndDestroy(dictionary);
1.735 + }
1.736 +
1.737 +void CSchClientIndex::EditL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
1.738 + {
1.739 + // Locate the existing stream (to be replaced)
1.740 + CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.741 + TStreamId id = dictionary->AtL(aClient.ExecutorFileName());
1.742 + CleanupStack::PopAndDestroy(dictionary);
1.743 + if (id == KNullStreamId)
1.744 + {
1.745 + // Wasn't found, add it instead...
1.746 + AddL(aIndexStream, aStore, aClient);
1.747 + }
1.748 + else
1.749 + {
1.750 + // Replace - the original stream is orphaned but the new
1.751 + // stream retains the old id.
1.752 + RStoreWriteStream stream;
1.753 + stream.ReplaceLC(aStore, id);
1.754 + stream << aClient;
1.755 + stream.CommitL();
1.756 + CleanupStack::PopAndDestroy(); // stream
1.757 + }
1.758 + }
1.759 +
1.760 +void CSchClientIndex::DeleteL(TStreamId aIndexStream, CStreamStore& aStore, const CClientProxy& aClient)
1.761 + {
1.762 + // Locate the existing stream (to be deleted)
1.763 + CSchClientDictionary* dictionary = DictionaryLC(aStore, aIndexStream);
1.764 + TStreamId id = dictionary->AtL(aClient.ExecutorFileName());
1.765 + __ASSERT_ALWAYS(id != KNullStreamId, SchBackupManagerUtils::Panic(SchBackupManagerUtils::ESchBackupManagerScheduleStreamToDeleteNotFound));
1.766 +
1.767 + // Remove the stream
1.768 + aStore.DeleteL(id);
1.769 +
1.770 + // Save changes to store - we have to do this here since
1.771 + // we must assure that the store is fully updated before
1.772 + // we remove this stream from the dictionary (in order to
1.773 + // maintain integrity).
1.774 + aStore.CommitL();
1.775 +
1.776 + // Remove entry from the stream dictionary
1.777 + dictionary->RemoveL(aClient.ExecutorFileName());
1.778 + StoreDictionaryL(aStore, *dictionary, aIndexStream);
1.779 + CleanupStack::PopAndDestroy(dictionary);
1.780 + }
1.781 +
1.782 +CSchClientIndex::CSchClientDictionary* CSchClientIndex::DictionaryLC(CStreamStore& aStore, TStreamId aIndexStream)
1.783 + {
1.784 + LOGSTRING("CSchClientIndex::DictionaryLC - restoring dictionary");
1.785 + CSchClientDictionary* dictionary = CSchClientDictionary::NewLC();
1.786 + RStoreReadStream stream;
1.787 + stream.OpenLC(aStore, aIndexStream);
1.788 + stream >> *dictionary;
1.789 + CleanupStack::PopAndDestroy(); // stream
1.790 + LOGSTRING("CSchClientIndex::DictionaryLC - dictionary restored");
1.791 + return dictionary;
1.792 + }
1.793 +
1.794 +void CSchClientIndex::StoreDictionaryL(CStreamStore& aStore, const CSchClientDictionary& aDictionary, TStreamId aStreamToReplace)
1.795 + {
1.796 + LOGSTRING("CSchClientIndex::DictionaryLC - storing dictionary");
1.797 + RStoreWriteStream stream;
1.798 + stream.ReplaceLC(aStore, aStreamToReplace);
1.799 + stream << aDictionary;
1.800 + stream.CommitL();
1.801 + CleanupStack::PopAndDestroy(); // stream
1.802 + LOGSTRING("CSchClientIndex::DictionaryLC - dictionary stored");
1.803 + }
1.804 +
1.805 +//
1.806 +// -----> TKeyArrayPtr (header)
1.807 +//
1.808 +NONSHARABLE_CLASS(TKeyArrayMapping) : public TKeyArrayFix
1.809 +{
1.810 +public:
1.811 + inline TKeyArrayMapping(TInt aOffset) : TKeyArrayFix(aOffset, TKeyCmpText()) {iHBufType=ETrue;}
1.812 + //
1.813 + virtual TAny* At(TInt aIndex) const;
1.814 + virtual TInt Compare(TInt aLeft,TInt aRight) const;
1.815 +
1.816 +private:
1.817 + TBool iHBufType;
1.818 + };
1.819 +
1.820 +TAny* TKeyArrayMapping::At(TInt aIndex) const
1.821 + {
1.822 + if (aIndex==KIndexPtr)
1.823 + {
1.824 + const CSchClientIndex::CSchClientMapplet** ppItem = (const CSchClientIndex::CSchClientMapplet**) iPtr;
1.825 + const CSchClientIndex::CSchClientMapplet* pItem = *ppItem;
1.826 + return (TAny*) pItem;
1.827 + }
1.828 + else
1.829 + {
1.830 + TInt baseOffset = aIndex * sizeof(const CSchClientIndex::CSchClientMapplet*);
1.831 + const TUint8* pItemUncast = iBase->Ptr(baseOffset).Ptr();
1.832 + const CSchClientIndex::CSchClientMapplet** ppItem = (const CSchClientIndex::CSchClientMapplet**) pItemUncast;
1.833 + const CSchClientIndex::CSchClientMapplet* pItem = *ppItem;
1.834 + return (TAny*) pItem;
1.835 + }
1.836 + }
1.837 +
1.838 +TInt TKeyArrayMapping::Compare(TInt aLeft,TInt aRight) const
1.839 + {
1.840 + if (iHBufType)
1.841 + {
1.842 + const CSchClientIndex::CSchClientMapplet* left = (const CSchClientIndex::CSchClientMapplet*) At(aLeft);
1.843 + const CSchClientIndex::CSchClientMapplet* right = (const CSchClientIndex::CSchClientMapplet*) At(aRight);
1.844 +
1.845 + return (left->Key().Compare(right->Key()));
1.846 + }
1.847 + else
1.848 + User::Invariant();
1.849 + return KErrNotFound;
1.850 + }
1.851 +
1.852 +//
1.853 +// -----> CSchClientIndex::CSchClientMapplet (header)
1.854 +//
1.855 +
1.856 +CSchClientIndex::CSchClientMapplet::~CSchClientMapplet()
1.857 + {
1.858 + delete iKey;
1.859 + }
1.860 +
1.861 +CSchClientIndex::CSchClientMapplet* CSchClientIndex::CSchClientMapplet::NewLC(RReadStream& aStream)
1.862 + {
1.863 + CSchClientMapplet* self = new(ELeave) CSchClientMapplet;
1.864 + CleanupStack::PushL(self);
1.865 + aStream >> *self;
1.866 + return self;
1.867 + }
1.868 +
1.869 +CSchClientIndex::CSchClientMapplet* CSchClientIndex::CSchClientMapplet::NewLC(const TDesC& aKey, TStreamId aStream)
1.870 + {
1.871 + CSchClientMapplet* self = new(ELeave) CSchClientMapplet;
1.872 + CleanupStack::PushL(self);
1.873 + self->iKey = aKey.AllocL();
1.874 + self->iStream = aStream;
1.875 + return self;
1.876 + }
1.877 +
1.878 +void CSchClientIndex::CSchClientMapplet::InternalizeL(RReadStream& aStream)
1.879 + {
1.880 + HBufC* key = HBufC::NewLC(aStream, KMaxTInt);
1.881 + delete iKey;
1.882 + iKey = key;
1.883 + CleanupStack::Pop(); // key
1.884 + aStream >> iStream;
1.885 + }
1.886 +
1.887 +void CSchClientIndex::CSchClientMapplet::ExternalizeL(RWriteStream& aStream) const
1.888 + {
1.889 + aStream << *iKey;
1.890 + aStream << iStream;
1.891 + }
1.892 +
1.893 +
1.894 +//
1.895 +// -----> CSchClientIndex::CSchClientDictionary (header)
1.896 +//
1.897 +
1.898 +CSchClientIndex::CSchClientDictionary::CSchClientDictionary()
1.899 + {
1.900 + }
1.901 +
1.902 +CSchClientIndex::CSchClientDictionary::~CSchClientDictionary()
1.903 + {
1.904 + if(iMappings)
1.905 + {
1.906 + for(int index = 0; index < iMappings->Count();index++)
1.907 + {
1.908 + delete iMappings->At(index);
1.909 + }
1.910 + delete iMappings;
1.911 + }
1.912 + }
1.913 +
1.914 +void CSchClientIndex::CSchClientDictionary::ConstructL()
1.915 + {
1.916 + const TInt KGranularity = 2;
1.917 + iMappings = new(ELeave) CArrayPtrSeg<CSchClientMapplet>(KGranularity);
1.918 + }
1.919 +
1.920 +CSchClientIndex::CSchClientDictionary* CSchClientIndex::CSchClientDictionary::NewLC()
1.921 + {
1.922 + CSchClientDictionary* self = new(ELeave) CSchClientDictionary();
1.923 + CleanupStack::PushL(self);
1.924 + self->ConstructL();
1.925 + return self;
1.926 + }
1.927 +
1.928 +void CSchClientIndex::CSchClientDictionary::AssignL(const TDesC& aKey, TStreamId aId)
1.929 + {
1.930 + if (aId == KNullStreamId)
1.931 + {
1.932 + RemoveL(aKey); // default associated stream is null
1.933 + return;
1.934 + }
1.935 +
1.936 + CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
1.937 + TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
1.938 + TInt i;
1.939 + if (iMappings->FindIsq(entry, key, i) == 0)
1.940 + {
1.941 + iMappings->At(i)->SetStream(aId);
1.942 + CleanupStack::PopAndDestroy(); // entry
1.943 + return;
1.944 + }
1.945 +
1.946 + entry->SetStream(aId);
1.947 + iMappings->InsertIsqL(entry, key);
1.948 + CleanupStack::Pop(); // entry
1.949 + }
1.950 +
1.951 +void CSchClientIndex::CSchClientDictionary::RemoveL(const TDesC& aKey)
1.952 + {
1.953 + CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
1.954 + TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
1.955 + TInt i;
1.956 + if (iMappings->FindIsq(entry, key, i) == 0)
1.957 + {
1.958 + delete iMappings->At(i);
1.959 + iMappings->Delete(i);
1.960 + }
1.961 + CleanupStack::PopAndDestroy(); // entry
1.962 + }
1.963 +
1.964 +TInt CSchClientIndex::CSchClientDictionary::Count() const
1.965 + {
1.966 + return iMappings->Count();
1.967 + }
1.968 +
1.969 +TStreamId CSchClientIndex::CSchClientDictionary::AtL(const TDesC& aKey) const
1.970 + {
1.971 + CSchClientMapplet* entry = CSchClientMapplet::NewLC(aKey, KNullStreamId);
1.972 + TKeyArrayMapping key(CSchClientMapplet::KeyOffset());
1.973 + TInt i;
1.974 + TInt found = iMappings->FindIsq(entry, key, i);
1.975 + CleanupStack::PopAndDestroy(); // entry
1.976 + if (found != 0)
1.977 + return KNullStreamId;
1.978 + return iMappings->At(i)->Stream();
1.979 + }
1.980 +
1.981 +TStreamId CSchClientIndex::CSchClientDictionary::AtIndex(TInt aIndex) const
1.982 + {
1.983 + return iMappings->At(aIndex)->Stream();
1.984 + }
1.985 +
1.986 +void CSchClientIndex::CSchClientDictionary::InternalizeL(RReadStream& aStream)
1.987 + {
1.988 + const TInt count = aStream.ReadInt32L();
1.989 + for(TInt i=0; i<count; i++)
1.990 + {
1.991 + CSchClientMapplet* mapplet = CSchClientMapplet::NewLC(aStream);
1.992 + iMappings->AppendL(mapplet);
1.993 + CleanupStack::Pop(); // mapplet
1.994 + }
1.995 + }
1.996 +
1.997 +void CSchClientIndex::CSchClientDictionary::ExternalizeL(RWriteStream& aStream) const
1.998 + {
1.999 + const TInt count = iMappings->Count();
1.1000 + aStream.WriteInt32L(count);
1.1001 + for(TInt i=0; i<count; i++)
1.1002 + aStream << *iMappings->At(i);
1.1003 + }