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: // Reads feature config file, checks it is valid, defines feature property from it and quits.
sl@0: // Debug builds panic if config file could not be read or is invalid, but only after all
sl@0: // processing is complete so debug and release executables still work roughly the same.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @internalComponent
sl@0: */
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <e32cmn.h>
sl@0: #include <e32property.h>
sl@0: #include <f32file.h>
sl@0: #include "featregpan.h"
sl@0: #include "featregcmn.h"
sl@0: 
sl@0: static TBool IsFeatureDataValid(const TDesC8& aFeatureDes)
sl@0: 	{
sl@0: 	// size from number of entries and ranges in header must match descriptor size
sl@0: 	const TFeatureHeader* header = reinterpret_cast<const TFeatureHeader*>(aFeatureDes.Ptr());
sl@0: 	if (header->IsInvalidOrBadSize(aFeatureDes.Size()))
sl@0: 		{
sl@0: 		return EFalse;
sl@0: 		}
sl@0: 
sl@0: 	// check feature entries are non-repeating and sorted from lowest to highest UID
sl@0: 	const TFeatureEntry* entry = reinterpret_cast<const TFeatureEntry*>(header + 1);
sl@0: 	TInt i = header->iFeatureEntryCount;
sl@0: 	TUint32 previousEntryUid = 0;
sl@0: 	if (i > 0)
sl@0: 		{
sl@0: 		previousEntryUid = entry->iUid;
sl@0: 		++entry;
sl@0: 		--i;
sl@0: 		}
sl@0: 	for (; i > 0; --i)
sl@0: 		{
sl@0: 		if (previousEntryUid >= entry->iUid)
sl@0: 			{
sl@0: 			return EFalse;
sl@0: 			}
sl@0: 		previousEntryUid = entry->iUid;
sl@0: 		++entry;
sl@0: 		}
sl@0: 
sl@0: 	// check default=supported ranges are in low-high UID pairs
sl@0: 	const TFeatureRange* range = reinterpret_cast<const TFeatureRange*>(entry);
sl@0: 	for (i = header->iFeatureRangeCount; i > 0; --i)
sl@0: 		{
sl@0: 		if (range->iLowUid > range->iHighUid)
sl@0: 			{
sl@0: 			return EFalse;
sl@0: 			}
sl@0: 		++range;
sl@0: 		}
sl@0: 
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Reads contents of a file into aBuf, reallocating if needed
sl@0:  * Afterwards aBuf may own memory even in case of failure - up to calling code to clean it up
sl@0:  * @return KErrNone on success, KErrCorrupt if invalid file size, otherwise other system-wide error code
sl@0:  */
sl@0: static TInt ReadFeatureFileToBuf(RFs &aFs, const TDesC& aFileName, RBuf8& aBuf)
sl@0: 	{
sl@0: 	RFile inFile;
sl@0: 	TInt result = inFile.Open(aFs, aFileName, EFileRead|EFileShareReadersOnly|EFileStream);
sl@0: 	if (result != KErrNone)
sl@0: 		{
sl@0: 		return result;
sl@0: 		}
sl@0: 	TInt fileSize;
sl@0: 	result = inFile.Size(fileSize);
sl@0: 	if ((fileSize < sizeof(TFeatureHeader)) || (fileSize > RProperty::KMaxLargePropertySize))
sl@0: 		{
sl@0: 		result = KErrCorrupt;
sl@0: 		}
sl@0: 	if (result == KErrNone)
sl@0: 		{
sl@0:  		result = aBuf.ReAlloc(fileSize);
sl@0: 		}
sl@0: 	if (result == KErrNone)
sl@0: 		{
sl@0: 		result = inFile.Read(aBuf);
sl@0: 		}
sl@0: 	inFile.Close();
sl@0: 	if (result == KErrNone && !IsFeatureDataValid(aBuf))
sl@0: 		{
sl@0: 		result = KErrCorrupt;
sl@0: 		}	
sl@0: 	return result;
sl@0: 	}
sl@0: 
sl@0: static TInt CompareFeatureEntry(const TFeatureEntry& aEntry1,const TFeatureEntry& aEntry2)
sl@0: 	{
sl@0: 	return (aEntry1.iUid-aEntry2.iUid);
sl@0: 	}
sl@0: 	
sl@0: static TInt CompareFeatureRange(const TFeatureRange& aEntry1,const TFeatureRange& aEntry2)
sl@0: 	{
sl@0: 	//the comparison when both default supported range are the same
sl@0: 	if (aEntry1.iLowUid==aEntry2.iLowUid && aEntry1.iHighUid==aEntry2.iHighUid)
sl@0: 		{
sl@0: 		return 0;		
sl@0: 		}
sl@0: 	return (aEntry1.iLowUid<aEntry2.iLowUid?-1:1);
sl@0: 	}	
sl@0: 
sl@0: static void ResetRBufArray(RArray<RBuf8>& aRBuf8Array)
sl@0: 	{
sl@0: 	TInt count=aRBuf8Array.Count();
sl@0: 	for (TInt i=0;i<count;i++)
sl@0: 		{
sl@0: 		aRBuf8Array[i].Close();
sl@0: 		}
sl@0: 	aRBuf8Array.Reset();
sl@0: 	aRBuf8Array.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: This function will try to find and open all the "featreg.cfg" files from the path specified
sl@0: process them in the order of increasing rom image id before copying the aggregate content
sl@0: into the buffer aBuf. Validation of each of the file is also performed inside this function.
sl@0: @param aFs an opened file server session
sl@0: @param aPath the path to look for the featreg files
sl@0: @param aBuf the buffer to contain the aggregated file content
sl@0: @return KErrNoMemory if no memory, KErrCorrupt if any of the featreg.cfg files it found in the path
sl@0: 		is corrupt.
sl@0: */
sl@0: GLDEF_C TInt ReadMultipleFeatureFileToBuf(RFs& aFs,const TDesC& aPath,RBuf8& aBuf)
sl@0: 	{
sl@0: 	CDir* featregList=NULL;
sl@0: 	HBufC* matchPattern=HBufC::New(aPath.Length()+KFeatregMatchPattern().Length());
sl@0: 	if (!matchPattern)
sl@0: 		{
sl@0: 		return KErrNoMemory;
sl@0: 		}
sl@0: 	TPtr matchPatternPtr(matchPattern->Des());		
sl@0: 	matchPatternPtr.Append(aPath);
sl@0: 	matchPatternPtr.Append(KFeatregMatchPattern);
sl@0: 	TInt ret=aFs.GetDir(*matchPattern,KEntryAttReadOnly | KEntryAttHidden | KEntryAttSystem | KEntryAttArchive,ESortByName,featregList);
sl@0: 	delete matchPattern;
sl@0: 	if (ret!=KErrNone)
sl@0: 		{
sl@0: 		return ret;
sl@0: 		}
sl@0: 	TInt fileCount=featregList->Count();
sl@0: 	//if only one file we do not need the array
sl@0: 	if (fileCount==1)
sl@0: 		{
sl@0: 		TFileName fullName(aPath);
sl@0: 		fullName.Append((*featregList)[0].iName);
sl@0: 		delete featregList;
sl@0: 		return ReadFeatureFileToBuf(aFs,fullName,aBuf);
sl@0: 		}
sl@0: 		
sl@0: 	//else if there are more than one file we need to open and validate each file
sl@0: 	//before appending each file content to the buffer array
sl@0: 	RArray<RBuf8> featregFileBufArray;
sl@0: 	for (TInt i=0;i<fileCount;i++)
sl@0: 		{
sl@0: 		TFileName fullName(aPath);
sl@0: 		fullName.Append((*featregList)[i].iName);
sl@0: 		RBuf8 fileBuffer;
sl@0: 		//first try to read the file into buffer and if successful append to the array
sl@0: 		if ((ret=ReadFeatureFileToBuf(aFs,fullName,fileBuffer))!=KErrNone || (ret=featregFileBufArray.Append(fileBuffer))!=KErrNone)
sl@0: 			{
sl@0: 			//something wrong here reset the buffer and return the error code
sl@0: 			fileBuffer.Close();
sl@0: 			delete featregList;
sl@0: 			ResetRBufArray(featregFileBufArray);
sl@0: 			return ret;
sl@0: 			}
sl@0: 		}
sl@0: 	//the list of files no longer needed we can delete now
sl@0: 	delete featregList;
sl@0: 
sl@0: 	//at this stage we are sure all the featreg files are not corrupt
sl@0: 	//we need to read the single feature entries and the default
sl@0: 	//supported range before reconstructing the output buffer
sl@0: 	RArray<TFeatureEntry> singleArray;
sl@0: 	RArray<TFeatureRange> rangeArray;
sl@0: 	//process it in the reverse order as we read it as rom image with higher id will be mounted first
sl@0: 	for (TInt idx=fileCount-1;idx>=0;idx--)
sl@0: 		{
sl@0: 		const TFeatureHeader* header = reinterpret_cast<const TFeatureHeader*>(featregFileBufArray[idx].Ptr());
sl@0: 		const TFeatureEntry* entry=reinterpret_cast<const TFeatureEntry*>(header+1);
sl@0: 		const TFeatureRange* range=reinterpret_cast<const TFeatureRange*>(entry+header->iFeatureEntryCount);		
sl@0: 		for (TInt s=0;s<header->iFeatureEntryCount;s++)
sl@0: 			{
sl@0: 			ret=singleArray.InsertInOrder(*(reinterpret_cast<const TFeatureEntry*>(entry+s)),TLinearOrder<TFeatureEntry>(CompareFeatureEntry));
sl@0: 			//ignore KErrAlreadyExists as we purposely do not want duplicate entries
sl@0: 			if (ret!=KErrNone && ret!=KErrAlreadyExists)
sl@0: 				{
sl@0: 				singleArray.Close();
sl@0: 				rangeArray.Close();
sl@0: 				ResetRBufArray(featregFileBufArray);
sl@0: 				return ret;			
sl@0: 				}
sl@0: 			}
sl@0: 		//for range, we just insert them but ignore duplicate
sl@0: 		for (TInt r=0;r<header->iFeatureRangeCount;r++)
sl@0: 			{
sl@0: 			ret=rangeArray.InsertInOrder(*(reinterpret_cast<const TFeatureRange*>(range+r)),TLinearOrder<TFeatureRange>(CompareFeatureRange));
sl@0: 			if (ret!=KErrNone && ret!=KErrAlreadyExists)
sl@0: 				{
sl@0: 				singleArray.Close();
sl@0: 				rangeArray.Close();
sl@0: 				ResetRBufArray(featregFileBufArray);
sl@0: 				return ret;	
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	//now the final step is to construct the aggregate RBuf
sl@0: 	RBuf8 buf8;
sl@0: 	TInt singleCount=singleArray.Count();
sl@0: 	TInt rangeCount=rangeArray.Count();
sl@0: 	ret=buf8.Create(sizeof(TFeatureHeader)+singleCount*sizeof(TFeatureEntry)+rangeCount*sizeof(TFeatureRange));
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		TFeatureHeader header={validTypePrefix,0,singleCount,rangeCount};
sl@0: 		buf8.Append(reinterpret_cast<const TUint8*>(&header),sizeof(TFeatureHeader));
sl@0: 		for (TInt s=0;s<singleCount;s++)
sl@0: 			{
sl@0: 			buf8.Append(reinterpret_cast<const TUint8*>(&(singleArray[s])),sizeof(TFeatureEntry));
sl@0: 			}
sl@0: 		for (TInt r=0;r<rangeCount;r++)
sl@0: 			{
sl@0: 			buf8.Append(reinterpret_cast<const TUint8*>(&(rangeArray[r])),sizeof(TFeatureRange));
sl@0: 			}	
sl@0: 		//transfer ownership now
sl@0: 		aBuf.Assign(buf8);	
sl@0: 		}
sl@0: 	//perform cleanup
sl@0: 	singleArray.Close();
sl@0: 	rangeArray.Close();
sl@0: 	ResetRBufArray(featregFileBufArray);	
sl@0: 	return ret;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  * @return KErrNone (0) if successful, KErrNoMemory or KErrCorrupt if file read failed,
sl@0:  * otherwise error result from calling RProperty::Define/Set
sl@0:  */
sl@0: #ifndef FEATREGSETUPTEST
sl@0: TInt E32Main()
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 	CTrapCleanup* trapCleanup=CTrapCleanup::New();
sl@0: 	if (!trapCleanup)
sl@0: 		{
sl@0: 		return KErrNoMemory;
sl@0: 		}
sl@0: 
sl@0: 	// if the following RProperty is defined, look for config file on the C: private
sl@0: 	// data cage instead of the normal Z:. Used for testing only.
sl@0: 	TInt testPropertyValue;
sl@0: 	TInt testResult = RProperty::Get(KFeaturePropCat, KFeatRegConfigTestKey, testPropertyValue);
sl@0: 	const TBool useCDataCage = testResult != KErrNotFound;
sl@0: 
sl@0: 	RBuf8 featureBuf;
sl@0: 	RFs fs;
sl@0: 	TInt readResult = KErrNone;
sl@0: 	TInt publishResult = KErrNone;
sl@0: 	readResult = fs.Connect();
sl@0: 	if (readResult == KErrNone)
sl@0: 		{
sl@0: 		if (useCDataCage)
sl@0: 			{
sl@0: 			TConfigFileName filename;
sl@0: 			GetSystemDrivePath(filename);
sl@0: 			readResult = ReadFeatureFileToBuf(fs, filename, featureBuf);
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			readResult=ReadMultipleFeatureFileToBuf(fs,KFeatregRomPrivatePath,featureBuf);
sl@0: 			}
sl@0: 		fs.Close();
sl@0: 		}
sl@0: 
sl@0: 	// lack of memory may be temporary, so end rather than publishing invalid property now
sl@0: 	if (readResult != KErrNoMemory)
sl@0: 		{
sl@0: 		RProcess thisProcess;
sl@0: 		// sanity check that feature property category in common header equals SID of this process
sl@0: 		ASSERT(KFeaturePropCat == thisProcess.SecureId());
sl@0: 		TSecurityPolicy readPolicy(TSecurityPolicy::EAlwaysPass);
sl@0: 		TSecurityPolicy writePolicy(thisProcess.SecureId());
sl@0: 		publishResult = RProperty::Define(KFeaturePropKey, RProperty::ELargeByteArray, readPolicy, writePolicy);
sl@0: 
sl@0: 		if ((publishResult == KErrNone) || (publishResult == KErrAlreadyExists))
sl@0: 			{
sl@0: 			if (readResult == KErrNone)
sl@0: 				{
sl@0: 				publishResult = RProperty::Set(KFeaturePropCat, KFeaturePropKey, featureBuf);
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				// bad config file: set up invalid property with number of features/ranges not consistent
sl@0: 				// with size of property, so Feature Registry API always returns KErrCorrupt
sl@0: 				TFeatureHeader corruptHeader;
sl@0: 				corruptHeader.SetInvalid();
sl@0: 				TPckg<TFeatureHeader> corruptFeaturePckg(corruptHeader);
sl@0: 				publishResult = RProperty::Set(KFeaturePropCat, KFeaturePropKey, corruptFeaturePckg);
sl@0: 				}
sl@0: 			}
sl@0: 
sl@0: 		if (readResult != KErrNone)
sl@0: 			{
sl@0: 			readResult = KErrCorrupt;
sl@0: 			// panic in debug mode alerts system integrators that config file is missing,
sl@0: 			// unreadable or invalid in this OS configuration: a serious problem
sl@0: 			__ASSERT_DEBUG(EFalse, Panic(EFeatRegBadConfig));
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	featureBuf.Close();
sl@0: 	delete trapCleanup;
sl@0: 	__UHEAP_MARKEND;
sl@0: 	return (readResult != KErrNone) ? readResult : publishResult;
sl@0: 	}
sl@0: #endif