1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/cenrepsrv/srvrepos_noc.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,341 @@
1.4 +// Copyright (c) 2006-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 SRVREPOS_H
1.20 +#define SRVREPOS_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include <s32file.h>
1.24 +#ifdef SYMBIAN_BAFL_SYSUTIL
1.25 +#include <bafl/sysutil.h>
1.26 +#endif
1.27 +#include "shrepos.h"
1.28 +#include "setting.h"
1.29 +#include "clientrequest.h"
1.30 +#include "sessnotf.h"
1.31 +#include "operations.h"
1.32 +#include "datatype.h"
1.33 +
1.34 +class MObserver;
1.35 +class CRestoredRepository;
1.36 +
1.37 +class CServerRepository : public CRepositoryTransactor, public MOperationLogic
1.38 + {
1.39 +public:
1.40 + void OpenL(TUid aUid, MObserver& aObserver, TBool aFailIfNotFound = ETrue);
1.41 + void HandleOpenMergeL();
1.42 + void Close();
1.43 + void RestoreNotify(const CRestoredRepository& aRstRepos);
1.44 + TInt RFSRepositoryL();
1.45 +#ifdef SYMBIAN_BAFL_SYSUTIL
1.46 + static void CheckROMReflashL();
1.47 +#endif
1.48 + static void RFSAllRepositoriesL();
1.49 +
1.50 + inline TInt StartTransaction(TInt aMode)
1.51 + {
1.52 + return iRepository->StartTransaction(*this, aMode);
1.53 + }
1.54 + inline TInt CommitTransaction(TUint32& aKeyInfo)
1.55 + {
1.56 + return iRepository->CommitTransaction(*this, aKeyInfo);
1.57 + }
1.58 + inline void CancelTransaction() // serves as both rollback and async cancel
1.59 + {
1.60 + TServerResources::iObserver->CancelTransaction(*this,iUid);
1.61 + }
1.62 + void CleanupCancelTransactionPushL();
1.63 + inline TInt FailTransaction(TInt aError, TUint32 aErrorKey)
1.64 + {
1.65 + // returns aError to allow "return FailTransaction(error, errorKey);" - error written once
1.66 + return iRepository->FailTransaction(*this, aError, aErrorKey);
1.67 + }
1.68 +
1.69 + inline void FailAllTransactions()
1.70 + {
1.71 + iRepository->FailAllTransactions(NULL);
1.72 + }
1.73 + /** must currently be in active Read transaction. Does not fail
1.74 + transaction here if promotion to read/write failed.
1.75 + @return KErrNone if promoted, KErrLocked if not
1.76 + */
1.77 + inline TInt AttemptPromoteTransactionToReadWrite()
1.78 + {
1.79 + ASSERT(IsInActiveReadTransaction());
1.80 + return iRepository->AttemptPromoteTransactionToReadWrite(*this);
1.81 + }
1.82 +
1.83 + inline TServerSetting* GetPersistentSetting(TUint32 aId)
1.84 + {
1.85 + return iRepository->GetSettings().Find(aId);
1.86 + }
1.87 + inline TServerSetting* GetTransactionSetting(TUint32 aId)
1.88 + {
1.89 + return iTransactionSettings.Find(aId);
1.90 + }
1.91 +
1.92 + template <class T>
1.93 + TInt TransactionCreateL(TUint32 aKey, const T& aVal, TUint32* aMeta);
1.94 +
1.95 + template <class T>
1.96 + TInt TransactionSetL(TUint32 aKey, const T& aVal);
1.97 +
1.98 + inline TInt TransactionDeleteL(TUint32 aId)
1.99 + {
1.100 + // all write operations now done in a transaction
1.101 + ASSERT(IsInActiveReadWriteTransaction());
1.102 + TRAPD(err,DeleteSettingL(aId));
1.103 + if (err==KErrNoMemory)
1.104 + User::LeaveNoMemory();
1.105 + return err;
1.106 + }
1.107 +
1.108 + TInt TransactionMoveL(const TClientRequest& aMessage, TUint32& aErrorKey);
1.109 + TInt TransactionDeleteRangeL(const TClientRequest& aMessage, TUint32& aErrId);
1.110 +
1.111 + TInt CheckPermissions(RSettingPointerArray& aSettings, const TClientRequest& aMessage, const char* aDiagnostic,TBool aReadPolicy,TUint32& aErrId);
1.112 +
1.113 + TInt CheckAccessPolicyBeforeMoving(const TClientRequest& aMessage, const TServerSetting* aSourceSetting, TUint32 aSourceKey,
1.114 + const TServerSetting* aTargetSetting, TUint32 aTargetKey, TUint32& aErrorKey);
1.115 +
1.116 + TInt CheckMovePermissions(const RSettingPointerArray& aSourceSettings,const TClientRequest& aMessage,TUint aSourceToTarget,TUint32& aErrorKey)
1.117 + {
1.118 + TInt error=KErrNone;
1.119 + for (TInt i=0;i<aSourceSettings.Count() && error==KErrNone;i++)
1.120 + {
1.121 + ASSERT(aSourceSettings[i]);
1.122 + TServerSetting* sourceSetting = aSourceSettings[i];
1.123 + TUint32 sourceKey = sourceSetting->Key();
1.124 + TUint32 targetKey = sourceKey ^ aSourceToTarget;
1.125 + TServerSetting* targetSetting = GetSetting(targetKey);
1.126 +
1.127 + error = CheckAccessPolicyBeforeMoving(aMessage, sourceSetting, sourceKey, targetSetting, targetKey, aErrorKey);
1.128 + }
1.129 + return error;
1.130 + }
1.131 +
1.132 + inline TInt FindPersistentSettings(TUint32 aPartialId, TUint32 aIdMask, RSettingPointerArray& aMatches) const
1.133 + {
1.134 + // guarantees to reset RSettingPointerArray in case of error
1.135 + return iRepository->GetSettings().Find(aPartialId, aIdMask, aMatches);
1.136 + }
1.137 + inline TInt FindTransactionSettings(TUint32 aPartialId, TUint32 aIdMask, RSettingPointerArray& aMatches) const
1.138 + {
1.139 + // guarantees to reset RSettingPointerArray in case of error
1.140 + return iTransactionSettings.Find(aPartialId, aIdMask, aMatches);
1.141 + }
1.142 +
1.143 + inline void CommitChangesL(TCentRepLocation aLocation = EPersists) const
1.144 + {
1.145 + iRepository->CommitChangesL(aLocation);
1.146 + }
1.147 +
1.148 + TInt ResetL(TUint32 aId);
1.149 + TInt ResetAllL();
1.150 +
1.151 + inline const TSecurityPolicy& GetReadAccessPolicy(const TServerSetting& aSetting) const
1.152 + {
1.153 + return iRepository->GetReadAccessPolicy(aSetting);
1.154 + }
1.155 + inline const TSecurityPolicy& GetReadAccessPolicy(TUint32 aId) const
1.156 + {
1.157 + return iRepository->GetReadAccessPolicy(aId);
1.158 + }
1.159 + inline const TSecurityPolicy& GetDefaultReadAccessPolicy() const
1.160 + {
1.161 + return iRepository->GetDefaultReadAccessPolicy();
1.162 + }
1.163 +
1.164 + inline const TSecurityPolicy& GetFallbackWriteAccessPolicy(TUint32 aId) const
1.165 + {
1.166 + return iRepository->GetFallbackWriteAccessPolicy(aId);
1.167 + }
1.168 +
1.169 + inline const TSecurityPolicy& GetWriteAccessPolicy(const TServerSetting& aSetting) const
1.170 + {
1.171 + return iRepository->GetWriteAccessPolicy(aSetting);
1.172 + }
1.173 + inline const TSecurityPolicy& GetWriteAccessPolicy(TUint32 aId) const
1.174 + {
1.175 + return iRepository->GetWriteAccessPolicy(aId);
1.176 + }
1.177 + inline const TSecurityPolicy& GetDefaultWriteAccessPolicy() const
1.178 + {
1.179 + return iRepository->GetDefaultWriteAccessPolicy();
1.180 + }
1.181 +
1.182 + void HandleSWIUpdateL(TUid aUid, TTime aModified, CSessionNotifier& aNotifier);
1.183 + void HandleSWIDeleteL(TUid aUid, CSessionNotifier& aNotifier);
1.184 +
1.185 + void StoreRepositoryContentsL(CStreamStore & aStore, TStreamId & aSettingStreamId, TStreamId & aDeletedSettingsStreamId) const;
1.186 + void StoreRepositorySettingValuesL(CStreamStore& aStore, TStreamId & aSettingStreamId) const;
1.187 + void RestoreRepositoryContentsL(CStreamStore& aStore, TStreamId aSettingStreamId, TStreamId aDeletedSettingsStreamId, CRestoredRepository& aRstRepos);
1.188 + void RestoreRepositorySettingValuesL(CStreamStore& aStore, TStreamId aSettingStreamId, CRestoredRepository& aRstRepos);
1.189 +
1.190 +#ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
1.191 + void ResetFromIniFileL(TUint32 aId,CIniFileIn::TIniFileOpenMode aIniFileOpenMode,TBool& aKeyFound);
1.192 +#else
1.193 + void ResetFromIniFileL(TUint32 aId,TCentRepLocation aLocation,TBool& aKeyFound);
1.194 +#endif
1.195 +
1.196 + void LoadIniRepL(CIniFileIn::TIniFileOpenMode aMode);
1.197 + TBool GetMetaFromIni(TUint32 aKey, TUint32& aMeta);
1.198 +
1.199 + void RestoreInstallRepositoryL(TUid aUid, CStreamStore& aStore, TStreamId& aSettingStreamId, CRestoredRepository& aRstRepos);
1.200 + void BackupInstallRepositoryL(TUid aUid, CStreamStore& aStore, TStreamId& aSettingStreamId);
1.201 +
1.202 +
1.203 +#ifdef CACHE_OOM_TESTABILITY
1.204 + TInt SizeiRepository()
1.205 + {
1.206 + return iRepository->Size();
1.207 + }
1.208 +#endif
1.209 +
1.210 + inline MObserver* Notifier()
1.211 + {
1.212 + ASSERT(iNotifier);
1.213 + return iNotifier;
1.214 + }
1.215 +
1.216 + inline void AccessRepositoryL()
1.217 + {
1.218 + iRepository = TServerResources::iObserver->AccessL(iUid);
1.219 + }
1.220 +
1.221 +private:
1.222 + enum TPersistedRepActions {ECenRepReflash,ECenRepReset};
1.223 +
1.224 +private:
1.225 + static void ProcessPersistsRepositoriesL(TPersistedRepActions aRomFlashOrReset);
1.226 + static void CacheRomVersionL(const TDesC& aFilename, TDesC8& aVersion);
1.227 + TInt HandleReflashofRepositoryL();
1.228 +
1.229 + //--------------------virtual functions from MOperation----------------------------
1.230 +public:
1.231 + void GetSingleMeta(TUint aKey,TUint32& aMeta)
1.232 + {
1.233 + TUint32 metaFromIni;
1.234 + if (GetMetaFromIni(aKey, metaFromIni))
1.235 + {
1.236 + aMeta=~KMetaDefaultValue & metaFromIni;
1.237 + }
1.238 + else
1.239 + {
1.240 + //First check for a matching "range" default
1.241 + TSettingsDefaultMeta* defaultMeta = iRepository->iSimRep->RangeMetaArray().Find(aKey);
1.242 + if (defaultMeta)
1.243 + {
1.244 + aMeta=defaultMeta->GetDefaultMetadata();
1.245 + }
1.246 + else
1.247 + {
1.248 + // Range value not found, try for a repository default
1.249 + aMeta=iRepository->iSimRep->DefaultMeta();
1.250 + }
1.251 + }
1.252 + }
1.253 +
1.254 + TSettingsAccessPolicy* GetFallbackAccessPolicy(TUint32 aId) const
1.255 + {
1.256 + return iRepository->GetFallbackAccessPolicy(aId);
1.257 + }
1.258 +
1.259 + RSettingsArray& GetWritableSettingList()
1.260 + {
1.261 + return iTransactionSettings;
1.262 + }
1.263 +
1.264 + TServerSetting* GetSetting(TUint aKey)
1.265 + {
1.266 + // try to be most efficient when no transaction changes
1.267 + if ((iTransactionSettings.Count() > 0) && IsInActiveReadWriteTransaction())
1.268 + {
1.269 + TServerSetting* s = GetTransactionSetting(aKey);
1.270 + if (s)
1.271 + {
1.272 + return (s);
1.273 + }
1.274 + }
1.275 + return GetPersistentSetting(aKey);
1.276 + }
1.277 +
1.278 + /** Returns pointer array of settings whose keys match the partial key and mask. Combines
1.279 + settings from the persistent list with those in the transaction, with priority given to the
1.280 + latter, including settings flagged as deleted eliminating the corresponding entry from the
1.281 + persistent settings (plus themselves so the final list has no settings flagged as deleted in it).
1.282 + Can also call this method when not in a transaction.
1.283 + In case of error, aMatches may contain entries and must be Reset.
1.284 + */
1.285 + TInt FindSettings(TUint32 aSourcePartialKey,TUint32 aMask,RSettingPointerArray& aOutputArray) const
1.286 + {
1.287 + TInt error = FindPersistentSettings(aSourcePartialKey, aMask, aOutputArray);
1.288 + // try to be most efficient when no transaction changes
1.289 + if ((iTransactionSettings.Count() > 0) && IsInActiveReadWriteTransaction() && (KErrNone == error))
1.290 + {
1.291 + RSettingPointerArray transactionSettings;
1.292 + error = FindTransactionSettings(aSourcePartialKey, aMask, transactionSettings);
1.293 + if (error == KErrNone)
1.294 + {
1.295 + error = RSettingsArray::Merge(aOutputArray, transactionSettings);
1.296 + }
1.297 + transactionSettings.Reset();
1.298 + }
1.299 + return error;
1.300 + }
1.301 +
1.302 + //---------------------end of virtual functions-------------------------------------------
1.303 +#ifndef FOTA_UNIT_TESTING
1.304 +private:
1.305 +#endif
1.306 + CSharedRepository* iRepository;
1.307 + MObserver* iNotifier;
1.308 + TUid iUid;
1.309 + };
1.310 +
1.311 +template <class T>
1.312 +TInt CServerRepository::TransactionSetL(TUint32 aKey, const T& aVal)
1.313 + {
1.314 + // all write operations now done in a transaction
1.315 + ASSERT(IsInActiveReadWriteTransaction());
1.316 +
1.317 + TRAPD(error,SetSettingL(aKey,aVal));
1.318 + if (error != KErrNone)
1.319 + {
1.320 + FailTransaction(error, aKey);
1.321 + }
1.322 + return error;
1.323 + }
1.324 +
1.325 +
1.326 +template <class T>
1.327 +TInt CServerRepository::TransactionCreateL(TUint32 aKey, const T& aVal, TUint32* aMeta)
1.328 + {
1.329 + // all write operations now done in a transaction
1.330 + ASSERT(IsInActiveReadWriteTransaction());
1.331 +
1.332 + TRAPD(err,CreateSettingL(aKey,aVal,aMeta));
1.333 + if (err==KErrAlreadyExists)
1.334 + {
1.335 + return FailTransaction(KErrAlreadyExists,aKey);
1.336 + }
1.337 + User::LeaveIfError(err);
1.338 +
1.339 + return KErrNone;
1.340 + }
1.341 +
1.342 +#endif // SRVREPOS_H
1.343 +
1.344 +