sl@0: // Copyright (c) 2006-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: #ifndef SRVREPOS_H
sl@0: #define SRVREPOS_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <s32file.h>
sl@0: #ifdef SYMBIAN_BAFL_SYSUTIL
sl@0: #include <bafl/sysutil.h>
sl@0: #endif
sl@0: #include "shrepos.h"
sl@0: #include "setting.h"
sl@0: #include "clientrequest.h"
sl@0: #include "sessnotf.h"
sl@0: #include "operations.h"
sl@0: #include "datatype.h"
sl@0: 
sl@0: class MObserver;
sl@0: class CRestoredRepository;
sl@0: 
sl@0: class CServerRepository : public CRepositoryTransactor, public MOperationLogic
sl@0: 	{
sl@0: public:
sl@0: 	void OpenL(TUid aUid, MObserver& aObserver, TBool aFailIfNotFound = ETrue);
sl@0: 	void HandleOpenMergeL();
sl@0: 	void Close();
sl@0: 	void RestoreNotify(const CRestoredRepository& aRstRepos);
sl@0: 	TInt RFSRepositoryL();
sl@0: #ifdef SYMBIAN_BAFL_SYSUTIL
sl@0: 	static void CheckROMReflashL();
sl@0: #endif
sl@0: 	static void RFSAllRepositoriesL();
sl@0: 
sl@0: 	inline TInt StartTransaction(TInt aMode)
sl@0: 		{
sl@0: 		return iRepository->StartTransaction(*this, aMode);
sl@0: 		}
sl@0: 	inline TInt CommitTransaction(TUint32& aKeyInfo)
sl@0: 		{
sl@0: 		return iRepository->CommitTransaction(*this, aKeyInfo);
sl@0: 		}
sl@0: 	inline void CancelTransaction() // serves as both rollback and async cancel
sl@0: 		{
sl@0: 		TServerResources::iObserver->CancelTransaction(*this,iUid);
sl@0: 		}
sl@0: 	void CleanupCancelTransactionPushL();
sl@0: 	inline TInt FailTransaction(TInt aError, TUint32 aErrorKey)
sl@0: 		{
sl@0: 		// returns aError to allow "return FailTransaction(error, errorKey);" - error written once
sl@0: 		return iRepository->FailTransaction(*this, aError, aErrorKey);
sl@0: 		}
sl@0: 
sl@0: 	inline void FailAllTransactions()
sl@0: 		{
sl@0: 		iRepository->FailAllTransactions(NULL);
sl@0: 		}
sl@0: 	/** must currently be in active Read transaction. Does not fail
sl@0: 	transaction here if promotion to read/write failed.
sl@0: 	@return KErrNone if promoted, KErrLocked if not
sl@0: 	*/
sl@0: 	inline TInt AttemptPromoteTransactionToReadWrite()
sl@0: 		{
sl@0: 		ASSERT(IsInActiveReadTransaction());
sl@0: 		return iRepository->AttemptPromoteTransactionToReadWrite(*this);
sl@0: 		}
sl@0: 
sl@0: 	inline TServerSetting* GetPersistentSetting(TUint32 aId)
sl@0: 		{
sl@0: 		return iRepository->GetSettings().Find(aId);
sl@0: 		}
sl@0: 	inline TServerSetting* GetTransactionSetting(TUint32 aId)
sl@0: 		{
sl@0: 		return iTransactionSettings.Find(aId);
sl@0: 		}
sl@0: 
sl@0: 	template <class T> 
sl@0: 	TInt TransactionCreateL(TUint32 aKey, const T& aVal, TUint32* aMeta);
sl@0: 
sl@0: 	template <class T>
sl@0: 	TInt TransactionSetL(TUint32 aKey, const T& aVal);
sl@0: 
sl@0: 	inline TInt TransactionDeleteL(TUint32 aId)
sl@0: 		{
sl@0: 		// all write operations now done in a transaction
sl@0: 		ASSERT(IsInActiveReadWriteTransaction());
sl@0: 		TRAPD(err,DeleteSettingL(aId));
sl@0: 		if (err==KErrNoMemory)
sl@0: 			User::LeaveNoMemory();
sl@0: 		return err;
sl@0: 		}
sl@0: 		
sl@0: 	TInt TransactionMoveL(const TClientRequest& aMessage, TUint32& aErrorKey);
sl@0: 	TInt TransactionDeleteRangeL(const TClientRequest& aMessage, TUint32& aErrId);
sl@0: 
sl@0: 	TInt CheckPermissions(RSettingPointerArray& aSettings, const TClientRequest& aMessage, const char* aDiagnostic,TBool aReadPolicy,TUint32& aErrId);
sl@0: 	
sl@0: 	TInt CheckAccessPolicyBeforeMoving(const TClientRequest& aMessage, const TServerSetting* aSourceSetting, TUint32 aSourceKey, 
sl@0: 							const TServerSetting* aTargetSetting, TUint32 aTargetKey, TUint32& aErrorKey);
sl@0: 								
sl@0: 	TInt CheckMovePermissions(const RSettingPointerArray& aSourceSettings,const TClientRequest& aMessage,TUint aSourceToTarget,TUint32& aErrorKey)
sl@0: 		{
sl@0: 		TInt error=KErrNone;
sl@0: 		for (TInt i=0;i<aSourceSettings.Count() && error==KErrNone;i++)	
sl@0: 			{
sl@0: 			ASSERT(aSourceSettings[i]);
sl@0: 			TServerSetting* sourceSetting = aSourceSettings[i];
sl@0: 			TUint32 sourceKey = sourceSetting->Key();
sl@0: 			TUint32 targetKey = sourceKey ^ aSourceToTarget;
sl@0: 			TServerSetting* targetSetting = GetSetting(targetKey);
sl@0: 		
sl@0: 			error = CheckAccessPolicyBeforeMoving(aMessage, sourceSetting, sourceKey, targetSetting, targetKey, aErrorKey);		
sl@0: 			}
sl@0: 		return error;
sl@0: 		}
sl@0: 
sl@0: 	inline TInt FindPersistentSettings(TUint32 aPartialId, TUint32 aIdMask, RSettingPointerArray& aMatches) const
sl@0: 		{
sl@0: 		// guarantees to reset RSettingPointerArray in case of error
sl@0: 		return iRepository->GetSettings().Find(aPartialId, aIdMask, aMatches);
sl@0: 		}
sl@0: 	inline TInt FindTransactionSettings(TUint32 aPartialId, TUint32 aIdMask, RSettingPointerArray& aMatches) const
sl@0: 		{
sl@0: 		// guarantees to reset RSettingPointerArray in case of error
sl@0: 		return iTransactionSettings.Find(aPartialId, aIdMask, aMatches);
sl@0: 		}
sl@0: 
sl@0: 	inline void CommitChangesL(TCentRepLocation aLocation = EPersists) const
sl@0: 		{
sl@0: 		iRepository->CommitChangesL(aLocation);
sl@0: 		}
sl@0: 
sl@0: 	TInt ResetL(TUint32 aId);
sl@0: 	TInt ResetAllL();
sl@0: 
sl@0: 	inline const TSecurityPolicy& GetReadAccessPolicy(const TServerSetting& aSetting) const
sl@0: 		{
sl@0: 		return iRepository->GetReadAccessPolicy(aSetting);
sl@0: 		}
sl@0: 	inline const TSecurityPolicy& GetReadAccessPolicy(TUint32 aId) const
sl@0: 		{
sl@0: 		return iRepository->GetReadAccessPolicy(aId);
sl@0: 		}
sl@0: 	inline const TSecurityPolicy& GetDefaultReadAccessPolicy() const
sl@0: 		{
sl@0: 		return iRepository->GetDefaultReadAccessPolicy();
sl@0: 		}
sl@0: 
sl@0: 	inline const TSecurityPolicy& GetFallbackWriteAccessPolicy(TUint32 aId) const
sl@0: 		{
sl@0: 		return iRepository->GetFallbackWriteAccessPolicy(aId);
sl@0: 		}
sl@0: 
sl@0: 	inline const TSecurityPolicy& GetWriteAccessPolicy(const TServerSetting& aSetting) const
sl@0: 		{
sl@0: 		return iRepository->GetWriteAccessPolicy(aSetting);
sl@0: 		}
sl@0: 	inline const TSecurityPolicy& GetWriteAccessPolicy(TUint32 aId) const
sl@0: 		{
sl@0: 		return iRepository->GetWriteAccessPolicy(aId);
sl@0: 		}
sl@0: 	inline const TSecurityPolicy& GetDefaultWriteAccessPolicy() const
sl@0: 		{
sl@0: 		return iRepository->GetDefaultWriteAccessPolicy();
sl@0: 		}
sl@0: 
sl@0: 	void HandleSWIUpdateL(TUid aUid, TTime aModified, CSessionNotifier& aNotifier);
sl@0: 	void HandleSWIDeleteL(TUid aUid, CSessionNotifier& aNotifier);
sl@0: 
sl@0: 	void StoreRepositoryContentsL(CStreamStore & aStore, TStreamId & aSettingStreamId, TStreamId & aDeletedSettingsStreamId) const;
sl@0: 	void StoreRepositorySettingValuesL(CStreamStore& aStore, TStreamId & aSettingStreamId) const;	
sl@0: 	void RestoreRepositoryContentsL(CStreamStore& aStore, TStreamId aSettingStreamId, TStreamId aDeletedSettingsStreamId, CRestoredRepository& aRstRepos);
sl@0: 	void RestoreRepositorySettingValuesL(CStreamStore& aStore, TStreamId aSettingStreamId, CRestoredRepository& aRstRepos);
sl@0: 
sl@0: #ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
sl@0: 	void ResetFromIniFileL(TUint32 aId,CIniFileIn::TIniFileOpenMode aIniFileOpenMode,TBool& aKeyFound);
sl@0: #else	
sl@0: 	void ResetFromIniFileL(TUint32 aId,TCentRepLocation aLocation,TBool& aKeyFound);
sl@0: #endif	
sl@0: 	
sl@0: 	void LoadIniRepL(CIniFileIn::TIniFileOpenMode aMode);
sl@0: 	TBool GetMetaFromIni(TUint32 aKey, TUint32& aMeta);
sl@0: 	
sl@0: 	void RestoreInstallRepositoryL(TUid aUid, CStreamStore& aStore, TStreamId& aSettingStreamId, CRestoredRepository& aRstRepos); 
sl@0: 	void BackupInstallRepositoryL(TUid aUid, CStreamStore& aStore, TStreamId& aSettingStreamId); 
sl@0: 
sl@0: 
sl@0: #ifdef CACHE_OOM_TESTABILITY
sl@0: 	TInt SizeiRepository()
sl@0: 		{
sl@0: 		return iRepository->Size();
sl@0: 		}
sl@0: #endif	
sl@0: 	
sl@0: 	inline MObserver* Notifier()
sl@0: 		{
sl@0: 		ASSERT(iNotifier);
sl@0: 		return iNotifier;
sl@0: 		}
sl@0: 	
sl@0: 	inline void AccessRepositoryL()
sl@0: 		{
sl@0: 		iRepository = TServerResources::iObserver->AccessL(iUid);
sl@0: 		}
sl@0: 
sl@0: private:
sl@0: 	enum TPersistedRepActions {ECenRepReflash,ECenRepReset};
sl@0: 	
sl@0: private:
sl@0: 	static void ProcessPersistsRepositoriesL(TPersistedRepActions aRomFlashOrReset);
sl@0: 	static void CacheRomVersionL(const TDesC& aFilename, TDesC8& aVersion);
sl@0: 	TInt HandleReflashofRepositoryL();
sl@0: 
sl@0: 	//--------------------virtual functions from MOperation----------------------------
sl@0: public:
sl@0: 	void GetSingleMeta(TUint aKey,TUint32& aMeta)
sl@0: 		{
sl@0: 		TUint32 metaFromIni;
sl@0: 		if (GetMetaFromIni(aKey, metaFromIni))
sl@0: 			{
sl@0: 			aMeta=~KMetaDefaultValue & metaFromIni;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			//First check for a matching "range" default
sl@0: 			TSettingsDefaultMeta* defaultMeta = iRepository->iSimRep->RangeMetaArray().Find(aKey);
sl@0: 			if (defaultMeta)
sl@0: 				{
sl@0: 				aMeta=defaultMeta->GetDefaultMetadata();
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				// Range value not found, try for a repository default
sl@0: 				aMeta=iRepository->iSimRep->DefaultMeta();
sl@0: 				}			
sl@0: 			}		
sl@0: 		}
sl@0: 		
sl@0: 	TSettingsAccessPolicy* GetFallbackAccessPolicy(TUint32 aId) const
sl@0: 		{
sl@0: 		return iRepository->GetFallbackAccessPolicy(aId);		
sl@0: 		}	
sl@0: 
sl@0: 	RSettingsArray& GetWritableSettingList()
sl@0: 		{
sl@0: 		return iTransactionSettings;
sl@0: 		}
sl@0: 
sl@0: 	TServerSetting* GetSetting(TUint aKey)
sl@0: 		{
sl@0: 		// try to be most efficient when no transaction changes
sl@0: 		if ((iTransactionSettings.Count() > 0) && IsInActiveReadWriteTransaction())
sl@0: 			{
sl@0: 			TServerSetting* s = GetTransactionSetting(aKey);
sl@0: 			if (s)
sl@0: 				{
sl@0: 				return (s);
sl@0: 				}
sl@0: 			}
sl@0: 		return GetPersistentSetting(aKey);
sl@0: 		}
sl@0: 
sl@0: 	/** Returns pointer array of settings whose keys match the partial key and mask. Combines
sl@0: 	settings from the persistent list with those in the transaction, with priority given to the
sl@0: 	latter, including settings flagged as deleted eliminating the corresponding entry from the 
sl@0: 	persistent settings (plus themselves so the final list has no settings flagged as deleted in it).
sl@0: 	Can also call this method when not in a transaction.
sl@0: 	In case of error, aMatches may contain entries and must be Reset.
sl@0: 	*/
sl@0: 	TInt FindSettings(TUint32 aSourcePartialKey,TUint32 aMask,RSettingPointerArray& aOutputArray) const
sl@0: 		{
sl@0: 		TInt error = FindPersistentSettings(aSourcePartialKey, aMask, aOutputArray);
sl@0: 		// try to be most efficient when no transaction changes
sl@0: 		if ((iTransactionSettings.Count() > 0) && IsInActiveReadWriteTransaction() && (KErrNone == error))
sl@0: 			{
sl@0: 			RSettingPointerArray transactionSettings;
sl@0: 			error = FindTransactionSettings(aSourcePartialKey, aMask, transactionSettings);
sl@0: 			if (error == KErrNone)
sl@0: 				{
sl@0: 				error = RSettingsArray::Merge(aOutputArray, transactionSettings);
sl@0: 				}
sl@0: 			transactionSettings.Reset();
sl@0: 			}
sl@0: 		return error;
sl@0: 		}
sl@0: 	
sl@0: 	//---------------------end of virtual functions-------------------------------------------	
sl@0: #ifndef FOTA_UNIT_TESTING
sl@0: private:
sl@0: #endif
sl@0: 	CSharedRepository* iRepository;
sl@0: 	MObserver* iNotifier;	
sl@0: 	TUid iUid;
sl@0: 	};
sl@0: 
sl@0: template <class T>
sl@0: TInt CServerRepository::TransactionSetL(TUint32 aKey, const T& aVal)
sl@0: 	{
sl@0: 	// all write operations now done in a transaction
sl@0: 	ASSERT(IsInActiveReadWriteTransaction());
sl@0: 	
sl@0: 	TRAPD(error,SetSettingL(aKey,aVal));
sl@0: 	if (error != KErrNone)
sl@0: 		{
sl@0: 		FailTransaction(error, aKey);
sl@0: 		}
sl@0: 	return error;
sl@0: 	}
sl@0: 	
sl@0: 
sl@0: template <class T>
sl@0: TInt CServerRepository::TransactionCreateL(TUint32 aKey, const T& aVal, TUint32* aMeta)
sl@0: 	{
sl@0: 	// all write operations now done in a transaction
sl@0: 	ASSERT(IsInActiveReadWriteTransaction());
sl@0: 	
sl@0: 	TRAPD(err,CreateSettingL(aKey,aVal,aMeta));
sl@0: 	if (err==KErrAlreadyExists)
sl@0: 		{
sl@0: 		return FailTransaction(KErrAlreadyExists,aKey);
sl@0: 		}
sl@0: 	User::LeaveIfError(err);
sl@0: 	
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: #endif // SRVREPOS_H
sl@0: 
sl@0: