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

// imapsyncmanager.cpp

// 

//

#include "cimapsyncmanager.h"

#include "cimapopsyncfoldertree.h"

#include "cimapopsyncsubs.h"

#include "cimapfolder.h"

#include "cimapsessionconsts.h"

#include "cimaplogger.h"

#ifdef __IMAP_LOGGING

#include <utf.h>

#endif

// Inbox mailbox name

_LIT(KIMAP_INBOX, "INBOX");

// Inbox mailbox name used for display purposes

_LIT(KImapInboxDisplayName, "Inbox");

/**

Private default class constructor

*/

CImapSyncManager::CImapSyncManager(CMsvServerEntry& aEntry, CImapSettings& aImapSettings)

:	CMsgActive(EPriorityStandard), 

	iServerEntry(aEntry), 

	iImapSettings(aImapSettings),

	iInboxClearNewFlags(ETrue),

	iNonInboxClearNewFlags(ETrue)

	{

	}

/**

Class destructor

*/

CImapSyncManager::~CImapSyncManager()

	{

	delete iFolderTreeSync;

	delete iSyncSubs;

	delete iSubscribeList;

	delete iUnsubscribeList;

	delete iInbox;

	iFolderList.ResetAndDestroy();

	}

/**

Static factory constructor

@param aServiceId

The TMsvId of the Imap service that is being accessed.

@param aOffLine The CImapOfflineControl that provides access methods to pending offline operations

@return The constructed CImapSuncManager object pushed onto the cleanup stack

*/

EXPORT_C CImapSyncManager* CImapSyncManager::NewLC(CMsvServerEntry& aEntry, CImapSettings& aImapSettings)

	{

	CImapSyncManager* self=new (ELeave) CImapSyncManager( aEntry, aImapSettings);

	CleanupStack::PushL(self);

	// Non-trivial constructor

	self->ConstructL();

	return self;

	}

/**

Static factory constructor with cleanup

@param aServiceId

The TMsvId of the Imap service that is being accessed.

@param aOffLine The CImapOfflineControl that provides access methods to pending offline operations

@return The constructed CImapSuncManager object

*/

EXPORT_C CImapSyncManager* CImapSyncManager::NewL(CMsvServerEntry& aEntry, CImapSettings& aImapSettings)

	{

	CImapSyncManager* self=NewLC( aEntry, aImapSettings);

	CleanupStack::Pop();

	return self;

	}

/**

The non-trival constructor. Initialise the data members and create the subcribed local folder list

*/

void CImapSyncManager::ConstructL()

	{

	// Get the flags from iImapSettings

	iSynchroniseStrategy = iImapSettings.Synchronise();

	iSubscribeStrategy = iImapSettings.Subscribe();

	iServiceId = iImapSettings.ServiceId();

	// Find the inbox

	GetInboxL();

	// Create the list for the rest of the folders

	iSubscribeList=new (ELeave) RArray<TUint>(4);

	iUnsubscribeList=new (ELeave) RArray<TUint>(4);

	CreateLocalFolderListL();

	// We're an active object...

	CActiveScheduler::Add(this);

	}

/** 

Set the current entry context on the Message server

@param aId

The entry id to set in the Message server

@leave KErrNotFound if the entry does not exist or KErrLocked if the entry is locked.

*/

void CImapSyncManager::SetEntryL(const TMsvId aId)

	{

	User::LeaveIfError(iServerEntry.SetEntry(aId));

	}

/**

Sets the context's index entry to the specified values on the Message server

@param  aEntry

The new details for the entry.

@leave KErrAccessDenied - the entry is read only (deleted entry, standard folder, or locked); 

KErrNotSupported - aEntry is invalid or the ID specified in aEntry is not the same as the context ID

or no context has been set for the object; 

KErrNoMemory - a memory allocation failed. 

*/

void CImapSyncManager::ChangeEntryL(const TMsvEntry& aEntry)

	{

	User::LeaveIfError(iServerEntry.ChangeEntry(aEntry));

	}

/**

Change entry in bulk mode (i.e no index file commit. no notify)

@param  aEntry

The new details for the entry.

@leave KErrAccessDenied - the entry is read only (deleted 

entry, standard folder, or locked); 

KErrNotSupported - aEntry is invalid or the 

ID specified in aEntry is not the same as the context ID or no context has been 

set for the object; 

KErrNoMemory - a memory allocation failed.

*/

void CImapSyncManager::ChangeEntryBulkL(const TMsvEntry& aEntry)

	{

	User::LeaveIfError(iServerEntry.ChangeEntryBulk(aEntry));

	}

/**

Return a list of all child entries of the currently selected entry node.

@param  aSelection

The ids for the found child entries will be put into this parameter

*/

void CImapSyncManager::GetChildrenL(CMsvEntrySelection& aSelection)

	{

	User::LeaveIfError(iServerEntry.GetChildren(aSelection));

	}

/** 

Returns a pointer to the CImapFolder object associated with the passed entry ID.

CImapSyncManager maintains an array of CImapFolder objects that are subscribed

according to sync and subscribe strategy settings - if the folder exists in this

array then the pointer to this instance is returned. Otherwise a CImapFolder

instance is created for the specified folder and appended to the list.

As the folder list is rebuilt on folder tree synscronisation, code using this

API cannot expect a returned pointer to remain valid following an account or

folder tree synchronisation operation.

This method preserves the context of the shared CMsvServerEntry

@param aMsvId The TMsvId of the folder as stored in the message server

@param aAddToSubscribedList holds bool value,  ETure adds to subscribed list, EFalse does not add.

@return NULL if the folder does not exist, pointer to the CImapFolder object otherwise.

*/

EXPORT_C CImapFolder* CImapSyncManager::GetFolderL(TMsvId aMsvId, TBool aAddToSubscribedList)

	{

	TMsvId preservedId = iServerEntry.Entry().Id();

	// Retrieve the folder from the maintained list if it is present.

	// Will be present if it is subscribed according to settings.

	CImapFolder* folder = GetFolderFromList(aMsvId);

	if (folder==NULL)

		{

		// Requested folder is not in the list of subscribed mailboxes.

		// It may have been subscribed locally since the last folder sync 

		// operation, or the client application may be attempting to access

		// a non-subscribed folder.

		// Create an instance for the folder and add it to the folder list.

		SetEntryL(aMsvId);

		TMsvEmailEntry entry = iServerEntry.Entry();

		folder = CImapFolder::NewLC(*this, iServerEntry, entry, iImapSettings, KNullDesC());

		if(aAddToSubscribedList)

			{

			iFolderList.AppendL(folder);

			}

		CleanupStack::Pop(folder);

		// recover original serverentry context

		SetEntryL(preservedId);

		}

	return folder;

	}

/**

Returns a pointer to the CImapFolder object associated with the passed entry ID,

if it appears in the array of CImapFolders.

@param aMsvId The TMsvId of the folder as stored in the message server

@return NULL if the folder is not in the list, pointer to the CImapFolder object otherwise.

*/

CImapFolder* CImapSyncManager::GetFolderFromList(TMsvId aMsvId)

	{

	// Check the inbox first

	if(iInbox)

		{

		if(iInbox->MailboxId() == aMsvId)

			{

			return iInbox;

			}

		}

	TInt count = iFolderList.Count();

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

		{

		if(iFolderList[i]->MailboxId() == aMsvId)

			{

			return iFolderList[i];

			}

		}

	// the folder does not exist

	return NULL;

	}

/** 

This function populates the CImapfolder object passed in by the caller using the TMsvId given to get the relevent folder from

the message server.

@param aMsvId.

The TMsvId of the folder as stored in the message server to be use to find the imap folder 

@return Returns NULL if the folder is not subscribed or does not exist, pointer to the CImapFolder object otherwise.

*/

EXPORT_C CImapFolder* CImapSyncManager::GetTempFolderL(TMsvId aMsvId)

	{

	CImapFolder* tempfolder = NULL;

	SetEntryL(aMsvId);

	TMsvEmailEntry entry = iServerEntry.Entry();

	tempfolder = CImapFolder::NewLC(*this, iServerEntry, entry, iImapSettings, KNullDesC());

	CleanupStack::Pop(tempfolder);

	return tempfolder;

	}

/** 

This function populates the CImapfolder object that represent the current service Inbox

@return Returns the pointer to the CImapFolder representing the Inbox.

*/

EXPORT_C CImapFolder* CImapSyncManager::Inbox()

	{

	return iInbox;

	}

RArray<TUint>* CImapSyncManager::GetUnSubscribedFolderToDoList()

	{

	return iUnsubscribeList;

	}

RArray<TUint>* CImapSyncManager::GetSubscribedFolderToDoList()

	{

	return iSubscribeList;

	}

/** 

Search through the messaging server to find the entry that represented the inbox and if not already

in the list of CImapFolder objects, create one.

*/

void CImapSyncManager::GetInboxL()

	{

	// Remove the old inbox

	delete iInbox;

	iInbox = NULL;

	// First of all, synchronise the inbox

	CMsvEntrySelection *findinbox=new (ELeave) CMsvEntrySelection;

	CleanupStack::PushL(findinbox);

	SetEntryL(iServiceId);

	GetChildrenL(*findinbox);

	// Find inbox	

	TMsvId inboxid=0;

	for(TInt a=0;a<findinbox->Count();a++)

		{

		SetEntryL((*findinbox)[a]);

		if(iServerEntry.Entry().iDetails.CompareF(KIMAP_INBOX)==0)

			{

			inboxid=(*findinbox)[a];

			TMsvEmailEntry e = iServerEntry.Entry();

			if((iInbox = GetFolderFromList(inboxid)) == NULL)

				{

				CImapFolder* tempfolder = CImapFolder::NewLC(*this, iServerEntry, e, iImapSettings, KIMAP_INBOX());

				CleanupStack::Pop(tempfolder);

				iInbox = tempfolder;

				}

			// Mailbox flag not set? It always should be. This will 'repair' it.

			if(!e.Mailbox())

				{

				// Set it

				e.SetMailbox(ETrue);

				ChangeEntryL(e);

				}

			// Found the inbox, so no need to search any further

			break; // from for loop

			}

		}

	// Clean up

	CleanupStack::PopAndDestroy(findinbox);

	findinbox = NULL;

	// Not found/no entries?

	if(inboxid == 0)

		{

		// Create an inbox entry below the service. This is a local-only

		// creation as the server *WILL* have an inbox.

		SetEntryL(iServiceId);

		TMsvEmailEntry entry;

		entry.iType = KUidMsvFolderEntry;

		entry.iMtm = KUidMsgTypeIMAP4;

		entry.iServiceId = iServiceId;

		entry.SetMtmData1(0);

		entry.SetMtmData2(0);

		entry.SetMtmData3(0);

		entry.iSize = 0;

		entry.SetUID(0);

		entry.SetValidUID(EFalse);

		entry.SetMailbox(ETrue);

		entry.SetLocalSubscription(ETrue);

		entry.SetComplete(ETrue);

		entry.iDetails.Set(KImapInboxDisplayName);

		User::LeaveIfError(iServerEntry.CreateEntry(entry));

		// Set inbox

		// not there so add it

		CImapFolder* tempfolder = CImapFolder::NewLC(*this, iServerEntry, entry, iImapSettings, KIMAP_INBOX());

		CleanupStack::Pop(tempfolder);

		iInbox = tempfolder;

		}

	}

/**

Synchronise outstanding delete operations on all subscribe folders on the IMAP service

@param aStatus

The TRequestStatus to complete

@param aSession

The session to be use for the sync operation

*/

EXPORT_C void CImapSyncManager::SynchroniseDeletesL(TRequestStatus& /*aStatus*/, CImapSession& /*aSession*/)

	{

	}

/**

Function to synchronise the inbox only.

@param aStatus

The TRequestStatus to complete

@param aSession

The session to be use for the sync operation

*/

EXPORT_C void CImapSyncManager::SynchroniseInboxL(TRequestStatus& aStatus, CImapSession& aSession)

	{

	//initialise progress 

	iFoldersToDo=0;

	iFoldersDone=0;

	iFoldersNotFound=0;

	iErrorCode=KErrNone;

	iSyncDoSingleStep = ETrue;

	iSession = &aSession;

	// Note the invisibility

	iNewFoldersAreInvisible = iImapSettings.UpdatingSeenFlags();

	iPerformDeletes = iImapSettings.DeleteEmailsWhenDisconnecting();

	// Get the synchronise settings

	iSynchroniseStrategy = iImapSettings.Synchronise();

	iSubscribeStrategy = iImapSettings.Subscribe();

	GetInboxL();

	// Reset stats: 1 folder remaining (inbox)

	iFoldersToDo = 1;

	iSyncProgressState = TImap4SyncProgress::ESyncInbox;

	// Synchronise with the inbox

	iInbox->SelectL(iStatus, aSession, EFalse);

	iSyncState = EInboxSelect;

	iNextSyncAction = EInboxSync;

	Queue(aStatus);

	SetActive();

	}

/**

Synchronise the subscription status for the folders on the remote server only.

@param aStatus

The TRequestStatus to complete

@param aSession

The session to be use for the sync operation

*/

EXPORT_C void CImapSyncManager::SynchroniseFolderSubscriptionsL(TRequestStatus& aStatus, CImapSession& aSession)

	{

	// Only do this step

	iSyncDoSingleStep = ETrue;

	// Save the session

	iSession = &aSession;

	// Run the sync folder subscriptions status step

	// set iSyncState when folder subscription is kicked off in DoRunL()

	iNextSyncAction = ECheckRemoteSubscription;

	Queue(aStatus);

	CompleteSelf();

	SetActive();

	}

/**

At the first call the value of aFolderId should be set to 0. This parameter will be updated with

each call. Therefore after each calll to this function the value of aFolderCounter should be check,

if the value is -1 then the last folder has already been processed.

The Inbox is not part of this function call.

@param aFolderCounter

Folder counter to keep track of the current folder to be process. 

*/

EXPORT_C void CImapSyncManager::NextSubscribedFoldersL(TMsvId& aFolderId)

	{

	// Only do this step

	iSyncDoSingleStep = ETrue;

	if(aFolderId > 0)

		{

		// Get the next folder TMsvId and sets the variable

		++iSyncFolderCounter;

		if((iSyncFolderCounter) < iFolderList.Count())

			{

			CImapFolder *folder = iFolderList[iSyncFolderCounter];

			aFolderId = folder->MailboxId();

			}

		else

			{			

			aFolderId = -1;

			}

		}

	else if(aFolderId == 0)

		{

		iSyncFolderCounter = 0;

		if(iFolderList.Count() > 0)

			{

			CImapFolder *folder = iFolderList[0];

			aFolderId = folder->MailboxId();

			}

		else

			{

			aFolderId = -1;

			}

		}

	else

		{

		aFolderId = -1;

		__ASSERT_DEBUG(EFalse,TImapServerPanic::ImapPanic(TImapServerPanic::EImapSyncManagerInvalidFolderID));

		}

	}

/**

Perform the next synchronise step for all subscribed folders on the IMAP service.

This function should only be call after one to NextSubscribedFoldersL to setup the folder to be synchronise.

The Inbox will not be synchronise with this function call.

@param aStatus

The TRequestStatus to complete

@param aSession

The session to be use for the sync operation

@param aFolderId

Folder id to keep track of the current folder to be process. 

*/

EXPORT_C void CImapSyncManager::SynchroniseSubscribedFoldersL(TRequestStatus& aStatus, CImapSession& aSession, TMsvId& aFolderId)

	{

	// Only do this step

	iSyncDoSingleStep = ETrue;

	// Save the session

	iSession = &aSession;

	// Run the sync folder subscriptions status step

	if(aFolderId > 0)

		{

		iNextSyncAction = EFolderSelect;

		Queue(aStatus);

		CompleteSelf();

		SetActive();

		}

	}