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: /**
sl@0:  @file
sl@0:  @internalTechnology
sl@0: */
sl@0: #include <s32mem.h>
sl@0: #include "BaSsndStore.h"
sl@0: #include "BASSNDUID.h"
sl@0: 
sl@0: // The repository format is: one setting for MajorUID, one
sl@0: // setting for sound type, one setting for the actual sound
sl@0: // data, and then leave one key space empty to round up to
sl@0: // power of 2.
sl@0: const TUint32 KSoundCatPartialKey = 0x1;
sl@0: const TUint32 KSoundTypePartialKey = 0x2;
sl@0: const TUint32 KSoundSettingPartialKey = 0x3;
sl@0: const TUint32 KNumUnusedKeySpace = 1;
sl@0: const TUint32 KSsndKeyMask = 0x3;
sl@0: 
sl@0: const TUint32 KKeyOffsetFromSoundType = 
sl@0: 	KSoundSettingPartialKey - KSoundTypePartialKey;
sl@0: const TUint32 KKeyOffsetFromSoundCat = 
sl@0: 	KSoundSettingPartialKey - KSoundCatPartialKey;
sl@0: const TUint32 KSsndBlockSize = KSoundSettingPartialKey + KNumUnusedKeySpace;
sl@0: 
sl@0: /** static factory method to instantiate an instance of CBaSsndStore */
sl@0: CBaSsndStore* CBaSsndStore::NewL()
sl@0: 	{
sl@0: 	CBaSsndStore* self = new(ELeave)CBaSsndStore;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /** CBaSsndStore constructor */
sl@0: CBaSsndStore::CBaSsndStore()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /** standard two phase construction to setup the CBaSsndStore object */
sl@0: void CBaSsndStore::ConstructL()
sl@0: 	{
sl@0: 	iRepository = CRepository::NewL(KSystemSoundRepositoryUID);
sl@0: 	}
sl@0: 
sl@0: /** CBaSsndStore destructor */
sl@0: CBaSsndStore::~CBaSsndStore()
sl@0: 	{
sl@0: 	delete iRepository;
sl@0: 	}
sl@0: 
sl@0: /** Retrieve sound data from repository.
sl@0: @param aSoundType identifies the sound to retrieve.
sl@0: @param aInfo contains the sound data on return.
sl@0: @leave any of the system-wide error codes.
sl@0: */
sl@0: void CBaSsndStore::GetSoundL(const TBaSystemSoundType& aSoundType,
sl@0: 							 TBaSystemSoundInfo& aInfo) const
sl@0: 	{
sl@0: 	TUint32 key;
sl@0: 	FindKeyL(aSoundType, key, EFalse);
sl@0: 
sl@0: 	HBufC8* hbuf8 = HBufC8::NewLC(sizeof(TBaSystemSoundInfo));
sl@0: 	TPtr8 buf8 = hbuf8->Des();
sl@0: 	User::LeaveIfError(iRepository->Get(key + KKeyOffsetFromSoundType, buf8));
sl@0: 
sl@0: 	RDesReadStream strm(buf8);
sl@0: 	aInfo.InternalizeL(strm);
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(hbuf8);
sl@0: 
sl@0: 	if (! (aSoundType == aInfo.iType))
sl@0: 		{
sl@0: 		User::Leave(KErrCorrupt);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /** Search for a sound from storage and return the sound data.
sl@0: @param aInfo as input contains the ID of the sound instance to
sl@0: 	get. As output, return the sound info if operation successful. 
sl@0: @return KErrNone if successful, otherwise KErrNotFound or
sl@0: 	any other system-wide errors.
sl@0: */
sl@0: TInt CBaSsndStore::GetSound(const TBaSystemSoundType& aSoundType,
sl@0: 							TBaSystemSoundInfo& aInfo) const
sl@0: 	{
sl@0: 	TRAPD(err, GetSoundL(aSoundType, aInfo));
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Overwrite existing sound if it is already in sound table.
sl@0: Add it if it does not exist.
sl@0: @param aInfo the sound data to save in repository.
sl@0: @leave one of the system-wide errors if set fails.
sl@0: */
sl@0: void CBaSsndStore::SetSoundL(const TBaSystemSoundInfo& aInfo) const
sl@0: 	{
sl@0: 	HBufC8* hbuf8 = HBufC8::NewLC(sizeof(TBaSystemSoundInfo));
sl@0: 	TPtr8 buf8 = hbuf8->Des();
sl@0: 	RDesWriteStream writeStream( buf8 );
sl@0: 	aInfo.ExternalizeL(writeStream);
sl@0: 	writeStream.CommitL();
sl@0: 
sl@0: 	TBaSystemSoundType ssType(aInfo.iType);
sl@0: 	// If two threads simultaneously add sound, one of them
sl@0: 	// will fail. Hence retry.
sl@0: 	const TInt KMaxRetryTransaction = 3;
sl@0: 	TInt err(KErrLocked);
sl@0: 	for (TInt i = 0; 
sl@0: 		 (i < KMaxRetryTransaction) && (err == KErrLocked || err == KErrAbort);
sl@0: 		 i++)
sl@0: 		{
sl@0: 		TRAP(err, SetSoundInTransactionL(ssType, buf8));
sl@0: 		}
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(hbuf8);
sl@0: 	User::LeaveIfError(err);
sl@0: 	}
sl@0: 
sl@0: /** If the given sound type exists in repository it is over written.
sl@0: If not exists, create a new entry. This modify/create logic must be
sl@0: wrapped in a CentRep transaction.
sl@0: @param aSoundType Use this unique indentifier to find
sl@0:        if the sound already exists in repository. If it exists
sl@0: 	   use Set. If not, use Create.
sl@0: @param aDes8 contains the sound data streamed to a TDesC8 buffer.
sl@0: @leave any of the system-wide errors.
sl@0: */
sl@0: void CBaSsndStore::SetSoundInTransactionL(TBaSystemSoundType& aSoundType,
sl@0: 										  const TDesC8& aDes8) const
sl@0: 	{
sl@0: 	User::LeaveIfError( iRepository->StartTransaction(CRepository::EConcurrentReadWriteTransaction) );
sl@0: 	iRepository->CleanupCancelTransactionPushL();
sl@0: 
sl@0: 	TUint32 errorId;
sl@0: 
sl@0: 	TUint32 key;
sl@0: 	KeyOfSoundTypeL(aSoundType, key);
sl@0: 
sl@0: 	if (key != NCentralRepositoryConstants::KUnspecifiedKey)
sl@0: 		{
sl@0: 		User::LeaveIfError(iRepository->Set(key + KKeyOffsetFromSoundType, aDes8));
sl@0: 		User::LeaveIfError(iRepository->CommitTransaction(errorId));
sl@0: 		CleanupStack::Pop(); // transaction
sl@0: 		return;
sl@0: 		}
sl@0: 	
sl@0: 	FindNextEmptySlotL(key);
sl@0: 
sl@0: 	TPckg<TBaSystemSoundUid> ssuid(aSoundType.iMajor);
sl@0: 	User::LeaveIfError(iRepository->Create(key++, ssuid));
sl@0: 
sl@0: 	TPckg<TBaSystemSoundType> sstype(aSoundType);
sl@0: 	User::LeaveIfError(iRepository->Create(key++, sstype));
sl@0: 
sl@0: 	User::LeaveIfError(iRepository->Create(key, aDes8) );
sl@0: 
sl@0: 	User::LeaveIfError(iRepository->CommitTransaction(errorId));
sl@0: 	CleanupStack::Pop(); // transaction
sl@0: 	}
sl@0: 
sl@0: /** Get all instances of a sound category
sl@0: @param aSSUid identifies the category to retrieve.
sl@0: @param aArray output parameter to return the sound instances
sl@0: @return KErrNone if successful, else one of the system-wide error codes
sl@0: */
sl@0: TInt CBaSsndStore::GetSoundCategory(const TBaSystemSoundUid& aSSUid,
sl@0: 									CArrayFixFlat<TBaSystemSoundInfo>& aArray) const
sl@0: 	{
sl@0: 	TRAPD(ret, GetSoundCategoryL(aSSUid, aArray));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: /** Get all instances of a sound category.
sl@0: @param aSSUid identifies the category to retrieve.
sl@0: @param aArray output parameter to return the sound instances.
sl@0: @leave any of the system-wide error codes.
sl@0: */
sl@0: void CBaSsndStore::GetSoundCategoryL(const TBaSystemSoundUid& aSSUid,
sl@0: 									 CArrayFixFlat<TBaSystemSoundInfo>& aArray) const
sl@0: 	{
sl@0: 	RArray<TUint32> keys;
sl@0: 	FindKeyL(aSSUid, keys);
sl@0: 	CleanupClosePushL(keys);
sl@0: 
sl@0: 	HBufC8* hbuf8 = HBufC8::NewLC(sizeof(TBaSystemSoundInfo));
sl@0: 	TPtr8 buf8 = hbuf8->Des();
sl@0: 	TBaSystemSoundInfo* sound = new(ELeave) TBaSystemSoundInfo;
sl@0: 	CleanupStack::PushL(sound);
sl@0: 
sl@0: 	TInt n = keys.Count();
sl@0: 	for (TInt i = 0; i < n; i++)
sl@0: 		{
sl@0: 		User::LeaveIfError(iRepository->Get(
sl@0: 			keys[i] + KKeyOffsetFromSoundCat, buf8));
sl@0: 		RDesReadStream strm(buf8);
sl@0: 		sound->InternalizeL(strm);
sl@0: 		aArray.AppendL(*sound);
sl@0: 		}
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(sound);
sl@0: 	CleanupStack::PopAndDestroy(hbuf8);
sl@0: 	CleanupStack::PopAndDestroy(&keys);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Search for a sound instance in repository.
sl@0: @param aSoundType identifies the TBaSystemSoundType to search for.
sl@0: @param aKey output parameter containing the key of the sound type.
sl@0: @param aNoLeaveIfNotFound indicate whether this method should leave if
sl@0: 		the sound type is not found.
sl@0: @leave KErrNotFound if not found, plus other system-wide errors.
sl@0: */
sl@0: void CBaSsndStore::FindKeyL(const TBaSystemSoundType& aSoundType,
sl@0: 							TUint32& aKey,
sl@0: 							TBool aNoLeaveIfNotFound) const
sl@0: 	{
sl@0: 	aKey = NCentralRepositoryConstants::KUnspecifiedKey;
sl@0: 
sl@0: 	TBaSystemSoundType soundTypeCopy = aSoundType;
sl@0: 	TPckg<TBaSystemSoundType> target(soundTypeCopy);
sl@0: 	RArray<TUint32> foundIds;
sl@0: 
sl@0: 	TInt ret = iRepository->FindEqL(KSoundTypePartialKey, 
sl@0: 		KSsndKeyMask, target, foundIds);
sl@0: 	if (ret == KErrNotFound && aNoLeaveIfNotFound)
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	User::LeaveIfError(ret);
sl@0: 	aKey = foundIds[0];
sl@0: 	foundIds.Reset();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Search for a sound category
sl@0: @param aSSUid the sound category to search for.
sl@0: @param aKeys output parameter containing keys having the sound category
sl@0: 		as their values.
sl@0: @leave KErrNotFound if not found, plus other system-wide errors.
sl@0: */
sl@0: void CBaSsndStore::FindKeyL(const TBaSystemSoundUid& aSSUid, RArray<TUint32>& aKeys) const
sl@0: 	{
sl@0: 	TBaSystemSoundUid ssuidCopy = aSSUid;
sl@0: 	TPckg<TBaSystemSoundUid> target(ssuidCopy);
sl@0: 
sl@0: 	User::LeaveIfError( iRepository->FindEqL(KSoundCatPartialKey, 
sl@0: 		KSsndKeyMask, target, aKeys) );
sl@0: 	}
sl@0: 
sl@0: /** Call FindKeyL with aNoLeaveIfNotFound parameter set to true.
sl@0: Used in SetSound to intercept and save the key.
sl@0: @param aSoundType is the sound type to search for.
sl@0: @param aKey output parameter to hold the key of the sound type.
sl@0: @see CBaSsndStore::FindKeyL
sl@0: */
sl@0: void CBaSsndStore::KeyOfSoundTypeL(TBaSystemSoundType& aSoundType,
sl@0: 								   TUint32& aKey) const
sl@0: 	{
sl@0: 	FindKeyL(aSoundType, aKey, ETrue);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Find the next unused key to append a new sound.
sl@0: @param aKey on return contains the key to use to store
sl@0: 	the next sound.
sl@0: @leave any of the system-wide error codes.
sl@0: */
sl@0: void CBaSsndStore::FindNextEmptySlotL(TUint32& aKey) const
sl@0: 	{
sl@0: 	RArray<TUint32> foundIds;
sl@0: 
sl@0: 	TInt ret = iRepository->FindL(KSoundSettingPartialKey,
sl@0: 		KSsndKeyMask, foundIds);
sl@0: 	if (ret == KErrNotFound)
sl@0: 		{
sl@0: 		// Empty repository. Start storing at key 1
sl@0: 		aKey = 1;
sl@0: 		}
sl@0: 	else if (ret == KErrNone)
sl@0: 		{
sl@0: 	    // The array is sorted. The max key is the last one in array.
sl@0: 		TInt n = foundIds.Count();
sl@0: 		TUint32 maxkey = foundIds[n-1];
sl@0: 		foundIds.Reset();
sl@0: 
sl@0: 		TUint32 expectedArraySize = maxkey / KSsndBlockSize + 1;
sl@0: 		if (expectedArraySize > n)
sl@0: 			{
sl@0: 			// Rogue app bypassed BaSystemSound and added non-contiguous
sl@0: 			// entries in repository.
sl@0: 			User::Leave(KErrCorrupt);
sl@0: 			}
sl@0: 
sl@0: 		// next record to be stored at maxkey + 2
sl@0: 		aKey = maxkey + KNumUnusedKeySpace + 1;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		User::Leave(ret);
sl@0: 		}
sl@0: 	}