/*

* Copyright (c) 2002-2006 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:  MsgAddressControl implementation

*

*/

// ========== INCLUDE FILES ================================

#include <eikenv.h>                        // for CEikonEnv

#include <eikappui.h>                      // for CEikAppUi

#include <barsread.h>                      // for TResourceReader

#include <eikedwin.h>                      // for TClipboardFunc

#include <txtrich.h>                       // for CRichText

#include <AknUtils.h>                      // for AknUtils

#include <aknbutton.h>                     // for CAknButton

#include <eiklabel.h>                      // for CEikLabel

#include "MsgAddressControl.h"             // for CMsgAddressControl

#include "MsgAddressControlEditor.h"       // for CMsgAddressControlEditor

#include "MsgAddressControlEditorField.h"  // for CMsgAddressControlEditorField

#include "MsgBaseControlObserver.h"        // for MMsgBaseControlObserver

#include "MsgRecipientItem.h"              // for CMsgRecipientItem

#include "MsgEditorPanic.h"                // for CMsgEditor panics

#include "MsgEditorCommon.h"               // for KArabicSemicolon

// ========== EXTERNAL DATA STRUCTURES =====================

// ========== EXTERNAL FUNCTION PROTOTYPES =================

// ========== CONSTANTS ====================================

// ========== MACROS =======================================

// ========== LOCAL CONSTANTS AND MACROS ===================

const TInt KRecipientArrayGranularity = 10;

const TInt KMaxEntryLength = 256;

const TUint KMsgListSeparator = ';';             // List separator

// Unicode sign for S60 "enter" symbol

const TInt KDownwardsArrowWithTipLeftwards  = 0x21B2;

const TInt KDownwardsArrowWithTipRightwards = 0x21B3;

// ========== MODULE DATA STRUCTURES =======================

// ========== LOCAL FUNCTION PROTOTYPES ====================

// ========== LOCAL FUNCTIONS ==============================

// ========== MEMBER FUNCTIONS =============================

// ---------------------------------------------------------

// CMsgAddressControl::CMsgAddressControl

//

// Constructor.

// ---------------------------------------------------------

//

CMsgAddressControl::CMsgAddressControl( MMsgBaseControlObserver& aBaseControlObserver ) : 

    CMsgExpandableControl( aBaseControlObserver )

    {

    }

// ---------------------------------------------------------

// CMsgAddressControl::~CMsgAddressControl

//

// Destructor.

// ---------------------------------------------------------

//

CMsgAddressControl::~CMsgAddressControl()

    {

    if ( iRecipientArray )

        {

        iRecipientArray->ResetAndDestroy();

        }

    delete iRecipientArray;

    }

// ---------------------------------------------------------

// CMsgAddressControl::AddRecipientL

//

//

// ---------------------------------------------------------

//

EXPORT_C void CMsgAddressControl::AddRecipientL( const TDesC& aName,

                                                 const TDesC& aAddress,

                                                 TBool aVerified,

                                                 MVPbkContactLink* aContactLink )

    {

    TInt count   = 0;

    TInt size    = 0;

    TInt entries = iAddressControlEditor->EntryCount();

    GetSizeOfAddresses( count, size );

    // when field is empty, count == 0 but entries == 1.

    // when count > 0, this inserts at the end of the field.

    if ( entries > 1 )

        {

        count = entries;

        }

    iAddressControlEditor->SetCursorPosAndCancelSelectionL(

        iAddressControlEditor->TextLength() );

    iAddressControlEditor->CheckHighlightingL();

    iAddressControlEditor->InsertEntryL(

        count,

        aName,

        aAddress,

        aVerified,

        ETrue,

        aContactLink

         );

    FormatAndSetCursorPosL( iAddressControlEditor->TextLength() );

    DrawDeferred();

    iControlModeFlags |= EMsgControlModeModified;

    }

// ---------------------------------------------------------

// CMsgAddressControl::AddRecipientsL

//

//

// ---------------------------------------------------------

//

EXPORT_C void CMsgAddressControl::AddRecipientsL(

    const CMsgRecipientList& aRecipients )

    {

    CMsgRecipientArray* recipients = GetRecipientsL();

    RefreshL( *recipients );

    TInt count = 0;

    TInt size = 0;

    TInt entries = iAddressControlEditor->EntryCount();

    GetSizeOfAddresses( count, size );

    // when field is empty, count == 0 but entries == 1.

    // when count > 0, this inserts at the end of the field.

    if ( entries > 1 )

        {

        count = entries;

        }

    TInt cc = aRecipients.Count();

    CMsgRecipientItem* item = NULL;

    iAddressControlEditor->SetCursorPosAndCancelSelectionL(

        iAddressControlEditor->TextLength() );

    iAddressControlEditor->CheckHighlightingL();

    TBool bandFormatting( EFalse );

    if ( iAddressControlEditor->TextLayout()->IsFormattingBand() )

        {

        bandFormatting = ETrue;

        }

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

        {

        item = aRecipients.At( i );

        iAddressControlEditor->InsertEntryL(

            count,

            *item->Name(),

            *item->Address(),

            item->IsVerified(),

            item->IsValidated(),

            item->ContactLink() );

        count++;

        }    

    TInt pos = iAddressControlEditor->TextLength();

    iAddressControlEditor->TextView()->SetDocPosL( pos, EFalse );

    FormatAndSetCursorPosL( pos );

    // Editor changed to band formatting due to address addition.

    // Set the editor height to maximum as text was added directly to

    // richtext and height is not updated correctly because of partial format.

    if ( !bandFormatting &&

         iAddressControlEditor->TextLayout()->IsFormattingBand() )

        {

        // Set newSize to current width and maximum body height and

        // force CMsgExpandableControl::HandleEdwinSizeChangeEventL to

        // update the control size.

        iControlModeFlags |= EMsgControlModeForceSizeUpdate;

        TSize newSize( iAddressControlEditor->Size().iWidth,

                       iMaxBodyHeight - 1 );

        iAddressControlEditor->SetSize( newSize );

        iControlModeFlags &= ~EMsgControlModeForceSizeUpdate;

        }

    DrawDeferred();

    iControlModeFlags |= EMsgControlModeModified;

    }

// ---------------------------------------------------------

// CMsgAddressControl::GetRecipientsL

//

//

// ---------------------------------------------------------

//

EXPORT_C CMsgRecipientArray* CMsgAddressControl::GetRecipientsL()

    {

    TInt entryNumber( iAddressControlEditor->EntryCount() );

    const CMsgAddressControlEditorField* field = NULL;

    TBuf<KMaxEntryLength> entryBuf;

    TInt ret( KErrNotFound );

    if ( iRecipientArray == NULL )

        {

        iRecipientArray = new ( ELeave )

            CMsgRecipientArray( KRecipientArrayGranularity );

        }

    else

        {

        iRecipientArray->ResetAndDestroy();

        }

    for ( TInt ii = 0; ii < entryNumber; ii++ )

        {

        field = iAddressControlEditor->Field( ii );

        if ( field && field->IsVerified() )

            {

            HBufC* addressCopy = field->Address()->AllocLC();

            TPtr addrTPtr = addressCopy->Des();

            AknTextUtils::ConvertDigitsTo( addrTPtr, EDigitTypeWestern );

            CMsgRecipientItem* item =

                CMsgRecipientItem::NewLC( *field->Name(), *addressCopy );

            const MVPbkContactLink* contactLink = field->ContactLink();

            if ( contactLink )                  

                {

                item->SetContactLink( contactLink );

                }

            item->SetVerified( field->IsVerified() );

            item->SetValidated( field->IsValidated() );

            iRecipientArray->AppendL( item );

            CleanupStack::Pop(); // item

            CleanupStack::PopAndDestroy(); // addressCopy

            }

        else

            {

            SetParsingInfo( ii, 0, 0 );

            ret = KErrNone;

            while ( ret == KErrNone )

                {

                ret = GetNextItemOnEntry( entryBuf );

                if ( ( ret == KErrNone ) && ( entryBuf.Length() > 0 ) )

                    {

                    AknTextUtils::ConvertDigitsTo( entryBuf, EDigitTypeWestern );

                    // unverified entries are treated as addresses.

                    CMsgRecipientItem* item =

                        CMsgRecipientItem::NewLC( KNullDesC, entryBuf );

                    iRecipientArray->AppendL( item );

                    CleanupStack::Pop(); // item

                    entryBuf.Zero();

                    }

                }

            }

        }

    ResetParsingInfo();

    return iRecipientArray;

    }

// ---------------------------------------------------------

// CMsgAddressControl::ResetL

//

// Clears content of the address control.

// ---------------------------------------------------------

//

EXPORT_C TInt CMsgAddressControl::ResetL()

    {

    ResetParsingInfo();

    TInt entryCount( iAddressControlEditor->EntryCount() );

    iAddressControlEditor->TurnHighlightingOffL();

    iAddressControlEditor->DeleteAllL();

    iControlModeFlags |= EMsgControlModeModified;

    return entryCount;

    }

// ---------------------------------------------------------

// CMsgAddressControl::Reset

//

// from CMsgBaseControl.

// Same as above but non-leaving version.

// ---------------------------------------------------------

//

EXPORT_C void CMsgAddressControl::Reset()

    {

    TRAP_IGNORE( ResetL() );

    }

// ---------------------------------------------------------

// CMsgAddressControl::GetFirstUnverifiedStringL

//

// Finds the first unverified string and updates also the iParserInfo

// correspondingly.

// ---------------------------------------------------------

//

EXPORT_C TInt CMsgAddressControl::GetFirstUnverifiedStringL( HBufC*& aString )

    {

    __ASSERT_DEBUG( IsFocused(), Panic( EMsgControlNotFocused ) );

    ResetParsingInfo();

    return GetNextUnverifiedStringL( aString );

    }

// ---------------------------------------------------------

// CMsgAddressControl::GetNextUnverifiedStringL

//

// Finds the next unverified string.

// ---------------------------------------------------------

//

EXPORT_C TInt CMsgAddressControl::GetNextUnverifiedStringL( HBufC*& aString )

    {

    __ASSERT_DEBUG( IsFocused(), Panic( EMsgControlNotFocused ) );

    if ( aString != NULL )

        {

        delete aString;

        aString = NULL;

        }

    iAddressControlEditor->TurnHighlightingOffL();

    TInt entryCount = iAddressControlEditor->EntryCount();

    TInt entryNumber( iParsingInfo.iEntryNum );

    TBuf<KMaxEntryLength> entryBuf;

    TInt ret( KErrNotFound );

    HBufC* string = NULL;

    while ( entryNumber < entryCount )

        {

        entryBuf.Zero();

        if ( iAddressControlEditor->IsEntryVerified( entryNumber ) )

            {

            entryNumber++;

            SetParsingInfo( entryNumber, 0, 0 );

            }

        else

            {

            ret = GetNextItemOnEntry( entryBuf );

            if ( ( ret == KErrNone ) && ( entryBuf.Length() > 0 ) )

                {

                string = entryBuf.AllocLC();

                TInt firstPos = iAddressControlEditor->EntryStartPos(

                    iParsingInfo.iEntryNum );

                FormatAndSetCursorPosL( firstPos + iParsingInfo.iEndPos );

                break;

                }

            else if ( iParsingInfo.iEndPos > iParsingInfo.iStartPos )

                {

                // a string could not be found but there seems to be white

                // spaces on an entry which may be also followed by the list

                // separator, hence clean them up

                iAddressControlEditor->DeleteEntryCharsL(

                    iParsingInfo.iEntryNum,

                    iParsingInfo.iStartPos,

                    iParsingInfo.iEndPos );

                SetParsingInfo(

                    entryNumber,

                    iParsingInfo.iStartPos,

                    iParsingInfo.iStartPos );

                }

            else if ( ( iParsingInfo.iEndPos == 0 ) &&

                     ( iParsingInfo.iEntryNum < entryCount - 1 ) )

                {

                // there is just an EParagraphDelimiter on the entry

                iAddressControlEditor->DeleteEntryL( iParsingInfo.iEntryNum );

                SetParsingInfo( entryNumber, 0, 0 );

                entryCount--;

                }

            else

                {

                // there are no strings left on the current entry

                entryNumber++;

                SetParsingInfo( entryNumber, 0, 0 );

                }

            }

        }

    if ( entryNumber >= entryCount )

        {

        FormatAndSetCursorPosL( iAddressControlEditor->TextLength() );

        }

    aString = string;

    if ( string )

        {

        CleanupStack::Pop();  // string

        }

    return ret;

    }

// ---------------------------------------------------------

// CMsgAddressControl::ReplaceUnverifiedStringL

//

// Replaces a string with contents of the recipient array aArray. 

// The string is replaced according to the iParsingInfo.

//

// This function cannot undelete a string if it leaves after/while removing it.

// ---------------------------------------------------------

//

EXPORT_C TInt CMsgAddressControl::ReplaceUnverifiedStringL(

    CMsgRecipientArray& aArray )

    {

    __ASSERT_DEBUG( IsFocused(), Panic( EMsgControlNotFocused ) );

    if ( ( iParsingInfo.iEndPos <= iParsingInfo.iStartPos ) || 

        ( iParsingInfo.iEntryNum >= iAddressControlEditor->EntryCount() ) )

        {

        return KErrNotFound;

        }

    iAddressControlEditor->TurnHighlightingOffL();

    TInt entryLength = iAddressControlEditor->EntryLength( iParsingInfo.iEntryNum );

    iAddressControlEditor->DeleteEntryCharsL(

        iParsingInfo.iEntryNum,

        iParsingInfo.iStartPos,

        iParsingInfo.iEndPos );

    if ( ( iParsingInfo.iStartPos > 0 ) && ( iParsingInfo.iEndPos < entryLength ) )

        {

        iAddressControlEditor->InsertEntryBreakL(

            iParsingInfo.iEntryNum,

            iParsingInfo.iStartPos );

        iParsingInfo.iEntryNum++;

        }

    TInt entryNumber( iParsingInfo.iEntryNum );

    TInt contactCount = aArray.Count();

    CMsgRecipientItem* recipientItem = NULL;

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

        {

        recipientItem = aArray.At( i );

        iAddressControlEditor->InsertEntryL(

            entryNumber,

            *recipientItem->Name(),

            *recipientItem->Address(),

            recipientItem->IsVerified(),

            recipientItem->IsValidated(),

            recipientItem->ContactLink() );

        entryNumber++;

        }

    SetParsingInfo( iParsingInfo.iEntryNum, 0, 0 );

    TInt firstPos = iAddressControlEditor->EntryStartPos( iParsingInfo.iEntryNum );

    entryLength = iAddressControlEditor->EntryLength( iParsingInfo.iEntryNum );

    TInt endPos = firstPos + entryLength - 1;

    SetParsingInfo( iParsingInfo.iEntryNum, endPos, endPos );

    FormatAndSetCursorPosL( endPos );

    iControlModeFlags |= EMsgControlModeModified;

    return KErrNone;

    }

// ---------------------------------------------------------

// CMsgAddressControl::RefreshL

//

// Refreshes the contents of address control.

// ---------------------------------------------------------

//

EXPORT_C TInt CMsgAddressControl::RefreshL( const CMsgRecipientArray& aArray )

    {

    iEditor->SetEdwinSizeObserver( NULL );

    TRAPD( error, ResetL() );  // Clears the control and turns highlighting off

    iEditor->SetEdwinSizeObserver( this );

    if ( error != KErrNone )

        {

        User::Leave( error );

        }

    TInt entryNumber = 0;

    TInt contactCount = aArray.Count();

    CMsgRecipientItem* item = NULL;

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

        {

        item = aArray.At( i );

        iAddressControlEditor->InsertEntryL(

            entryNumber,

            *item->Name(),

            *item->Address(),

            item->IsVerified(),

            item->IsValidated(),

            item->ContactLink() );

        entryNumber++;

        }

    ResetParsingInfo();

    FormatAndSetCursorPosL( iAddressControlEditor->TextLength() );