sl@0: // Copyright (c) 2005-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: // Implementation of API for querying support for features on a device, and
sl@0: // receiving notification if features are added or removed.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32property.h>
sl@0: #include <e32cmn.h>
sl@0: #include <e32uid.h>
sl@0: #include "featreg.h"
sl@0: #include "featregpan.h"
sl@0: #include "featregcmn.h"
sl@0: 
sl@0: /**
sl@0:  * Run setup exe, wait for completion: ends only once property defined, or failed
sl@0:  * @internalComponent
sl@0:  * @return KErrNone on success, or system-wide error code
sl@0:  */
sl@0: static TInt RunFeaturePropertySetupExe()
sl@0: 	{
sl@0: 	const TUidType setupExeUidType(KExecutableImageUid, TUid::Null(), KFeaturePropCat);
sl@0: 	RProcess setupProc;
sl@0: 	TInt result = setupProc.Create(KFeatRegSetupExe, KNullDesC, setupExeUidType);
sl@0: 	if (result != KErrNone)
sl@0: 		{
sl@0: 		return result;
sl@0: 		}
sl@0: 	TRequestStatus setupStatus;
sl@0: 	// request Rendezvous before Resume() to avoid race condition.
sl@0: 	// Also note if request to rendezvous fails (OOM etc.) then setup exe may
sl@0: 	// complete after query code, with feature property possibly undefined
sl@0: 	setupProc.Rendezvous(setupStatus);
sl@0: 	setupProc.Resume();
sl@0: 	setupProc.Close();
sl@0: 	User::WaitForRequest(setupStatus);
sl@0: 	return setupStatus.Int();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Dummy feature registry implementation object - never instantiated.
sl@0:  * @internalComponent
sl@0:  */
sl@0: class RFeatureRegistry::TImpl
sl@0: 	{
sl@0: 	TUint32 iDummy;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  * Opens connection to the Feature Registry for making non-static queries.
sl@0:  * Note all non-static queries return state at the time Open() was called;
sl@0:  * Feature Registry changes are not observed until instance closed and re-opened.
sl@0:  *
sl@0:  * @return KErrNone if successful, negative system-wide error code if fails
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistry::Open()
sl@0: 	{
sl@0: 	RProperty featureProperty;
sl@0: 	TInt result = featureProperty.Attach(KFeaturePropCat, KFeaturePropKey);
sl@0: 	if (result != KErrNone)
sl@0: 		{
sl@0: 		return result;
sl@0: 		}
sl@0: 
sl@0: 	// read feature property header
sl@0: 	TInt propertySize = 0;
sl@0: 	TFeatureHeader header;
sl@0: 	TPckg<TFeatureHeader> headerPckg(header);
sl@0: 	TBool ranSetup = EFalse;
sl@0: 	TInt setupResult = KErrNone;
sl@0: 	while (ETrue)
sl@0: 		{
sl@0: 		result = featureProperty.Get(headerPckg);
sl@0: 		if ((result == KErrOverflow)
sl@0: 			|| ((result == KErrNone) && (headerPckg.Size() >= sizeof(TFeatureHeader))))
sl@0: 			{
sl@0: 			if (header.IsInvalid())
sl@0: 				{
sl@0: 				result = KErrCorrupt;
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				propertySize = header.PredictedPropertySize();
sl@0: 				result = KErrOverflow;	// indicates successful outcome from this phase
sl@0: 				}
sl@0: 			break;
sl@0: 			}
sl@0: 		if (ranSetup)
sl@0: 			{
sl@0: 			if (setupResult == KErrNoMemory)
sl@0: 				{
sl@0: 				result = KErrNoMemory;
sl@0: 				}
sl@0: 			else if (setupResult == KErrCorrupt)
sl@0: 				{
sl@0: 				result = KErrCorrupt;
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				// must force an error return - other than KErrOverflow
sl@0: 				result = KErrUnknown;
sl@0: 				}
sl@0: 			break;
sl@0: 			}
sl@0: 		setupResult = RunFeaturePropertySetupExe();
sl@0: 		ranSetup = ETrue;
sl@0: 		}
sl@0: 
sl@0: 	// allocate and read property. Iterate while overflow reported
sl@0: 	// in case property is republished while reading it
sl@0: 	while (result == KErrOverflow)
sl@0: 		{
sl@0: 		// the feature property data consists of only 32-bit values
sl@0: 		// allocate in TUint32 blocks to cover any alignment issues
sl@0: 		TUint32 size32 = (propertySize + sizeof(TUint32) - 1) / sizeof(TUint32);
sl@0: 		TUint32* propertyBuf32 = new TUint32[size32];
sl@0: 		TUint8* propertyBuf = reinterpret_cast<TUint8*>(propertyBuf32);
sl@0: 		if (propertyBuf == NULL)
sl@0: 			{
sl@0: 			result = KErrNoMemory;
sl@0: 			break;
sl@0: 			}
sl@0: 		TPtr8 propertyDes(propertyBuf, 0, propertySize);
sl@0: 		result = featureProperty.Get(propertyDes);
sl@0: 		if (propertyDes.Size() >= sizeof(TFeatureHeader))
sl@0: 			{
sl@0: 			const TFeatureHeader& headerRef = *(reinterpret_cast<const TFeatureHeader*>(propertyBuf));
sl@0: 			// overflow checking for the following is already done by setup exe
sl@0: 			if ((result == KErrNone) && (!headerRef.IsInvalidOrBadSize(propertyDes.Size())))
sl@0: 				{
sl@0: 				// success
sl@0: 				iImpl = reinterpret_cast<TImpl*>(propertyBuf);
sl@0: 				break;
sl@0: 				}
sl@0: 			// if it's not a valid overflow (where predicted size is indeed larger than maxsize), it's corrupt
sl@0: 			if ((result != KErrOverflow) || (headerRef.PredictedPropertySize() < propertyDes.MaxSize()))
sl@0: 				{
sl@0: 				result = KErrCorrupt;
sl@0: 				}
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			result = KErrCorrupt;
sl@0: 			}
sl@0: 		delete[] propertyBuf;
sl@0: 		if (result != KErrOverflow)
sl@0: 			{
sl@0: 			result = KErrCorrupt;
sl@0: 			break;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	featureProperty.Close();
sl@0: 	// panic in debug mode to alert system integrators that the setup exe
sl@0: 	// is absent/inaccessible or the config data is invalid in this OS
sl@0: 	// configuration: a serious problem
sl@0: 	__ASSERT_DEBUG(result != KErrCorrupt, Panic(EFeatRegBadConfig));
sl@0: 	return result;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Queries support for feature on the device.
sl@0:  * Non-static version requiring open instance of class.
sl@0:  * Recommended when making multiple queries.
sl@0:  * Note: returns support for feature from the time Open() was called.
sl@0:  *
sl@0:  * @param aFeatureUid Unique identifier of feature being queried
sl@0:  * @return positive value if feature is supported, zero if feature is not supported,
sl@0:  *     or negative system-wide error code if could not be determined.
sl@0:  * @pre this registry instance is open
sl@0:  * @panic FeatReg EFeatRegInvalidUse if this registry instance is not open
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistry::QuerySupport(TUid aFeatureUid)
sl@0: 	{
sl@0: 	TUint32 dummyInfo;
sl@0: 	return QuerySupport(aFeatureUid, dummyInfo);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Queries support for feature on the device.
sl@0:  * Non-static version requiring open instance of class.
sl@0:  * Recommended when making multiple queries.
sl@0:  * Note: returns support for feature from the time Open() was called.
sl@0:  *
sl@0:  * @param aFeatureUid Unique identifier of feature being queried
sl@0:  * @param aInfo addition status information about feature
sl@0:  * @return positive value if feature is supported, zero if feature is not supported,
sl@0:  *     or negative system-wide error code if could not be determined.
sl@0:  * @pre this registry instance is open
sl@0:  * @panic FeatReg EFeatRegInvalidUse if this registry instance is not open
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistry::QuerySupport(TUid aFeatureUid, TUint32& aInfo)
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iImpl != NULL, Panic(EFeatRegInvalidUse));
sl@0: 
sl@0: 	TFeatureHeader* header = reinterpret_cast<TFeatureHeader*>(iImpl);
sl@0: 	TUint32 featureUid = aFeatureUid.iUid;
sl@0: 
sl@0: 	// try to find in feature entries first
sl@0: 	TFeatureEntry* entry = reinterpret_cast<TFeatureEntry*>(header + 1);
sl@0: 	if (header->iFeatureEntryCount > 0)
sl@0: 		{
sl@0: 		RArray<TFeatureEntry> entryArray(sizeof(TFeatureEntry), entry, header->iFeatureEntryCount);	
sl@0: 		TFeatureEntry searchEntry = { featureUid , 0 };
sl@0: 		TInt index = entryArray.FindInUnsignedKeyOrder(searchEntry);
sl@0: 		if (index >= 0)
sl@0: 			{
sl@0: 			aInfo = entryArray[index].iInfo;
sl@0: 			return aInfo & EStatusSupportBit;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	// fall back to default ranges - first range to match wins
sl@0: 	TFeatureRange* range = reinterpret_cast<TFeatureRange*>(entry + header->iFeatureEntryCount);
sl@0: 	for (TInt i = header->iFeatureRangeCount; i > 0; --i, ++range)
sl@0: 		{
sl@0: 		if ((featureUid >= range->iLowUid) && (featureUid <= range->iHighUid))
sl@0: 			{
sl@0: 			aInfo = EStatusSupportBit;
sl@0: 			return EStatusSupportBit;
sl@0: 			}
sl@0: 		}
sl@0: 	
sl@0: 	// final default: feature not supported
sl@0: 	aInfo = 0;
sl@0: 	return 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Closes this registry instance.
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C void RFeatureRegistry::Close()
sl@0: 	{
sl@0: 	TUint8* propertyBuf = reinterpret_cast<TUint8*>(iImpl);
sl@0: 	delete[] propertyBuf;
sl@0: 	iImpl = NULL;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Queries support for feature on the device.
sl@0:  * Static version recommended for single queries.
sl@0:  *
sl@0:  * @param aFeatureUid Unique identifier of feature being queried
sl@0:  * @return positive value if feature is supported, zero if feature is not supported,
sl@0:  *     or negative system-wide error code if could not be determined.
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistry::QuerySupportS(TUid aFeatureUid)
sl@0: 	{
sl@0: 	TUint32 dummyInfo;
sl@0: 	return QuerySupportS(aFeatureUid, dummyInfo);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Queries support for feature on the device.
sl@0:  * Static version recommended for single queries.
sl@0:  *
sl@0:  * @param aFeatureUid Unique identifier of feature being queried
sl@0:  * @param aInfo addition status information about feature
sl@0:  * @return positive value if feature is supported, zero if feature is not supported,
sl@0:  *     or negative system-wide error code if could not be determined.
sl@0:  * @publishedPartner
sl@0:  * @deprecated
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistry::QuerySupportS(TUid aFeatureUid, TUint32& aInfo)
sl@0: 	{
sl@0: 	RFeatureRegistry featReg;
sl@0: 	TInt result = featReg.Open();
sl@0: 	if (result == KErrNone)
sl@0: 		{
sl@0: 		result = featReg.QuerySupport(aFeatureUid, aInfo);
sl@0: 		featReg.Close();
sl@0: 		}
sl@0: 	return result;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Implementation class allocated when RFeatureRegistryNotify is opened.
sl@0:  *
sl@0:  * @internalComponent
sl@0:  */
sl@0: class RFeatureRegistryNotify::TImpl
sl@0: 	{
sl@0: public:
sl@0: 	RProperty iNotifyProperty;
sl@0: 
sl@0: 	TImpl()
sl@0: 		: iNotifyProperty()
sl@0: 		{
sl@0: 		}
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  * Open instance of notify object so it can be subscribed to.
sl@0:  *
sl@0:  * @return KErrNone if successful, negative system-wide error code if not
sl@0:  * @internalComponent
sl@0:  */
sl@0: EXPORT_C TInt RFeatureRegistryNotify::Open()
sl@0: 	{
sl@0: 	iImpl = new TImpl;
sl@0: 	if (iImpl == NULL)
sl@0: 		{
sl@0: 		return KErrNoMemory;
sl@0: 		}
sl@0: 	TInt result = iImpl->iNotifyProperty.Attach(KFeaturePropCat, KFeaturePropKey);
sl@0: 	if (result != KErrNone)
sl@0: 		{
sl@0: 		// must clean up memory allocated above
sl@0: 		delete iImpl;
sl@0: 		iImpl = NULL;
sl@0: 		return result;
sl@0: 		}
sl@0: 	// feature property and notify property are same in current implementation
sl@0: 	// hence must ensure feature property is already published to avoid false
sl@0: 	// notification when it is first published (just-in-time by the next query)
sl@0: 	TFeatureHeader header;
sl@0: 	TPckg<TFeatureHeader> headerPckg(header);
sl@0: 	result = iImpl->iNotifyProperty.Get(headerPckg);
sl@0: 	if (!((result == KErrOverflow)
sl@0: 		|| ((result == KErrNone) && (headerPckg.Size() >= sizeof(TFeatureHeader)))))
sl@0: 		{
sl@0: 		RunFeaturePropertySetupExe();
sl@0: 		}
sl@0: 	// return fact that Attach() succeeded
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Issues an asynchronous request to be notified the next time the support
sl@0:  * status of any features change.
sl@0:  *
sl@0:  * To ensure that changes are not missed, always re-subscribe before
sl@0:  * querying the feature registry.
sl@0:  *
sl@0:  * If an outstanding request is cancelled through a call to Cancel(), then it
sl@0:  * completes with KErrCancel.
sl@0:  *
sl@0:  * @pre this instance of notify object must be Open and not already Subscribed to.
sl@0:  * @param aNotifyStatus The request status object to be signalled on update.
sl@0:  * @panic FeatReg EFeatRegInvalidUse if this registry notify instance is not open
sl@0:  * @internalComponent
sl@0:  */
sl@0: EXPORT_C void RFeatureRegistryNotify::Subscribe(TRequestStatus &aNotifyStatus)
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iImpl != NULL, Panic(EFeatRegInvalidUse));
sl@0: 	iImpl->iNotifyProperty.Subscribe(aNotifyStatus);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Cancels an outstanding subscription request for notification of feature registry changes.
sl@0:  *
sl@0:  * If the request has not already completed, then it completes with KErrCancel.
sl@0:  *
sl@0:  * @pre this instance of notify object must be Open
sl@0:  * @panic FeatReg EFeatRegInvalidUse if this registry notify instance is not open
sl@0:  * @internalComponent
sl@0:  */
sl@0: EXPORT_C void RFeatureRegistryNotify::Cancel()
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iImpl != NULL, Panic(EFeatRegInvalidUse));
sl@0: 	iImpl->iNotifyProperty.Cancel();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Closes the registry notify instance.
sl@0:  *
sl@0:  * Note: automatically cancels any outstanding notify subscription.
sl@0:  *
sl@0:  * @internalComponent
sl@0:  */
sl@0: EXPORT_C void RFeatureRegistryNotify::Close()
sl@0: 	{
sl@0: 	if (iImpl)
sl@0: 		{
sl@0: 		// Have checked RProperty::Close() cancels the outstanding subscription
sl@0: 		iImpl->iNotifyProperty.Close();
sl@0: 		}
sl@0: 	delete iImpl;
sl@0: 	iImpl = NULL;
sl@0: 	}