// Copyright (c) 1998-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:

// Client MTM for the POP3 protocol

// 

//

#include <bautils.h>	// BaflUtils

#include <mtmdef.h>		//KUidMtmQueryxxx & TMsvPartList flags

#include <barsc.h>		//RResourceFile

#include <barsread.h>

#include <msvftext.h>

#include <cemailaccounts.h>

#include "POPCMTM.H"

#include "POP3SET.H"		//CImPop3Settings

#include <imcm.rsg>

#include "MIUT_ERR.H"

#include "IMCMMAIN.H"

#include "IMCMUTIL.H"

#include <autosend.h>

#include <msvenhancesearchsortutil.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS  

#include <mtmuidsdef.hrh>

#include "miut_errconsts.h"

#include "cimmessagepart.h"

#endif

#if defined (_UNICODE)

	#define KUidMsgInternetMailEditorDLL	0x10003C53  // (268450899)

#else

	#define KUidMsgInternetMailEditorDLL	0x100011AC  // (268439980)

#endif

_LIT(KMsvAutoSendExe, "Autosend.exe");

const TUid KMsvAutoSendExeUid = {0x1000A402}; //268477442

/**

@internalTechnology 

*/

EXPORT_C CPop3ClientMtm* CPop3ClientMtm::NewL(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession)

	{

	CPop3ClientMtm* self = new(ELeave) CPop3ClientMtm(aRegisteredMtmDll, aMsvSession);

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop();

	return self;

	}

CPop3ClientMtm::CPop3ClientMtm(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession)

: CBaseMtm(aRegisteredMtmDll, aMsvSession)

	{

	__DECLARE_NAME(_S("CPop3ClientMtm"));

	}

void CPop3ClientMtm::ConstructL()

	{

	iImPop3Settings = new (ELeave) CImPop3Settings;

	iHeader = CImHeader::NewLC();

	CleanupStack::Pop();	// iHeader

	//open the resource file

	RResourceFile resourceFile;

	OpenResourceFileL(resourceFile, Session().FileSession());

	CleanupClosePushL(resourceFile);

	HBufC8* buf = resourceFile.AllocReadLC(EMAIL_ADDRESS_FORMATTING_STRING);

	TResourceReader reader;

	reader.SetBuffer(buf);

	iEmailAddressFormatString = (reader.ReadTPtrC()).AllocL();

	CleanupStack::PopAndDestroy(2); // resourceFile (Close resourceFile), buf

	}

CPop3ClientMtm::~CPop3ClientMtm()

/** Destructor. */

	{

	delete iEmailAddressFormatString;

	delete iImPop3Settings;

	delete iImPOP3GetMail;

	delete iHeader;

	}

void CPop3ClientMtm::SaveMessageL()

/** Client MTM base class function, with an empty implementation. */

	{

	}

void CPop3ClientMtm::LoadMessageL()

/** Loads the cache with the message data for the current context. */

	{

	Body().Reset();

	iHeader->Reset();

	switch (iMsvEntry->Entry().iType.iUid)

		{

		case KUidMsvServiceEntryValue:

			RestoreSettingsL();

			break;

		case KUidMsvMessageEntryValue:

			{//restore header

			if (!iMsvEntry->HasStoreL())

				return;

		// Get a reference to TMsvEnhanceSearchSortUtil  instance set by CMsvSearchsortOpOnHeaderBody class

		// If advanced search and sort is being performed than do not load the message header and body.

		// These are loaded when the search criteria is known in FindL()

		// For API's other than CMsvSearchsortOpOnHeaderBody-> FindInHeaderBodyL(), a call to LoadMessageL()

		// loads the body and the header.

			TMsvEnhanceSearchSortUtil* searchsortutil = (TMsvEnhanceSearchSortUtil*)(GetExtensionData());

			if ( searchsortutil == NULL )

				{

				// Load message Body

				CMsvStore* msvStore = iMsvEntry->ReadStoreL();

				CleanupStack::PushL(msvStore);

		   		if (! msvStore->IsPresentL(KUidMsgFileIMailHeader) )

		    		{

		    		CleanupStack::PopAndDestroy(); //store

		    		return;

		    		}

				//Restore the header

				iHeader->RestoreL(*msvStore);

				CleanupStack::PopAndDestroy();//store

				CImEmailMessage* message=CImEmailMessage::NewLC(*iMsvEntry);

				message->GetBodyTextL(iMsvEntry->Entry().Id(),CImEmailMessage::EThisMessageOnly,Body(),*iParaFormatLayer,*iCharFormatLayer);

				CleanupStack::PopAndDestroy();//message	

				break;

				}

			}

		};

	}

EXPORT_C void CPop3ClientMtm::StoreSettingsL()

/** Stores the current service settings from the object's cache in to the Central 

Repository for the current entry.

The current entry must be a service. */

	{

	__ASSERT_DEBUG(iMsvEntry!=NULL,gPanic(EPopcMTMNoCMsvEntrySet));

	// check that current context is a service entry - Assuming that StoreL() is ONLY used to write to Service Entry. True?!

	__ASSERT_DEBUG(iMsvEntry->Entry().iType==KUidMsvServiceEntry,gPanic(EPopcMTMNotAServiceEntry));

	CEmailAccounts* account = CEmailAccounts::NewLC();

	TPopAccount id;

	account->GetPopAccountL(iMsvEntry->Entry().Id(), id);

	account->SavePopSettingsL(id, *iImPop3Settings);

	CleanupStack::PopAndDestroy(account);    

	}

EXPORT_C void CPop3ClientMtm::RestoreSettingsL()

/** Loads into the object's cache the service settings from the Central Repository for

the current entry.

The current entry must be a service. */

	{

	if (iMsvEntry->Entry().iType==KUidMsvServiceEntry)

		{

		CEmailAccounts* account = CEmailAccounts::NewLC();

		TPopAccount id;

		account->GetPopAccountL(iMsvEntry->Entry().Id(), id);

		account->LoadPopSettingsL(id, *iImPop3Settings);

		CleanupStack::PopAndDestroy(account);    

		}

	}

void CPop3ClientMtm::SendOnNextConnectionL()

	{

	TMsvId smtpServiceId = KMsvNullIndexEntryId;

	TMsvId entry = iMsvEntry->Entry().Id();

	if (iMsvEntry->Entry().iType.iUid==KUidMsvServiceEntryValue)

		smtpServiceId = iMsvEntry->Entry().iRelatedId;

	else if (iMsvEntry->Entry().iType.iUid==KUidMsvMessageEntryValue)

		{

		TMsvId id=iMsvEntry->Entry().iServiceId;

		iMsvEntry->SetEntryL(iMsvEntry->Entry().iServiceId);		

		smtpServiceId = iMsvEntry->Entry().iRelatedId;

		iMsvEntry->SetEntryL(id);		

		}

	iMsvEntry->SetEntryL(KMsvGlobalOutBoxIndexEntryId);

	CMsvEntrySelection* sel = iMsvEntry->ChildrenWithMtmL(KUidMsgTypeSMTP);

	CleanupStack::PushL(sel);

	// there is no need to start the autosend operation if there are no SMTP messages

	// in the outbox

	if(sel->Count())

		{

		TBuf<20> cmdString;

		cmdString.Num(smtpServiceId, EDecimal);

			RProcess p;

			TInt error=p.Create(KMsvAutoSendExe, cmdString, TUidType(KNullUid, KNullUid, KMsvAutoSendExeUid));

			if (error==KErrNone)

				{

				p.Resume();

				p.Close();

				}

		}

	CleanupStack::PopAndDestroy(sel);

	iMsvEntry->SetEntryL(entry);

	}

CMsvOperation* CPop3ClientMtm::ReplyL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus)

/** Creates a reply message to the current message context.

The reply is an SMTP message.

@return	If successful, this is an asynchronously completing reply operation. 

If failed, this is a completed operation, with status set to the relevant error code. 

@param aDestination The entry to which to assign the reply 

@param aPartList Defines the parts that are to be copied from the original message into the reply

@param aCompletionStatus The request status to be completed when the operation has finished 

*/

	{

	TMsvEmailTypeList msvEmailTypeList = 0;

	TUid messageType = KUidMsgTypeSMTP;

	return iImEmailOperation->CreateReplyL(aCompletionStatus, Session(), iMsvEntry->EntryId(), aDestination, aPartList, msvEmailTypeList, messageType);

	}

CMsvOperation* CPop3ClientMtm::ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus)

/** Creates a forwarded message from the current message context.

The forwarded message is an SMTP message.

@return	If successful, this is an asynchronously completing forward message operation. 

If failed, this is a completed operation, with status set to the relevant error code. 

@param aDestination The entry to which to assign the forwarded message  

@param aPartList Defines the parts that are to be copied from the original message into the forwarded message 

@param aCompletionStatus The request status to be completed when the operation has finished 

*/

	{

	TMsvEmailTypeList msvEmailTypeList = 0;

	TUid messageType = KUidMsgTypeSMTP;

	return iImEmailOperation->CreateForwardL(aCompletionStatus, Session(), iMsvEntry->EntryId(), aDestination, aPartList, msvEmailTypeList, messageType);

	}

TUint CPop3ClientMtm::ValidateMessage(TMsvPartList /*aPartList*/)

	/** Client MTM base class function, with an empty implementation.

	@param aPartList Unused

	@return Unused */

	{

	return KMsvMessagePartRecipient;

	}

TBool CPop3ClientMtm::ValidateAddress(const TPtrC& anAddress)

	{

	return iTImMessageField.ValidInternetEmailAddress(anAddress);

	}

TMsvPartList CPop3ClientMtm::DoFindL(const TDesC& aTextToFind, TMsvPartList aPartList)

   	{

   	CImClientMTMUtils* clientMTMUtils = CImClientMTMUtils::NewL();

   	CleanupStack::PushL(clientMTMUtils);

   	TMsvPartList retList = KMsvMessagePartNone;

 	// For POP3 mail we need to search the entry as well as the header. This is because the header stream might not be present.

 	CMsvFindText* findText = CMsvFindText::NewLC();

  	// Get a reference to TMsvEnhanceSearchSortUtil instance set by CMsvSearchsortOpOnHeaderBody class

 	TMsvEnhanceSearchSortUtil* searchsortutil = (TMsvEnhanceSearchSortUtil*)(GetExtensionData());

 	// searchsortuitl variable will not be NULL for Advanced Search and Sort called from CMsvSearchsortOpOnHeaderBody

 	// For the old implementation, it will be NULL

  	if( searchsortutil != NULL )

 		{

 		// Get the searchsort setting flags

 		TInt32 searchsortsetting=searchsortutil->GetSearchSortSetting();

 		// The body was not loaded in LoadMessageL()

 		// If 2 search query options are on the body or on the header, than it sets EMessagePartBodyLoaded flag

 		// of searchsortsetting

 		if(aPartList & KMsvMessagePartBody && !(searchsortsetting & EMessagePartBodyLoaded))  	

   			{

   			// Restore Body

   			CImEmailMessage* message=CImEmailMessage::NewLC(*iMsvEntry);

			message->GetBodyTextL(iMsvEntry->Entry().Id(),CImEmailMessage::EThisMessageOnly,Body(),*iParaFormatLayer,*iCharFormatLayer);

			CleanupStack::PopAndDestroy();//message

			searchsortutil->SetSearchSortSetting(EMessagePartBodyLoaded);

   			}

   		else if(!(searchsortsetting & EMessagePartHeaderLoaded))

   			{

 			// Restore header

			CMsvStore* msvStore = iMsvEntry->ReadStoreL();

  			CleanupStack::PushL(msvStore);

		   	if (! msvStore->IsPresentL(KUidMsgFileIMailHeader) )

		    	{

		    	CleanupStack::PopAndDestroy(); //store

		    	return 0;

		    	}

			iHeader->RestoreL(*msvStore);

			CleanupStack::PopAndDestroy();//store

			searchsortutil->SetSearchSortSetting(EMessagePartHeaderLoaded);

			}

   		// Issue the find request

   		clientMTMUtils->FindL(aTextToFind, Body(), *iHeader, aPartList, retList);

   		/* If the search didn't succeed, than search in the details field of TMsvEntry class. It holds the From field

		   If the search is on subject, than look in description field of TMsvEntry class.	*/

   		if(!retList)

 			{

 			if (aPartList & KMsvMessagePartFrom)

 				{

 				findText->FindTextL(aTextToFind, iMsvEntry->Entry().iDetails, aPartList) ? retList|=KMsvMessagePartOriginator : retList;

 				}

	 		if (aPartList & KMsvMessagePartSubject)

	 			{

		 		findText->FindTextL(aTextToFind, iMsvEntry->Entry().iDescription, aPartList) ? retList|=KMsvMessagePartDescription : retList;

		 		}

 			}

 		/* Copy the sort data if sorting is specified.

		 The operations being performed could be only be sort or it could be search and sort

		 If the operation is search and sort than copy the sort data only if the

		 search operation succeeded	*/   		

   		if ((searchsortsetting & EMessagePartSort ) || (((searchsortsetting & EMessagePartSearchSort) && (searchsortsetting & EMessagePartLastQueryOption) && (retList))))

   			{

   			/* Copy the data to be sorted from the header stream.

   			   This done by setting iExtensionData to point to the field being copied */

	   		if (iHeader)

   				{

   				if (searchsortsetting & EMessagePartToSort )

   					{

	   				SetExtensionData((TAny*)&iHeader->ToRecipients()); 

   					}

   				else if(searchsortsetting & EMessagePartCcSort)

   					{

	   				SetExtensionData((TAny*)&iHeader->CcRecipients());

   					}

 	  			else if(searchsortsetting & EMessagePartBccSort)

    				{

    				SetExtensionData((TAny*)&iHeader->BccRecipients());

    				}

	    		else if(searchsortsetting & EMessagePartFromSort)

    				{

    				SetExtensionData((TAny*)(iHeader->From().Ptr()));

    				}

				else if(searchsortsetting & EMessagePartSubjectSort)

					{

					SetExtensionData((TAny*)(iHeader->Subject().Ptr()));	

					}

    			}

   			else  // Header not present only originator and description is available 

   	   			{ 

   		    	if(searchsortsetting & EMessagePartFromSort)

   		    		{

   		    		SetExtensionData((TAny*)&iMsvEntry->Entry().iDetails);

   		    		}

 				else if(searchsortsetting & EMessagePartSubjectSort)

 					{

 					SetExtensionData((TAny*)&iMsvEntry->Entry().iDescription);		

 					}

  				}

   			}

   		}

   	else // Old implementation for search

   		{

		clientMTMUtils->FindL(aTextToFind, Body(), *iHeader, aPartList, retList);

   		if(!retList)

 			{

 			if (aPartList & KMsvMessagePartOriginator)

 				{

 				findText->FindTextL(aTextToFind, iMsvEntry->Entry().iDetails, aPartList) ? retList|=KMsvMessagePartOriginator : retList;

 				}

	 		if (aPartList & KMsvMessagePartDescription)

	 			{

		 		findText->FindTextL(aTextToFind, iMsvEntry->Entry().iDescription, aPartList) ? retList|=KMsvMessagePartDescription : retList;

		 		}

 			}

   		}

	CleanupStack::PopAndDestroy(findText);

	CleanupStack::PopAndDestroy(); //clientMTMUtils

  	return retList;

 	}

TMsvPartList CPop3ClientMtm::Find(const TDesC& aTextToFind, TMsvPartList aPartList)

/** Searches the specified message part(s) for the plain-text version of the text 

to be found.

@param aTextToFind The plain-text version of the text to be found. 

@param aPartList Indicates the message parts which should be searched. 

@return If the text was not found, or searching is unsupported, 0. If the text 

was found, a bitmask of the TMsvPartList IDs for each part in which the text 

was present. */

 	{

 	TMsvPartList retList = KMsvMessagePartNone;

 	TRAPD(ret, retList = DoFindL(aTextToFind, aPartList));

   	return retList;

   	}

void CPop3ClientMtm::AddAddresseeL(const TDesC& aRealAddress)

/** Adds an addressee for the current context.

@param aRealAddress String representing an address to be added to the list 

for the current message */

	{

	iAddresseeList->AppendL(aRealAddress);

	}

void CPop3ClientMtm::AddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias)

/** Adds an addressee with an alias for the current context.

@param aRealAddress String representing an address to be added to the list 

for the current message 

@param aAlias Alias information */

	{

	HBufC* emailAddress = HBufC::NewLC(aRealAddress.Length()+aAlias.Length()+iEmailAddressFormatString->Length()-4);

	emailAddress->Des().Format(*iEmailAddressFormatString,&aAlias,&aRealAddress);

	iAddresseeList->AppendL(aRealAddress);

	CleanupStack::PopAndDestroy();	// emailAddress

	}

void CPop3ClientMtm::RemoveAddressee(TInt aIndex)

/** Removes an address from the current address list.

@param aIndex Index of address to be removed */

	{

	if (iAddresseeList->Count() > aIndex)

		iAddresseeList->Delete(aIndex);

	}

void CPop3ClientMtm::ContextEntrySwitched()

	{

	iImPop3Settings->Reset();

	iHeader->Reset();

	Body().Reset();	

	}

TInt CPop3ClientMtm::QueryCapability(TUid aCapability, TInt& aResponse)

/** Queries if the MTM supports a particular capability, specified by a UID.

@param aCapability UID of capability to be queried 

@param aResponse Response value. The format of the response varies according 

to the capability. 

@return KErrNone: aCapability is a recognised value and a response is returned 

KErrNotSupported: aCapability is not a recognised value */

	{

	TInt error = KErrNone;

	// Supported

	switch (aCapability.iUid)

		{

	case KUidMtmQueryMaxBodySizeValue:

	case KUidMtmQueryMaxTotalMsgSizeValue:

		aResponse = KMaxTInt;

		break;

	case KUidMsvMtmQueryEditorUidValue:

		aResponse = KUidMsgInternetMailEditorDLL;

		break;

	case KUidMtmQuerySupportedBodyValue:

		aResponse = KMtm7BitBody + KMtm8BitBody + KMtm16BitBody + KMtmBinaryBody;

		break;

	case KUidMtmQuerySupportAttachmentsValue:

	case KUidMtmQueryCanReceiveMsgValue:		

		break;

	// All others - Not Supported:

	default:

		error = KErrNotSupported;

		}

	return error;

	}

EXPORT_C void CPop3ClientMtm::SetSettingsL(const CImPop3Settings& aSettings)

/** Copies the specified service settings to the cached service settings.

@param aSettings New service settings */

	{

	iImPop3Settings->CopyL(aSettings);

	}

EXPORT_C const CImPop3Settings& CPop3ClientMtm::Settings() const

/** Gets the current cached service settings.

@return The current cached service settings */

	{

	return *iImPop3Settings;

	}

void CPop3ClientMtm::InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter)

/** Invokes synchronous POP3-specific operations.

@param aFunctionId ID of the requested operation. The only supported operation 

is KPOP3MTMIsConnected.

@param aSelection Selection of message entries. This is used if the operation 

requires message entries to work on. 

@param aParameter Buffer containing input and output parameters. The format 

of this is specific to the operation. */

	{

	__ASSERT_DEBUG(iMsvEntry!=NULL,gPanic(EPopcMTMNoCMsvEntrySet));

	TInt error = KErrNone;

	switch (aFunctionId)

		{

		case KPOP3MTMIsConnected:

			{

			CMsvOperationActiveSchedulerWait* synchOperation;

			synchOperation=CMsvOperationActiveSchedulerWait::NewLC();

			CMsvOperation* operation = Session().TransferCommandL(aSelection, KPOP3MTMIsConnected, aParameter, synchOperation->iStatus);

			synchOperation->Start();

			CleanupStack::PushL(operation);

			error = operation->iStatus.Int();

			CleanupStack::PopAndDestroy(2);	// synchOperation, operation

			TPop3Progress progress;

			progress.iErrorCode = error;