/*

* Copyright (c) 2002-2007 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:  A class that processes sim contacts into appropritate form for

*                the copying process.

*                Handles errors related to SIM contact fields

*

*/

// INCLUDE FILES

#include "CPsu2SimContactProcessor.h"

// Phonebook 2

#include "Pbk2USimUI.hrh"

#include "CPsu2CopyToSimFieldInfoArray.h"

#include "CPsu2CharConv.h"

#include <MPbk2FieldProperty.h>

#include <MPbk2ContactNameFormatter.h>

#include <Pbk2ContactFieldCopy.h>

// Virtual Phonebook

#include <TVPbkFieldTypeMapping.h>

#include <CVPbkContactManager.h>

#include <MVPbkContactStore.h>

#include <MVPbkFieldType.h>

#include <MVPbkBaseContact.h>

#include <MVPbkStoreContact.h>

#include <MVPbkStoreContactField.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkContactFieldTextData.h>

#include <CVPbkFieldTypeRefsList.h>

#include <CVPbkContactFieldIterator.h>

#include <CVPbkFieldTypeRefsList.h>

#include <VPbkEng.rsg>

// System includes

#include <gsmerror.h>

#include <exterror.h>

#include <barsread.h>

#include <coemain.h>

#include <featmgr.h>

// Debugging headers

#include <Pbk2Debug.h>

/// Unnamed namespace for local definitions

namespace {

#ifdef _DEBUG

enum TPanicCode

    {

    EPreCond_SplitToSimContactsL

    };

void Panic(TInt aReason)

    {

    _LIT( KPanicText, "CPsu2SimContactProcessor");

    User::Panic( KPanicText, aReason );

    }

#endif // _DEBUG

/**

 * A helper class to keep track of the number fields of certain type

 */

class TFieldTypeCounter

    {

    public: // Construction

        /**

         * Constructor.

         *

         * @param aType     Field type.

         */

        TFieldTypeCounter(

                const MVPbkFieldType& aType ) :

                    iType( aType ), iCounter( 0 )

            {}

    public: // Data

        // Ref: Field type

        const MVPbkFieldType& iType;

        // Own: Number of fields

        TInt iCounter;

    };

/**

 * Returns matching field type counter object based on given field type.

 *

 * @param aArray    Array of field type counters.

 * @param aType     Field type of interest.

 * @return  Matching field type counter.

 */

TFieldTypeCounter& FieldTypeCounterL( 

        RArray<TFieldTypeCounter>& aArray, const MVPbkFieldType& aType )

    {

    const TInt count = aArray.Count();

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

        {

        if (aArray[i].iType.IsSame(aType))

            {

            return aArray[i];

            }

        }

    aArray.AppendL(TFieldTypeCounter(aType));

    return aArray[count];

    }

/**

 * Checks if the contact already has maximum amount fields

 * of given field type.

 *

 * @param aMaxAmountFieldInContact  Max number of allowed fields of type.

 * @param aType                     Field type.

 * @param aArray                    Array of field type counters.

 * @return  ETrue if contact already has max amount of fields of given type.

 */

TBool CheckNumberOfFieldsL( 

        TInt aMaxAmountFieldInContact, const MVPbkFieldType& aType,

        RArray<TFieldTypeCounter>& aArray )

    {

    TBool ret( EFalse );

    TFieldTypeCounter& counter = FieldTypeCounterL( aArray, aType );

    // Compare the max amount fields to the current amount of the

    // fields in the contact

    if (counter.iCounter >= aMaxAmountFieldInContact)

        {

        ret = ETrue;

        }

    // Add one to counter of the given type

    ++counter.iCounter;

    return ret;

    }

/**

 * Checks is given field type a number type.

 *

 * @param aSimType  Field type.

 * @return  ETrue if the field is of number type.

 */

TBool IsNumberType( const MVPbkFieldType& aSimType )

    {

    TBool ret = EFalse;

    // SIM number type is always Mobile phone (general) -> EVPbkVersitNameTEL,

    // therefore a selector is not needed

    TArray<TVPbkFieldVersitProperty> props = aSimType.VersitProperties();

    if ( props.Count() > 0 && props[0].Name() == EVPbkVersitNameTEL )

        {

        ret = ETrue;

        }

    return ret;

    }

/**

 * Returns a valid number, removes e.g spaces, braces...

 *

 * @param aSource           Source descriptor.

 * @param aNumberKeyMap     Number key mapping.

 * @return  Formatted valid number.

 */

HBufC* CreateValidNumberLC( 

        const TDesC& aSource, const TDesC& aNumberKeyMap )

    {

    const TInt length = aSource.Length();

    HBufC* number = HBufC::NewLC( length );

    TPtr ptr( number->Des() );

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

        {

        if ( aNumberKeyMap.Locate( aSource[i] ) != KErrNotFound )

            {

            ptr.Append( aSource[i] );

            }

        }

    return number;

    }

} /// namespace

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

// CPsu2SimContactProcessor::CPsu2SimContactProcessor

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

//

CPsu2SimContactProcessor::CPsu2SimContactProcessor( 

        MVPbkContactStore& aTargetStore,

        CPsu2CopyToSimFieldInfoArray& aCopyToSimFieldInfoArray,

        MPbk2ContactNameFormatter& aNameFormatter,

        const MVPbkFieldTypeList& aMasterFieldTypeList )

        :   iTargetStore( aTargetStore ),

            iCopyToSimFieldInfoArray( aCopyToSimFieldInfoArray ),

            iNameFormatter( aNameFormatter ),

            iMasterFieldTypeList( aMasterFieldTypeList ),

            iSimMaxMatchPriority( 

                aTargetStore.StoreProperties().SupportedFields().

                  MaxMatchPriority() )

    {

    }

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

// CPsu2SimContactProcessor::~CPsu2SimContactProcessor

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

//

CPsu2SimContactProcessor::~CPsu2SimContactProcessor()

    {

    iNewSimContacts.ResetAndDestroy();

    iIncludedTypes.Close();

    delete iCharConvUcs2;

    delete iCharConvSms7Bit;

    }

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

// CPsu2SimContactProcessor::NewL

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

//

CPsu2SimContactProcessor* CPsu2SimContactProcessor::NewL( 

        MVPbkContactStore& aTargetStore,

        CPsu2CopyToSimFieldInfoArray& aCopyToSimFieldInfoArray,

        MPbk2ContactNameFormatter& aNameFormatter,

        const MVPbkFieldTypeList& aMasterFieldTypeList,

        RFs& aFs )

    {

    CPsu2SimContactProcessor* self = new( ELeave ) CPsu2SimContactProcessor

        ( aTargetStore, aCopyToSimFieldInfoArray, aNameFormatter,

          aMasterFieldTypeList );

    CleanupStack::PushL( self );

    self->ConstructL( aFs );

    CleanupStack::Pop( self );

    return self;

    }

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

// CPsu2SimContactProcessor::ConstructL

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

//

void CPsu2SimContactProcessor::ConstructL( RFs& aFs )

    {

    const TInt count = iCopyToSimFieldInfoArray.Count();

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

        {

        iIncludedTypes.AppendL( 

            &iCopyToSimFieldInfoArray[i].SourceType() );

        }

    iCharConvUcs2 = CPsu2CharConv::NewL( aFs, KCharacterSetIdentifierUcs2 );

    // Symbian character converter uses CR/LF by default. (U)SIM uses CR.

    // (JustLineFeed is ok here because the converter is used just to check

    // SIM conversion lengths)

    iCharConvUcs2->SetDownGradeLf( CCnvCharacterSetConverter::

            EDowngradeExoticLineTerminatingCharactersToJustLineFeed );

    iCharConvSms7Bit = CPsu2CharConv::NewL( aFs, KCharacterSetIdentifierSms7Bit );

    iCharConvSms7Bit->SetDownGradeLf( CCnvCharacterSetConverter::

            EDowngradeExoticLineTerminatingCharactersToJustLineFeed );

    }

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

// CPsu2SimContactProcessor::HandleSimError

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

//

TBool CPsu2SimContactProcessor::HandleSimError( TInt aError )

    {

    TBool result = EFalse;

    switch (aError)

        {

        case KErrGsmSimServAnrFull:

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

            ("CPsu2SimContactProcessor::HandleSimError KErrGsmSimServAnrFull"));

            // There might be several EF ANR files in USIM. Save the number

            // of error messages and use it later to check how many numbers

            // can be put to one contact

            ++iNumOfAdditionalNumberErrors;

            result = ETrue;

            break;

            }

        case KErrGsmSimServEmailFull:

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::HandleSimError KErrGsmSimServEmailFull"));

            // SIM contact can not have emails anymore because EF(email) is full

            iSimErrors |= KPsu2EMailFullError;

            RemoveFieldTypesFromIncludedTypes( KPsu2EMailFullError );

            result = ETrue;

            break;

            }

        case KErrGsmSimServSneFull:

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::HandleSimError KErrGsmSimServSneFull"));

            iSimErrors |= KPsu2SecondNameFullError;

            RemoveFieldTypesFromIncludedTypes( KPsu2SecondNameFullError );

            result = ETrue;

            break;

            }

        default:

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::HandleSimError unhandled error code %d"),

                    aError );

            break;

            }

        }

    return result;

    }

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

// CPsu2SimContactProcessor::CreateSimContactsL

//

// This called to create SIM contacts from a source contact

// The copying logic:

//  1) Create a SIM contact and add all the fields from the source

//     that possibly can be copied.

//  2) If the created SIM contact has too many fields for one SIM contact,

//     split the SIM contact. If the splitted contact has still too many

//     fields for one SIM contact split the splitted contact. This is

//     continued until the splitted contact doesn't need to be splitted

//     again.

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

//

void CPsu2SimContactProcessor::CreateSimContactsL( 

        MVPbkStoreContact& aSourceContact,

        RPointerArray<MVPbkStoreContact>& aSimContacts )

    {

    iNewSimContacts.ResetAndDestroy();

    // Create a target contact

    MVPbkStoreContact* contact = iTargetStore.CreateNewContactLC();

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateSimContactsL target contact created"));

    // Add name to the new contact

    AddNameFieldsL(aSourceContact, *contact);

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateSimContactsL name fields added"));

    // Append fields that can possible be copied to the SIM

    AppendSupportedFieldsL(aSourceContact, *contact);

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateSimContactsL supported fields added"));

    // Split the contact

    CleanupStack::Pop(); // contact

    SplitToSimContactsL(contact);

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateSimContactsL contact splitted"));

    // Contacts that have only name are not copied to SIM

    RemoveContactsThatHaveOnlyNameL();

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateSimContactsL name only contacts removed"));

    const TInt firstPos = 0;

    const TInt count = iNewSimContacts.Count();

    for ( TInt i = count - 1; i >= 0; --i )

        {

        aSimContacts.InsertL( iNewSimContacts[i], firstPos );

        PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

            ("CPsu2SimContactProcessor::CreateSimContactsL contact added to new SIM contacts"));

        iNewSimContacts.Remove( i );

        }

    }

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

// CPsu2SimContactProcessor::CreateFixedSimContactsL

//

// This is called when saving a SIM contact has failed and HandleSimError

// has handled the error. It means that the state of this processor has

// changed and the failed SIM contact can be splitted or there are fields

// that must be removed from the failed contact. After this the resulted

// SIM contacts will be copied again.

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

//

void CPsu2SimContactProcessor::CreateFixedSimContactsL( 

        MVPbkStoreContact& aSimContact,

        RPointerArray<MVPbkStoreContact>& aSimContacts )

    {

    iNewSimContacts.ResetAndDestroy();

    // Create a target contact

    MVPbkStoreContact* contact = iTargetStore.CreateNewContactLC();

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateFixedSimContactsL target contact created"));

    // Add name to the new contact

    AddNameFieldsL(aSimContact, *contact);

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateFixedSimContactsL name fields added"));

    // Append fields that can possible be copied to the SIM

    AppendSupportedFieldsL(aSimContact, *contact);

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPsu2SimContactProcessor::CreateFixedSimContactsL supported fields added"));

    const TInt firstPos = 0;

    const TInt newCount = contact->Fields().FieldCount();

    if (newCount > 0 && newCount != aSimContact.Fields().FieldCount())

        {

        // After appending supported fields the amount of field is different

        // than in the original contact. This means that there has been

        // an error that has changed the included types list.

        if ( IsValidContactToSaveL( *contact ) )

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL is valid contact to save"));

            aSimContacts.InsertL(contact, firstPos);

            CleanupStack::Pop(); // contact

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL contact added to new SIM contacts"));

            }

        else

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL is not valid contact to save"));

            CleanupStack::PopAndDestroy(); // contact

            }

        }

    else

        {

        // Split the contact

        CleanupStack::Pop(); // contact

        // Takes ownership of the contact

        if ( SplitToSimContactsL( contact ) )

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL contact splitted"));

            // Contacts that have only name are not copied to SIM

            RemoveContactsThatHaveOnlyNameL();

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL name only contacts removed"));

            const TInt count = iNewSimContacts.Count();

            for (TInt i = count - 1; i >= 0; --i)

                {

                aSimContacts.InsertL(iNewSimContacts[i], firstPos);

                iNewSimContacts.Remove(i);

                PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                    ("CPsu2SimContactProcessor::CreateFixedSimContactsL contact added to new SIM contacts"));

                }

            }

        else

            {

            PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

                ("CPsu2SimContactProcessor::CreateFixedSimContactsL contact does not split"));

            iNewSimContacts.ResetAndDestroy();

            }

        }

    }

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

// CPsu2SimContactProcessor::CreateFixedSimContactsL

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

//

TBool CPsu2SimContactProcessor::DetailsDropped()

    {

    TBool ret( EFalse );

    ret = iSimErrors & KPsu2EMailFullError;

    if ( !ret  )

        {

        ret = iSimErrors & KPsu2SecondNameFullError;

        }

    return ret;

    }

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

// CPsu2SimContactProcessor::RemoveFieldTypesFromIncludedTypes

//

// Removes error related field types from the included types so those

// types won't be copied to SIM contact anymore.

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

//

void CPsu2SimContactProcessor::RemoveFieldTypesFromIncludedTypes( 

        TPsu2ErrorCode aBlockingError )

    {

    const TInt includedCount = iIncludedTypes.Count();

    for ( TInt i = includedCount - 1; i >= 0; --i )

        {

        const TPsu2CopyToSimFieldInfo* info = 

            iCopyToSimFieldInfoArray.FindInfoForSourceType( 

                *iIncludedTypes[i] );

        if ( info && info->BlockedByError( aBlockingError ) )

            {

            iIncludedTypes.Remove( i );

            }

        }

    }

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

// CPsu2SimContactProcessor::AddNameFieldsL

//

// Adds name fields from source contact to the target.

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

//

void CPsu2SimContactProcessor::AddNameFieldsL( 

        MVPbkStoreContact& aSource, MVPbkStoreContact& aTarget )

    {

    // Copy formatted name always to SIM's name field

    CopyTitleFieldDataL( aSource, aTarget,

        iCopyToSimFieldInfoArray.SimNameType() );

    }

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