1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/cenrepsrv/backup.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,230 @@
1.4 +// Copyright (c) 1997-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 +/**
1.20 + @internalTechnology
1.21 +*/
1.22 +
1.23 +#ifndef BACKUP_H
1.24 +#define BACKUP_H
1.25 +
1.26 +#include <e32base.h>
1.27 +#include <f32file.h>
1.28 +#include <e32property.h>
1.29 +#include <connect/abclient.h>
1.30 +#include "sessnotf.h"
1.31 +#include "srvrepos_noc.h"
1.32 +#include "rstrepos.h"
1.33 +
1.34 +typedef RPointerArray<CRestoredRepository> RRestoredRepositoriesArray ;
1.35 +
1.36 +using namespace conn ;
1.37 +
1.38 +const TUint KArbitraryNumber = 1024 ;
1.39 +const TUint32 KBackupStreamVersion = 1 ;
1.40 +
1.41 +// Bitfield representing backup stream features present in the
1.42 +// incoming backup stream.
1.43 +enum TBackupExtensions
1.44 + {
1.45 + ENoBackupExtensions = 0x00000000,
1.46 + EDeletedKeysSupported = 0x00000001,
1.47 + EInstalledKeysSupported = 0x00000002
1.48 + };
1.49 +
1.50 +// Backup stream extension features supported by this version of central
1.51 +// repository backup/restore - OR together bitwise values defined in
1.52 +// TBackupExtensions to get correct value!
1.53 +const TUint32 KBackupExtensionsSupported = EDeletedKeysSupported | EInstalledKeysSupported;
1.54 +
1.55 +class TRepositoryBackupStreamHeader
1.56 + {
1.57 +public :
1.58 + inline TRepositoryBackupStreamHeader(TStreamId aIndexStreamId) ;
1.59 + inline TRepositoryBackupStreamHeader();
1.60 + inline void ExternalizeL(RWriteStream& aStream) const;
1.61 + inline void InternalizeL(RReadStream& aStream);
1.62 + inline TUid getUid();
1.63 + inline TStreamId getIndexStreamId() ;
1.64 + inline TUint32 getVersion();
1.65 + inline TUint32 getBackupExtensionsSupported();
1.66 +
1.67 +private :
1.68 + TUid iBackupStreamUid ;
1.69 + TUint32 iBackupStreamVersion ;
1.70 + TStreamId iIndexStreamId ;
1.71 + TUint32 iBackupExtensionsSupported ;
1.72 +
1.73 + // Reserved for future expansion
1.74 + TUint32 iReserved1 ;
1.75 + TUint32 iReserved2 ;
1.76 + TUint32 iReserved3 ;
1.77 + TUint32 iReserved4 ;
1.78 + };
1.79 +
1.80 +//
1.81 +// Backup stream index class - Used to hold association between a UID (in
1.82 +// our case the UID of a repository) and a stream ID - Can't use CStreamDictionary
1.83 +// because that only lets you retrieve stream IDs by a (previously known) UID rather
1.84 +// than iterate through its contents retrieving UID/StreamID pairs...
1.85 +//
1.86 +
1.87 +class TRepositoryBackupStreamIndexElement
1.88 + {
1.89 +
1.90 +public :
1.91 + inline void Set (TUid aUid, TStreamId aSettingsStream, TStreamId aDeletedSettingsStream, TStreamId aInstalledSettingsStream) ;
1.92 + inline void SetDeletedSettingsStream (TStreamId aDeletedSettingsStream) ;
1.93 + inline void Get (TUid& aUid, TStreamId& aSettingsStreamId, TStreamId& aDeletedSettingsStreamId, TStreamId& aInstalledSettingsStream) ;
1.94 + inline void GetDeletedSettingsStream (TStreamId& aDeletedSettingsStream) ;
1.95 + inline void ExternalizeL(RWriteStream& aStream) const;
1.96 + inline void InternalizeL(RReadStream& aStream, TUint32 aBackupStreamExtensions = ENoBackupExtensions);
1.97 +
1.98 +private:
1.99 + TUid iUid ;
1.100 + TStreamId iSettingsStream ;
1.101 + TStreamId iDeletedSettingsStream ;
1.102 + TStreamId iInstalledSettingsStream ;
1.103 + };
1.104 +
1.105 +class CRepositoryBackupStreamIndex : public CBase
1.106 + {
1.107 +public:
1.108 + inline static CRepositoryBackupStreamIndex* NewL() ;
1.109 + inline static CRepositoryBackupStreamIndex* NewLC();
1.110 + inline ~CRepositoryBackupStreamIndex();
1.111 + inline void Close(void) ;
1.112 +
1.113 + void AddL(TUid aUid, TStreamId aSettingStreamId, TStreamId aDeletedSettingsStreamId, TStreamId aInstalledSettingsStreamId) ;
1.114 + TInt GetNext(TUid& aUid, TStreamId& aSettingsStreamId, TStreamId& aDeletedSettingsStreamId, TStreamId& aInstalledSettingsStreamId) ;
1.115 + inline void Reset();
1.116 + inline void ExternalizeL(RWriteStream& aStream) const;
1.117 + inline void InternalizeL(RReadStream& aStream, TUint32 aBackupStreamExtensions = ENoBackupExtensions);
1.118 +
1.119 +private:
1.120 + inline CRepositoryBackupStreamIndex(){} ;
1.121 +
1.122 +private:
1.123 + TInt iIndex ;
1.124 + RArray<TRepositoryBackupStreamIndexElement> iStreamIndex ;
1.125 + };
1.126 +
1.127 +
1.128 +enum TRepositoryBackupState
1.129 +{
1.130 + ENoBackupActivty,
1.131 + EBackupInProgress,
1.132 + ERestoreInProgress
1.133 +};
1.134 +
1.135 +//
1.136 +// Backup client class.
1.137 +//
1.138 +// Has Active object functionality to monitor the state of the publish and subscribe
1.139 +// flags associated with backup and restore and also implements MActiveBackupDataClient
1.140 +// to perform active backup according to the "proxy data holder" model.
1.141 +//
1.142 +class CRepositoryBackupClient : public CActive, public MActiveBackupDataClient
1.143 + {
1.144 +public:
1.145 + static CRepositoryBackupClient* NewL(RFs& aFs);
1.146 + static CRepositoryBackupClient* NewLC(RFs& aFs);
1.147 + inline static TRepositoryBackupState GetBackupStatus(void) {return iBackupStatus;} ;
1.148 +
1.149 + CRepositoryBackupClient(RFs& aFs);
1.150 + ~CRepositoryBackupClient();
1.151 + void ConstructL();
1.152 + void StartL();
1.153 + void NotifyChange();
1.154 +
1.155 + // Implementations of virtual functions inherited from MActiveBackupDataClient
1.156 + void AllSnapshotsSuppliedL();
1.157 + void ReceiveSnapshotDataL(TDriveNumber aDrive, TDesC8& aBuffer, TBool aLastSection);
1.158 + TUint GetExpectedDataSize(TDriveNumber aDrive);
1.159 + void GetSnapshotDataL(TDriveNumber aDrive, TPtr8& aBuffer, TBool& aFinished);
1.160 + void InitialiseGetBackupDataL(TDriveNumber aDrive);
1.161 + void GetBackupDataSectionL(TPtr8& aBuffer, TBool& aFinished);
1.162 +
1.163 + void InitialiseGetProxyBackupDataL(TSecureId aSID, TDriveNumber aDrive) ;
1.164 + void InitialiseRestoreProxyBaseDataL(TSecureId aSID, TDriveNumber aDrive) ;
1.165 +
1.166 + void InitialiseRestoreBaseDataL(TDriveNumber aDrive);
1.167 + void RestoreBaseDataSectionL(TDesC8& aBuffer, TBool aFinished);
1.168 + void InitialiseRestoreIncrementDataL(TDriveNumber aDrive);
1.169 + void RestoreIncrementDataSectionL(TDesC8& aBuffer, TBool aFinished);
1.170 + void RestoreComplete(TDriveNumber aDrive);
1.171 +
1.172 + void TerminateMultiStageOperation();
1.173 + TUint GetDataChecksum(TDriveNumber aDrive);
1.174 + void CompleteOwnerIdLookupTableL();
1.175 +
1.176 + void RestoreRepositoryAndListL(TUid repositoryUid, CDirectFileStore* store, TStreamId settingsStreamId, TStreamId deletedSettingsStreamId,TInt& repIndex);
1.177 +
1.178 +private:
1.179 + // Usual active object stuff
1.180 + void RunL() ;
1.181 + void DoCancel() ;
1.182 + TInt RunError(TInt aError) ;
1.183 +
1.184 + void TestBURstatusL(void) ;
1.185 +
1.186 + // Leaving version of RestoreComplete to make it a bit easier
1.187 + // for us to handle cleanup...
1.188 + void RestoreCompleteL();
1.189 +
1.190 + TInt AddRestoredRepositoryL(TUid aUid);
1.191 +
1.192 +private:
1.193 + enum TBackupDirectoryScan
1.194 + {
1.195 + EScanRom,
1.196 + EScanInstall,
1.197 + EScanPersist
1.198 + };
1.199 +
1.200 +private:
1.201 + // Used to open a repository for backup and/or restore
1.202 + CServerRepository* iRepository ;
1.203 +
1.204 + CSessionNotifier* iNotifier ;
1.205 +
1.206 + // Used to subscribe to Backup/Restore flag
1.207 + RProperty iBackupRestoreProperty ;
1.208 +
1.209 + // File server session used to get directory listings
1.210 + RFs& iFs;
1.211 + RFile iFile ;
1.212 +
1.213 + // Secure ID being restored
1.214 + TSecureId iSid ;
1.215 +
1.216 + // Active backup client to register with BUR engine
1.217 + CActiveBackupClient* iActiveBackupClient ;
1.218 +
1.219 + TBool iRomScanDone;
1.220 + // Current state (backup in proress, restore in progress, etc, etc, etc)
1.221 + static TRepositoryBackupState iBackupStatus ;
1.222 +
1.223 + // Features supported by Backup Stream
1.224 + TUint32 iBackupExtensionsSupported ;
1.225 +
1.226 + // The list of the restored repositories
1.227 + RRestoredRepositoriesArray iRestoredRepositoriesArray ;
1.228 + };
1.229 +
1.230 +
1.231 +#include "backup.inl"
1.232 +
1.233 +#endif // BACKUP_H