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

//

#ifdef _DEBUG

#undef _NO_SESSION_LOGGING_

#endif

#include <s32std.h>

#include <txtrich.h>

#include "MSVIDS.H"

#include "MSVUIDS.H"

#include "MSVAPI.H"

#include "MSVCOP.H"

#include "MCLENTRY.H"

#include "MSVPANIC.H"

#include "MSVUTILS.H"

#include <mmsvstoremanager.h>

const TInt KMsvClientEntryArrayGranuality=8;

const TInt KMsvEntryObserverArrayGranuality=4;

const TInt KMsvMtmListGranularity=8;

//**********************************

// CMsvClientEntry

//**********************************

// static 

CMsvClientEntry* CMsvClientEntry::NewLC(const TMsvEntry& aEntry, TMsvClientEntryType aType)

	{

	CMsvClientEntry* self = new(ELeave) CMsvClientEntry(aEntry, aType);

	CleanupStack::PushL(self);

	self->ConstructL();

	return self;

	}

CMsvClientEntry::CMsvClientEntry(const TMsvEntry& aEntry, TMsvClientEntryType aType)

:iEntry(aEntry), iType(aType)

	{

	__DECLARE_NAME(_S("CMsvClientEntry"));

	}

CMsvClientEntry::~CMsvClientEntry()

	{

	delete iDescription;

	delete iDetails;

	}

void CMsvClientEntry::ConstructL()

	{

	iDescription = HBufC::NewL(iEntry.iDescription.Length());

	iDescription->Des().Copy(iEntry.iDescription);

	iEntry.iDescription.Set(iDescription->Des());

	iDetails = HBufC::NewL(iEntry.iDetails.Length());

	iDetails->Des().Copy(iEntry.iDetails);

	iEntry.iDetails.Set(iDetails->Des());

	}

//**********************************

// CMsvEntry

//**********************************

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

EXPORT_C CMsvEntry* CMsvEntry::NewL(CMsvSession& aMsvSession, TMsvId aMsvId, const TMsvSelectionOrdering& aOrdering, TBool aChildrenOfAvailableDrives)

/** Creates a new CMsvEntry for the specified entry ID. 

Note that this function does not create a new entry, but simply a new object 

to access an existing entry. To create a new entry, use CreateL().

@param aMsvSession The client’s Message Server session 

@param aMsvId ID of the entry to access 

@param aSortType  The initial sort order of children of the entry, for example, 

when returned by ChildrenL(). The order can be changed later by SetSortTypeL().

@param aChildrenOfAvailableDrives Indicates whether children from all available drives are 

to be fetched during construction of this entry. However, a value of true is valid only

if aMsvId is one of the standard folders, i.e. Inbox, Outbox, Drafts, Sent or Deleted.

@return If the function succeeds, this is a pointer to a newly allocated and initialised object. 

@leave KErrNotFound The requested entry does not exist.

@leave KErrNoMemory A memory allocation failed.

@leave KErrArgument aChildrenOfAvailableDrives is set to true and the requested entry is not 

one of the standard folders, i.e. Inbox, Outbox, Drafts, Sent or Deleted.

*/

    {

    CMsvEntry* self = new(ELeave) CMsvEntry(aMsvSession, aOrdering, aChildrenOfAvailableDrives);

    CleanupStack::PushL(self);

    self->ConstructL(aMsvId);

    CleanupStack::Pop();

    return self;

    }

CMsvEntry::CMsvEntry(CMsvSession& aMsvSession, const TMsvSelectionOrdering& aOrdering, TBool aChildrenOfAvailableDrives)

:iState(EValid), iMsvSession(aMsvSession), iOrdering(aOrdering), iChildrenOfAvailableDrives(aChildrenOfAvailableDrives)

    {

    __DECLARE_NAME(_S("CMsvEntry"));

    }

EXPORT_C void CMsvEntry::SetStandardFolderEntryL(TMsvId aId)

//

// Changes the context to another entry

// If the function leaves, the context is unchanged

//

/** Sets the context to the specified entry while also fetching

children from all available drives. This function can be used to

set the context to only the standard folders i.e. Inbox, Outbox,

Drafts, Sent or Deleted.

If the function leaves, the context is unchanged.

@param aId ID of the message entry which is to become the new context 

@leave KErrNotFound aId could not be found in the index.

@leave KErrArgument aId is not one of the standard folders, i.e. Inbox,

Outbox, Drafts, Sent or Deleted folders.

*/

    {

    __ASSERT_ALWAYS(iStore==NULL, PanicServer(EMsvStoreLeftOpen));

    if (aId==iEntryPtr->Id() && iState==EValid)

        return;

    SetEntryNoCheckL(aId, ETrue);

    }

#endif           // #if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

EXPORT_C CMsvEntry* CMsvEntry::NewL(CMsvSession& aMsvSession, TMsvId aMsvId, const TMsvSelectionOrdering& aOrdering)

//

//

//

/** Creates a new CMsvEntry for the specified entry ID. 

Note that this function does not create a new entry, but simply a new object 

to access an existing entry. To create a new entry, use CreateL().

@param aMsvSession The client’s Message Server session 

@param aMsvId ID of the entry to access 

@param aSortType  The initial sort order of children of the entry, for example, 

when returned by ChildrenL(). The order can be changed later by SetSortTypeL(). 

@return If the function succeeds, this is a pointer to a newly allocated and initialised object. 

@leave KErrNotFound The requested entry does not exist 

@leave KErrNoMemory A memory allocation failed 

*/

	{

	CMsvEntry* self = new(ELeave) CMsvEntry(aMsvSession, aOrdering);

	CleanupStack::PushL(self);

	self->ConstructL(aMsvId);

	CleanupStack::Pop();

	return self;

	}

CMsvEntry::CMsvEntry(CMsvSession& aMsvSession, const TMsvSelectionOrdering& aOrdering)

:iState(EValid), iMsvSession(aMsvSession), iOrdering(aOrdering)

//

//

//

	{

	__DECLARE_NAME(_S("CMsvEntry"));

	}

EXPORT_C CMsvEntry::~CMsvEntry()

//

//

//

/** Destructor. 

This cleans up the object. CMsvEntry objects must be deleted by client applications 

when they are no longer required. Note that deleting a CMsvEntry object does 

not delete the context, simply the immediate means of accessing it. */

	{

	__ASSERT_ALWAYS(iStore==NULL, PanicServer(EMsvStoreLeftOpenOnDestruction2));

	if (iOberserverAdded)

		iMsvSession.RemoveObserver(*this);

	if (iEntries)

		iEntries->ResetAndDestroy();

	delete iEntries;

	delete iSortedChildren;

	delete iObservers;

	delete iMtmList;

	}

void CMsvEntry::ConstructL(TMsvId aId)

//

//

//

	{

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

    if(iChildrenOfAvailableDrives && !MsvUtils::IsStandardId(aId))

        {

        User::Leave(KErrArgument);

        }

#endif

	iEntries = new (ELeave) CArrayPtrFlat<CMsvClientEntry>(KMsvClientEntryArrayGranuality);

	iMtmList = new(ELeave) CArrayFixFlat<TUid>(KMsvMtmListGranularity);

	iSortedChildren = CMsvEntryArray::NewL(*iMtmList);

	// get the required entry from the server

	CMsvClientEntry* cEntry = DoGetEntryLC(aId, iOwningService);

	cEntry->SetType(EMsvClientContext);

	iEntries->AppendL(cEntry);

	CleanupStack::Pop(); // cEntry

	iEntryPtr = &iEntries->At(0)->Entry();

	// get the children

	DoGetChildrenL();

	// Get the notification sequence number

	iNotifySequence = iMsvSession.Session().NotifySequenceL();

	// get the event notifications from the server

	iMsvSession.AddObserverL(*this);

	iOberserverAdded=ETrue;

#ifndef _NO_SESSION_LOGGING_

	Log(_L("Constructed CMsvEntry on entry %x"), aId); 

#endif

	}

#ifndef _NO_SESSION_LOGGING_

void CMsvEntry::Log(TRefByValue<const TDesC> aFmt, ...)

	{

	VA_LIST list;

	VA_START(list, aFmt);

	// Generate the text

	TBuf<256> buf;

	buf.FormatList(aFmt, list);

	// Write to file

	_LIT(KFormatFile, "CMsvEntry %x: %S");

	iMsvSession.iLog.WriteFormat(KFormatFile, this, &buf);

	// Write to serial

#ifndef _NO_SESSION_LOGGING_SERIAL_

	_LIT(KFormatSerial, "MSGS: CMsvEntry %x: %S");

	RDebug::Print(KFormatSerial, this, &buf);

#endif

	}

#endif

CMsvClientEntry* CMsvEntry::DoGetEntryLC(TMsvId aId, TMsvId& aOwningService)

//

// Gets the entry data from the server and create a CMsvClientEntry around it

//

	{

	TMsvEntry tEntry;

	User::LeaveIfError(iMsvSession.Session().GetEntry(aId, aOwningService, tEntry));

	if (tEntry.iType==KUidMsvRootEntry)

		aOwningService=aId;

	return CMsvClientEntry::NewLC(tEntry, EMsvClientNull);

	}

void CMsvEntry::DoGetChildrenL()

//

// Gets the children of the context and places them in the entries array

// The sorted children pointer array is implicited sorted, as the entries are retrieved

// from the server with the current sort order

//

	{

	__ASSERT_DEBUG(iEntries->Count()==1, PanicServer(EMsvChildEntriesExist1));

	__ASSERT_DEBUG(iSortedChildren->Count()==0, PanicServer(EMsvChildEntriesExist2));

	// get the children from the server - using only the visible flag

	TMsvSelectionOrdering order(KMsvNoGrouping, EMsvSortByNone, iOrdering.ShowInvisibleEntries());

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

    // If child entries from all drives in the device are to be fetched.

    if(iChildrenOfAvailableDrives)

        {

		User::LeaveIfError(iMsvSession.Session().GetChildrenAll(iEntryPtr->Id(), *iEntries, order));

		}

	else

#endif

        {

        User::LeaveIfError(iMsvSession.Session().GetChildren(iEntryPtr->Id(), *iEntries, order));

		}

	// add the children to the sorted pointer list - current context is the first entry

	TInt totalCount=iEntries->Count();

	for (TInt count=1; count<totalCount; count++)

		iSortedChildren->AppendL(&iEntries->At(count)->Entry());

	// sort the children

	iSortedChildren->SortL(iOrdering);

	}

EXPORT_C void CMsvEntry::SetEntryL(TMsvId aId)

//

// Changes the context to another entry

// If the function leaves, the context is unchanged

//

/** Sets the context to the specified entry. 

If the function leaves, the context is unchanged.

@param aId ID of the message entry which is to become the new context 

@leave KErrNotFound aId could not be found in the index */

	{

	__ASSERT_ALWAYS(iStore==NULL, PanicServer(EMsvStoreLeftOpen));

	if (aId==iEntryPtr->Id() && iState==EValid)

		return;

 	SetEntryNoCheckL(aId);

	}

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

EXPORT_C void CMsvEntry::SetEntryNoCheckL(TMsvId aId, TBool aChildrenOfAvailableDrives /* DEFAULT=EFalse*/)

//

// Changes the context to another entry

// If the function leaves, the context is unchanged

// The function does not check for when the context is already on

// the given TMsvId.

//

/** Sets the context to the specified entry.

Children from all available drives will be fetched depending on the value of

aChildrenOfAvailableDrives.

If the function leaves, the context is unchanged.

@internalTechnology

@param aId ID of the message entry which is to become the new context

@param aChildrenOfAvailableDrives Indicates whether children from all available drives are to

be fetched during construction of this entry. However, a value of true is valid only

if aMsvId is one among TMsvId's of Inbox, Outbox, Drafts, Sent or Deleted folders.

@leave KErrNotFound aMsvId could not be found in the index 

@leave KErrArgument aChildrenOfAvailableDrives is set to true and the requested entry is not

one of the standard folders, i.e. Inbox, Outbox, Drafts, Sent or Deleted. */

    {

    __ASSERT_ALWAYS(iStore==NULL, PanicServer(EMsvStoreLeftOpen));

    if(aChildrenOfAvailableDrives && !MsvUtils::IsStandardId(aId))

        {

        User::Leave(KErrArgument);

        }

    // create new entry array

    CArrayPtrFlat<CMsvClientEntry>* newEntries = new (ELeave) CArrayPtrFlat<CMsvClientEntry>(KMsvClientEntryArrayGranuality);

    CleanupStack::PushL(newEntries);

    // get the new context and place in array

    TMsvId newOwningService;

    CMsvClientEntry* cEntry = DoGetEntryLC(aId, newOwningService);

    cEntry->SetType(EMsvClientContext);

    newEntries->AppendL(cEntry);

    // create new children array

    CMsvEntryArray* newSortedChildren = CMsvEntryArray::NewL(*iMtmList);

    // keep the old arrays

    CArrayPtrFlat<CMsvClientEntry>* oldEntries = iEntries;

    CMsvEntryArray* oldSortedChildren = iSortedChildren;

    TBool oldFlag = iChildrenOfAvailableDrives;

    iChildrenOfAvailableDrives = aChildrenOfAvailableDrives;

    // use new arrays

    CleanupStack::Pop(2); // cEntry, newEntries

    iEntries = newEntries;

    iSortedChildren = newSortedChildren;

    iEntryPtr = &iEntries->At(0)->Entry();

    // get the children and sort accordingly

    TRAPD(leave, DoGetChildrenL(); iNotifySequence = iMsvSession.Session().NotifySequenceL());

    if (leave)

        {

#ifndef _NO_SESSION_LOGGING_

        Log(_L("Failed to SetEntryL to %x with %d"), aId, leave); 

#endif

        // reset the old context

        iChildrenOfAvailableDrives = oldFlag;

        iEntries = oldEntries;

        iSortedChildren = oldSortedChildren;

        iEntryPtr = &iEntries->At(0)->Entry();

        // cleanup

        newEntries->ResetAndDestroy();

        delete newEntries;

        delete newSortedChildren;

        // propogate leave

        User::Leave(leave);

        }

    else

        {

#ifndef _NO_SESSION_LOGGING_

        Log(_L("SetEntryL to %x, sequence %d"), aId, iNotifySequence); 

#endif

        // set the new owning service

        iOwningService = newOwningService;

        // delete the old context

        oldEntries->ResetAndDestroy();

        delete oldEntries;

        delete oldSortedChildren;

        // make sure the state is marked as valid

        iState = EValid;

        }

    }

#else   //#define SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT

EXPORT_C void CMsvEntry::SetEntryNoCheckL(TMsvId aId)

//

// Changes the context to another entry

// If the function leaves, the context is unchanged

// The function does not check for when the context is already on

// the given TMsvId.

//

/** Sets the context to the specified entry. 

If the function leaves, the context is unchanged.

@internalTechnology

@param aId ID of the message entry which is to become the new context 

@leave KErrNotFound aMsvId could not be found in the index */

	{

	__ASSERT_ALWAYS(iStore==NULL, PanicServer(EMsvStoreLeftOpen));

	// create new entry array

	CArrayPtrFlat<CMsvClientEntry>* newEntries = new (ELeave) CArrayPtrFlat<CMsvClientEntry>(KMsvClientEntryArrayGranuality);

	CleanupStack::PushL(newEntries);

	// get the new context and place in array

	TMsvId newOwningService;

	CMsvClientEntry* cEntry = DoGetEntryLC(aId, newOwningService);

	cEntry->SetType(EMsvClientContext);

	newEntries->AppendL(cEntry);

	// create new children array

	CMsvEntryArray* newSortedChildren = CMsvEntryArray::NewL(*iMtmList);

	// keep the old arrays

	CArrayPtrFlat<CMsvClientEntry>* oldEntries = iEntries;

	CMsvEntryArray* oldSortedChildren = iSortedChildren;

	// use new arrays

	CleanupStack::Pop(2); // cEntry, newEntries

	iEntries = newEntries;

	iSortedChildren = newSortedChildren;

	iEntryPtr = &iEntries->At(0)->Entry();

	// get the children and sort accordingly

	TRAPD(leave, DoGetChildrenL(); iNotifySequence = iMsvSession.Session().NotifySequenceL());

	if (leave)

		{

#ifndef _NO_SESSION_LOGGING_

		Log(_L("Failed to SetEntryL to %x with %d"), aId, leave); 

#endif

		// reset the old context

		iEntries = oldEntries;

		iSortedChildren = oldSortedChildren;

		iEntryPtr = &iEntries->At(0)->Entry();

		// cleanup

		newEntries->ResetAndDestroy();

		delete newEntries;

		delete newSortedChildren;

		// propogate leave

		User::Leave(leave);

		}

	else

		{

#ifndef _NO_SESSION_LOGGING_

		Log(_L("SetEntryL to %x, sequence %d"), aId, iNotifySequence); 

#endif

		// set the new owning service

		iOwningService = newOwningService;

		// delete the old context

		oldEntries->ResetAndDestroy();

		delete oldEntries;

		delete oldSortedChildren;

		// make sure the state is marked as valid

		iState = EValid;

		}

	}

#endif

/**

Creates a new child entry owned by the context asynchronously.

Note that all session observers are notified when a new entry is created with 

an EMsvEntriesCreated event (see TMsvSessionEvent). CMsvEntry objects are 

such session observers themselves. When the object receives such a session 

notification, it calls all registered entry observers with a TMsvEntryEvent 

event EMsvNewChildren, passing in the ID of the new child.

If aEntry is not a service entry, then the context must not be set to the root entry and iServiceId field must be defined .

If aEntry is a service entry, then the context must be set to the root entry.

The returned CMsvOperation object completes when creation is complete.

@param	aEntry

Index entry value for the new entry 

@param	aStatus

The request status to be completed when the operation has finished 

@leave	KErrArgument aEntry is invalid