1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/cenrepsrv/shrepos.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,282 @@
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 +#ifndef SHREPOS_H
1.20 +#define SHREPOS_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include "obsrvr_noc.h"
1.24 +#include "srvres.h"
1.25 +#include "srvdefs.h"
1.26 +#include "setting.h"
1.27 +#include "clientrequest.h"
1.28 +#include "panic.h"
1.29 +#include "transstate.h"
1.30 +#include "inifile.h"
1.31 +#include "rstrepos.h"
1.32 +#include "datatype.h"
1.33 +#include "heaprepos.h"
1.34 +
1.35 +class CRepositoryTransactor;
1.36 +
1.37 +class CSharedRepository : public CBase
1.38 + {
1.39 + friend class CObservable;
1.40 + friend class CServerRepository;
1.41 + friend class TConvToolTester;
1.42 +
1.43 +public:
1.44 + static CSharedRepository* NewL(TUid aUid);
1.45 + ~CSharedRepository();
1.46 +
1.47 + TUid Uid() const;
1.48 +
1.49 + TInt CommitChanges(TCentRepLocation aLocation = EPersists);
1.50 + void CommitChangesL(TCentRepLocation aLocation = EPersists)
1.51 + {
1.52 + User::LeaveIfError(CommitChanges(aLocation));
1.53 + }
1.54 +
1.55 + void CreateL(TServerSetting& s, TSettingsAccessPolicy* &aPolicy, TBool aFirstLoad, TBool aSingleMetaFound=EFalse);
1.56 +
1.57 + void SetMetaDataOnRead(TServerSetting& aSetting, TBool aSingleMetaFound);
1.58 +
1.59 + void SetMetaDataOnCreate(TServerSetting& aNewSetting, TUint32* aMeta);
1.60 +
1.61 + TInt DeleteAndPersist(TUint32 aId);
1.62 + TInt DeleteNoPersist(TUint32 aId);
1.63 +
1.64 + TInt ResetNoPersistL(TServerSetting& aSetting);
1.65 + void ResetAndPersistL(TServerSetting& aSetting);
1.66 + TInt ResetAllNoPersistL(CSharedRepository& aRepository);
1.67 +
1.68 + const TSecurityPolicy& GetFallbackReadAccessPolicy(TUint32 aId);
1.69 + inline const TSecurityPolicy& GetReadAccessPolicy(const TServerSetting& aSetting);
1.70 + inline const TSecurityPolicy& GetReadAccessPolicy(TUint32 aId);
1.71 + inline const TSecurityPolicy& GetDefaultReadAccessPolicy();
1.72 +
1.73 + const TSecurityPolicy& GetFallbackWriteAccessPolicy(TUint32 aId);
1.74 + inline const TSecurityPolicy& GetWriteAccessPolicy(const TServerSetting& aSetting);
1.75 + inline const TSecurityPolicy& GetWriteAccessPolicy(TUint32 aId);
1.76 + inline const TSecurityPolicy& GetDefaultWriteAccessPolicy();
1.77 +
1.78 + TSettingsAccessPolicy* GetFallbackAccessPolicy(TUint32 aId
1.79 +#ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
1.80 + ,TBool aSkipSingle=EFalse
1.81 +#endif
1.82 + );
1.83 +
1.84 + TInt StartTransaction(CRepositoryTransactor& aTransactor, TInt aMode);
1.85 + TInt CommitTransaction(CRepositoryTransactor& aTransactor, TUint32& aKeyInfo);
1.86 + TInt FailTransaction(CRepositoryTransactor& aTransactor, TInt aError, TUint32 aErrorKey);
1.87 + void FailAllTransactions(const CRepositoryTransactor* aExcludeTransactor);
1.88 + TInt AttemptPromoteTransactionToReadWrite(CRepositoryTransactor& aTransactor);
1.89 + TBool IsTransactionActive();
1.90 +
1.91 + void MergeL(CSharedRepository& aInstallRep, TMergeType aMergeType);
1.92 +#ifndef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
1.93 + TInt FindLocationForFileL(TCentRepLocation& aLocation,TUid aUid,const TCentRepFileType aType) const;
1.94 +#endif
1.95 +
1.96 + void HandleUpdateMergeL(TTime aInstallFileTimeStamp, CSharedRepository& aInstallRep);
1.97 + void HandleDeleteMergeL(CSharedRepository& aRomRep);
1.98 + void SetInstallTime(TTime aInstallTime);
1.99 +
1.100 + inline TUid Owner() {return iSimRep->Owner(); }
1.101 + inline void WriteBackupStream(RWriteStream& aStream) const;
1.102 + inline void WriteDeletedSettingsStream(RWriteStream& aStream) const;
1.103 + inline void InternalizeL(RReadStream& aStream, CRestoredRepository& aRstRepos) ;
1.104 + void ExternalizeCre(RWriteStream& aStream) const;
1.105 + void InternalizeCreL(RReadStream& aStream) ;
1.106 +#ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
1.107 + void InternalizeCreL(RReadStream& aStream,TUint8& aCreVersion);
1.108 +#endif
1.109 + TInt ReloadContentL(CIniFileIn& aIniFile, TBool aFirstLoad = EFalse);
1.110 +#ifdef CENTREP_CONV_TOOL
1.111 + void DoCommitChangesToIniFileL(const TDesC& aOutFileName
1.112 +#ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
1.113 + ,TUint32 aCreVersion
1.114 +#endif
1.115 + );
1.116 +#endif
1.117 + inline void SetSize(TInt aSize);
1.118 + inline TInt Size() const;
1.119 +
1.120 +private:
1.121 +
1.122 + void ResetContent();
1.123 + void RestoreConsistencyL();
1.124 + void DoRestoreConsistencyL();
1.125 + TInt CreateRepositoryFromCreFileL(TCentRepLocation aLocation);
1.126 + TInt ReadSettingSavePolicyL(CIniFileIn& aFile,TServerSetting& aSetting, TSettingsAccessPolicy* &aPolicy, TBool& aSingleMetaFound);
1.127 + TInt DoCommitTransactionSettings(CRepositoryTransactor& aTransactor, TUint32& aKeyInfo);
1.128 + void Notify(TUint32 aVal) const;
1.129 +
1.130 + RSettingsArray& GetSettings();
1.131 + CSharedRepository();
1.132 + void ConstructL(TUid aUid);
1.133 +
1.134 +#ifdef FOTA_UNIT_TESTING
1.135 +public:
1.136 + void SetUid(TUid aUid)
1.137 + {
1.138 + iSimRep->SetUid(aUid);
1.139 + }
1.140 +#endif
1.141 + CHeapRepository* iSimRep;
1.142 +
1.143 + TInt32 iSize; //approximate size(in memory) of the repository after internalisation
1.144 + TBool iNotificationState;//Notification can be made if iNotificationState is non-zero,
1.145 + //otherwise the notification is disabled
1.146 +
1.147 + //iInconsistentData data flag will be set at the beginning of CommitChangesL()
1.148 + //and reset at the end of it. The flag is used to implement lazy-load approach for the
1.149 + //repository - if CommitChangesL() fails, the in-memory representation of the repository
1.150 + //won't match the updated by CommitChangesL() repository (ini) file. The repository
1.151 + //consistency has to be restored before any next call of CSharedRepository methods.
1.152 + TBool iInconsistentData;
1.153 + };
1.154 +
1.155 +/**
1.156 +@internalTechnology
1.157 +Base class for CServerRepository and other objects that may be in transactions with the
1.158 +shared repository. Contains a double queue link so the shared repository can build a queue
1.159 +of them. In order to use transactions in the shared repository, the object needs to supply a
1.160 +CRepositoryTransactor - either itself or a member variable. This makes it possible to
1.161 +prevent one transactor from closing another's transaction.
1.162 +Stores transaction state and changes made during the transaction.
1.163 +Also stores RMessage2 while pending async start or commit, and handles its completion.
1.164 +*/
1.165 +class CRepositoryTransactor : public CBase
1.166 + {
1.167 + // shared repository may set private transaction state, but not derived classes
1.168 + friend class CSharedRepository;
1.169 + // for the _FOFF macro to work
1.170 + friend class CObservable::TSharedRepositoryInfo;
1.171 + friend class CObservable;
1.172 +public:
1.173 +
1.174 + inline TInt TransactionState() const
1.175 + {
1.176 + return iTransactionState;
1.177 + }
1.178 + inline TInt TransactionMode() const
1.179 + {
1.180 + return iTransactionState & EAllTransactionModeBits;
1.181 + }
1.182 + inline TBool IsInTransaction() const
1.183 + {
1.184 + return iTransactionState != ENoTransaction;
1.185 + }
1.186 + inline TBool IsInActiveTransaction() const
1.187 + {
1.188 + // transaction is active if no bits apart from the (non-zero) mode are set
1.189 + return (iTransactionState != ENoTransaction) && (TransactionMode() == iTransactionState);
1.190 + }
1.191 + inline TBool IsInActiveReadTransaction() const
1.192 + {
1.193 + return iTransactionState == EReadTransaction;
1.194 + }
1.195 + inline TBool IsInActiveConcurrentReadWriteTransaction() const
1.196 + {
1.197 + return (iTransactionState == EConcurrentReadWriteTransaction);
1.198 + }
1.199 + inline TBool IsInActiveExclusiveReadWriteTransaction() const
1.200 + {
1.201 + return (iTransactionState == EReadWriteTransaction);
1.202 + }
1.203 + inline TBool IsInActiveReadWriteTransaction() const
1.204 + {
1.205 + return (iTransactionState == EReadWriteTransaction)
1.206 + || (iTransactionState == EConcurrentReadWriteTransaction);
1.207 + }
1.208 + inline TBool IsInFailedTransaction() const
1.209 + {
1.210 + return (iTransactionState & EFailedBit) != 0;
1.211 + }
1.212 +
1.213 +protected:
1.214 + inline void ClearSettings()
1.215 + {
1.216 + iTransactionSettings.Reset();
1.217 + }
1.218 +
1.219 +private:
1.220 + inline void SetFailed(TInt aError, TUint32 aErrorKey)
1.221 + {
1.222 + // don't want to fail more than once
1.223 + ASSERT(IsInActiveTransaction());
1.224 + ASSERT(aError != KErrNone); // must fail for a reason
1.225 + iTransactionState |= EFailedBit;
1.226 + ClearSettings();
1.227 + iTransactionResult = aError;
1.228 + iTransactionErrorKey = aErrorKey;
1.229 + }
1.230 + inline void PromoteToExclusiveReadWrite()
1.231 + {
1.232 + ASSERT(iTransactionState == EReadTransaction);
1.233 + iTransactionState = EReadWriteTransaction;
1.234 + ClearSettings();
1.235 + }
1.236 + inline void AddToQueue(TSglQue<CRepositoryTransactor>& aTransactors, TInt aMode)
1.237 + {
1.238 + ASSERT(!IsInTransaction());
1.239 + // if the following ASSERT fails, transactor is already in a queue
1.240 + ASSERT(iLink.iNext == NULL);
1.241 + aTransactors.AddLast(*this);
1.242 + iTransactionState = aMode;
1.243 + // check adding to queue in an active state
1.244 + ASSERT(IsInActiveTransaction());
1.245 + ClearSettings();
1.246 + // clear failure reasons
1.247 + iTransactionResult = KErrNone;
1.248 + iTransactionErrorKey = KUnspecifiedKey;
1.249 + }
1.250 + inline void Deque()
1.251 + {
1.252 + iTransactionState = ENoTransaction;
1.253 + ClearSettings();
1.254 + delete iIniRep;
1.255 + iIniRep = NULL;
1.256 + }
1.257 +
1.258 +protected:
1.259 + // derived classes are free to change transaction settings.
1.260 + // these can be made persistent by committing write transaction
1.261 + RSettingsArray iTransactionSettings;
1.262 +
1.263 + // 'Create' needs to check the default (INI) file to see if the
1.264 + // key position has a setting defined. If that is the case,
1.265 + // the new setting uses meta defined for the original setting
1.266 + // in the INI file.
1.267 + // Store data read from INI here so that we only read the INI
1.268 + // once per transaction.
1.269 + CSharedRepository* iIniRep;
1.270 +
1.271 +private:
1.272 + // A queue link used by the CSharedRepository the CTransactor is working on
1.273 + TSglQueLink iLink;
1.274 + // integer encoding transaction state using definition of TTransactionState
1.275 + TInt iTransactionState;
1.276 + // result to be returned by commit if transaction failed earlier
1.277 + TInt iTransactionResult;
1.278 + // if transaction failed earlier, key or partial key involved in the original error,
1.279 + // or KUnspecifiedKey if could not be attributed to just one.
1.280 + TUint32 iTransactionErrorKey;
1.281 + };
1.282 +
1.283 +#include "shrepos.inl"
1.284 +
1.285 +#endif // SHREPOS_H