// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// CPDTextLoader class

// 

//

#define __INCLUDE_CAPABILITY_NAMES__

#define __REFERENCE_CAPABILITY_NAMES__

#include "e32capability.h"

#include "SC_Strings.h"

#include "SC_TextIn.h"

namespace DBSC

{

/**

Max capability count, when SID or VID used.

@internalComponent

*/

const TInt KMaxCapabilityCount1 = 3;

/**

Max capability count, when no SID and no VID are used.

@internalComponent

*/

const TInt KMaxCapabilityCount2 = 7;

static TInt CompareCapabilities(const TCapability& aLeft, const TCapability& aRight)

	{

	return aRight - aLeft;

	}

/**

TStmtProps describes an object representing text file statement type and value

(the right side of "=" expression)

@internalComponent

*/

struct TStmtProps

	{

	inline TStmtProps() :

		iType(EStmtTEof),

		iValue(NULL, 0)

		{

		}

	TStmtType	iType;

	TPtrC		iValue;

	};

/**

StmtType2Class() function returns the statement class of the supplied statement type parameter.

@param aType Statement type.

@return Statement class.

@internalComponent

*/

static TStmtClass StmtType2Class(TStmtType aType)

	{

	switch(aType)

		{

		case EStmtTComment: 

		case EStmtTBlank: 

			return EStmtCNoData;

		case EStmtTDatabase: 

		case EStmtTTable: 

			return EStmtCPolicyObj;

		case EStmtTRead: 

		case EStmtTWrite: 

		case EStmtTSchema: 

			return EStmtCPolicyType;

		case EStmtTCapability:

		case EStmtTSID: 

		case EStmtTVID: 

			return EStmtCPolicyItem;

		case EStmtTBackup:

			return EStmtCBackup;

		default:

			break;

		}

	return EStmtCInvalid;

	}

/**

Capabilities count.

@internalComponent

*/

const TInt KCapabilityCount = sizeof(CapabilityNames) / sizeof(CapabilityNames[0]);

/**

CapabilityName2Id() function searches and returns the related capability ID having

the capability name as an input parameter.

@param aName Capability name

@return Related to aName capability ID

@internalComponent

*/

static TCapability CapabilityName2Id(const TDesC& aName)

	{

	const TInt KMaxCapabilityStringLen = 20;

	TBufC8<KMaxCapabilityStringLen> cap;

	TPtr8 capPtr (cap.Des());

	capPtr.Copy(aName);

 	for(TInt i=0;i<KCapabilityCount;++i)

		{	

		if(0 == capPtr.CompareF(TBuf8<20>((TText8*)CapabilityNames[i])))

			return (TCapability)i;

		}			

	return (TCapability) -1; // Return 'None' if no other capabilities are found

	}

/**

Statement keywords, which format is:

<Keyword>

KStmtKeywordT1 array is in 1:1 relation with KStmtT1 array, except the last KStmtT1 

member - EStmtTInvalid - it does not have a match in KStmtKeywordT1 array.

@internalComponent

*/

const TDesC* const KStmtKeywordT1[] = 

	{

	&KDbStr(), &KTblStr(), &KReadStr(), &KWriteStr(), &KSchemaStr(), &KBackupStr()

	};

/**

Statements count, which format is:

<Keyword>

@internalComponent

*/

const TInt KStmtT1Count = sizeof(KStmtKeywordT1) / sizeof(KStmtKeywordT1[0]);

/**

Statement IDs, which format is:

<Keyword>

KStmtKeywordT1 array is in 1:1 relation with KStmtT1 array, except the last KStmtT1 

member - EStmtTInvalid - it does not have a match in KStmtKeywordT1 array.

"EStmtTInvalid" always has to be the last array element.

@internalComponent

*/

const TStmtType KStmtT1[KStmtT1Count + 1] = 

	{ 

	EStmtTDatabase, EStmtTTable, EStmtTRead, EStmtTWrite, EStmtTSchema, EStmtTBackup, EStmtTInvalid

	};

/**

StmtKeywordT1ToId() function searches and returns the related statement ID having

the statement keyword as an input parameter.

@param aKeyword Statement keyword

@return Related to aKeyword statement ID

@internalComponent

*/

static TStmtType StmtKeywordT1ToId(const TDesC& aKeyword)

	{

	TInt i;

	for(i=0;i<KStmtT1Count && aKeyword.CompareF(*(KStmtKeywordT1[i]));++i)

		{

		}

	return KStmtT1[i];

	}

/**

Statement keywords, which format is:

<Keyword>=<Data>

KStmtKeywordT2 array is in 1:1 relation with KStmtT2 array, except the last KStmtT2 

member - EStmtTInvalid - it does not have a match in KStmtKeywordT2 array.

@internalComponent

*/

const TDesC* const KStmtKeywordT2[] = 

	{

	&KNameStr(), &KCapabilityStr(), &KSIDStr(), &KVIDStr()

	};

/**

Statements count, which format is:

<Keyword>=<Data>

@internalComponent

*/

const TInt KStmtT2Count = sizeof(KStmtKeywordT2) / sizeof(KStmtKeywordT2[0]);

/**

Statement IDs, which format is:

<Keyword>=<Data>

KStmtKeywordT2 array is in 1:1 relation with KStmtT2 array, except the last KStmtT2 

member - EStmtTInvalid - it does not have a match in KStmtKeywordT2 array.

EStmtTInvalid always has to be the last element in KStmtT2 array.

@internalComponent

*/

const TStmtType KStmtT2[KStmtT2Count + 1] = 

	{ 

	EStmtTName, EStmtTCapability, EStmtTSID, EStmtTVID, EStmtTInvalid

	};

/**

StmtKeywordT2ToId() function searches and returns the related statement ID having

the statement keyword as an input parameter.

@param aKeyword Statement keyword

@return Related to aKeyword statement ID

@internalComponent

*/

static TStmtType StmtKeywordT2ToId(const TDesC& aKeyword)

	{

	TInt i;

	for(i=0;i<KStmtT2Count && aKeyword.CompareF(*(KStmtKeywordT2[i]));++i)

		{

		}

	return KStmtT2[i];

	}

/** 

TDes::Trim() does not work properly when the descriptor length is 0, 

or the descriptor holds a NULL pointer.

@internalComponent 

*/

static void Trim(TDes& aDes) 

	{

	if(aDes.Length() > 0)

		{

		aDes.Trim();

		}

	}

/**

StmtType2PolicyType() function returns the related to aStmtType value - policy type.

@param aStmtType Statement type

@return The related policy type - R/W/S

@internalComponent

*/

static TPolicyType StmtType2PolicyType(TStmtType aStmtType) 

	{

	switch(aStmtType)

		{

		case EStmtTRead:

			return EPTRead;

		case EStmtTWrite:

			return EPTWrite;

		case EStmtTSchema:

			return EPTSchema;

		default:

			break;

		}

	return EPTNone;

	}

/**

Creates TSecurityPolicy instance of type 1: SID and a set of up to 3 capabilities.

@param aSid Security ID

@param aCapabilities Capabilities array.

@param aSecurityPolicy Output. Created security policy.

@internalComponent

*/

static void CreateSecurityPolicyT1(TSecureId aSid, const RArray<TCapability>& aCapabilities, 

									TSecurityPolicy& aSecurityPolicy)

	{

	TInt count = aCapabilities.Count();

	if(count == 0)

		{

		aSecurityPolicy = TSecurityPolicy(aSid);

		}

	else if(count == 1)

		{

		aSecurityPolicy = TSecurityPolicy(aSid, aCapabilities[0]);

		}

	else if(count == 2)

		{

		aSecurityPolicy = TSecurityPolicy(aSid, aCapabilities[0], aCapabilities[1]);

		}

	else if(count == 3)

		{

		aSecurityPolicy = TSecurityPolicy(aSid, aCapabilities[0], aCapabilities[1], aCapabilities[2]);

		}

	else

		{

		User::Invariant();

		}

	}

/**

Creates TSecurityPolicy instance of type 2: VID and a set of up to 3 capabilities.

@param aVid Vendor ID

@param aCapabilities Capabilities array.

@param aSecurityPolicy Output. Created security policy.

@internalComponent

*/

static void CreateSecurityPolicyT2(TVendorId aVid, const RArray<TCapability>& aCapabilities, 

									TSecurityPolicy& aSecurityPolicy)

	{

	TInt count = aCapabilities.Count();

	if(count == 0)

		{

		aSecurityPolicy = TSecurityPolicy(aVid);

		}

	else if(count == 1)

		{

		aSecurityPolicy = TSecurityPolicy(aVid, aCapabilities[0]);

		}

	else if(count == 2)

		{

		aSecurityPolicy = TSecurityPolicy(aVid, aCapabilities[0], aCapabilities[1]);

		}

	else if(count == 3)

		{

		aSecurityPolicy = TSecurityPolicy(aVid, aCapabilities[0], aCapabilities[1], aCapabilities[2]);

		}

	else

		{

		User::Invariant();

		}

	}

/**

Creates TSecurityPolicy instance of type 3: A set of up to 7 capabilities.

@param aCapabilities Capabilities array.

@param aSecurityPolicy Output. Created security policy.

@internalComponent

*/

static void CreateSecurityPolicyT3(const RArray<TCapability>& aCapabilities, TSecurityPolicy& aSecurityPolicy)

	{

	TInt count = aCapabilities.Count();

	if(count == 1)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0]);

		}

	else if(count == 2)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1]);

		}

	else if(count == 3)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1], aCapabilities[2]);

		}

	else if(count == 4)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1], aCapabilities[2], aCapabilities[3]);

		}

	else if(count == 5)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1], aCapabilities[2], aCapabilities[3], aCapabilities[4]);

		}

	else if(count == 6)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1], aCapabilities[2], aCapabilities[3], aCapabilities[4], aCapabilities[5]);

		}

	else if(count == 7)

		{

		aSecurityPolicy = TSecurityPolicy(aCapabilities[0], aCapabilities[1], aCapabilities[2], aCapabilities[3], aCapabilities[4], aCapabilities[5], aCapabilities[6]);

		}

	else

		{

		User::Invariant();

		}

	}

/**

Creates TSecurityPolicy instance (initializing aSecurityPolicy parameter).

@param aSid Security ID

@param aVid Vendor ID

@param aCapabilities Capabilities array.

@leave KErrCorrupt Bad set of SID/VID/Capabilities

@internalComponent

*/

static void CreateSecurityPolicyL(TSecureId aSid, TVendorId aVid, 

								  const RArray<TCapability>& aCapabilities, 

								  TSecurityPolicy& aSecurityPolicy)

	{

	TInt cababilityCount = aCapabilities.Count();

	if(aSid != 0 && aVid != 0)

		{

		__LEAVE(KErrCorrupt);

		}

	if(aSid != 0 || aVid != 0)

		{

		if(cababilityCount > KMaxCapabilityCount1)

			{

			__LEAVE(KErrCorrupt);

			}

		if(aSid != 0)

			{

			DBSC::CreateSecurityPolicyT1(aSid, aCapabilities, aSecurityPolicy);

			}

		else

			{

			DBSC::CreateSecurityPolicyT2(aVid, aCapabilities, aSecurityPolicy);

			}

		}

	else if(cababilityCount > KMaxCapabilityCount2 || cababilityCount == 0)

		{

		__LEAVE(KErrCorrupt);

		}

	else

		{

		DBSC::CreateSecurityPolicyT3(aCapabilities, aSecurityPolicy);

		}

	}

/**

*/

inline CPDTextLoader::CPDTextLoader()

	{

	}

/**

Standard phase-one factory method for CPDTextLoader instance.

CPDTextLoader instance will be used for loading a set of security policies information 

from a text file, creating the related security policy objects and adding them to 

a CPolicyDomain collection.

@param aFs File server session

@param aTextFileName Full text file path, which will be used as an input.

@return A pointer to just created CPDTextLoader instance.

@leave System-wide error codes, including KErrNoMemory.

*/

CPDTextLoader* CPDTextLoader::NewLC(RFs& aFs, const TDesC& aTextFileName)

	{

	CPDTextLoader* self = new (ELeave) CPDTextLoader;

	CleanupStack::PushL(self);

	self->ConstructL(aFs, aTextFileName);

	return self;

	}

/**

*/

CPDTextLoader::~CPDTextLoader()

	{

	iRdStream.Close();

	}

/**

Standard phase-two construction method for CPDTextLoader instance.

@param aFs File server session

@param aTextFileName Full text file path, which will be used as an input.

*/

void CPDTextLoader::ConstructL(RFs& aFs, const TDesC& aTextFileName)

	{

	__LEAVE_IF_ERROR(iRdStream.Open(aFs, aTextFileName, EFileRead | EFileStreamText));

	}

/**

MPolicyDomainLoader::RunL() implementation, which is used to load security policies

from a text file, create the related security policy objects and add them

to CPolicyDomain instance, controlled by aPolicyDomainBuilder object.

It is not called directly, but will be called back.

@param aPolicyDomainBuilder TPolicyDomainBuilder instance, which will be used to add

       created security policy objects to the controlled by it collection. 

@leave System-wide error codes

*/

void CPDTextLoader::RunL(TPolicyDomainBuilder& aPolicyDomainBuilder)

	{

	TStmtProps stmtProps;

	const CDbPolicy* dbPolicy = LoadDbPolicyL(aPolicyDomainBuilder, stmtProps);

	__ASSERT(dbPolicy);

	LoadTblPoliciesL(aPolicyDomainBuilder, stmtProps, dbPolicy);

	LoadBackupSIDL(aPolicyDomainBuilder, stmtProps);

	}

/**

The method returns ETrue if this is the end of file.

@return ETrue - EOF, EFalse otherwise

*/

TBool CPDTextLoader::IsEofL()

	{

	return iRdStream.Source()->TellL(MStreamBuf::ERead) >= iRdStream.Source()->SizeL();

	}

/**

The method parses a line from the text file, detects its type and gets the right side

of "=" as a text line data descriptor. The information will be stored in aStmtProps

parameter. If the text line is not recognizable, the method leaves with KErrCorrupt.

Recognizable text line formats are:

<[keyword]>

<keyword>

<keyword>=<value>

<;>[comments]

<blank line>

@param aStmt Current text line

@param aStmtProps The collected information will be stored there. Output parameter.

@leave KErrCorrupt - the text line has unknown format

*/

void CPDTextLoader::GetStmtPropsL(const TDesC& aStmt, TStmtProps& aStmtProps) const

	{

	aStmtProps.iValue.Set(aStmt);

	if(aStmt.Length() == 0)

		{

		aStmtProps.iType = EStmtTBlank;

		return;

		}

	else if(aStmt[0] == ';')

		{

		aStmtProps.iType = EStmtTComment;

		return;

		}

	TBool res = TryGetStmt1Props(aStmt, aStmtProps);

	if(!res)

		{

		res = TryGetStmt2Props(aStmt, aStmtProps);

		}

	if(!res)

		{

		__LEAVE(KErrCorrupt);

		}

	}

/**

Tries to process a text line as a:

<keyword>

or

<[keyword]>

@param aStmt Current text line

@param aStmtProps Output parameter

@return ETrue, if it is recognizable text line. Then the method will set the text line type 

			   in aStmtProps.iType data member.

		EFalse This is not recognizable text line with <keyword> or <[keyword]> format.

*/

TBool CPDTextLoader::TryGetStmt1Props(const TDesC& aStmt, TStmtProps& aStmtProps) const

	{

	aStmtProps.iType = DBSC::StmtKeywordT1ToId(aStmt);

	return aStmtProps.iType != EStmtTInvalid;

	}