sl@0: // Copyright (c) 1996-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 <e32std.h>
sl@0: #include "server.h"
sl@0: #include "inifile.h"
sl@0: 
sl@0: // uncomment so that if the wsini.ini file is not found on drive Wserv loaded from or drive Z: (if different)
sl@0: // it will be searched for on drive C: (if different from Wserv's drive)
sl@0: //#define LOAD_INI_FILE_FROM_DRIVE_Z_OR_C
sl@0: 
sl@0: 
sl@0: GLREF_D CDebugLogBase *wsDebugLog;
sl@0: 
sl@0: _LIT(KDefaultSectionName,"DEFAULT");
sl@0: _LIT(KCommentMarker,"//");
sl@0: _LIT(KScreenSectionName,"SCREEN");
sl@0: const TUint16 KNewSection('[');
sl@0: const TUint16 KSpaceChar(' ');
sl@0: const TUint16 KNewSection2(']');
sl@0: const TInt KDefaultSectionNumber(0);
sl@0: const TInt KDefaultScreenId(-1);
sl@0: 
sl@0: 
sl@0: CIniFile::CIniFile()
sl@0: 	{}
sl@0: 
sl@0: CIniFile::~CIniFile()
sl@0: 	{
sl@0: 	FreeData();
sl@0: 	}
sl@0: 
sl@0: CIniSection * CIniFile::FindSection(TInt aScreen)
sl@0: 	{
sl@0: 	for (TInt sect = 0; sect < iSectionArray.Count(); ++sect)
sl@0: 		{
sl@0: 		if (iSectionArray[sect]->Screen() == aScreen)
sl@0: 			{
sl@0: 			return iSectionArray[sect];
sl@0: 			}
sl@0: 		}
sl@0: 	return NULL;
sl@0: 	}
sl@0: 
sl@0: CIniSection * CIniFile::FindSection(const TDesC& aName)
sl@0: 	{
sl@0: 	for (TInt sect = 0; sect < iSectionArray.Count(); ++sect)
sl@0: 		{
sl@0: 		if (iSectionArray[sect]->Screen() == KDefaultScreenId && !iSectionArray[sect]->Name().CompareF(aName))
sl@0: 			{
sl@0: 			return iSectionArray[sect];
sl@0: 			}
sl@0: 		}
sl@0: 	return NULL;
sl@0: 	}
sl@0: 
sl@0: /* Processes a .ini file entry section name.
sl@0: 
sl@0:  @return the corresponding index.
sl@0:  @param aLine Input line of text from the .ini file, stripped of comments & excess whitespace.
sl@0:  @leave KErrNoMemory
sl@0:  */
sl@0: CIniSection * CIniFile::AddOrFindIniSectionL(TPtr& aSectionName)
sl@0: 	{
sl@0: 	aSectionName.Trim();
sl@0: 
sl@0: 	// DEFAULT section
sl@0: 	if (aSectionName.CompareF(KDefaultSectionName) == 0)
sl@0: 		{ 
sl@0: 		return iSectionArray[KDefaultSectionNumber];
sl@0: 		}
sl@0: 
sl@0: 	// SCREENx section
sl@0: 	if (0 == aSectionName.FindF(KScreenSectionName))
sl@0: 		{
sl@0: 		TLex lex(aSectionName.Mid(KScreenSectionName().Length()));
sl@0: 		TInt screenNum;
sl@0: 		lex.SkipSpace();
sl@0: 		if (lex.Val(screenNum) == KErrNone)
sl@0: 			{
sl@0: 			return AddOrFindScreenSectionL(screenNum);
sl@0: 			}
sl@0: 		}
sl@0: 		
sl@0: 	// other section
sl@0: 	return AddOrFindNamedSectionL(aSectionName);
sl@0: 	}
sl@0: 
sl@0: CIniSection * CIniFile::CreateSectionL(TInt aScreen)
sl@0: 	{
sl@0: 	CIniSection* newSection = new (ELeave) CIniSection(aScreen);
sl@0: 	CleanupStack::PushL( newSection ) ;
sl@0: 	newSection->ConstructL() ;
sl@0: 	User::LeaveIfError(iSectionArray.Append(newSection));
sl@0: 	CleanupStack::Pop( newSection ) ;
sl@0: 	if (aScreen + 1 > iScreenCount)
sl@0: 		iScreenCount = aScreen + 1;
sl@0: 	return newSection;
sl@0: 	}
sl@0: 
sl@0: CIniSection * CIniFile::CreateSectionL(const TDesC& aName)
sl@0: 	{
sl@0: 	CIniSection* newSection = new (ELeave) CIniSection(KDefaultScreenId);
sl@0: 	CleanupStack::PushL( newSection ) ;
sl@0: 	newSection->ConstructL(aName) ;
sl@0: 	User::LeaveIfError(iSectionArray.Append(newSection));
sl@0: 	CleanupStack::Pop( newSection ) ;
sl@0: 	return newSection;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CIniFile::doConstructL(RFile &aFile)
sl@0: 	{
sl@0: 	TFileText textFile;
sl@0: 	textFile.Set(aFile);
sl@0: 	const TInt KMaxIniLine=256;
sl@0: 	TBuf<KMaxIniLine> readLine;
sl@0: 	TBool first=ETrue;
sl@0: 
sl@0: 	// always have a [DEFAULT] section
sl@0: 	CIniSection * currentSection = CreateSectionL(KDefaultSectionName);
sl@0: 
sl@0: 	FOREVER
sl@0: 		{
sl@0: 		TInt err=textFile.Read(readLine);
sl@0: 		if (err==KErrEof)
sl@0: 			break;
sl@0: 		User::LeaveIfError(err);
sl@0: 
sl@0: 		if (readLine.Length()>0)
sl@0: 			{
sl@0: 			if (first && (readLine[0]==0xFFFE || readLine[0]==0xFEFF))
sl@0: 				readLine.Delete(0,1);
sl@0: 			
sl@0: 			// Comment marker "//" indicates the rest of the line should be discarded
sl@0: 			TInt commentStart = readLine.Find(KCommentMarker);
sl@0: 			if (commentStart != KErrNotFound)
sl@0: 				{
sl@0: 				readLine.Delete(commentStart, readLine.Length());
sl@0: 				}
sl@0: 
sl@0: 			// compact unnecessary whitespace
sl@0: 			readLine.TrimAll();
sl@0: 
sl@0: 			// anything left in buffer?
sl@0: 			if (readLine.Length() > 0)
sl@0: 				{
sl@0: 				// section name requires "[" and "]"
sl@0: 				if (readLine[0] == KNewSection && readLine.LocateReverse(KNewSection2) == readLine.Length() - 1)
sl@0: 					{
sl@0: 					TPtr nameText = readLine.MidTPtr(1, readLine.Length() - 2); // strip [ and ]
sl@0: 					currentSection = AddOrFindIniSectionL(nameText);
sl@0: 					}
sl@0: 				else
sl@0: 					{
sl@0: 					if (currentSection)
sl@0: 						{
sl@0: 						currentSection->AddVariableL(readLine);
sl@0: 						}
sl@0: 					}
sl@0: 				}
sl@0: 			first=EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	if (iScreenCount == 0)
sl@0: 		{
sl@0: 		iScreenCount = 1;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: CIniFile* CIniFile::NewL()
sl@0:     {
sl@0:     CIniFile* self = new(ELeave) CIniFile();
sl@0:     CleanupStack::PushL(self);
sl@0:     self->ConstructL();
sl@0:     CleanupStack::Pop(self);
sl@0:     return self;
sl@0:     }
sl@0: 
sl@0: void CIniFile::FreeData() 
sl@0: 	{
sl@0: 	iSectionArray.ResetAndDestroy() ;
sl@0: 	iScreenCount = 0;
sl@0: 	}
sl@0: 
sl@0: void errFreeData(TAny *aIniFile)
sl@0: 	{
sl@0: 	((CIniFile *)aIniFile)->FreeData();
sl@0: 	}
sl@0: 
sl@0: HBufC* IniFileSearchPathLC()
sl@0: 	{
sl@0: 	_LIT(KPath,"\\SYSTEM\\DATA\\");
sl@0: 	_LIT(KPathSep,";");
sl@0: 	const TInt KLengthPerPath = 2 + KPath().Length();
sl@0: 	// work out which drive Wserv loaded from
sl@0: 	RProcess self;
sl@0: 	TFileName myPath = self.FileName();
sl@0: 	TParsePtrC myDrive(myPath);
sl@0: 	TDriveUnit myDriveUnit(myDrive.Drive());
sl@0: 	// need extra buffer space for search paths for drives Z: or C: ?
sl@0: #if defined(LOAD_INI_FILE_FROM_DRIVE_Z_OR_C)
sl@0: 	TInt numPaths = 2;
sl@0: 	if (myDriveUnit != EDriveZ && myDriveUnit != EDriveC)
sl@0: 		{
sl@0: 		numPaths += 1;
sl@0: 		}
sl@0: #else
sl@0: 	TInt numPaths = 1;
sl@0: 	if (myDriveUnit != EDriveZ)
sl@0: 		{
sl@0: 		numPaths += 1;
sl@0: 		}
sl@0: #endif
sl@0: 	HBufC* searchPath = HBufC::NewLC(numPaths * KLengthPerPath + (numPaths - 1) * KPathSep().Length());
sl@0: 	TPtr pPath(searchPath->Des());
sl@0: 	pPath.Append(myDrive.Drive());
sl@0: 	pPath.Append(KPath);
sl@0: 	if (myDriveUnit != EDriveZ)
sl@0: 		{
sl@0: 		pPath.Append(KPathSep);
sl@0: 		pPath.Append(TDriveUnit(EDriveZ).Name());
sl@0: 		pPath.Append(KPath);
sl@0: 		}
sl@0: #if defined(LOAD_INI_FILE_FROM_DRIVE_Z_OR_C)
sl@0: 	if (myDriveUnit != EDriveC)
sl@0: 		{
sl@0: 		pPath.Append(KPathSep);
sl@0: 		pPath.Append(TDriveUnit(EDriveC).Name());
sl@0: 		pPath.Append(KPath);
sl@0: 		}
sl@0: #endif
sl@0: 	return searchPath;
sl@0: 	}
sl@0: 
sl@0: void CIniFile::ConstructL()
sl@0: 	{
sl@0: 	TAutoClose<RFs> fs;
sl@0: 	User::LeaveIfError(fs.iObj.Connect());
sl@0: 	fs.iObj.SetNotifyUser(EFalse);
sl@0: 	fs.PushL();
sl@0: 	HBufC* searchPath = IniFileSearchPathLC();
sl@0: 	_LIT(KFileName,"WSINI.INI");
sl@0: 	TFindFile findinifile(fs.iObj);
sl@0: 	TInt err=findinifile.FindByPath(KFileName,searchPath);
sl@0: 	User::LeaveIfError(err);
sl@0: 	CleanupStack::PopAndDestroy(searchPath);
sl@0:  	TAutoClose<RFile> file;
sl@0: 	User::LeaveIfError(file.iObj.Open(fs.iObj,findinifile.File(),EFileStreamText|EFileRead));
sl@0: 	file.PushL();
sl@0: 	CleanupStack::PushL(TCleanupItem(errFreeData,this));
sl@0: 	doConstructL(file.iObj);
sl@0: 	CleanupStack::Pop(); // TCleanupItem
sl@0: 	file.Pop();
sl@0: 	fs.Pop();
sl@0: 	}
sl@0: 
sl@0: /* If the Section for the screen exists find the data, otherwise create a new data structure.
sl@0: 
sl@0:  @param aScreen Screen number
sl@0:  @return index to section
sl@0:  @leave KErrNoMemory
sl@0:  */
sl@0: CIniSection * CIniFile::AddOrFindScreenSectionL(TInt aScreen)
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aScreen);
sl@0: 	if (!section)
sl@0: 		section = CreateSectionL(aScreen);
sl@0: 	return section;
sl@0: 	}
sl@0: 
sl@0: /* If the Section exists find the data, otherwise create a new data structure.
sl@0: 
sl@0:  @param aName section name
sl@0:  @return index to section
sl@0:  @leave KErrNoMemory
sl@0:  */
sl@0: CIniSection * CIniFile::AddOrFindNamedSectionL(const TDesC& aName)
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aName);
sl@0: 	if (!section)
sl@0: 		section = CreateSectionL(aName);
sl@0: 	return section;
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar(const TDesC &aVarName, TPtrC &aResult)
sl@0: 	{
sl@0: 	return iSectionArray[KDefaultSectionNumber]->FindVar(aVarName, aResult);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TBool CIniFile::FindVar(const TDesC &aVarName, TInt &aResult)
sl@0: 	{
sl@0: 	return iSectionArray[KDefaultSectionNumber]->FindVar(aVarName, aResult);
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar(const TDesC &aVarName)
sl@0: //
sl@0: // Used to simply detect the presence of the specified variable name
sl@0: //
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	return FindVar(aVarName, ptr);
sl@0: 	}
sl@0: 
sl@0: // FindVar in [SCREENx] sections
sl@0: TBool CIniFile::FindVar( TInt aScreen, const TDesC &aVarName)
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	return FindVar(aScreen, aVarName, ptr);
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar( TInt aScreen, const TDesC& aVarName, TPtrC &aResult )
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aScreen);
sl@0: 	TBool found = EFalse;
sl@0: 	if (section)
sl@0: 		found = section->FindVar(aVarName, aResult);
sl@0: 	if (!found)
sl@0: 		found = FindVar(aVarName, aResult);
sl@0: 	return found;
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar(TInt aScreen, const TDesC &aVarName, TInt &aResult)
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aScreen);
sl@0: 	TBool found = EFalse;
sl@0: 	if (section)
sl@0: 		found = section->FindVar(aVarName, aResult);
sl@0: 	if (!found)
sl@0: 		found = FindVar(aVarName, aResult);
sl@0: 	return found;
sl@0: 	}
sl@0: 
sl@0: // FindVar in named sections
sl@0: TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC &aVarName)
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	return FindVar(aSectionName, aVarName, ptr);
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC& aVarName, TPtrC &aResult )
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aSectionName);
sl@0: 	TBool found = EFalse;
sl@0: 	if (section)
sl@0: 		found = section->FindVar(aVarName, aResult);
sl@0: 	if (!found)
sl@0: 		found = FindVar(aVarName, aResult);
sl@0: 	return found;
sl@0: 	}
sl@0: 
sl@0: TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC &aVarName, TInt &aResult)
sl@0: 	{
sl@0: 	CIniSection * section = FindSection(aSectionName);
sl@0: 	TBool found = EFalse;
sl@0: 	if (section)
sl@0: 		found = section->FindVar(aVarName, aResult);
sl@0: 	if (!found)
sl@0: 		found = FindVar(aVarName, aResult);
sl@0: 	return found;
sl@0: 	}
sl@0: 
sl@0: TInt CIniFile::NumberOfScreens() const 
sl@0: 	{
sl@0:   	return iScreenCount;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: // CIniSection.
sl@0: // ini file structure is now in sections like this
sl@0: //
sl@0: // [DEFAULT]
sl@0: // varname value
sl@0: // varname2 value2
sl@0: // [SCREEN0]
sl@0: // screenvar value
sl@0: // etc
sl@0: //
sl@0: // CIniSection represents a section - i.e. section name and content pairs.  
sl@0: // Content pairs are as ini file was previously (so use same code)
sl@0: // [default] section name is optional to support backwards compatibility
sl@0: // if no sutable value is found in a [screenN] section the [default] section will be searched.
sl@0: 
sl@0: 
sl@0: CIniSection::CIniSection(TInt aScreen) : iScreen(aScreen)
sl@0: 	{}
sl@0: 
sl@0: void CIniSection::ConstructL()
sl@0: 	{
sl@0: 	iPtrArray = new (ELeave) CArrayPtrFlat<TDesC>(8) ;
sl@0: 	}
sl@0: 
sl@0: void CIniSection::ConstructL(const TDesC& aName)
sl@0: 	{
sl@0: 	iName.CreateL(aName);
sl@0: 	ConstructL();
sl@0: 	}
sl@0: 
sl@0: CIniSection::~CIniSection()
sl@0: 	{
sl@0: 	iName.Close();
sl@0: 	iPtrArray->ResetAndDestroy() ;
sl@0: 	delete iPtrArray ;
sl@0: 	}
sl@0: 
sl@0: inline TInt CIniSection::Screen() const
sl@0: 	{ return iScreen; }
sl@0: 
sl@0: inline const TDesC& CIniSection::Name() const
sl@0: 	{ return iName; }
sl@0: 
sl@0: TBool CIniSection::FindVar( const TDesC& aVarName, TPtrC &aResult )
sl@0: 	{
sl@0: 	if (iPtrArray)
sl@0: 		{
sl@0: 		TInt index(KErrNotFound);
sl@0: 		
sl@0: 		if (FindVarName(aVarName, index))
sl@0: 			{
sl@0: 			TLex lex((*iPtrArray)[index]->Mid(aVarName.Length()));
sl@0: 			lex.SkipSpace();
sl@0: 			aResult.Set(lex.Remainder());
sl@0: 
sl@0: 			if (wsDebugLog)
sl@0: 				{
sl@0: 				wsDebugLog->IniFileSettingRead(iScreen, aVarName, ETrue, aResult);
sl@0: 				}
sl@0: 			return(ETrue);
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	if (wsDebugLog)
sl@0: 		{
sl@0: 		wsDebugLog->IniFileSettingRead(iScreen, aVarName, EFalse, KNullDesC);
sl@0: 		}
sl@0: 	return(EFalse);
sl@0: 	}
sl@0: 
sl@0: /*
sl@0:  create a TPtrC with just the first word (variable name) in the given string
sl@0:  */
sl@0: TPtrC CIniSection::VarName(const TDesC& aVarString)
sl@0: 	{
sl@0: 	TInt varLength = aVarString.Locate(KSpaceChar);
sl@0: 	if (varLength == KErrNotFound)
sl@0: 		{
sl@0: 		varLength = aVarString.Length();
sl@0: 		}
sl@0: 	return aVarString.Left(varLength);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TBool CIniSection::FindVar(const TDesC &aVarName, TInt &aResult)
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	// do text Find
sl@0: 	if (FindVar(aVarName, ptr))
sl@0: 		{
sl@0: 		TLex lex(ptr);
sl@0: 		_LIT(HexFormatCheck,"0x");
sl@0: 		TPtrC hexPtr(HexFormatCheck);
sl@0: 		if(ptr.Left(2) != hexPtr)
sl@0: 			{
sl@0: 			if (lex.Val(aResult) == KErrNone)
sl@0: 				{
sl@0: 				return ETrue;
sl@0: 				}
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			lex.SkipAndMark(2); //To skip 0x in hex code
sl@0: 			if (lex.Val((TUint32&)aResult, EHex) == KErrNone)
sl@0: 				{
sl@0: 				return ETrue;
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /*
sl@0:  Find variable name in sorted array, using binary search
sl@0:  @param aVarName variable name to search for, must have any space and variable value stripped.
sl@0:  @param aIndex output index of matching or preceeding item
sl@0:  @return
sl@0:  */
sl@0: TBool CIniSection::FindVarName(const TDesC& aVarName, TInt& aIndex)
sl@0: 	{
sl@0: 	// Binary Search
sl@0: 	// left is lowest index to include, right is highest index + 1;
sl@0: 	TInt left = 0;
sl@0: 	TInt right = iPtrArray->Count();
sl@0: 
sl@0: 	while (right > left)
sl@0: 		{
sl@0: 		TInt middle = (left + right)>>1;
sl@0: 		// compare to start of variable string
sl@0: 		TPtrC cmpString = VarName(*(*iPtrArray)[middle]);
sl@0: 		TInt cmp = aVarName.CompareF(cmpString);
sl@0: 
sl@0: 		if (cmp == 0)
sl@0: 			{
sl@0: 			aIndex = middle;
sl@0: 			return ETrue;
sl@0: 			}
sl@0: 		else if (cmp > 0)
sl@0: 			{
sl@0: 			left = middle + 1;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			right = middle;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	aIndex = right;
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: void CIniSection::AddVariableL(const TDesC& aNewVariable)
sl@0: 	{
sl@0: 	// use variable name only for search
sl@0: 	TPtrC varName = VarName(aNewVariable);
sl@0: 	TInt index(0);
sl@0: 	
sl@0: 	// ignore duplicate definitions
sl@0: 	if (0 == FindVarName(varName, index))
sl@0: 		{ // insert in sorted array
sl@0: 		HBufC* hbuf = aNewVariable.AllocLC() ;
sl@0: 		iPtrArray->InsertL(index, hbuf);
sl@0: 		CleanupStack::Pop(hbuf);
sl@0: 		}
sl@0: 	}
sl@0: