sl@0: // Copyright (c) 2004-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 SHREPOS_H
sl@0: #define SHREPOS_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include "obsrvr_noc.h"
sl@0: #include "srvres.h"
sl@0: #include "srvdefs.h"
sl@0: #include "setting.h"
sl@0: #include "clientrequest.h"
sl@0: #include "panic.h"
sl@0: #include "transstate.h"
sl@0: #include "inifile.h"
sl@0: #include "rstrepos.h"
sl@0: #include "datatype.h"
sl@0: #include "heaprepos.h"
sl@0: 
sl@0: class CRepositoryTransactor;
sl@0: 
sl@0: class CSharedRepository : public CBase
sl@0: 	{
sl@0: 	friend class CObservable;
sl@0: 	friend class CServerRepository;
sl@0: 	friend class TConvToolTester;
sl@0: 
sl@0: public:
sl@0: 	static CSharedRepository* NewL(TUid aUid);
sl@0: 	~CSharedRepository();
sl@0: 
sl@0: 	TUid Uid() const;
sl@0: 	
sl@0: 	TInt CommitChanges(TCentRepLocation aLocation = EPersists);
sl@0: 	void CommitChangesL(TCentRepLocation aLocation = EPersists)
sl@0: 		{
sl@0: 		User::LeaveIfError(CommitChanges(aLocation));
sl@0: 		}
sl@0: 
sl@0: 	void CreateL(TServerSetting& s, TSettingsAccessPolicy* &aPolicy, TBool aFirstLoad, TBool aSingleMetaFound=EFalse);
sl@0: 	
sl@0: 	void SetMetaDataOnRead(TServerSetting& aSetting, TBool aSingleMetaFound);
sl@0: 	
sl@0: 	void SetMetaDataOnCreate(TServerSetting& aNewSetting, TUint32* aMeta);
sl@0: 
sl@0: 	TInt DeleteAndPersist(TUint32 aId);
sl@0: 	TInt DeleteNoPersist(TUint32 aId);
sl@0: 
sl@0: 	TInt ResetNoPersistL(TServerSetting& aSetting);
sl@0: 	void ResetAndPersistL(TServerSetting& aSetting);
sl@0: 	TInt ResetAllNoPersistL(CSharedRepository& aRepository);
sl@0: 	
sl@0: 	const TSecurityPolicy& GetFallbackReadAccessPolicy(TUint32 aId);
sl@0: 	inline const TSecurityPolicy& GetReadAccessPolicy(const TServerSetting& aSetting);
sl@0: 	inline const TSecurityPolicy& GetReadAccessPolicy(TUint32 aId);
sl@0: 	inline const TSecurityPolicy& GetDefaultReadAccessPolicy();
sl@0: 
sl@0: 	const TSecurityPolicy& GetFallbackWriteAccessPolicy(TUint32 aId);
sl@0: 	inline const TSecurityPolicy& GetWriteAccessPolicy(const TServerSetting& aSetting);
sl@0: 	inline const TSecurityPolicy& GetWriteAccessPolicy(TUint32 aId);
sl@0: 	inline const TSecurityPolicy& GetDefaultWriteAccessPolicy();
sl@0: 
sl@0: 	TSettingsAccessPolicy* GetFallbackAccessPolicy(TUint32 aId
sl@0: #ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
sl@0: 	,TBool aSkipSingle=EFalse
sl@0: #endif	
sl@0: 	);
sl@0: 															
sl@0: 	TInt StartTransaction(CRepositoryTransactor& aTransactor, TInt aMode);
sl@0: 	TInt CommitTransaction(CRepositoryTransactor& aTransactor, TUint32& aKeyInfo);
sl@0: 	TInt FailTransaction(CRepositoryTransactor& aTransactor, TInt aError, TUint32 aErrorKey);
sl@0: 	void FailAllTransactions(const CRepositoryTransactor* aExcludeTransactor);
sl@0: 	TInt AttemptPromoteTransactionToReadWrite(CRepositoryTransactor& aTransactor);
sl@0: 	TBool IsTransactionActive();
sl@0: 
sl@0: 	void	MergeL(CSharedRepository& aInstallRep, TMergeType aMergeType);
sl@0: #ifndef SYMBIAN_CENTREP_SUPPORT_MULTIROFS	
sl@0: 	TInt FindLocationForFileL(TCentRepLocation& aLocation,TUid aUid,const TCentRepFileType aType) const;
sl@0: #endif	
sl@0: 	
sl@0: 	void	HandleUpdateMergeL(TTime aInstallFileTimeStamp, CSharedRepository& aInstallRep);
sl@0: 	void	HandleDeleteMergeL(CSharedRepository& aRomRep);
sl@0: 	void	SetInstallTime(TTime aInstallTime);
sl@0: 
sl@0: 	inline TUid Owner() {return iSimRep->Owner(); }
sl@0: 	inline void WriteBackupStream(RWriteStream& aStream) const;
sl@0: 	inline void WriteDeletedSettingsStream(RWriteStream& aStream) const;
sl@0: 	inline void InternalizeL(RReadStream& aStream, CRestoredRepository& aRstRepos) ;
sl@0: 	void ExternalizeCre(RWriteStream& aStream) const;
sl@0: 	void InternalizeCreL(RReadStream& aStream) ;
sl@0: #ifdef	SYMBIAN_CENTREP_SUPPORT_MULTIROFS
sl@0: 	void InternalizeCreL(RReadStream& aStream,TUint8& aCreVersion);
sl@0: #endif		
sl@0: 	TInt ReloadContentL(CIniFileIn& aIniFile, TBool aFirstLoad = EFalse);
sl@0: #ifdef CENTREP_CONV_TOOL	
sl@0: 	void DoCommitChangesToIniFileL(const TDesC& aOutFileName
sl@0: #ifdef SYMBIAN_CENTREP_SUPPORT_MULTIROFS
sl@0: 	,TUint32 aCreVersion
sl@0: #endif	
sl@0: 	);
sl@0: #endif	
sl@0: 	inline void SetSize(TInt aSize);
sl@0: 	inline TInt Size() const;
sl@0: 
sl@0: private:
sl@0: 
sl@0: 	void	ResetContent();
sl@0: 	void	RestoreConsistencyL();
sl@0: 	void 	DoRestoreConsistencyL();
sl@0: 	TInt	CreateRepositoryFromCreFileL(TCentRepLocation aLocation);
sl@0: 	TInt	ReadSettingSavePolicyL(CIniFileIn& aFile,TServerSetting& aSetting, TSettingsAccessPolicy* &aPolicy, TBool& aSingleMetaFound);
sl@0: 	TInt DoCommitTransactionSettings(CRepositoryTransactor& aTransactor, TUint32& aKeyInfo);
sl@0: 	void Notify(TUint32 aVal) const;
sl@0: 	
sl@0: 	RSettingsArray& GetSettings();
sl@0: 	CSharedRepository();	
sl@0: 	void ConstructL(TUid aUid);
sl@0: 
sl@0: #ifdef FOTA_UNIT_TESTING	
sl@0: public:
sl@0: 	void SetUid(TUid aUid)
sl@0: 		{
sl@0: 		iSimRep->SetUid(aUid);
sl@0: 		}
sl@0: #endif
sl@0: 	CHeapRepository* iSimRep;
sl@0: 
sl@0: 	TInt32 iSize; //approximate size(in memory) of the repository after internalisation
sl@0: 	TBool iNotificationState;//Notification can be made if iNotificationState is non-zero, 
sl@0: 	                         //otherwise the notification is disabled
sl@0: 	                         
sl@0: 	//iInconsistentData data flag will be set at the beginning of CommitChangesL()
sl@0: 	//and reset at the end of it. The flag is used to implement lazy-load approach for the
sl@0: 	//repository - if CommitChangesL() fails, the in-memory representation of the repository 
sl@0: 	//won't match the updated by CommitChangesL() repository (ini) file. The repository
sl@0: 	//consistency has to be restored before any next call of CSharedRepository methods.
sl@0: 	TBool iInconsistentData;	                         
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalTechnology
sl@0: Base class for CServerRepository and other objects that may be in transactions with the
sl@0: shared repository. Contains a double queue link so the shared repository can build a queue
sl@0: of them. In order to use transactions in the shared repository, the object needs to supply a
sl@0: CRepositoryTransactor - either itself or a member variable. This makes it possible to
sl@0: prevent one transactor from closing another's transaction.
sl@0: Stores transaction state and changes made during the transaction.
sl@0: Also stores RMessage2 while pending async start or commit, and handles its completion.
sl@0: */
sl@0: class CRepositoryTransactor : public CBase
sl@0: 	{
sl@0: 	// shared repository may set private transaction state, but not derived classes
sl@0: 	friend class CSharedRepository;
sl@0: 	// for the _FOFF macro to work
sl@0: 	friend class CObservable::TSharedRepositoryInfo;
sl@0: 	friend class CObservable;
sl@0: public:
sl@0: 
sl@0: 	inline TInt TransactionState() const
sl@0: 		{
sl@0: 		return iTransactionState;
sl@0: 		}
sl@0: 	inline TInt TransactionMode() const
sl@0: 		{
sl@0: 		return iTransactionState & EAllTransactionModeBits;
sl@0: 		}
sl@0: 	inline TBool IsInTransaction() const
sl@0: 		{
sl@0: 		return iTransactionState != ENoTransaction;
sl@0: 		}
sl@0: 	inline TBool IsInActiveTransaction() const
sl@0: 		{
sl@0: 		// transaction is active if no bits apart from the (non-zero) mode are set
sl@0: 		return (iTransactionState != ENoTransaction) && (TransactionMode() == iTransactionState);
sl@0: 		}
sl@0: 	inline TBool IsInActiveReadTransaction() const
sl@0: 		{
sl@0: 		return iTransactionState == EReadTransaction;
sl@0: 		}
sl@0: 	inline TBool IsInActiveConcurrentReadWriteTransaction() const
sl@0: 		{
sl@0: 		return (iTransactionState == EConcurrentReadWriteTransaction);
sl@0: 		}
sl@0: 	inline TBool IsInActiveExclusiveReadWriteTransaction() const
sl@0: 		{
sl@0: 		return (iTransactionState == EReadWriteTransaction);
sl@0: 		}
sl@0: 	inline TBool IsInActiveReadWriteTransaction() const
sl@0: 		{
sl@0: 		return (iTransactionState == EReadWriteTransaction)
sl@0: 			|| (iTransactionState == EConcurrentReadWriteTransaction);
sl@0: 		}
sl@0: 	inline TBool IsInFailedTransaction() const
sl@0: 		{
sl@0: 		return (iTransactionState & EFailedBit) != 0;
sl@0: 		}
sl@0: 
sl@0: protected:
sl@0: 	inline void ClearSettings()
sl@0: 		{
sl@0: 		iTransactionSettings.Reset();
sl@0: 		}
sl@0: 
sl@0: private:
sl@0: 	inline void SetFailed(TInt aError, TUint32 aErrorKey)
sl@0: 		{
sl@0: 		// don't want to fail more than once
sl@0: 		ASSERT(IsInActiveTransaction());
sl@0: 		ASSERT(aError != KErrNone); // must fail for a reason
sl@0: 		iTransactionState |= EFailedBit;
sl@0: 		ClearSettings();
sl@0: 		iTransactionResult = aError;
sl@0: 		iTransactionErrorKey = aErrorKey;
sl@0: 		}
sl@0: 	inline void PromoteToExclusiveReadWrite()
sl@0: 		{
sl@0: 		ASSERT(iTransactionState == EReadTransaction);
sl@0: 		iTransactionState = EReadWriteTransaction;
sl@0: 		ClearSettings();
sl@0: 		}
sl@0: 	inline void AddToQueue(TSglQue<CRepositoryTransactor>& aTransactors, TInt aMode)
sl@0: 		{
sl@0: 		ASSERT(!IsInTransaction());
sl@0: 		// if the following ASSERT fails, transactor is already in a queue
sl@0: 		ASSERT(iLink.iNext == NULL);
sl@0: 		aTransactors.AddLast(*this);
sl@0: 		iTransactionState = aMode;
sl@0: 		// check adding to queue in an active state
sl@0: 		ASSERT(IsInActiveTransaction());
sl@0: 		ClearSettings();
sl@0: 		// clear failure reasons
sl@0: 		iTransactionResult = KErrNone;
sl@0: 		iTransactionErrorKey = KUnspecifiedKey;
sl@0: 		}
sl@0: 	inline void Deque()
sl@0: 		{
sl@0: 		iTransactionState = ENoTransaction;
sl@0: 		ClearSettings();
sl@0: 		delete iIniRep;
sl@0: 		iIniRep = NULL;
sl@0: 		}
sl@0: 
sl@0: protected:
sl@0: 	// derived classes are free to change transaction settings.
sl@0: 	// these can be made persistent by committing write transaction
sl@0: 	RSettingsArray iTransactionSettings;
sl@0: 
sl@0: 	// 'Create' needs to check the default (INI) file to see if the
sl@0: 	// key position has a setting defined. If that is the case,
sl@0: 	// the new setting uses meta defined for the original setting
sl@0: 	// in the INI file.
sl@0: 	// Store data read from INI here so that we only read the INI
sl@0: 	// once per transaction.
sl@0: 	CSharedRepository* iIniRep;
sl@0: 
sl@0: private:
sl@0: 	// A queue link used by the CSharedRepository the CTransactor is working on
sl@0: 	TSglQueLink iLink;
sl@0: 	// integer encoding transaction state using definition of TTransactionState
sl@0: 	TInt iTransactionState;
sl@0: 	// result to be returned by commit if transaction failed earlier
sl@0: 	TInt iTransactionResult;
sl@0: 	// if transaction failed earlier, key or partial key involved in the original error,
sl@0: 	// or KUnspecifiedKey if could not be attributed to just one.
sl@0: 	TUint32 iTransactionErrorKey;
sl@0: 	};
sl@0: 
sl@0: #include "shrepos.inl"
sl@0: 
sl@0: #endif // SHREPOS_H