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

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Symbian Foundation License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// [TestStep Name]

// ComparePopEmailMsgs

// [Paramaters]

// PopAccountName		: 		Name of the POP account

// Compares the recieved mails with the expected numbers of lines to test POP3 TOP command

// 

//

/**

 @file

*/

// User includes

#include "CExpMailInfo.h"

#include "T_ComparePopEmailMsgs.h"

#include <t_utils.h>

#include <t_utilscentralrepository.h>

#include <t_utilsenumconverter.h>

// Epoc includes

#include <imcm.rsg>

#include <miutmsg.h>

#include <mmsvattachmentmanager.h>

// Literals Used

_LIT(KPopAccountName,"PopAccountName");

/**

ConstructL()

Used to ensure that MMsvAttachmentManager is not destroyed until we want it to be.

To do this we need to preserve certain objects of CImEmailMessage, which if disappeared

would invalidate MMsvAttachmentManager. But this should be deleted in a controlled manner.

@param aSession

An object of type CMsvSession object.

@param aEntry

An object of type TMsvEntry used to get the entry ID. 

*/

void CAttachmentItem::ConstructL(CMsvSession& aSession, TMsvEntry aEntry)

	{

	iMsvEntry = aSession.GetEntryL(aEntry.Id());

	iMsvEntry->SetEntryL(aEntry.Id());

	iEmailMsg = CImEmailMessage::NewL(*iMsvEntry);

	CMsvOperationActiveSchedulerWait* waiter = CMsvOperationActiveSchedulerWait::NewLC();

 	iEmailMsg->GetAttachmentsListL(waiter->iStatus, aEntry.Id(),

								   CImEmailMessage::EAllAttachments, 

								   CImEmailMessage::EThisMessageOnly);

	waiter->Start();

	CleanupStack::PopAndDestroy(1, waiter); //waiter		

	}

/**

NewL()

Allocates and creates a new CAttachmentItem object

@param aSession

An object of type CMsvSession object.

@param aEntry

An object of type TMsvEntry

@leave KErrNoMemory

@return 

A pointer to an object of type CAttachmentItem

*/

CAttachmentItem* CAttachmentItem::NewL(CMsvSession& aSession, TMsvEntry aEntry)

	{

	CAttachmentItem* self=CAttachmentItem::NewLC(aSession, aEntry);

	CleanupStack::Pop(self);

	return self;

	}

/**

NewLC()

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack.

@param aSession

An object of type CMsvSession object.

@param aEntry

An object of type TMsvEntry

@leave KErrNoMemory

@return

A pointer to the newly created CAttachmentItem object.

*/

CAttachmentItem* CAttachmentItem::NewLC(CMsvSession& aSession, TMsvEntry aEntry)

	{

	CAttachmentItem* self=new (ELeave) CAttachmentItem;

	CleanupStack::PushL(self);

	self->ConstructL(aSession, aEntry);

	return self;

	}

/**

~CAttachmentItem()

Destroy the data members.

*/

CAttachmentItem::~CAttachmentItem()

	{

	delete iEmailMsg;

	iEmailMsg=NULL;

	delete iMsvEntry;

	iMsvEntry=NULL;

	}

/**

MMsvAttachmentManager()

@return

An object of MMsvAttachmentManager

*/

MMsvAttachmentManager& CAttachmentItem::MMsvAttachmentManager() const

	{			

	return (iEmailMsg->AttachmentManager());		

	}

/**

GetExpPop3MailInfoLC()

Sets the CExpPop3MailInfo attributes reading from the INI file

@param  aIndx

Index in the selection list.

@leave KErrNotReady

@return

A pointer to an object of type CExpPop3MailInfo

*/

CExpPop3MailInfo* CT_MsgComparePopEmailMsgs::GetExpPop3MailInfoLC(TInt aIndx)

	{

	CExpPop3MailInfo* expMailInfo  = new (ELeave) CExpPop3MailInfo;

	CleanupStack::PushL(expMailInfo);

	TInt comInt = -1;

	_LIT(KNumOfLines,"NumOfLines%d");

	TBuf<256> param;

	param.Format(KNumOfLines,aIndx);

	if (!GetIntFromConfig(ConfigSection(), param, comInt))

		{

		ERR_PRINTF1(_L("No Input for NumOfLines"));

		User::Leave(KErrNotReady);

		}

	expMailInfo->SetNumLinesBodyText(comInt);

	comInt = -1;

	_LIT(KFooterExpected, "FooterExpected%d");

	param.Format(KFooterExpected,aIndx);

	if (!GetIntFromConfig(ConfigSection(), param, comInt))

		{

		ERR_PRINTF1(_L("No Input for Footer Expected"));

		User::Leave(KErrNotReady);

		}

	expMailInfo->SetFooterExpected(comInt);

	comInt = -1;

	_LIT(KNumOfLinesHtml, "NumOfLinesHtml%d");

	param.Format(KNumOfLinesHtml, aIndx);

	if (!GetIntFromConfig(ConfigSection(), param, comInt))

		{

		ERR_PRINTF1(_L("No Input For NumOfLinesHtml"));

		User::Leave(KErrNotReady);

		}

	expMailInfo->SetNumLinesHtml(comInt);

	TPtrC ptrDes;

	_LIT(KDescription, "Description%d");

	param.Format(KDescription, aIndx);

	if(!GetStringFromConfig(ConfigSection(), param, ptrDes))

		{

		ERR_PRINTF1(_L("No Input for Description"));

		User::Leave(KErrNotReady);

		}

	expMailInfo->SetDescription(ptrDes);

	_LIT(KNumOfAttachments, "NumOfAttachments%d");

	param.Format(KNumOfAttachments, aIndx);

	if (!GetIntFromConfig(ConfigSection(), param, comInt))

		{

		ERR_PRINTF1(_L("No Input for NumOfAttachments"));

		User::Leave(KErrNotReady);

		}

	expMailInfo->SetNumAttachments(comInt);

	comInt = -1;

	if(expMailInfo->GetFooterExpected())

		{

		_LIT(KFooterSize, "FooterSize%d");

		param.Format(KFooterSize, aIndx);

		if (!GetIntFromConfig(ConfigSection(), param, comInt))

			{

			ERR_PRINTF1(_L("No Input for FooterSize"));

			User::Leave(KErrNotReady);

			}

		expMailInfo->SetFooterSize(comInt);

		}

	else

		{

		expMailInfo->SetFooterSize(0);

		}

	return expMailInfo;

	}

/**

LoadParametersL()

Loads the test parameters 

@leave KErrNotReady

@return

ETrue if parameters loaded, Efalse on failure.

*/

TBool CT_MsgComparePopEmailMsgs::LoadParametersL()

	{

	TPtrC sentFolder;

	_LIT(KSentFolder, "SentFolder");

	if(!GetStringFromConfig(ConfigSection(), KSentFolder, sentFolder))

		{

		ERR_PRINTF1(_L("No Input for Sent Folder"));

		User::Leave(KErrNotReady);

		}

	iSentSelectionList = CT_MsgUtils ::CreateChildrenSelectionL(iSharedDataPOP.iSession, CT_MsgUtilsEnumConverter::FindFolderIdByName(sentFolder));

	if(! iSentSelectionList)

		{

		ERR_PRINTF1(_L("Invalid sentSelectionList"));

		SetTestStepResult(EFail);

		return EFalse;

		}

	TPtrC inboxFolder;

	_LIT(KInboxFolder, "InboxFolder");

	if(!GetStringFromConfig(ConfigSection(), KInboxFolder, inboxFolder))

		{

		ERR_PRINTF1(_L("No Input for Inbox Folder"));

		User::Leave(KErrNotReady);

		}

	TPtrC popAccountName;

	if(!GetStringFromConfig(ConfigSection(), KPopAccountName, popAccountName))

		{

		ERR_PRINTF1(_L("Account name not specified"));

		SetTestStepResult(EFail);

		}

	if (CT_MsgUtilsEnumConverter::FindFolderIdByName(inboxFolder) == KMsvLocalServiceIndexEntryId)

		{

		// We are expecting to get a selection of remote Folder(which is the serviceId)

		TMsvId popServiceId = CT_MsgUtilsCentralRepository::GetPopServiceIdL((TDes&)popAccountName);

		CMsvEntry* entry = iSharedDataPOP.iSession->GetEntryL(popServiceId);

		CleanupStack::PushL(entry);

		entry->SetEntryL(popServiceId); // Setting the context to remote folder.

		iInboxSelectionList = CT_MsgUtils ::CreateChildrenSelectionL(iSharedDataPOP.iSession, popServiceId);

		CleanupStack::PopAndDestroy(entry);

		}

	else

		{

		iInboxSelectionList = CT_MsgUtils ::CreateChildrenSelectionL(iSharedDataPOP.iSession, CT_MsgUtilsEnumConverter::FindFolderIdByName(inboxFolder));

		}

	if(! iInboxSelectionList)

		{

		ERR_PRINTF1(_L("Invalid inboxSelectionList"));

		SetTestStepResult(EFail);

		return EFalse;

		}

	//Starting the comparision

	if(iInboxSelectionList->Count() != iSentSelectionList->Count())

		{

		ERR_PRINTF3(_L("iInboxSelectionList->Count(%d) != iSentSelectionList->Count(%d)"),

								 iInboxSelectionList->Count(), iSentSelectionList->Count());

		SetTestStepResult(EFail);

		return EFalse;

		}

	TInt comInt = -1;

	_LIT(KNumTest, "NumTest");

	if (!GetIntFromConfig(ConfigSection(), KNumTest, comInt))

		{

		ERR_PRINTF1(_L("No Input for NumTests"));

		User::Leave(KErrNotReady);

		}

	TInt numTests = comInt;

	if(numTests != iInboxSelectionList->Count())

		{

		ERR_PRINTF1(_L("iNumTests != iInboxSelectionList"));

		SetTestStepResult(EFail);

		return EFalse;

		}

	iExpResults.Reset();

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

		{

		CExpPop3MailInfo* pExp = GetExpPop3MailInfoLC(i);

		if(! pExp)

			{

			ERR_PRINTF1(_L("Invalid expected mail Info"));

			SetTestStepResult(EFail);

			return EFalse;

			}

		else

			{

			CleanupStack::Pop(pExp); // pExp			

			iExpResults.Append(pExp);

			}

		}

	return ETrue;

	}

/**

DoCompareL()

Comparison of 2 email messages identified by TMsvEntry

@param  aRecvEntry

The recieved email identifier.

@param  aMailInfo

Expected state of the recieved email.

@param  aSentEntry

Identifier of the original sent email foir comparison purposes.

@return

ETrue if emails match EFalse otherwise

*/

TBool CT_MsgComparePopEmailMsgs::DoCompareL(TMsvEntry& aRecvEntry, CExpPop3MailInfo& aMailInfo, TMsvEntry& aSentEntry)

	{

	TBool ret = ETrue;

	TBool footerExists = EFalse;

	TInt footersize = 0;

	TInt nLines = GetMessageLinesL(aRecvEntry, KUidMsvEmailTextEntry, footerExists, footersize);

	if(nLines != aMailInfo.GetNumLinesBodyText())

		{

		ERR_PRINTF3(_L("Lines of body text wrong actual = %d expected = %d!"), nLines, aMailInfo.GetNumLinesBodyText());

		ret = EFalse;

		}

	nLines = GetMessageLinesL(aRecvEntry, KUidMsvEmailHtmlEntry, footerExists, footersize);

	if(nLines != aMailInfo.GetNumLinesHtml())

		{		

		ERR_PRINTF3(_L("HTML size wrong actual = %d expected = %d!"), nLines, aMailInfo.GetNumLinesHtml());

		ret = EFalse;

		}

	else if(! CheckAttachmentsL(aRecvEntry, aMailInfo, aSentEntry))

		{

		ERR_PRINTF1(_L("Attachment comparison failed !"));

		ret = EFalse;

		}

	else if(! footerExists && aMailInfo.GetFooterExpected())

		{

		ERR_PRINTF1(_L("An expected footer was missing !"));

		ret = EFalse;

		}

	else if(footerExists && ! aMailInfo.GetFooterExpected())

		{

		ERR_PRINTF1(_L("An unexpected footer was found !"));

		ret = EFalse;

		}

	else if(aMailInfo.GetFooterExpected() && aMailInfo.GetFooterSize()!=0 

			&& aMailInfo.GetFooterSize() != footersize)

		{

		ERR_PRINTF3(_L("KB left on server size wrong = %d expected = %d!"), footersize, aMailInfo.GetFooterSize());

		ret = EFalse;			

		}

	return ret;

	}

/**

CheckAttachmentsL()

Compares attachments for the email messages aRecvEntry and aSentEntry using

expected results in aMailInfo

@param aRecvEntry

An identifier for the recieved email

@param aMailInfo

Expected state of recieved email attachments

@param aSentEntry

An identifier for the original email

@return

ETrue if attachments match otherwise EFalse

*/

TBool CT_MsgComparePopEmailMsgs::CheckAttachmentsL(TMsvEntry& aRecvEntry, CExpPop3MailInfo& aMailInfo, TMsvEntry& aSentEntry)

	{

	TBool ret = ETrue;

	CAttachmentItem* recvManager = CAttachmentItem::NewLC(*iSharedDataPOP.iSession, aRecvEntry);

	CAttachmentItem* sentManager = CAttachmentItem::NewLC(*iSharedDataPOP.iSession, aSentEntry);

	TInt recvCount = recvManager->MMsvAttachmentManager().AttachmentCount();	

	TInt sentCount = sentManager->MMsvAttachmentManager().AttachmentCount();

	TFileName recvFileName;

	TFileName sentFileName;

	if(recvCount == aMailInfo.GetNumAttachments())

		{

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

			{

			for(TInt j=0;j<sentCount;j++)

				{

				CMsvAttachment* recvAttInfo = recvManager->MMsvAttachmentManager().GetAttachmentInfoL(i);

				CleanupStack::PushL(recvAttInfo);

				CMsvAttachment* sentAttInfo = sentManager->MMsvAttachmentManager().GetAttachmentInfoL(j);

				CleanupStack::PushL(sentAttInfo);

				if(recvAttInfo->AttachmentName().Compare(sentAttInfo->AttachmentName()) == 0)

					{

					recvFileName = recvAttInfo->FilePath();

					sentFileName = sentAttInfo->FilePath();

					ret = CompareFilesL(recvFileName, sentFileName);

					}

				CleanupStack::PopAndDestroy(2, recvAttInfo);		

				}

			}

		}

	else

		{

		INFO_PRINTF3(_L("Warning - Expected attachments mismatch recieved (%d) expected (%d)"),

								 recvCount, aMailInfo.GetNumAttachments());

		ret = EFalse;

		}

	CleanupStack::PopAndDestroy(2, recvManager); // recvManager,sentManager

	return ret;

	}

/**

CompareFilesL()

Performs byte for byte copmparison of the files indicated by aFileName1 and aFileName2

@param aFileName1

Filename of first file to be compared

@param aFileName2

Filename of second file to be compared

@return

ETrue if files match, EFalse otherwise

*/

TBool CT_MsgComparePopEmailMsgs::CompareFilesL(TFileName& aFileName1, TFileName& aFileName2)

	{

	TBool ret = ETrue;

	RFile file1, file2;

	User::LeaveIfError(file1.Open(iFs, aFileName1, EFileRead));

	User::LeaveIfError(file2.Open(iFs, aFileName2, EFileRead));

	TInt sz1, sz2;

	User::LeaveIfError(file1.Size(sz1));

	User::LeaveIfError(file2.Size(sz2));

	if(sz1 != sz2)

		{

		ERR_PRINTF3(_L("File size mismatch 1(%d)   2(%d)"), sz1, sz2);

		ret = EFalse;

		}

	else

		{

		TBuf8<1> char1;

		TBuf8<1> char2;

		TInt len1, len2;

		do

			{

			file1.Read(char1);

			file2.Read(char2);

			len1 = char1.Length();

			len2 = char2.Length();

			if(char1.Compare(char2) != 0)

				{

				ret = EFalse;

				break;

				}