// 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:

// Deal with a connection to an IMAP4rev1 server

// This involves logging in, issuing commands and parsing responses into

// suitable return formats as necessary, and updating the message server's

// database.

// 

//

#include <msvstd.h>

#include <miuthdr.h>

#include <miut_err.h>

#include <msventry.h>

#include <imcvutil.h>

#include <txtetext.h>

#include <cmsvbodytext.h>

#include <txtrich.h>

#include <imcvtext.h>

#include <imcvsend.h>

#include <imcm.rsg>		// resource definition for IMCV

#include <barsread.h>	// TResourceReader

#include <msvapi.h>

#include "impsmtm.h"

#include "imapsess.h"

#include "impspan.h"

#include "fldindex.h"

#include <imapset.h>

#include <miutlog.h>

#include <msvstore.h>

#include <commdb.h>

#include <commdbconnpref.h>

#include <mmsvattachmentmanager.h>

#include <mmsvattachmentmanagersync.h>

#include <cemailaccounts.h>

#ifdef __WINS__

#include <e32wins.h>    // for maxfilename lengths

#include <msvapi.h>

#endif

#ifdef _DEBUG

#define LOG_COMMANDS(a) a

#define DBG(a) a

#define PRINTING

#else

#define LOG_COMMANDS(a)

#define DBG(a)

#undef PRINTING

#endif

#include "cimapcanceltimer.h"

#include "mimapsessionobserver.h"

// For the "UID SEARCH" command, the reply is of the form:

// "* SEARCH 1234547890 1234567891 ......."

//      :         :

//  |---9---|	  :

//           |---11----|

//

// Here the untagged headers is 9 characters and each UID part may be up to 11 characters.

// So if we wanted to limit the number of replies recieved in a single search so that it is

// no larger is size than a single body fetch part....

// Maximum number of UIDs acceptable in a single reply.

const TInt KImapUidSearchSize=(5120-9)/11;

// Initial size of buffer in which the "Real name <user@host>" strings

// are built before they're put into the CImHeader and the size by

// which to increment the buffer when necessary

const TInt KImapAddressSizeInc=256;

// Initial size of the buffer containing the UID Search list

const TInt KUidListStringSize=256;

// Illegal UID we use for marker

const TUint KIllegalUID	= 0xffffffff;

// Idle time when waiting for a cancelled fetch to complete (microseconds)

const TInt KImapFetchCancelIdleTime	= 10000000;	// 10 seconds

// Idle time (seconds) when waiting for a DONE command to complete

// when coming out of IMAP IDLE state.

const TInt KImapDoneInactivityTimeSeconds = 5;

// IMAP text

_LIT8(KIMAP_UNTAGGED, "*");

_LIT8(KIMAP_CONTINUATION, "+");

_LIT8(KIMAP_BODY, "BODY");

_LIT8(KIMAP_BODYPEEK, "BODY.PEEK");

_LIT8(KIMAP_BODYSTRUCTURE, "BODYSTRUCTURE");

_LIT8(KIMAP_BYE, "BYE");

_LIT8(KIMAP_CAPABILITY, "CAPABILITY");

_LIT8(KIMAP_EXISTS, "EXISTS");

_LIT8(KIMAP_EXPUNGE, "EXPUNGE");

_LIT8(KIMAP_FETCH, "FETCH");

_LIT8(KIMAP_FLAGS, "FLAGS"); 

_LIT8(KIMAP_HEADERFIELDS, "HEADER.FIELDS");

_LIT8(KIMAP_ALERT, "ALERT");

_LIT8(KIMAP_LIST, "LIST");

_LIT8(KIMAP_LSUB, "LSUB");

_LIT8(KIMAP_NIL, "NIL");

_LIT8(KIMAP_NO, "NO");

_LIT8(KIMAP_PREAUTH, "PREAUTH");

_LIT8(KIMAP_READWRITE, "READ-WRITE");

_LIT8(KIMAP_READONLY, "READ-ONLY");

_LIT8(KIMAP_RECENT, "RECENT");

_LIT8(KIMAP_RFC822SIZE, "RFC822.SIZE");

_LIT8(KIMAP_UID, "UID");

_LIT8(KIMAP_UIDVALIDITY, "UIDVALIDITY");

_LIT8(KIMAP_UIDNEXT, "UIDNEXT");

_LIT8(KIMAP_MIME, "MIME");

_LIT8(KIMAP_SEARCH, "SEARCH");

// IMAP capabilities

_LIT8(KIMAP_VERSION, "IMAP4rev1");

_LIT8(KIMAP_STARTTLS, "STARTTLS");

_LIT8(KIMAP_LOGINDISABLED, "LOGINDISABLED");

_LIT8(KIMAP_IDLE, "IDLE");

// IMAP commands (trailing spaces, except for those which take no params)

_LIT8(KIMAPC_CLOSE, "CLOSE");

_LIT8(KIMAPC_LOGOUT, "LOGOUT");

_LIT8(KIMAPC_SUBSCRIBE, "SUBSCRIBE ");

_LIT8(KIMAPC_UNSUBSCRIBE, "UNSUBSCRIBE ");

_LIT8(KIMAPC_IDLE, "IDLE");

_LIT8(KIMAPC_DONE, "DONE");

// IMAP flags

_LIT8(KIMAPFLAG_NOSELECT, "\\Noselect");

_LIT8(KIMAPFLAG_NOINFERIORS, "\\Noinferiors");

_LIT8(KIMAPFLAG_ANSWERED, "\\Answered");

_LIT8(KIMAPFLAG_DELETED, "\\Deleted");

_LIT8(KIMAPFLAG_DRAFT, "\\Draft");

_LIT8(KIMAPFLAG_FLAGGED, "\\Flagged");

_LIT8(KIMAPFLAG_RECENT, "\\Recent");

_LIT8(KIMAPFLAG_SEEN, "\\Seen");

_LIT8(KIMAPFLAG_UNREAD, "\\Unread");

// MIME message types

_LIT8(KMIME_MESSAGE, "MESSAGE");

_LIT8(KMIME_RFC822, "RFC822");

_LIT8(KMIME_TEXT, "TEXT");

_LIT8(KMIME_HTML, "HTML");

_LIT8(KMIME_XVCARD, "X-VCARD");

_LIT8(KMIME_VCALENDAR, "X-VCALENDAR");

_LIT8(KMIME_ICALENDAR, "CALENDAR");

_LIT8(KMIME_NAME, "NAME");

_LIT8(KMIME_NAME_RFC2231, "NAME*");

_LIT8(KMIME_FILENAME, "FILENAME");

_LIT8(KMIME_FILENAME_RFC2231, "FILENAME*");

_LIT8(KMIME_ATTACHMENT, "ATTACHMENT");

_LIT8(KMIME_DELIVERY_STATUS, "DELIVERY-STATUS");

_LIT8(KMIME_ALTERNATIVE, "ALTERNATIVE");

_LIT8(KMIME_RELATED, "RELATED");

_LIT8(KMIME_IMAGE, "IMAGE");

_LIT8(KMIME_AUDIO, "AUDIO");

_LIT8(KMIME_VIDEO, "VIDEO");

_LIT8(KMIME_APPLICATION, "APPLICATION");

// Encoding types

_LIT8(KMIME_BASE64, "BASE64");

// Multipart types

_LIT8(KMIME_MIXED, "MIXED");

// for first stage download (to view in folder list)

_LIT8(KImapFetchSmallHeaderToEnd, "%d UID FETCH %d:* (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From %S)])\r\n");

_LIT8(KImapFetchSmallHeaderRange,"%d UID FETCH %d:%d (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From %S)])\r\n");

_LIT8(KImapFetchSmallHeaderRangeRefined,"%d UID FETCH %S (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From %S)])\r\n");

// for second stage download (to view when downloading whole email)

_LIT8(KImapFetchLargeHeader, "%d UID FETCH %d (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From Reply-to To Cc Bcc Message-ID %S)])\r\n");

_LIT8(KImapFetchLargeHeaderRange, "%d UID FETCH %d:* (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From Reply-to To Cc Bcc Message-ID %S)])\r\n");

// Use %S so we can specify a refined FETCH based on a previous refined SEARCH

_LIT8(KImapFetchLargeHeaderRangeRefined, "%d UID FETCH %S (UID FLAGS BODYSTRUCTURE BODY.PEEK[HEADER.FIELDS (Received Date Subject From Reply-to To Cc Bcc Message-ID %S)])\r\n");

// Constants for fetching body

_LIT8(KImapFetchBodyPeek, "%d UID FETCH %d (BODY.PEEK[%S]<%d.%d>)\r\n");

_LIT8(KImapFetchBody,     "%d UID FETCH %d (BODY[%S]<%d.%d>)\r\n");

_LIT8(KImapFetchMimeBodyPeek, "%d UID FETCH %u (BODY.PEEK[%S]<0.%d> BODY.PEEK[%S.MIME])\r\n");

_LIT8(KImapFetchMimeBody,     "%d UID FETCH %u (BODY[%S]<0.%d> BODY[%S.MIME])\r\n");

// Constants for sending commands 

_LIT8(KImapCommand, "%S\r\n");

// The maximum number of octets to be uuencoded on each line is 45

const TInt KUuDecodedLineLength = 45;	

const TInt KBodyTextChunkSizeBytes = 512;

const TInt KKiloByteSize = 1024;

// UIDs are  32bit integers, which takes maximum 10 decimal digits.

// KMaxUint32Chars is used to check whether the string containg the UID 

// list has allocated enough memory when creating it.

const TInt KMaxUint32Chars = 10;

// Processing to remove illegal characters from a filename

LOCAL_C void StripIllegalCharactersFromFileName(TDes16& aName)

    {

    TInt length=aName.Length();

    for(TInt index=0; index < length; index++)

        {

		//parse extracted filename and replace any illegal chars  with a default

        TUint charr=(TUint)aName[index];

        if(	charr == '*' || charr == '\\' || charr == '<' || charr == '>' ||

            charr == ':'  || charr == '"' || charr == '/' || charr == '|' ||

			charr == '?' || charr < ' ')

            {

            aName[index] = KImcvDefaultChar;

            }

        }

   }

// We don't do the async notifications yet: they make everything a bit more wobbly

// SJM actually I guess we do do them now!

#define ASYNC_NOTIFICATIONS

// do we automatically set the iRelatedId of each object to itself? No

// for now as it confuses the offline handling code which assumes it

// is a shadow entry if iRelatedId is set.

#define SET_RELATED_ID	0

// This is very nasty but necessary as the flag returning functions

// return 0 or not-zero not 0 or 1

#define FIXBOOL(a)		(a?ETrue:EFalse)

// Directory structure

CImImap4DirStruct::CImImap4DirStruct()

	{

	}

CImImap4DirStruct::~CImImap4DirStruct()

	{

	// Get rid of leaf

	delete iLeafname;

	}

void CImImap4DirStruct::SetLeafnameL(const TDesC& aName)

	{

	// Make buffer, set it

	iLeafname=HBufC::NewL(aName.Length());

	*iLeafname=aName;

	}

TPtrC CImImap4DirStruct::Leafname()

	{

	// Return it

	return(*iLeafname);

	}

CImImap4Session::CImImap4Session(MImapSessionObserver& aObserver) // construct high-priority active object

	: CMsgActive(1), iState(EImapStateDisconnected), iCancelledTag(-1),

	  iSecurityState(EUnknown), iCharset(KCharacterSetIdentifierUtf8),

	  iObserver(aObserver),iPrimarySession(NULL)

	{

	__DECLARE_NAME(_S("CImImap4Session"));

	}

CImImap4Session* CImImap4Session::NewLC(TInt aId, MImapSessionObserver& aObserver)

	{

	CImImap4Session* self=new (ELeave) CImImap4Session(aObserver);

	CleanupStack::PushL(self);

	self->ConstructL(aId);

	return self;

	}

CImImap4Session* CImImap4Session::NewL(TInt aId, MImapSessionObserver& aObserver)

	{

	CImImap4Session* self=NewLC(aId, aObserver);

	CleanupStack::Pop();

	return self;

	}

void CImImap4Session::ConstructL(TInt aId)

	{

	// Add to active scheduler

	CActiveScheduler::Add(this);

	// Get FS

	User::LeaveIfError(iFs.Connect());

	// Get somewhere to store service settings

	iServiceSettings=new (ELeave) CImImap4Settings;

	// Get an IO processor

	iImapIO=CImapIO::NewL(aId);

	// Message selection

	iSelection=new (ELeave) CMsvEntrySelection;

	// List of messages to delete on folder close

	iDeletedUids=new (ELeave) CArrayFixFlat<TMsvId>(8);

	// List of messages to fetch in single fetch operation

	iFetchList=new (ELeave) CArrayFixFlat<TMsvId>(8);

	// List of messages who's Seen status has changed

	iSetSeenList=new (ELeave) CArrayFixFlat<TMsvId>(8);

	iClearSeenList=new (ELeave) CArrayFixFlat<TMsvId>(8);

	RResourceFile resFile;

	OpenResourceFileL(resFile,iFs);	// NB leaves if file not found

	// make sure the resource file will be closed if anything goes wrong

	// CloseResourceFile is declared in IMCVDLL.H and defined in IMCVDLL.CPP

	TCleanupItem close(CloseResourceFile,&resFile);

	CleanupStack::PushL(close);

	// Read iStore8BitData flag.

	HBufC8* buf = resFile.AllocReadLC( STORE_8BIT_BODY_TEXT );

	TResourceReader reader;

	reader.SetBuffer(buf);

	iStore8BitData = reader.ReadInt8();

	CleanupStack::PopAndDestroy(buf);

	buf=resFile.AllocReadLC(DEFAULT_ATTACHMENT_NAME);

	reader.SetBuffer(buf);

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

	CleanupStack::PopAndDestroy(2, &resFile); // buf, resFile (Close resfile)

	if (!iStore8BitData)

		{

		// CRichText bits

		iParaLayer=CParaFormatLayer::NewL();

		iCharLayer=CCharFormatLayer::NewL();

		}

	// Create converter objects

	iCharacterConverter=CCnvCharacterSetConverter::NewL();

	iCharConv=CImConvertCharconv::NewL(*iCharacterConverter, iFs);

	iHeaderConverter=CImConvertHeader::NewL(*iCharConv); 

	// we assume that this message is MIME as we have no way of

	// detecting otherwise (without sending a new FETCH to the

	// server to get the MIME-Version).

	iHeaderConverter->SetMessageType(ETrue);

	// Get timer to defeat IMSK timeout

	iDummyRead = CImImap4SessionDummyRead::NewL(*this, *iImapIO, Priority());

	iIdleRead =  CImImap4SessionIdleRead::NewL(*this, Priority());

	// List of message UIDs in a folder

	iSearchList=new (ELeave) CArrayFixFlat<TUint32>(8);		// For granularity of 8, 32 bytes are allocated each time.

	iSyncLimit = KImImapSynchroniseAll;

	// set up progress types

	iProgress.iType=EImap4GenericProgressType;

	iCurrentDrive = MessageServer::CurrentDriveL(iFs);

	iIdleTimerExpired = EFalse;

	iIdleTimer = CIdleTimeoutTimer::NewL(*this);

	iReissueIdle = EFalse;

	iDisconnectAfterIdleStopped = EFalse;

	iFetchPartialMail=EFalse;

	iCaf = new (ELeave) CImCaf(iFs);

	iIsICalendar = EFalse;

	iIsVCalendar = EFalse;

	iUidString = HBufC8::NewL(KUidListStringSize);

	iCancelTimer = CImapCancelTimer::NewL(*this);

	}

CImImap4Session::~CImImap4Session()

	{

	Cancel(); // make sure we're cancelled

	delete iDummyRead;

	delete iIdleRead;

	// No settings

	delete iServiceSettings;

	delete iPrefs;

	// Get rid of connection

	delete iImapIO;

	// Get rid of message body bits

	delete iBodyBuf;

	delete iMessageBody;

	delete iBodyText;

	delete iParaLayer;

	delete iCharLayer;

	// Message selection

	delete iSelection;

	// List of messages to delete

	delete iDeletedUids;

	// List of messages to fetch

	delete iFetchList;

	// List of seen flags to set/clear

	delete iSetSeenList;

	delete iClearSeenList;

	// Partial line: used when doing Q-P decoding, as it works on a line at a time.

	delete iPartialLine;

	// Any attachment info (ie: there was a fetch in progress)

	delete iAttachmentFile;

	delete iAttachmentFullPath;

	delete iAttachmentMimeInfo;

	delete iDefaultAttachmentName;

	delete iFooterString;

	// Any message sizer left over (ie: we've been deleted in the middle of

	// an append operation)

	delete iMessageSizer;

	delete iMessageSender;

	delete iLineBuffer;

	// Characterset conversion

	delete iHeaderConverter;

	delete iCharConv;

	delete iCharacterConverter;

	// CMsvServerEntry used for moves

	delete iMoveEntry;

	//cached TMsvEntry data

	delete iCachedEntryData;

	// List of message UIDs in a folder

	delete iSearchList;

	// Selection passed during synchronisation

	delete iSynchronisationSelection;

	delete iIdleTimer;

	delete iCaf;

	delete iUidString;

	iFs.Close();

	delete iCancelTimer;

	//Delete Username and Password

	delete iUsername;

	delete iPassword;

	// Note: iList is owned by a caller, not us - we don't delete it

	}

// Logging calls: passed through to ImapIO

void CImImap4Session::LogText(const TDesC8& aString)

	{

	// Log the text

	iImapIO->LogText(aString);

	}

void CImImap4Session::LogText(TRefByValue<const TDesC8> aFmt,...)

	{

	VA_LIST list;

	VA_START(list,aFmt);

	TBuf8<1024> aBuf;

	//handles the data over flow panics. returns immediately without performing any action.

	TDes8OverflowHandler overFlowHandler;

	aBuf.AppendFormatList(aFmt,list, &overFlowHandler);

	LogText(aBuf);

	}

// Do setentry, leave if there is an error

void CImImap4Session::SetEntryL(const TMsvId aId)

	{

#ifdef PRINTING

	TInt error=iEntry->SetEntry(aId);

	if (error)

		LogText(_L8("SetEntryL(%x) returned %d"),aId,error);

	User::LeaveIfError(error);

#else

	User::LeaveIfError(iEntry->SetEntry(aId));

#endif

	}

// Change entry, leave if error

void CImImap4Session::ChangeEntryL(const TMsvEntry& aEntry)

	{

#ifdef PRINTING

	TInt error=iEntry->ChangeEntry(aEntry);

	if (error)

		LogText(_L8("ChangeEntryL(%x) returned %d"),aEntry.Id(),error);

	User::LeaveIfError(error);

#else

	User::LeaveIfError(iEntry->ChangeEntry(aEntry));

#endif

	}

// Change entry in bulk mode (i.e. no index file commit), leave if error

void CImImap4Session::ChangeEntryBulkL(const TMsvEntry& aEntry)

	{

#ifdef PRINTING

	TInt error=iEntry->ChangeEntryBulk(aEntry);

	if (error)

		LogText(_L8("ChangeEntryL(%x) returned %d"),aEntry.Id(),error);

	User::LeaveIfError(error);

#else

	User::LeaveIfError(iEntry->ChangeEntryBulk(aEntry));

#endif

	}

// Get children, leave if error

void CImImap4Session::GetChildrenL(CMsvEntrySelection& aSelection)

	{

#ifdef PRINTING

	TInt error=iEntry->GetChildren(aSelection);

	if (error)

		LogText(_L8("GetChildrenL() returned %d"),error);

	User::LeaveIfError(error);