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: #include <barsc2.h>
sl@0: #include "BaArchiveImpl.h"
sl@0: #include <baflpan.h>
sl@0: #include <bautils.h>
sl@0: 
sl@0: /** TCleanupItem function.
sl@0: @internalComponent
sl@0: */
sl@0: LOCAL_C void CloseAndDeleteFile(TAny* aFile)
sl@0: 	{
sl@0: 	RFile* const file=static_cast<RFile*>(aFile);
sl@0: 	if (file!=NULL)
sl@0: 		{
sl@0: 		file->Close();
sl@0: 		delete file;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /** TCleanupItem function.
sl@0: @internalComponent
sl@0: */
sl@0: LOCAL_C void CloseAndDeleteChunk(TAny* aChunk)
sl@0: 	{
sl@0: 	RChunk* const rchunk=static_cast<RChunk*>(aChunk);
sl@0: 	if (rchunk!=NULL)
sl@0: 		{
sl@0: 		rchunk->Close();
sl@0: 		delete rchunk;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /** Default Constructor
sl@0: @internalComponent
sl@0: */
sl@0: CResourceArchiveImpl::CResourceArchiveImpl() :
sl@0: 	iCurrentIndex(0),
sl@0: 	iSpiFileType(KNullUid)
sl@0: 	{}
sl@0: 
sl@0: /** Class destructor
sl@0: @internalComponent 
sl@0: */
sl@0: CResourceArchiveImpl::~CResourceArchiveImpl()
sl@0: 	{
sl@0: 	iRscList.Close();
sl@0: 	
sl@0: 	for(TInt i=0; i<iSpiChunkBufferArray.Count(); i++)
sl@0: 		{
sl@0: 		RChunk* const chunk = iSpiChunkBufferArray[i];                     
sl@0: 		chunk->Close();
sl@0: 		delete chunk;
sl@0: 		}
sl@0: 	
sl@0: 	iSpiChunkBufferArray.Reset();
sl@0: 	iSpiChunkBufferArray.Close();
sl@0: 
sl@0: 	iSpiBufferArray.ResetAndDestroy();
sl@0: 	iSpiBufferArray.Close();
sl@0: 	iCurrentIndex=0;
sl@0: 	iSpiFileType=KNullUid;
sl@0: #ifdef __BASPITEST__
sl@0: 	iSpiFileNameArray.Reset();
sl@0: 	iSpiFileNameArray.Close();
sl@0: #endif	
sl@0: 	}
sl@0: 
sl@0: /** Creates a CResourceArchiveImpl instance to read a single spi file
sl@0: @internalComponent
sl@0: */
sl@0: CResourceArchiveImpl* CResourceArchiveImpl::NewL(RFs& aFs,const TDesC& aName)
sl@0: 	{
sl@0: 	CResourceArchiveImpl* self=new (ELeave) CResourceArchiveImpl;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aFs,aName);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /** Creates a CResourceArchiveImpl instance to read a set of spi files
sl@0: @internalComponent
sl@0: */	
sl@0: CResourceArchiveImpl* CResourceArchiveImpl::NewL(RFs& aFs,const TDesC& aPath,const TDesC& aPattern)
sl@0: 	{
sl@0: 	CResourceArchiveImpl* self=new (ELeave) CResourceArchiveImpl;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aFs,aPath,aPattern);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;	
sl@0: 	}
sl@0: 
sl@0: /** ConstructL method of CResourceArchiveImpl
sl@0: @internalComponent
sl@0: */
sl@0: void CResourceArchiveImpl::ConstructL(RFs& aFs,const TDesC& aName)
sl@0: 	{
sl@0: 	RArray<TPtrC8> hiddenRscList;
sl@0: 	CleanupClosePushL(hiddenRscList);
sl@0: 	//Open the file and initialise the buffer pointer
sl@0: 	TPtr8 bufferPtr(NULL,0,0);
sl@0: 	OpenFileL(aFs,aName,bufferPtr);
sl@0: 	//Now validate the header
sl@0: 	ValidateHeaderL(bufferPtr);
sl@0: 	//Process all the rsc entry
sl@0: 	ProcessEntryL(bufferPtr,hiddenRscList);	
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 	
sl@0: 
sl@0: /** Function to get the string representation of a language code
sl@0: assume language code has max N digits currently equal to ELangMaximum
sl@0: note that the minimum suffix required is NN so TLang(0-9) needs to have a 0
sl@0: e.g s01...s09, s10, s100 etc
sl@0: @internalComponent
sl@0: */
sl@0: static void GetLangCodeStringRep(TLanguage lang,TDes& aStringRep)
sl@0: {
sl@0: 	aStringRep.Zero();
sl@0: 	//special case for 0-9 where you need the 0 appended, langcode min two digit
sl@0: 	if (lang<10)
sl@0: 		aStringRep.AppendNumFixedWidthUC(lang,EDecimal,2);
sl@0: 	else
sl@0: 		aStringRep.AppendFormat(_L("%d"),lang);
sl@0: }
sl@0: 
sl@0: /**
sl@0: Open the file and initialise the aBufferPtr to point at the buffer
sl@0: @internalComponent
sl@0: */
sl@0: void CResourceArchiveImpl::OpenFileL(RFs& aFs,const TDesC& aName,TPtr8& aBufferPtr)
sl@0: 	{
sl@0: 	#ifdef __WINS__
sl@0: 	TUint8* romAddress=NULL;
sl@0: 	#else // ! __WINS__
sl@0: 	TUint8* romAddress=aFs.IsFileInRom(aName);
sl@0: 	#endif // ! __WINS__
sl@0: 	
sl@0: 	RFile* const file=new(ELeave) RFile;
sl@0: 	CleanupStack::PushL(TCleanupItem(CloseAndDeleteFile,file));
sl@0: 	User::LeaveIfError(file->Open(aFs, aName, EFileStream | EFileRead | EFileShareReadersOnly));
sl@0: 	TInt fileSize=0;
sl@0: 	User::LeaveIfError(file->Size(fileSize));						
sl@0: 	if (romAddress)
sl@0: 		{	
sl@0: 		aBufferPtr.Set(romAddress,fileSize,fileSize);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		RChunk* rchunk = new(ELeave) RChunk;
sl@0: 		
sl@0: 		CleanupStack::PushL(TCleanupItem(CloseAndDeleteChunk,rchunk));
sl@0: 		
sl@0: 		TInt createRet = rchunk->CreateDisconnectedLocal(0, 0, fileSize);
sl@0: 		TInt commitRet = rchunk->Commit(0, fileSize);
sl@0: 		
sl@0: 		// Create a chunk to store the large file contents of which is closed and destroyed in destructor...
sl@0: 		if(createRet==KErrNone && commitRet==KErrNone)
sl@0: 			{
sl@0: 			TUint8* chunkBase = (TUint8*)rchunk->Base();
sl@0: 			TPtr8 tempBuffer(chunkBase, fileSize);
sl@0: 			User::LeaveIfError(file->Read(0, tempBuffer, fileSize));
sl@0: 			aBufferPtr.Set(tempBuffer);
sl@0: 			iSpiChunkBufferArray.AppendL(rchunk);
sl@0: 			
sl@0: 			CleanupStack::Pop(rchunk);
sl@0: 			}
sl@0: 		else	// Unable to create a chunk so use heap memory...
sl@0: 			{
sl@0: 			HBufC8* fileBuffer=HBufC8::NewMaxLC(fileSize);
sl@0: 			aBufferPtr.Set(fileBuffer->Des());
sl@0: 			User::LeaveIfError(file->Read(0,aBufferPtr,fileSize));
sl@0: 			iSpiBufferArray.AppendL(fileBuffer);
sl@0: 			
sl@0: 			CleanupStack::Pop(fileBuffer);
sl@0: 			CleanupStack::PopAndDestroy(rchunk);
sl@0: 			}
sl@0: 		}
sl@0: 	//can close the file now
sl@0: 	CleanupStack::PopAndDestroy(file);
sl@0: #ifdef __BASPITEST__
sl@0: 	iSpiFileNameArray.AppendL(aName);
sl@0: #endif		
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Validate the spi header in the file buffer
sl@0: On return it will update the bufferPtr to point to start of the first
sl@0: rsc entry
sl@0: @internalComponent
sl@0: */
sl@0: void CResourceArchiveImpl::ValidateHeaderL(TPtr8& aBufferPtr)
sl@0: 	{
sl@0: 	//Getting the 32 bytes header information. At the moment maybe we should just buffer 16 bytes
sl@0: 	//of the header as the remaining 16 bytes are padding bytes
sl@0: 	TUidType uidType=TCheckedUid(aBufferPtr.Left(16)).UidType();			
sl@0: 	if (uidType[0]!=KSpiFileUid)
sl@0: 		User::Leave(KErrCorrupt);
sl@0: 	//now get the spi file type
sl@0: 	TUid spiFileType=TUid::Uid(uidType[1].iUid);
sl@0: 	if (iSpiFileType==KNullUid)
sl@0: 		iSpiFileType=spiFileType;
sl@0: 	//also check consistency with previous spi files
sl@0: 	__ASSERT_DEBUG(iSpiFileType==spiFileType,::Panic(EBafPanicBadResourceFileFormat));							
sl@0: 
sl@0: 	//update the bufferPtr to point to start of first rsc entry
sl@0: 	aBufferPtr.Set(aBufferPtr.MidTPtr(KSpiFirstRscOffset));	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Process all the entry found in the buffer and update the internal rscList
sl@0: @internalComponent
sl@0: */
sl@0: void CResourceArchiveImpl::ProcessEntryL(TPtr8& aBufferPtr,RArray<TPtrC8>& aHiddenList)
sl@0: 	{
sl@0: 	//now traverse content of the spi file and build up the hidden list and the TRscEntry array
sl@0: 	TRscEntry rscEntry;
sl@0: 	while (aBufferPtr.Length()>0)
sl@0: 		{
sl@0: 		//length(first 4 bytes) and the actual rsc file size(second 4 bytes)
sl@0: 		//Retrieving the rscfilename length
sl@0: 		TUint32 rscFileNameLength=LittleEndianFourByteInteger(aBufferPtr,0);
sl@0: 		TUint32 rscFileSize=LittleEndianFourByteInteger(aBufferPtr,4);
sl@0: 		TUint32 paddingbyte=(4-((rscFileNameLength+rscFileSize)%4))%4;
sl@0: 		__ASSERT_DEBUG((rscFileNameLength+rscFileSize+paddingbyte)%4==0,::Panic(EBafPanicFileSize));
sl@0: 		//construct the TRscEntry				
sl@0: 		rscEntry.iRscName.Set(aBufferPtr.Mid(8,rscFileNameLength));
sl@0: 		rscEntry.iRscData.Set(aBufferPtr.Mid(8+rscFileNameLength,rscFileSize));
sl@0: #ifdef __BASPITEST__
sl@0: 		rscEntry.iFileNamePtr.Set(iSpiFileNameArray[iSpiFileNameArray.Count()-1].Mid(0));
sl@0: #endif				
sl@0: 		//update the buffer pointer
sl@0: 		aBufferPtr.Set(aBufferPtr.MidTPtr(8+rscFileNameLength+rscFileSize+paddingbyte));
sl@0: 
sl@0: 		//process the TRscEntry
sl@0: 		if (rscEntry.iRscData.Length()==0)
sl@0: 			aHiddenList.AppendL(rscEntry.iRscName);
sl@0: 		else
sl@0: 			{
sl@0: 			//if can find a matching resource name entry in the hidden list ignore this entry
sl@0: 			TIdentityRelation<TPtrC8> identity(MatchDescriptor);
sl@0: 			if (aHiddenList.Find(rscEntry.iRscName,identity)==KErrNotFound)
sl@0: 				{
sl@0: 				//note no duplicate entry, this implies the lastly mounted resource
sl@0: 				//entry is preferred over earlier mounted resource entry.(REPLACING)
sl@0: 				TInt ret=iRscList.InsertInOrder(rscEntry,EntryOrder);
sl@0: 				if (ret!=KErrNone && ret!=KErrAlreadyExists)
sl@0: 					User::Leave(ret);
sl@0: 				}		
sl@0: 			}
sl@0: 		}//end while loop	
sl@0: 	}
sl@0: 	
sl@0: /** ConstructL method that accepts a spi path and a matching pattern
sl@0: aPath here must end with \\ as well e.g. z:\\private\\10009d8f\\ 
sl@0: aPattern should be the spi file withou rom image id and extension
sl@0: @internalComponent
sl@0: */
sl@0: void CResourceArchiveImpl::ConstructL(RFs& aFs,const TDesC& aPath,const TDesC& aPattern)
sl@0: 	{
sl@0: 	//Get the downgradepath
sl@0: 	RArray<TLanguage> downgradeList;
sl@0: 	BaflUtils::GetDowngradePathL(aFs,User::Language(),downgradeList);
sl@0: 	CleanupClosePushL(downgradeList);
sl@0: 	
sl@0: 	//used to check if there is any matching pattern and leave with KErrNotFound if
sl@0: 	//no matching spi
sl@0: 	TInt spiDiscovered=0;
sl@0: 	
sl@0: 	//sort out the language specific spi first
sl@0: 	for (int i=0;i<=downgradeList.Count();i++)	
sl@0: 		{
sl@0: 		//list all the files in the directory that matches this language
sl@0: 		TFileName matchPattern;
sl@0: 		TBuf<5> langExtension;
sl@0: 		if (i<downgradeList.Count())
sl@0: 			GetLangCodeStringRep(downgradeList[i],langExtension);
sl@0: 		else
sl@0: 			{
sl@0: 			//process the default spi lastly
sl@0: 			langExtension.Append(_L("pi"));			
sl@0: 			}
sl@0: 		matchPattern.AppendFormat(_L("%S%S-*-*.s%S"),&aPath,&aPattern,&langExtension);
sl@0: 
sl@0: 		//Get all the spis that match the language pattern
sl@0: 		CDir* spiList=NULL;
sl@0: 		User::LeaveIfError(aFs.GetDir(matchPattern,KEntryAttReadOnly | KEntryAttHidden | KEntryAttSystem | KEntryAttArchive,ESortByName,spiList));
sl@0: 		CleanupStack::PushL(spiList);
sl@0: 
sl@0: 		//the hidden list is only a temporary variable for each language
sl@0: 		RArray<TPtrC8> hiddenRscList;
sl@0: 		CleanupClosePushL(hiddenRscList);
sl@0: 		
sl@0: 		//reverse processing
sl@0: 		for (TInt i=spiList->Count()-1;i>=0;i--)
sl@0: 			{
sl@0: 			//reuse the matchPattern buffer to hold the full path of the spi file name
sl@0: 			matchPattern.Zero();
sl@0: 			matchPattern.Append(aPath);
sl@0: 			matchPattern.Append((*spiList)[i].iName);
sl@0: 
sl@0: 			//Open the file and initialise the buffer pointer
sl@0: 			TPtr8 bufferPtr(NULL,0,0);
sl@0: 			OpenFileL(aFs,matchPattern,bufferPtr);
sl@0: 	
sl@0: 			//Now validate the header
sl@0: 			ValidateHeaderL(bufferPtr);
sl@0: 	
sl@0: 			//Process all the rsc entry
sl@0: 			ProcessEntryL(bufferPtr,hiddenRscList);
sl@0: 			}//end for loop
sl@0: 		spiDiscovered+=spiList->Count();
sl@0: 		CleanupStack::PopAndDestroy(2);				//hiddenRscList and spiList
sl@0: 		}//end for loop
sl@0: 	//if no spi files are discovered at all leave with KErrNotFound
sl@0: 	if (spiDiscovered==0)
sl@0: 		User::Leave(KErrNotFound);
sl@0: 	CleanupStack::PopAndDestroy(&downgradeList);
sl@0: 	}
sl@0: 
sl@0: /** Create the next CResourceFile that correponds to the next resource file
sl@0: in the resource archive(SPI) file
sl@0: @internalComponent
sl@0: */
sl@0: CResourceFile* CResourceArchiveImpl::NextL(HBufC*& aRscFileName)
sl@0: 	{
sl@0: 	//if end of list return nothing
sl@0: 	if (iCurrentIndex==iRscList.Count())
sl@0: 		return NULL;
sl@0: 	//Construct the resource file name buffer
sl@0: 	TRscEntry currentEntry=iRscList[iCurrentIndex];
sl@0: 	HBufC* rscFileName=HBufC::NewLC(currentEntry.iRscName.Length());
sl@0: 	TPtr modifiable(rscFileName->Des());
sl@0: 	modifiable.Copy(currentEntry.iRscName);
sl@0: 	//Construct the CResourceFile object	
sl@0: 	CResourceFile* resourceFile=CResourceFile::NewL(currentEntry.iRscData);
sl@0: 	CleanupStack::Pop(rscFileName);
sl@0: 	//update the index
sl@0: 	iCurrentIndex++;
sl@0: 	aRscFileName=rscFileName;
sl@0: 	return resourceFile;
sl@0: 	}
sl@0: 
sl@0: /** Reset the archive reader to start reading from the first resource
sl@0: @internalComponent 
sl@0: */
sl@0: void CResourceArchiveImpl::Reset()
sl@0: 	{
sl@0: 	iCurrentIndex=0;
sl@0: 	}
sl@0: 
sl@0: /** Return the type of the resource archive(SPI) file being read
sl@0: @internalComponent 
sl@0: */
sl@0: TUid CResourceArchiveImpl::Type()
sl@0: 	{
sl@0: 	return iSpiFileType;
sl@0: 	}
sl@0: 
sl@0: /** Function to look ahead whether next resource exists in the resource archive
sl@0: @internalComponent
sl@0: */
sl@0: TBool CResourceArchiveImpl::NextResourceExist() const
sl@0: 	{
sl@0: 	return (iCurrentIndex<iRscList.Count());
sl@0: 	}
sl@0: 
sl@0: /** Function used to retrieve a 4 bytes signed integer stored in Little Endian Format
sl@0: @internalComponent
sl@0: */
sl@0: TInt32 CResourceArchiveImpl::LittleEndianFourByteInteger(const TDesC8& aBuffer,TInt aIndexOfFirstByte) const
sl@0: 	{
sl@0: 	__ASSERT_DEBUG((aIndexOfFirstByte + 3) < aBuffer.Length(), ::Panic(EBafPanicBadIndex));
sl@0: 	return aBuffer[aIndexOfFirstByte] | (aBuffer[aIndexOfFirstByte+1]<<8) | (aBuffer[aIndexOfFirstByte+2]<<16) | (aBuffer[aIndexOfFirstByte+3]<<24);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: