sl@0: // Copyright (c) 1997-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: /** sl@0: @internalTechnology sl@0: */ sl@0: sl@0: #ifndef BACKUP_H sl@0: #define BACKUP_H sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include "sessnotf.h" sl@0: #include "srvrepos_noc.h" sl@0: #include "rstrepos.h" sl@0: sl@0: typedef RPointerArray RRestoredRepositoriesArray ; sl@0: sl@0: using namespace conn ; sl@0: sl@0: const TUint KArbitraryNumber = 1024 ; sl@0: const TUint32 KBackupStreamVersion = 1 ; sl@0: sl@0: // Bitfield representing backup stream features present in the sl@0: // incoming backup stream. sl@0: enum TBackupExtensions sl@0: { sl@0: ENoBackupExtensions = 0x00000000, sl@0: EDeletedKeysSupported = 0x00000001, sl@0: EInstalledKeysSupported = 0x00000002 sl@0: }; sl@0: sl@0: // Backup stream extension features supported by this version of central sl@0: // repository backup/restore - OR together bitwise values defined in sl@0: // TBackupExtensions to get correct value! sl@0: const TUint32 KBackupExtensionsSupported = EDeletedKeysSupported | EInstalledKeysSupported; sl@0: sl@0: class TRepositoryBackupStreamHeader sl@0: { sl@0: public : sl@0: inline TRepositoryBackupStreamHeader(TStreamId aIndexStreamId) ; sl@0: inline TRepositoryBackupStreamHeader(); sl@0: inline void ExternalizeL(RWriteStream& aStream) const; sl@0: inline void InternalizeL(RReadStream& aStream); sl@0: inline TUid getUid(); sl@0: inline TStreamId getIndexStreamId() ; sl@0: inline TUint32 getVersion(); sl@0: inline TUint32 getBackupExtensionsSupported(); sl@0: sl@0: private : sl@0: TUid iBackupStreamUid ; sl@0: TUint32 iBackupStreamVersion ; sl@0: TStreamId iIndexStreamId ; sl@0: TUint32 iBackupExtensionsSupported ; sl@0: sl@0: // Reserved for future expansion sl@0: TUint32 iReserved1 ; sl@0: TUint32 iReserved2 ; sl@0: TUint32 iReserved3 ; sl@0: TUint32 iReserved4 ; sl@0: }; sl@0: sl@0: // sl@0: // Backup stream index class - Used to hold association between a UID (in sl@0: // our case the UID of a repository) and a stream ID - Can't use CStreamDictionary sl@0: // because that only lets you retrieve stream IDs by a (previously known) UID rather sl@0: // than iterate through its contents retrieving UID/StreamID pairs... sl@0: // sl@0: sl@0: class TRepositoryBackupStreamIndexElement sl@0: { sl@0: sl@0: public : sl@0: inline void Set (TUid aUid, TStreamId aSettingsStream, TStreamId aDeletedSettingsStream, TStreamId aInstalledSettingsStream) ; sl@0: inline void SetDeletedSettingsStream (TStreamId aDeletedSettingsStream) ; sl@0: inline void Get (TUid& aUid, TStreamId& aSettingsStreamId, TStreamId& aDeletedSettingsStreamId, TStreamId& aInstalledSettingsStream) ; sl@0: inline void GetDeletedSettingsStream (TStreamId& aDeletedSettingsStream) ; sl@0: inline void ExternalizeL(RWriteStream& aStream) const; sl@0: inline void InternalizeL(RReadStream& aStream, TUint32 aBackupStreamExtensions = ENoBackupExtensions); sl@0: sl@0: private: sl@0: TUid iUid ; sl@0: TStreamId iSettingsStream ; sl@0: TStreamId iDeletedSettingsStream ; sl@0: TStreamId iInstalledSettingsStream ; sl@0: }; sl@0: sl@0: class CRepositoryBackupStreamIndex : public CBase sl@0: { sl@0: public: sl@0: inline static CRepositoryBackupStreamIndex* NewL() ; sl@0: inline static CRepositoryBackupStreamIndex* NewLC(); sl@0: inline ~CRepositoryBackupStreamIndex(); sl@0: inline void Close(void) ; sl@0: sl@0: void AddL(TUid aUid, TStreamId aSettingStreamId, TStreamId aDeletedSettingsStreamId, TStreamId aInstalledSettingsStreamId) ; sl@0: TInt GetNext(TUid& aUid, TStreamId& aSettingsStreamId, TStreamId& aDeletedSettingsStreamId, TStreamId& aInstalledSettingsStreamId) ; sl@0: inline void Reset(); sl@0: inline void ExternalizeL(RWriteStream& aStream) const; sl@0: inline void InternalizeL(RReadStream& aStream, TUint32 aBackupStreamExtensions = ENoBackupExtensions); sl@0: sl@0: private: sl@0: inline CRepositoryBackupStreamIndex(){} ; sl@0: sl@0: private: sl@0: TInt iIndex ; sl@0: RArray iStreamIndex ; sl@0: }; sl@0: sl@0: sl@0: enum TRepositoryBackupState sl@0: { sl@0: ENoBackupActivty, sl@0: EBackupInProgress, sl@0: ERestoreInProgress sl@0: }; sl@0: sl@0: // sl@0: // Backup client class. sl@0: // sl@0: // Has Active object functionality to monitor the state of the publish and subscribe sl@0: // flags associated with backup and restore and also implements MActiveBackupDataClient sl@0: // to perform active backup according to the "proxy data holder" model. sl@0: // sl@0: class CRepositoryBackupClient : public CActive, public MActiveBackupDataClient sl@0: { sl@0: public: sl@0: static CRepositoryBackupClient* NewL(RFs& aFs); sl@0: static CRepositoryBackupClient* NewLC(RFs& aFs); sl@0: inline static TRepositoryBackupState GetBackupStatus(void) {return iBackupStatus;} ; sl@0: sl@0: CRepositoryBackupClient(RFs& aFs); sl@0: ~CRepositoryBackupClient(); sl@0: void ConstructL(); sl@0: void StartL(); sl@0: void NotifyChange(); sl@0: sl@0: // Implementations of virtual functions inherited from MActiveBackupDataClient sl@0: void AllSnapshotsSuppliedL(); sl@0: void ReceiveSnapshotDataL(TDriveNumber aDrive, TDesC8& aBuffer, TBool aLastSection); sl@0: TUint GetExpectedDataSize(TDriveNumber aDrive); sl@0: void GetSnapshotDataL(TDriveNumber aDrive, TPtr8& aBuffer, TBool& aFinished); sl@0: void InitialiseGetBackupDataL(TDriveNumber aDrive); sl@0: void GetBackupDataSectionL(TPtr8& aBuffer, TBool& aFinished); sl@0: sl@0: void InitialiseGetProxyBackupDataL(TSecureId aSID, TDriveNumber aDrive) ; sl@0: void InitialiseRestoreProxyBaseDataL(TSecureId aSID, TDriveNumber aDrive) ; sl@0: sl@0: void InitialiseRestoreBaseDataL(TDriveNumber aDrive); sl@0: void RestoreBaseDataSectionL(TDesC8& aBuffer, TBool aFinished); sl@0: void InitialiseRestoreIncrementDataL(TDriveNumber aDrive); sl@0: void RestoreIncrementDataSectionL(TDesC8& aBuffer, TBool aFinished); sl@0: void RestoreComplete(TDriveNumber aDrive); sl@0: sl@0: void TerminateMultiStageOperation(); sl@0: TUint GetDataChecksum(TDriveNumber aDrive); sl@0: void CompleteOwnerIdLookupTableL(); sl@0: sl@0: void RestoreRepositoryAndListL(TUid repositoryUid, CDirectFileStore* store, TStreamId settingsStreamId, TStreamId deletedSettingsStreamId,TInt& repIndex); sl@0: sl@0: private: sl@0: // Usual active object stuff sl@0: void RunL() ; sl@0: void DoCancel() ; sl@0: TInt RunError(TInt aError) ; sl@0: sl@0: void TestBURstatusL(void) ; sl@0: sl@0: // Leaving version of RestoreComplete to make it a bit easier sl@0: // for us to handle cleanup... sl@0: void RestoreCompleteL(); sl@0: sl@0: TInt AddRestoredRepositoryL(TUid aUid); sl@0: sl@0: private: sl@0: enum TBackupDirectoryScan sl@0: { sl@0: EScanRom, sl@0: EScanInstall, sl@0: EScanPersist sl@0: }; sl@0: sl@0: private: sl@0: // Used to open a repository for backup and/or restore sl@0: CServerRepository* iRepository ; sl@0: sl@0: CSessionNotifier* iNotifier ; sl@0: sl@0: // Used to subscribe to Backup/Restore flag sl@0: RProperty iBackupRestoreProperty ; sl@0: sl@0: // File server session used to get directory listings sl@0: RFs& iFs; sl@0: RFile iFile ; sl@0: sl@0: // Secure ID being restored sl@0: TSecureId iSid ; sl@0: sl@0: // Active backup client to register with BUR engine sl@0: CActiveBackupClient* iActiveBackupClient ; sl@0: sl@0: TBool iRomScanDone; sl@0: // Current state (backup in proress, restore in progress, etc, etc, etc) sl@0: static TRepositoryBackupState iBackupStatus ; sl@0: sl@0: // Features supported by Backup Stream sl@0: TUint32 iBackupExtensionsSupported ; sl@0: sl@0: // The list of the restored repositories sl@0: RRestoredRepositoriesArray iRestoredRepositoriesArray ; sl@0: }; sl@0: sl@0: sl@0: #include "backup.inl" sl@0: sl@0: #endif // BACKUP_H