/*

* 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:  Email interface implementation.

*

*/

//MsgStore.

//<cmail>

#include "MsgStore.h"

#include "MsgStoreAccount.h"

#include "MsgStoreMailBox.h"

#include "MsgStoreMessage.h"

#include "MsgStoreFolder.h"

#include "MsgStorePropertyContainer.h"

#include "MsgStorePropertyKeys.h"

#include "MsgStoreSortCriteria.h"

#include "MsgStoreSortResultIterator.h"

//Freestyle.

#include "CFSMailCommon.h"

#include "CFSMailMessage.h"

#include "cmrcalendarinfo.h" 

//</cmail>

//Base plugin.

#include "BasePlugin.h"

#include "BasePluginPanic.h"

#include "baseplugincommonutils.h"

#include "MailIterator.h"

#include "baseplugindelayedopsprivate.h"

//<qmail>

#include "CFSMailFolder.h"

#include "baseplugindef.h"

//</qmail>

// Other

#include <e32base.h>

#include <utf.h>

#include <calsession.h>

//<qmail>

//<cmail>

//#include "freestyleemailuiconstants.h" // removed from 10.1

//</cmail>

//</qmail>

//size of the read buffer when reading body content from the quoted

//message when replying/forwarding.

const TInt KQuotedReadBufferSize = 1024*64;

/**

 *

 */

CBasePlugin* CBasePlugin::NewLC()

    {

    CBasePlugin* api = new (ELeave) CBasePlugin();

    CleanupStack::PushL( api );

    api->ConstructL();

    return api;

    } 

/**

 *

 */

CBasePlugin* CBasePlugin::NewL()

   {

   CBasePlugin* api =  CBasePlugin::NewLC();

   CleanupStack:: Pop(api);

   return api;

   }

/**

 *

 */

 void CBasePlugin::ConstructL()

    {

    __LOG_CONSTRUCT( "baseplugin", "CBasePlugin" )

    __LOG_ENTER( "ConstructL" )

    iMsgStore = CMsgStore::NewL( EFalse );

    iDelayedOpsManager = CDelayedOpsManager::NewL( *this );

    __LOG_EXIT

    }

/**

 *

 */

 CBasePlugin::CBasePlugin()

: iMailboxes( RMap<TInt, CMailboxInfo>::CompareInt )

   {

   }

/**

 *

 */

CBasePlugin::~CBasePlugin()

    {

    //needs to be first thing to do as it might force execution of operations

    //that depend on the plugin's current state.

    delete iDelayedOpsManager;

    iMailboxes.ResetAndDestroy();

    iMailboxes.Close();

//<qmail>

    if ( iObservers.Count() > 0 && iMsgStore )

//</qmail>

        {

        TRAP_IGNORE( iMsgStore->RemoveObserverL( this ) );

        }

    iObservers.Close();

    delete iMsgStore;

    iReqs.ResetAndDestroy();

    iReqs.Close();

//<qmail>

    // Note that all the ops in iDelayedOpReqs array (if any) have already been

    // deleted in the destructor of CDelayedOpsManager class.

    iDelayedOpReqs.Reset();

    iDelayedOpReqs.Close();

//</qmail>

    ResetCache();

    __LOG_DESTRUCT

    }

#pragma mark --- "MFSMAILPLUGIN - MAILBOX RELATED" ---

/**

 * Note that as the msgstore performs the delete immediately the observer will get

 * called from within this method.

 */

 void CBasePlugin::DeleteMailBoxByUidL(

    const TFSMailMsgId& aMailBoxId,

    MFSMailRequestObserver& aOperationObserver,

	const TInt aRequestId )

    {

    __LOG_ENTER( "DeleteMailBoxByUidL" )

    RPointerArray< CMsgStoreAccount > accounts;

    iMsgStore->AccountsL( accounts );

    CleanupResetAndDestroyClosePushL( accounts );

    TFSProgress progress = { TFSProgress::EFSStatus_RequestCancelled, 0, 0, 0 };

    progress.iError = KErrNotFound;

    TInt count = accounts.Count();

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

        {

        CMsgStoreMailBox* msbox = iMsgStore->OpenAccountL( *accounts[i] );

        CleanupStack::PushL( msbox );

        if( aMailBoxId.Id() == msbox->Id() )

            {

            __LOG_WRITE_INFO( "Found, about to start the delete.." )

            //remove from the cache.

            if ( KErrNotFound != iMailboxes.Find( msbox->Id() ) )

                {

                iMailboxes.RemoveL( msbox->Id() );

                }

            iMsgStore->DeleteAccountL( *accounts[i] );

            CleanupStack::PopAndDestroy( msbox );

            progress.iError = KErrNone;

            progress.iProgressStatus = TFSProgress::EFSStatus_RequestComplete;

            __LOG_WRITE_INFO( "Delete complete." )

            break;

            }

        CleanupStack::PopAndDestroy( msbox );

        }

    CleanupStack::PopAndDestroy( &accounts );

    aOperationObserver.RequestResponseL( progress, aRequestId );

    __LOG_EXIT

    }

/**

 *

 */

 void CBasePlugin::ListMailBoxesL( RArray<TFSMailMsgId>& aMailboxes )

    {

    __LOG_ENTER( "ListMailBoxesL" )

    RPointerArray< CMsgStoreAccount > accounts;

    iMsgStore->AccountsL( accounts );

    CleanupResetAndDestroyClosePushL( accounts );

    TFSMailMsgId fsid;

    fsid.SetPluginId( TUid::Uid( GetPluginId() ) );

    __LOG_WRITE_FORMAT1_INFO( "Plugin id: 0x%X,", GetPluginId() )

    TInt count = accounts.Count();

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

        {

        __LOG_WRITE_FORMAT1_INFO( "Owner id: 0x%X,", accounts[i]->Owner() )

        if ( accounts[i]->Owner() == GetPluginId() )

            {

            CMsgStoreMailBox* msbox = iMsgStore->OpenAccountL( *accounts[i] );

            CleanupStack::PushL( msbox );

            fsid.SetId( msbox->Id() );

            aMailboxes.AppendL( fsid );

            __LOG_WRITE_FORMAT1_INFO( "Found mailbox with id of 0x%X,", msbox->Id() )

            __LOG_WRITE_FORMAT1_INFO( "and account name of %S.", &accounts[i]->Name() )

            CleanupStack::PopAndDestroy( msbox );

            }

        }

    CleanupStack::PopAndDestroy( &accounts );

    __LOG_EXIT

    }

/**

 *

 * @param aMailBoxId if not found leaves with KErrNotFound.

 */

 CFSMailBox* CBasePlugin::GetMailBoxByUidL( const TFSMailMsgId& aMailBox )

    {

    __LOG_ENTER( "GetMailBoxByUidL" )

    CMailboxInfo& mailBox = GetMailboxInfoL( aMailBox.Id() );

    CFSMailBox* result = CFSMailBox::NewL( aMailBox );

    CleanupStack::PushL( result ); 

    CFSMailAddress* ownMailBox = CFSMailAddress::NewLC();

    ownMailBox->SetEmailAddress( *mailBox.iMailBoxName );

    if ( !( mailBox.iMailBoxDisplayName->Length() ) )

        {

        ownMailBox->SetDisplayName( KNullDesC );

        result->SetName( *mailBox.iMailBoxName );

        }

    else

        {

        ownMailBox->SetDisplayName( *(mailBox.iMailBoxDisplayName) );

        result->SetName( *(mailBox.iMailBoxDisplayName) );

        }

    result->SetOwnMailAddressL( ownMailBox );

    CleanupStack::Pop( ownMailBox );

    MMRInfoProcessor* infoProcessor = CBaseMrInfoProcessor::NewL( *this );

    result->SetMRInfoProcessorL( infoProcessor );

    //JOJA-83VJ4L Plugins need to set the correct Calendar Database ID for MRUI to work

    //get the calendar file name from the derived class

    const TDesC& calFileName = CalendarFileName();

    if ( calFileName != KNullDesC )

        {

        //the derived class does use its own calendar file, check if that file exists

        //the file may not exist because cal sync was disabled, or the file was deleted from the calendar UI

        CCalSession* calSession = CCalSession::NewL();

        CleanupStack::PushL( calSession );

        TRAPD( error, calSession->OpenL( calFileName ) );

        if ( error == KErrNone )

            {

            //calendar file exists, get its file id, and set it to cMail Celendar Info via the extention

            TCalFileId fileId = KNullFileId; 

            calSession->FileIdL( fileId );

            //get the extention api for the MR info, set the cal db id, and release the extention

            CEmailExtension* extension = NULL;

            TRAP( error, extension = result->ExtensionL( KMailboxExtMrCalInfo ) );

            if ( error == KErrNone )

                {

                CMRCalendarInfo* calInfo = reinterpret_cast<CMRCalendarInfo*>( extension );

                calInfo->SetCalendarDatabaseIdL( fileId ); // cannot actually leave

                result->ReleaseExtension( calInfo );

                }

            }

        CleanupStack::PopAndDestroy( calSession );

        }

    CleanupStack::Pop( result );

    __LOG_EXIT

    return result;

    }

#pragma mark --- "MFSMAILPLUGIN - FOLDER RELATED" ---

/**

 *

 * @param aMailBoxId if not found leaves with KErrNotFound.

 */

 TFSMailMsgId CBasePlugin::GetStandardFolderIdL(

    const TFSMailMsgId& aMailBoxId,

    const TFSFolderType aFolderType )

    {

    __LOG_ENTER( "GetStandardFolderIdL" )

    CMailboxInfo& mailBox = GetMailboxInfoL( aMailBoxId.Id() );

    TFSMailMsgId result;

    result.SetPluginId( TUid::Uid( GetPluginId() ) );

    if( EFSInbox <= aFolderType && aFolderType <= EFSDeleted )

        {

        result.SetId( mailBox.iRootFolders.iFolders[ aFolderType ] );

        }

    __LOG_EXIT

    return result;

    }

/**

 * Note that the unseen count is not set by the plugin as this information is not

 * readily available.

 *

 * @param aMailBoxId if not found leaves with KErrNotFound.

 */

 CFSMailFolder* CBasePlugin::GetFolderByUidL(

    const TFSMailMsgId& aMailBoxId,

    const TFSMailMsgId& aFolderId )

    {

    __LOG_ENTER( "GetFolderByUidL" )

    CMailboxInfo& mailBox = GetMailboxInfoL( aMailBoxId.Id() );

    TUint totalCount, unreadCount;

    mailBox().MessageCountsL( aFolderId.Id(), totalCount, unreadCount );

    //prepare the fsfw folder.

    CFSMailFolder* result = CFSMailFolder::NewLC( aFolderId );

    result->SetMailBoxId( aMailBoxId );

    result->SetMessageCount( totalCount );

    result->SetUnreadCount( unreadCount );

    //get the folder name from the msgstore folder object.

    __LOG_WRITE_INFO( "About to get the folder's name." )

    CMsgStoreFolder* msgStoreFolder = mailBox().FolderL( aFolderId.Id() );

    CleanupStack::PushL( msgStoreFolder );

    TUint idx;

    if ( msgStoreFolder->FindProperty( KMsgStorePropertyFolderDisplayName, idx ) )

        {

        const TDesC& name = msgStoreFolder->PropertyValueDesL( idx );

        result->SetFolderName( const_cast<TDesC&>( name ) );

        }

    else

        {

        //the root folders will get names from the UI. the base plugin should not

        //deal with any localization.

        result->SetFolderName( KNullDesC() );

        }

    TFSFolderType folderType = EFSOther;

    TUint i = 0;

    if ( msgStoreFolder->FindProperty( KMsgStorePropertyFolderType, i ) )

        {

        __LOG_WRITE_INFO( "Getting the folder's type." )

        folderType = (TFSFolderType)( msgStoreFolder->PropertyValueUint32L( i ) );

        result->SetFolderType( folderType );

        }

    TFSMailMsgId parentId( GetPluginId(), msgStoreFolder->ParentId() );

    result->SetParentFolderId( parentId );

    CleanupStack::PopAndDestroy( msgStoreFolder );

    RPointerArray<CMsgStoreFolder> folders;

    CleanupResetAndDestroyClosePushL( folders );

    mailBox().FoldersL( aFolderId.Id(), folders );

    result->SetSubFolderCount( folders.Count() );

    BlockCopyMoveFromFoldersL( aFolderId, folderType, *result );

    CleanupStack::PopAndDestroy( &folders );

    CleanupStack::Pop( result );

    __LOG_EXIT

    return result;

    } //GetFolderByUidL.

/**

 * @param aFolderId parent folder id.

 * @param aMailBoxId if not found leaves with KErrNotFound.

 * @return if the folder already exists returns the existing one.

 */

 CFSMailFolder* CBasePlugin::CreateFolderL(

    const TFSMailMsgId& aMailBoxId,

    const TFSMailMsgId& aParentFolderId,

    const TDesC& aFolderName,

    const TBool aSync )

    {

    __LOG_ENTER( "CreateFolderL" )

    CMailboxInfo& mailboxInfo = GetMailboxInfoL( aMailBoxId.Id() );

    CMsgStorePropertyContainer* props = CMsgStorePropertyContainer::NewL();

    CleanupStack::PushL( props );

    props->AddPropertyL( KMsgStorePropertyName, aFolderName );

    props->AddPropertyL( KMsgStorePropertyFolderType, EMsgStoreOther );

    TMsgStoreId parent = aParentFolderId.Id();

    TMsgStoreId folderId =

        mailboxInfo().CreateFolderL( parent, *props, aSync );

    CleanupStack::PopAndDestroy( props );

    //return the FS folder.

    TFSMailMsgId fid( GetPluginId(), folderId );

    CFSMailFolder* result = CFSMailFolder::NewLC( fid );

    result->SetParentFolderId( aParentFolderId );

    result->SetFolderName( aFolderName );

    result->SetMailBoxId( aMailBoxId );

    result->SetMessageCount( 0 );

    result->SetUnreadCount( 0 );

    BlockCopyMoveFromFoldersL( fid, EFSOther, *result );

    CleanupStack::Pop( result );

    __LOG_EXIT

    return result;

    }

/**

 *

 * @param aMailBoxId if not found leaves with KErrNotFound.

 */

 void CBasePlugin::DeleteFolderByUidL(

    const TFSMailMsgId& aMailBoxId,

    const TFSMailMsgId& aFolder )

    {

    __LOG_ENTER( "DeleteFolderByUidL" )

    CMailboxInfo& mailBox = GetMailboxInfoL( aMailBoxId.Id() );

    mailBox().DeleteFolderL( aFolder.Id() );

    __LOG_EXIT

    }

/**

 *

 */

 void CBasePlugin::ListFoldersL(

    const TFSMailMsgId& aMailBoxId,

    const TFSMailMsgId& aFolderId,

    RPointerArray<CFSMailFolder>& aFolderList )

    {

    __LOG_ENTER( "ListFoldersL, aFolderId" )

    TMsgStoreId folderId;

    if ( 0 == aFolderId.Id() )

    	{

    	folderId = aMailBoxId.Id();

    	}

    else

    	{

    	folderId = aFolderId.Id();

    	}

	DoListFoldersL( aMailBoxId, folderId, EFalse, aFolderList );

    __LOG_EXIT 

    }

/**

 *

 */

 void CBasePlugin::ListFoldersL(

    const TFSMailMsgId& aMailBoxId,

    RPointerArray<CFSMailFolder>& aFolderList )

    {

    __LOG_ENTER( "ListFoldersL" )

    DoListFoldersL( aMailBoxId, KMsgStoreInvalidId, ETrue, aFolderList );

    __LOG_EXIT

    }

#pragma mark --- "MFSMAILPLUGIN - MESSAGE RELATED" ---

/**