1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/src/BaArchiveImpl.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,409 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#include <barsc2.h>
1.20 +#include "BaArchiveImpl.h"
1.21 +#include <baflpan.h>
1.22 +#include <bautils.h>
1.23 +
1.24 +/** TCleanupItem function.
1.25 +@internalComponent
1.26 +*/
1.27 +LOCAL_C void CloseAndDeleteFile(TAny* aFile)
1.28 + {
1.29 + RFile* const file=static_cast<RFile*>(aFile);
1.30 + if (file!=NULL)
1.31 + {
1.32 + file->Close();
1.33 + delete file;
1.34 + }
1.35 + }
1.36 +
1.37 +/** TCleanupItem function.
1.38 +@internalComponent
1.39 +*/
1.40 +LOCAL_C void CloseAndDeleteChunk(TAny* aChunk)
1.41 + {
1.42 + RChunk* const rchunk=static_cast<RChunk*>(aChunk);
1.43 + if (rchunk!=NULL)
1.44 + {
1.45 + rchunk->Close();
1.46 + delete rchunk;
1.47 + }
1.48 + }
1.49 +
1.50 +/** Default Constructor
1.51 +@internalComponent
1.52 +*/
1.53 +CResourceArchiveImpl::CResourceArchiveImpl() :
1.54 + iCurrentIndex(0),
1.55 + iSpiFileType(KNullUid)
1.56 + {}
1.57 +
1.58 +/** Class destructor
1.59 +@internalComponent
1.60 +*/
1.61 +CResourceArchiveImpl::~CResourceArchiveImpl()
1.62 + {
1.63 + iRscList.Close();
1.64 +
1.65 + for(TInt i=0; i<iSpiChunkBufferArray.Count(); i++)
1.66 + {
1.67 + RChunk* const chunk = iSpiChunkBufferArray[i];
1.68 + chunk->Close();
1.69 + delete chunk;
1.70 + }
1.71 +
1.72 + iSpiChunkBufferArray.Reset();
1.73 + iSpiChunkBufferArray.Close();
1.74 +
1.75 + iSpiBufferArray.ResetAndDestroy();
1.76 + iSpiBufferArray.Close();
1.77 + iCurrentIndex=0;
1.78 + iSpiFileType=KNullUid;
1.79 +#ifdef __BASPITEST__
1.80 + iSpiFileNameArray.Reset();
1.81 + iSpiFileNameArray.Close();
1.82 +#endif
1.83 + }
1.84 +
1.85 +/** Creates a CResourceArchiveImpl instance to read a single spi file
1.86 +@internalComponent
1.87 +*/
1.88 +CResourceArchiveImpl* CResourceArchiveImpl::NewL(RFs& aFs,const TDesC& aName)
1.89 + {
1.90 + CResourceArchiveImpl* self=new (ELeave) CResourceArchiveImpl;
1.91 + CleanupStack::PushL(self);
1.92 + self->ConstructL(aFs,aName);
1.93 + CleanupStack::Pop();
1.94 + return self;
1.95 + }
1.96 +
1.97 +/** Creates a CResourceArchiveImpl instance to read a set of spi files
1.98 +@internalComponent
1.99 +*/
1.100 +CResourceArchiveImpl* CResourceArchiveImpl::NewL(RFs& aFs,const TDesC& aPath,const TDesC& aPattern)
1.101 + {
1.102 + CResourceArchiveImpl* self=new (ELeave) CResourceArchiveImpl;
1.103 + CleanupStack::PushL(self);
1.104 + self->ConstructL(aFs,aPath,aPattern);
1.105 + CleanupStack::Pop();
1.106 + return self;
1.107 + }
1.108 +
1.109 +/** ConstructL method of CResourceArchiveImpl
1.110 +@internalComponent
1.111 +*/
1.112 +void CResourceArchiveImpl::ConstructL(RFs& aFs,const TDesC& aName)
1.113 + {
1.114 + RArray<TPtrC8> hiddenRscList;
1.115 + CleanupClosePushL(hiddenRscList);
1.116 + //Open the file and initialise the buffer pointer
1.117 + TPtr8 bufferPtr(NULL,0,0);
1.118 + OpenFileL(aFs,aName,bufferPtr);
1.119 + //Now validate the header
1.120 + ValidateHeaderL(bufferPtr);
1.121 + //Process all the rsc entry
1.122 + ProcessEntryL(bufferPtr,hiddenRscList);
1.123 + CleanupStack::PopAndDestroy();
1.124 + }
1.125 +
1.126 +
1.127 +/** Function to get the string representation of a language code
1.128 +assume language code has max N digits currently equal to ELangMaximum
1.129 +note that the minimum suffix required is NN so TLang(0-9) needs to have a 0
1.130 +e.g s01...s09, s10, s100 etc
1.131 +@internalComponent
1.132 +*/
1.133 +static void GetLangCodeStringRep(TLanguage lang,TDes& aStringRep)
1.134 +{
1.135 + aStringRep.Zero();
1.136 + //special case for 0-9 where you need the 0 appended, langcode min two digit
1.137 + if (lang<10)
1.138 + aStringRep.AppendNumFixedWidthUC(lang,EDecimal,2);
1.139 + else
1.140 + aStringRep.AppendFormat(_L("%d"),lang);
1.141 +}
1.142 +
1.143 +/**
1.144 +Open the file and initialise the aBufferPtr to point at the buffer
1.145 +@internalComponent
1.146 +*/
1.147 +void CResourceArchiveImpl::OpenFileL(RFs& aFs,const TDesC& aName,TPtr8& aBufferPtr)
1.148 + {
1.149 + #ifdef __WINS__
1.150 + TUint8* romAddress=NULL;
1.151 + #else // ! __WINS__
1.152 + TUint8* romAddress=aFs.IsFileInRom(aName);
1.153 + #endif // ! __WINS__
1.154 +
1.155 + RFile* const file=new(ELeave) RFile;
1.156 + CleanupStack::PushL(TCleanupItem(CloseAndDeleteFile,file));
1.157 + User::LeaveIfError(file->Open(aFs, aName, EFileStream | EFileRead | EFileShareReadersOnly));
1.158 + TInt fileSize=0;
1.159 + User::LeaveIfError(file->Size(fileSize));
1.160 + if (romAddress)
1.161 + {
1.162 + aBufferPtr.Set(romAddress,fileSize,fileSize);
1.163 + }
1.164 + else
1.165 + {
1.166 + RChunk* rchunk = new(ELeave) RChunk;
1.167 +
1.168 + CleanupStack::PushL(TCleanupItem(CloseAndDeleteChunk,rchunk));
1.169 +
1.170 + TInt createRet = rchunk->CreateDisconnectedLocal(0, 0, fileSize);
1.171 + TInt commitRet = rchunk->Commit(0, fileSize);
1.172 +
1.173 + // Create a chunk to store the large file contents of which is closed and destroyed in destructor...
1.174 + if(createRet==KErrNone && commitRet==KErrNone)
1.175 + {
1.176 + TUint8* chunkBase = (TUint8*)rchunk->Base();
1.177 + TPtr8 tempBuffer(chunkBase, fileSize);
1.178 + User::LeaveIfError(file->Read(0, tempBuffer, fileSize));
1.179 + aBufferPtr.Set(tempBuffer);
1.180 + iSpiChunkBufferArray.AppendL(rchunk);
1.181 +
1.182 + CleanupStack::Pop(rchunk);
1.183 + }
1.184 + else // Unable to create a chunk so use heap memory...
1.185 + {
1.186 + HBufC8* fileBuffer=HBufC8::NewMaxLC(fileSize);
1.187 + aBufferPtr.Set(fileBuffer->Des());
1.188 + User::LeaveIfError(file->Read(0,aBufferPtr,fileSize));
1.189 + iSpiBufferArray.AppendL(fileBuffer);
1.190 +
1.191 + CleanupStack::Pop(fileBuffer);
1.192 + CleanupStack::PopAndDestroy(rchunk);
1.193 + }
1.194 + }
1.195 + //can close the file now
1.196 + CleanupStack::PopAndDestroy(file);
1.197 +#ifdef __BASPITEST__
1.198 + iSpiFileNameArray.AppendL(aName);
1.199 +#endif
1.200 + }
1.201 +
1.202 +/**
1.203 +Validate the spi header in the file buffer
1.204 +On return it will update the bufferPtr to point to start of the first
1.205 +rsc entry
1.206 +@internalComponent
1.207 +*/
1.208 +void CResourceArchiveImpl::ValidateHeaderL(TPtr8& aBufferPtr)
1.209 + {
1.210 + //Getting the 32 bytes header information. At the moment maybe we should just buffer 16 bytes
1.211 + //of the header as the remaining 16 bytes are padding bytes
1.212 + TUidType uidType=TCheckedUid(aBufferPtr.Left(16)).UidType();
1.213 + if (uidType[0]!=KSpiFileUid)
1.214 + User::Leave(KErrCorrupt);
1.215 + //now get the spi file type
1.216 + TUid spiFileType=TUid::Uid(uidType[1].iUid);
1.217 + if (iSpiFileType==KNullUid)
1.218 + iSpiFileType=spiFileType;
1.219 + //also check consistency with previous spi files
1.220 + __ASSERT_DEBUG(iSpiFileType==spiFileType,::Panic(EBafPanicBadResourceFileFormat));
1.221 +
1.222 + //update the bufferPtr to point to start of first rsc entry
1.223 + aBufferPtr.Set(aBufferPtr.MidTPtr(KSpiFirstRscOffset));
1.224 + }
1.225 +
1.226 +/**
1.227 +Process all the entry found in the buffer and update the internal rscList
1.228 +@internalComponent
1.229 +*/
1.230 +void CResourceArchiveImpl::ProcessEntryL(TPtr8& aBufferPtr,RArray<TPtrC8>& aHiddenList)
1.231 + {
1.232 + //now traverse content of the spi file and build up the hidden list and the TRscEntry array
1.233 + TRscEntry rscEntry;
1.234 + while (aBufferPtr.Length()>0)
1.235 + {
1.236 + //length(first 4 bytes) and the actual rsc file size(second 4 bytes)
1.237 + //Retrieving the rscfilename length
1.238 + TUint32 rscFileNameLength=LittleEndianFourByteInteger(aBufferPtr,0);
1.239 + TUint32 rscFileSize=LittleEndianFourByteInteger(aBufferPtr,4);
1.240 + TUint32 paddingbyte=(4-((rscFileNameLength+rscFileSize)%4))%4;
1.241 + __ASSERT_DEBUG((rscFileNameLength+rscFileSize+paddingbyte)%4==0,::Panic(EBafPanicFileSize));
1.242 + //construct the TRscEntry
1.243 + rscEntry.iRscName.Set(aBufferPtr.Mid(8,rscFileNameLength));
1.244 + rscEntry.iRscData.Set(aBufferPtr.Mid(8+rscFileNameLength,rscFileSize));
1.245 +#ifdef __BASPITEST__
1.246 + rscEntry.iFileNamePtr.Set(iSpiFileNameArray[iSpiFileNameArray.Count()-1].Mid(0));
1.247 +#endif
1.248 + //update the buffer pointer
1.249 + aBufferPtr.Set(aBufferPtr.MidTPtr(8+rscFileNameLength+rscFileSize+paddingbyte));
1.250 +
1.251 + //process the TRscEntry
1.252 + if (rscEntry.iRscData.Length()==0)
1.253 + aHiddenList.AppendL(rscEntry.iRscName);
1.254 + else
1.255 + {
1.256 + //if can find a matching resource name entry in the hidden list ignore this entry
1.257 + TIdentityRelation<TPtrC8> identity(MatchDescriptor);
1.258 + if (aHiddenList.Find(rscEntry.iRscName,identity)==KErrNotFound)
1.259 + {
1.260 + //note no duplicate entry, this implies the lastly mounted resource
1.261 + //entry is preferred over earlier mounted resource entry.(REPLACING)
1.262 + TInt ret=iRscList.InsertInOrder(rscEntry,EntryOrder);
1.263 + if (ret!=KErrNone && ret!=KErrAlreadyExists)
1.264 + User::Leave(ret);
1.265 + }
1.266 + }
1.267 + }//end while loop
1.268 + }
1.269 +
1.270 +/** ConstructL method that accepts a spi path and a matching pattern
1.271 +aPath here must end with \\ as well e.g. z:\\private\\10009d8f\\
1.272 +aPattern should be the spi file withou rom image id and extension
1.273 +@internalComponent
1.274 +*/
1.275 +void CResourceArchiveImpl::ConstructL(RFs& aFs,const TDesC& aPath,const TDesC& aPattern)
1.276 + {
1.277 + //Get the downgradepath
1.278 + RArray<TLanguage> downgradeList;
1.279 + BaflUtils::GetDowngradePathL(aFs,User::Language(),downgradeList);
1.280 + CleanupClosePushL(downgradeList);
1.281 +
1.282 + //used to check if there is any matching pattern and leave with KErrNotFound if
1.283 + //no matching spi
1.284 + TInt spiDiscovered=0;
1.285 +
1.286 + //sort out the language specific spi first
1.287 + for (int i=0;i<=downgradeList.Count();i++)
1.288 + {
1.289 + //list all the files in the directory that matches this language
1.290 + TFileName matchPattern;
1.291 + TBuf<5> langExtension;
1.292 + if (i<downgradeList.Count())
1.293 + GetLangCodeStringRep(downgradeList[i],langExtension);
1.294 + else
1.295 + {
1.296 + //process the default spi lastly
1.297 + langExtension.Append(_L("pi"));
1.298 + }
1.299 + matchPattern.AppendFormat(_L("%S%S-*-*.s%S"),&aPath,&aPattern,&langExtension);
1.300 +
1.301 + //Get all the spis that match the language pattern
1.302 + CDir* spiList=NULL;
1.303 + User::LeaveIfError(aFs.GetDir(matchPattern,KEntryAttReadOnly | KEntryAttHidden | KEntryAttSystem | KEntryAttArchive,ESortByName,spiList));
1.304 + CleanupStack::PushL(spiList);
1.305 +
1.306 + //the hidden list is only a temporary variable for each language
1.307 + RArray<TPtrC8> hiddenRscList;
1.308 + CleanupClosePushL(hiddenRscList);
1.309 +
1.310 + //reverse processing
1.311 + for (TInt i=spiList->Count()-1;i>=0;i--)
1.312 + {
1.313 + //reuse the matchPattern buffer to hold the full path of the spi file name
1.314 + matchPattern.Zero();
1.315 + matchPattern.Append(aPath);
1.316 + matchPattern.Append((*spiList)[i].iName);
1.317 +
1.318 + //Open the file and initialise the buffer pointer
1.319 + TPtr8 bufferPtr(NULL,0,0);
1.320 + OpenFileL(aFs,matchPattern,bufferPtr);
1.321 +
1.322 + //Now validate the header
1.323 + ValidateHeaderL(bufferPtr);
1.324 +
1.325 + //Process all the rsc entry
1.326 + ProcessEntryL(bufferPtr,hiddenRscList);
1.327 + }//end for loop
1.328 + spiDiscovered+=spiList->Count();
1.329 + CleanupStack::PopAndDestroy(2); //hiddenRscList and spiList
1.330 + }//end for loop
1.331 + //if no spi files are discovered at all leave with KErrNotFound
1.332 + if (spiDiscovered==0)
1.333 + User::Leave(KErrNotFound);
1.334 + CleanupStack::PopAndDestroy(&downgradeList);
1.335 + }
1.336 +
1.337 +/** Create the next CResourceFile that correponds to the next resource file
1.338 +in the resource archive(SPI) file
1.339 +@internalComponent
1.340 +*/
1.341 +CResourceFile* CResourceArchiveImpl::NextL(HBufC*& aRscFileName)
1.342 + {
1.343 + //if end of list return nothing
1.344 + if (iCurrentIndex==iRscList.Count())
1.345 + return NULL;
1.346 + //Construct the resource file name buffer
1.347 + TRscEntry currentEntry=iRscList[iCurrentIndex];
1.348 + HBufC* rscFileName=HBufC::NewLC(currentEntry.iRscName.Length());
1.349 + TPtr modifiable(rscFileName->Des());
1.350 + modifiable.Copy(currentEntry.iRscName);
1.351 + //Construct the CResourceFile object
1.352 + CResourceFile* resourceFile=CResourceFile::NewL(currentEntry.iRscData);
1.353 + CleanupStack::Pop(rscFileName);
1.354 + //update the index
1.355 + iCurrentIndex++;
1.356 + aRscFileName=rscFileName;
1.357 + return resourceFile;
1.358 + }
1.359 +
1.360 +/** Reset the archive reader to start reading from the first resource
1.361 +@internalComponent
1.362 +*/
1.363 +void CResourceArchiveImpl::Reset()
1.364 + {
1.365 + iCurrentIndex=0;
1.366 + }
1.367 +
1.368 +/** Return the type of the resource archive(SPI) file being read
1.369 +@internalComponent
1.370 +*/
1.371 +TUid CResourceArchiveImpl::Type()
1.372 + {
1.373 + return iSpiFileType;
1.374 + }
1.375 +
1.376 +/** Function to look ahead whether next resource exists in the resource archive
1.377 +@internalComponent
1.378 +*/
1.379 +TBool CResourceArchiveImpl::NextResourceExist() const
1.380 + {
1.381 + return (iCurrentIndex<iRscList.Count());
1.382 + }
1.383 +
1.384 +/** Function used to retrieve a 4 bytes signed integer stored in Little Endian Format
1.385 +@internalComponent
1.386 +*/
1.387 +TInt32 CResourceArchiveImpl::LittleEndianFourByteInteger(const TDesC8& aBuffer,TInt aIndexOfFirstByte) const
1.388 + {
1.389 + __ASSERT_DEBUG((aIndexOfFirstByte + 3) < aBuffer.Length(), ::Panic(EBafPanicBadIndex));
1.390 + return aBuffer[aIndexOfFirstByte] | (aBuffer[aIndexOfFirstByte+1]<<8) | (aBuffer[aIndexOfFirstByte+2]<<16) | (aBuffer[aIndexOfFirstByte+3]<<24);
1.391 + }
1.392 +
1.393 +
1.394 +
1.395 +
1.396 +
1.397 +
1.398 +
1.399 +
1.400 +
1.401 +
1.402 +
1.403 +
1.404 +
1.405 +
1.406 +
1.407 +
1.408 +
1.409 +
1.410 +
1.411 +
1.412 +