/*

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

*		Phonebook Contact item class

*

*/

// INCLUDE FILES

#include    "CPbkContactItem.h"

#include    <cntfield.h>    // CContactItemField

#include    <cntitem.h>     // CContactItem

#include    <FeatMgr.h>	    // Feature manager

#include    <CPbkSINDHandlerInterface.h>

#include    "CPbkFieldsInfo.h"

#include    "CPbkFieldInfo.h"

#include    "TPbkContactItemField.h"

#include    "PbkFields.hrh"

#include    <PbkEngUtils.h>

#include    <pbkdebug.h>

#include    "PbkDefaults.h"

#include    <MPbkContactNameFormat.h>

#include    "TPbkMatchPriorityLevel.h"

#include    "CPbkContactEngine.h"

#include    "cpbkenginelocalstorage.h"

#include    "CPbkSyncronizationConstants.h"

#ifdef _DEBUG

// Engine needed only for a few asserts

#include    "CPbkContactEngine.h"

#endif

// Unnamed namespace for local definitions

namespace {

// LOCAL CONSTANTS AND MACROS

enum TPanicCode

    {

    EPanicPostCond_Constructor = 1,

    EPanicPreCond_ConstructL,

    EPanicInvariant_Pointer,

    EPanicInvariant_Count,

    EPanicInvariant_Field,

    EPanicInvariant_FieldInfo,

    EPanicInvariant_Sorting,

    EPanicInvariant_PrefCount,

    EPanicInvariant_SmsCount,

    EPanicInvariant_PrefSmsCount,

    EPanicInvariant_PhoneDefaultCount,

    EPanicInvariant_SmsDefaultCount,

    EPanicInvariant_EmailDefaultCount,

    EPanicInvariant_VideoTagCount,

    EPanicPostCond_FindFieldIndex,

    EPanicPreCond_RemoveField,

    EPanicLogic_RemoveField,

    EPanicPostCond_RemoveField,

    EPanicPostCond_AddFieldL,

    EPanicPreCond_GroupsJoinedLC,

    EPanicPostCond_SetDefaultPhoneNumberFieldL,

    EPanicPostCond_SetDefaultVideoNumberFieldL,

    EPanicPostCond_SetDefaultEmailFieldL,

    EPanicPreCond_UpdateFieldSetL,

    EPanicPostCond_InsertionPos,

    EPanicPostCond_SetVoiceTagFieldL,

    EPanicInvariant_VoiceTagCount,

    EPanicInvariant_VoiceTagFieldCount,

    EPanicPostCond_SetDefaultMmsFieldL,

    EPanicPostCond_SetDefaultEmailOverSmsFieldL,

    EPanicPostCond_SetDefaultPocFieldL,

    EPanicPostCond_SetDefaultVoipFieldL,

    EPanicPreCond_VoiceTagField1,

    EPanicPreCond_VoiceTagField2,

    EPanicPreCond_LoadSindHandlerImplL

    };

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

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbkContactItem");

    User::Panic(KPanicText, aReason);

    }

/**

 * Searches a field set for the first field with type specified type.

 *

 * @param aFields   the field set to search.

 * @param aFieldInfo    the field type to search for.

 * @param aIndex        index where to start the search.

 * @return index of the matching field in aFields or KErrNotFound if not found.

 */

TInt FindFieldWithType

        (const CPbkFieldArray& aFields,

        const CPbkFieldInfo& aFieldInfo,

        TInt aIndex=0)

    {

    const TInt fieldCount = aFields.Count();

    for (TInt i=aIndex; i < fieldCount; ++i)

        {

        if (aFields[i].FieldInfo().IsSame(aFieldInfo))

            {

            return i;

            }

        }

    return KErrNotFound;

    }

inline void LoadSindHandlerImplL(TUid& aDtorIDKey,

    CPbkSINDHandlerInterface*& aSINDHandler)

    {

    // Check does the SIND handler implementation exist:

    TUid interfaceUid = {KPbkSINDHandlerInterfaceUID};

    RImplInfoPtrArray pluginArray;

    REComSession::ListImplementationsL( interfaceUid ,pluginArray );

    __ASSERT_DEBUG(pluginArray.Count() == 1, Panic(EPanicPreCond_LoadSindHandlerImplL));

    if ( pluginArray.Count() > 0 )

        {

        // There should be only one implementation for SIND handler and

        // we would like to use that one

        TUid SINDHandlerImpUid = {KPbkSINDHandlerPluginUID};

        aSINDHandler = static_cast<CPbkSINDHandlerInterface*>

            (REComSession::CreateImplementationL(SINDHandlerImpUid ,aDtorIDKey));

        }

    pluginArray.ResetAndDestroy();

    }

}  // namespace

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

/**

 * C++ constructor.

 */

inline CPbkContactItem::CPbkContactItem(MPbkContactNameFormat& aNameFormat) :

    iNameFormat(aNameFormat)

    {

    // new(ELeave) in NewL will reset members

    __ASSERT_DEBUG(!iItem, Panic(EPanicPostCond_Constructor));

    }

/**

 * Second phase constructor.

 */

inline void CPbkContactItem::ConstructL

        (CContactItem* aItem,

        const CPbkFieldsInfo& aFieldsInfo)

    {

    //PreCond:

    __ASSERT_DEBUG(aItem && !iItem, Panic(EPanicPreCond_ConstructL));

    CreateFieldArrayL(*aItem, aFieldsInfo);

    // construction was succesful, take ownership of aItem

    iItem = aItem;

    // Philosophical note: class invariant is effectively a postcondition

    // for a constructor.

    __TEST_INVARIANT;

    }

EXPORT_C CPbkContactItem* CPbkContactItem::NewL

        (CContactItem* aItem,

        const CPbkFieldsInfo& aFieldsInfo,

        MPbkContactNameFormat& aNameFormat)

    {

    CPbkContactItem* self = new(ELeave) CPbkContactItem(aNameFormat);

    CleanupStack::PushL(self);

    self->ConstructL(aItem, aFieldsInfo);

    CleanupStack::Pop(self);

    return self;

    }

CPbkContactItem::~CPbkContactItem()

    {

#ifdef _DEBUG

    // Test invariant only at the beginning of destructor and only if

    // construction was succesful.

    if (iItem)

        __TEST_INVARIANT;

#endif

    // Delete own data

    delete iItem;

    }

EXPORT_C CContactItem& CPbkContactItem::ContactItem()

    {

    return *iItem;

    }

EXPORT_C const CContactItem& CPbkContactItem::ContactItem() const

    {

    return *iItem;

    }

EXPORT_C HBufC* CPbkContactItem::GetContactTitleL() const

    {

    __TEST_INVARIANT;

    // Delegate call to iNameFormat

    return iNameFormat.GetContactTitleL(*this);

    }

EXPORT_C HBufC* CPbkContactItem::GetContactTitleOrNullL() const

    {

    __TEST_INVARIANT;

    // Delegate call to iNameFormat

    return iNameFormat.GetContactTitleOrNullL(*this);

    }

EXPORT_C TPbkIconId CPbkContactItem::ContactIconIdL() const

    {

    __TEST_INVARIANT;

    TPbkContactItemField* field = DefaultPhoneNumberField();

    if (field)

        {

        return field->IconId();

        }

    return EPbkNullIconId;

    }

EXPORT_C TPbkContactItemField* CPbkContactItem::DefaultPhoneNumberField() const

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    // scan the fields for a match in default field for field id.

    const TInt fieldCount = iFields.Count();

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

        {

        if (iFields[i].DefaultPhoneNumberField())

            {

            return const_cast<TPbkContactItemField*>(&(iFields[i]));

            }

        }

    return NULL;

    }

EXPORT_C void CPbkContactItem::SetDefaultPhoneNumberFieldL

        (TPbkContactItemField* aField)

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    if (aField)

        {

        aField = FindSameField(*aField);

        if (!aField)

            {

            // Not this item's field

            User::Leave(KErrNotFound);

            }

        }

    // Test can we set the default for this field

    if (aField && !aField->FieldInfo().IsPhoneNumberField())

        {

        User::Leave(KErrNotSupported);

        }

    // 1. Fetch previous default

    TPbkContactItemField* prevDefault = DefaultPhoneNumberField();

    // 2. Set the new default, if specified

    if (aField)

        {

        if (prevDefault == aField)

            {

            // Default already set to aField

            return;

            }

        // If this leaves, this object's state remains unchanged

        aField->ItemField().AddFieldTypeL(KUidPbkDefaultFieldPref);

        }

    // 3. Unset any previous default (invariant tests that there is always just

    // one default.

    if (prevDefault)

        {

        // Unset previous default

        prevDefault->ItemField().RemoveFieldType(KUidPbkDefaultFieldPref);

        }

    __ASSERT_DEBUG(

        (aField && DefaultPhoneNumberField()==aField) ||

        (!aField && !DefaultPhoneNumberField()),

        Panic(EPanicPostCond_SetDefaultPhoneNumberFieldL));

    }

EXPORT_C void CPbkContactItem::RemoveDefaultPhoneNumberField()

    {

    // This is safe because SetDefaultPhoneNumberFieldL(NULL)

    // guarantees not to leave

    SetDefaultPhoneNumberFieldL(NULL);

    }

EXPORT_C TPbkContactItemField* CPbkContactItem::DefaultVideoNumberField() const

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    // scan the fields for a match in default field for field id.

    const TInt fieldCount = iFields.Count();

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

        {

        if (iFields[i].DefaultVideoNumberField())

            {

            return const_cast<TPbkContactItemField*>(&(iFields[i]));

            }

        }

    return NULL;

    }

EXPORT_C void CPbkContactItem::SetDefaultVideoNumberFieldL

        (TPbkContactItemField* aField)

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    if (aField)

        {

        aField = FindSameField(*aField);

        if (!aField)

            {

            // Not this item's field

            User::Leave(KErrNotFound);

            }

        }

    // Test can we set the default for this field

    if (aField && !aField->FieldInfo().IsPhoneNumberField())

        {

        User::Leave(KErrNotSupported);

        }

    // 1. Fetch previous default

    TPbkContactItemField* prevDefault = DefaultVideoNumberField();

    // 2. Set the new default, if specified

    if (aField)

        {

        if (prevDefault == aField)

            {

            // Default already set to aField

            return;

            }

        // If this leaves, this object's state remains unchanged

        aField->ItemField().AddFieldTypeL(KUidPbkDefaultFieldVideo);

        }

    // 3. Unset any previous default (invariant tests that there is always just

    // one default.

    if (prevDefault)

        {

        // Unset previous default

        prevDefault->ItemField().RemoveFieldType(KUidPbkDefaultFieldVideo);

        }

    __ASSERT_DEBUG(

        (aField && DefaultVideoNumberField()==aField) ||

        (!aField && !DefaultVideoNumberField()),

        Panic(EPanicPostCond_SetDefaultVideoNumberFieldL));

    }

EXPORT_C void CPbkContactItem::RemoveDefaultVideoNumberField()

    {

    // This is safe because SetDefaultPhoneNumberFieldL(NULL)

    // guarantees not to leave

    SetDefaultVideoNumberFieldL(NULL);

    }

EXPORT_C TPbkContactItemField* CPbkContactItem::DefaultSmsField() const

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    const TInt fieldCount = iFields.Count();

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

        {

        const TPbkContactItemField& field = iFields[i];

        if (field.DefaultSmsField())

            {

            return const_cast<TPbkContactItemField*>(&field);

            }

        }

    return NULL;

    }

EXPORT_C void CPbkContactItem::SetDefaultSmsFieldL

        (TPbkContactItemField* aField)

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    if (aField)

        {

        aField = FindSameField(*aField);

        if (!aField)

            {

            // Not this item's field

            User::Leave(KErrNotFound);

            }

        }

    // Test can we set the default for this field

    if (aField && !aField->FieldInfo().IsPhoneNumberField())

        {

        User::Leave(KErrNotSupported);

        }

    // 1. Fetch previous default

    TPbkContactItemField* prevDefault = DefaultSmsField();

    // 2. Set the new default if specified

    if (aField)

        {

        if (aField == prevDefault)

            {

            // Already set

            return;

            }

        // If this leaves, this object's state remains unchanged

        aField->ItemField().AddFieldTypeL(KUidPbkDefaultFieldSms);

        }

    // 3. Unset any previous default (invariant tests that there is always just

    // one default).

    if (prevDefault)

        {

        prevDefault->ItemField().RemoveFieldType(KUidPbkDefaultFieldSms);

        }

    __ASSERT_DEBUG(

        (aField && DefaultSmsField()==aField) ||

        (!aField && !DefaultSmsField()),

        Panic(EPanicPostCond_SetDefaultPhoneNumberFieldL));

    }

EXPORT_C void CPbkContactItem::RemoveDefaultSmsField()

    {

    // This is safe because SetDefaultSmsFieldL(NULL) guarantees

    // not to leave

    SetDefaultSmsFieldL(NULL);

    }

EXPORT_C TPbkContactItemField* CPbkContactItem::DefaultEmailField() const

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    // scan the fields for a match in default field for field id.

    const TInt fieldCount = iFields.Count();

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

        {

        const TPbkContactItemField& field = iFields[i];

        if (field.DefaultEmailField())

            {

            return const_cast<TPbkContactItemField*>(&field);

            }

        }

    return NULL;

    }

EXPORT_C void CPbkContactItem::SetDefaultEmailFieldL

        (TPbkContactItemField* aField)

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;

    if (aField)

        {

        aField = FindSameField(*aField);

        if (!aField)

            {

            // Not this item's field

            User::Leave(KErrNotFound);

            }

        }

    if (aField && aField->FieldInfo().FieldId() != EPbkFieldIdEmailAddress)

        {

        User::Leave(KErrNotSupported);

        }

    // 1. Fetch previous default

    TPbkContactItemField* prevDefault = DefaultEmailField();

    // 2. Set the new default if specified

    if (aField)

        {

        if (aField == prevDefault)

            {

            // Already set

            return;

            }

        aField->ItemField().AddFieldTypeL(KUidPbkDefaultFieldPref);

        }

    // 3. Unset any previous default (invariant tests that there is always just

    // one default).

    if (prevDefault)

        {

        prevDefault->ItemField().RemoveFieldType(KUidPbkDefaultFieldPref);

        }

    __ASSERT_DEBUG(

        (aField && DefaultEmailField()==aField) ||

        (!aField && !DefaultEmailField()),

        Panic(EPanicPostCond_SetDefaultEmailFieldL));

    }

EXPORT_C void CPbkContactItem::RemoveDefaultEmailField()

    {

    // This is safe because SetDefaultEmailFieldL(NULL) guarantees

    // not to leave

    SetDefaultEmailFieldL(NULL);

    }

EXPORT_C TPbkContactItemField* CPbkContactItem::DefaultEmailOverSmsField() const

    {

    PBK_DEBUG_TEST_INVARIANT_ON_ENTRY_AND_EXIT;