/*

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

*       Represents a connection to the Phonebook contact database

*

*/

// INCLUDE FILES

#include "CPbkContactEngine.h"

#include <cntdb.h>       // CContactDatabase class

#include <cntitem.h>     // ContactItem class

#include <barsc.h>       // RResourceFile

#include <barsread.h>    // TResourceReader

#include <shareddataclient.h>    // RSharedDataClient

#include <featmgr.h>	// Feature manager

#include <ecom/ecom.h>

#include <PbkUID.h>

#include <bautils.h>    // BaflUtils

#include "CPbkFieldsInfo.h"

#include "CPbkFieldInfo.h"

#include "CPbkContactItem.h"

#include "CPbkContactIter.h"

#include "MPbkContactDbObserver.h"

#include "CPbkContactChangeNotifier.h"

#include "CPbkIdleFinder.h"

#include <PbkEngUtils.h>

#include <CPbkConstants.h>

#include "CPbkEngineExtension.h"

#include "CContactDbConnection.h"

#include <MPbkContactNameFormat.h>

#include "CPbkDeleteContacts.h"

#include "CPbkIdleProcessRunner.h"

#include "PbkDataCaging.hrh"

#include "cpbkenginelocalstorage.h"

#include <PbkDebug.h>  // Phonebook debugging support

#include "PbkProfiling.h"

/// Unnamed namespace for local definitons

namespace {

// LOCAL CONSTANTS AND MACROS

_LIT(KCntModelResFileName, "cntmodel.rsc");

_LIT(KCntModelResFileDrive, "z:");

_LIT8(KSettingsVisibleCompareStr, "*1*");

enum TPanicCode

    {

    EPanicContactNotGroup = 1,

    EPanicPreCond_AddObserverL,

    EPanicPostCond_AddObserverL,

    EPanicPreCond_RemoveObserver,

    EPanicPostCond_RemoveObserver,

    EPanicObserverNotFoundInRemove,

    EPanicPreCond_ConstructL,

    EPanicPreCond_UnnamedTitle,

    EPanicPreCond_CreateEmptyContactL,

    EPanicFieldInfoNotFound,

    EPanicLogic_ConstructL,

    EPanicSetTlsFails,

    EPanicSINDHandlerNotFound // obsolete

    };

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

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbkContactEngine");

    User::Panic(KPanicText, aReason);

    }

/**

 * Returns true if aError is a fatal database open error.

 */

TBool IsFatalDbOpenError(TInt aError);

/**

 * Removes all information that should not be duplicated from aContactItem.

 */

void RemoveNonDuplicableContactInformation(CContactItem& aContactItem);

}  // namespace

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

inline CPbkContactEngine::CPbkContactEngine() :

    iFreeSpaceRequiredToDelete(8*1024)  // 8 kB by default

    // CBase::operator new(TLeave) will reset other members

	{

	}

EXPORT_C CPbkContactEngine* CPbkContactEngine::NewL(RFs* aFs/*=NULL*/)

	{

	CPbkContactEngine* self = new(ELeave) CPbkContactEngine;

	CleanupStack::PushL(self);

	self->ConstructL(NULL, EFalse, aFs);

	CleanupStack::Pop(self);

	return self;

	}

EXPORT_C CPbkContactEngine* CPbkContactEngine::NewL

        (const TDesC& aFileName, TBool aReplace/*=EFalse*/, RFs* aFs/*=NULL*/)

    {

	CPbkContactEngine* self = new(ELeave) CPbkContactEngine;

	CleanupStack::PushL(self);

	self->ConstructL(&aFileName, aReplace, aFs);

	CleanupStack::Pop(self);

	return self;

    }

EXPORT_C CPbkContactEngine* CPbkContactEngine::ReplaceL

        (RFs* aFs/*=NULL*/)

    {

	CPbkContactEngine* self = new(ELeave) CPbkContactEngine;

	CleanupStack::PushL(self);

	self->ConstructL(NULL, ETrue, aFs);

	CleanupStack::Pop(self);

	return self;

    }

CPbkContactEngine::~CPbkContactEngine()

	{

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING("CPbkContactEngine(%x)::~CPbkContactEngine"), this);

    // Check if this is the Tls-registered instance and remove it from Tls

    CPbkEngineLocalStorage* storage =

                    reinterpret_cast<CPbkEngineLocalStorage*> (Dll::Tls());

    if ( storage )

        {

        // check that this instance is the same than stored instance

        if ( &storage->iEngine == this )

            {

            // delete the storage instance.

            delete storage;

            Dll::SetTls( NULL );

            }

        }

    if (iSharedDataClient)

        {

        iSharedDataClient->Close();

        delete iSharedDataClient;

        }

	delete iDbConnection;

    delete iObservers;

    delete iPbkFieldsInfo;

    delete iPbkConstants;

	delete iExtension;

	FeatureManager::UnInitializeLib();

    iOwnFs.Close();

    // Cleanup ECom session

    REComSession::FinalClose();

	}

EXPORT_C CPbkContactEngine* CPbkContactEngine::Static()

    {

    CPbkEngineLocalStorage* storage =

        reinterpret_cast<CPbkEngineLocalStorage*> ( Dll::Tls( ) );

    if ( storage )

        {

        return &storage->iEngine;

        }

    else

        {

        return NULL;

        }

    }

inline void CPbkContactEngine::ConnectFsL(RFs* aRfs)

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING("CPbkContactEngine::ConnectFsL(0x%x)"), this);

    if (aRfs)

        {

        iFs = *aRfs;

        }

    else

        {

	    User::LeaveIfError(iOwnFs.Connect());

        iFs = iOwnFs;

        }

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING("CPbkContactEngine::ConnectFsL(0x%x) succesful"), this);

    }

inline void CPbkContactEngine::ReadResourcesL(TBool& aSettingsVisibility)

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::ReadResourcesL(0x%x)"), this);

    __PBK_PROFILE_START(PbkProfiling::EInitEngineResources);

    // Open the resource files

    RResourceFile pbkResFile;

    PbkEngUtils::FindAndOpenDefaultResourceFileLC(iFs, pbkResFile);

    RResourceFile cntModelResFile;

    PbkEngUtils::FindAndOpenResourceFileLC

        (iFs, KCntModelResFileName, KDC_CONTACTS_RESOURCE_DIR, KCntModelResFileDrive,

        cntModelResFile);

    // Read fields info array

    iPbkFieldsInfo = CPbkFieldsInfo::NewL(pbkResFile, cntModelResFile);

    // load phonebook constants

    iPbkConstants = CPbkConstants::NewL(pbkResFile);

    // read the name ordering settings menu item visibility value:

    HBufC8* buffer = pbkResFile.AllocReadLC(R_PBK_NAME_ORDERING_SETTINGS_VISIBILITY);

    if ( buffer->MatchF(KSettingsVisibleCompareStr) == 0 )

        {

        aSettingsVisibility = ETrue;

        }

    // Close resource files

    CleanupStack::PopAndDestroy(3);

    __PBK_PROFILE_END(PbkProfiling::EInitEngineResources);

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::ReadResourcesL(0x%x) succesful"), this);

    }

inline void CPbkContactEngine::CreateDbConnectionL

        (const TDesC* aFileName,

		TBool aReplace,

		TInt& aDbOpenError,

		TBool aSettingsVisible)

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::CreateDbConnectionL(0x%x)"), this);

    // Create contact database connection object

    CContactDbConnection::TParams params;

    params.iDbFileName = aFileName;

    params.iReplaceExistingDb = aReplace;

    params.iContactDbObserver = this;

    params.iFs = iFs;

    params.iFieldsInfo = iPbkFieldsInfo;

    params.iExtension = iExtension;

    params.iDbOpenError = &aDbOpenError;

	params.iUnnamedTitle = &iPbkConstants->UnnamedTitle();

    params.iEngine = this;

    iDbConnection = CContactDbConnection::NewL(params, aSettingsVisible);

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::CreateDbConnectionL(0x%x) succesful"), this);

    }

void CPbkContactEngine::ConstructL

        (const TDesC* aFileName,

		TBool aReplace, RFs* aRfs)

	{

    __ASSERT_DEBUG(

        !iDbConnection && !iPbkFieldsInfo,

        Panic(EPanicPreCond_ConstructL));

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::ConstructL(0x%x)"), this);

    ConnectFsL(aRfs);

	FeatureManager::InitializeLibL();

	// Shared data objects have to created after ConnectFsL,

	// but before ReadResourcesL

    iSharedDataClient = new (ELeave) RSharedDataClient;

    User::LeaveIfError(iSharedDataClient->Connect());

    iExtension = CPbkEngineExtension::NewL(iFs);

    TBool settingsVisible(EFalse);

    ReadResourcesL(settingsVisible);

    TInt dbOpenError = KErrNone;

    TRAPD(dbConnectError, CreateDbConnectionL(aFileName, aReplace, dbOpenError, settingsVisible));

    if (IsFatalDbOpenError(dbOpenError))

        {

        __ASSERT_DEBUG(dbOpenError == dbConnectError, Panic(EPanicLogic_ConstructL));

        // Map all fatal database open errors to KErrCorrupt

        User::Leave(KErrCorrupt);

        }

    if (dbConnectError != KErrNone)

        {

        if (dbConnectError == KErrCorrupt)

            {

            // Convert KErrCorrupt to another error code to avoid clients

            // mixing this error up with database corruption

            dbConnectError = KErrGeneral;

            }

        User::Leave(dbConnectError);

        }

    if (!Dll::Tls())

        {

        CPbkEngineLocalStorage* storage = CPbkEngineLocalStorage::NewL(*this);

        TInt ret = Dll::SetTls(storage);  // Takes ownership

        __ASSERT_DEBUG( ret == KErrNone, Panic( EPanicSetTlsFails ) );

        }

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

		("CPbkContactEngine::ConstructL(0x%x) succesful"), this);

	}

EXPORT_C CPbkContactItem* CPbkContactEngine::CreateEmptyContactL()

    {

    // Create an empty (ie. no fields) contact card

    CContactCard* card = CContactCard::NewLC();

    __ASSERT_DEBUG(card->CardFields().Count()==0,

        Panic(EPanicPreCond_CreateEmptyContactL));

    // Loop through Phonebook field infos

    const TInt count = FieldsInfo().Count();

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

        {

        const CPbkFieldInfo* fi = FieldsInfo()[i];

        if (fi->TemplateField())

            {

            // Create a CContactItemField for fields belonging

			// to the default template

            CContactItemField* field = fi->CreateFieldL();

            CleanupStack::PushL(field);

            // Add the field to the contact card

            card->AddFieldL(*field);

            CleanupStack::Pop(field);

            }

        }

    // Create phonebook contact item from card and return it.

    CPbkContactItem* pbkItem = CPbkContactItem::NewL(card,

		FieldsInfo(), ContactNameFormat());

    CleanupStack::Pop(); // card

    return pbkItem;

    }

EXPORT_C const CPbkFieldsInfo& CPbkContactEngine::FieldsInfo()

    {

    return *iPbkFieldsInfo;

    }

EXPORT_C RFs& CPbkContactEngine::FsSession() const

    {

    return const_cast<RFs&>(iFs);

    }

EXPORT_C CPbkContactIter* CPbkContactEngine::CreateContactIteratorLC

        (TBool aUseMinimalRead/*=EFalse*/)

    {

    iDbConnection->CancelCompress();

    return CPbkContactIter::NewLC(*this, aUseMinimalRead);

    }

EXPORT_C CPbkContactChangeNotifier*

    CPbkContactEngine::CreateContactChangeNotifierL

        (MPbkContactDbObserver *aObserver)

    {

    return CPbkContactChangeNotifier::NewL(*this, aObserver);

    }

EXPORT_C const TDesC& CPbkContactEngine::UnnamedTitle() const

    {

    __ASSERT_DEBUG(iPbkConstants, Panic(EPanicPreCond_UnnamedTitle));

    return iPbkConstants->UnnamedTitle();

    }

EXPORT_C TContactItemId CPbkContactEngine::AddNewContactL

        (CPbkContactItem& aContact, TBool aImmediateNotify/*=EFalse*/)

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

	("CPbkContactEngine(%x)::AddNewContactL(aContact=%x, aImmediateNotify=%d)"),

        this, &aContact, aImmediateNotify);

    iDbConnection->CancelCompress();

    // Prepare contact for saving to the DB

    aContact.PrepareForSaveL();

    TContactItemId cid = iDbConnection->Database().AddNewContactL

		(aContact.ContactItem());

    // Undo PrepareForSaveL

    aContact.PrepareAfterLoadL();

    // Send immediate event

    SendImmidiateEventToAllObservers(EContactDbObserverEventContactAdded,

        cid, aImmediateNotify);

    return cid;

    }

EXPORT_C CPbkContactItem* CPbkContactEngine::ReadContactL

        (TContactItemId aContactId,

        const CPbkFieldIdArray* aFieldTypes/*=NULL*/)

    {

    CPbkContactItem* item = ReadContactLC(aContactId, aFieldTypes);

    CleanupStack::Pop();  // item

    return item;

    }

EXPORT_C CPbkContactItem* CPbkContactEngine::ReadContactLC

        (TContactItemId aContactId,

        const CPbkFieldIdArray* aFieldTypes/*=NULL*/)

    {

    iDbConnection->CancelCompress();

    CContactItem* item = NULL;

    if (aFieldTypes)

        {

        CContactItemViewDef* viewDef =

            FieldsInfo().CreateContactItemViewDefLC(*aFieldTypes);

        item = iDbConnection->Database().ReadContactL(aContactId, *viewDef);

        CleanupStack::PopAndDestroy(viewDef);

        CleanupStack::PushL(item);

        }

    else

        {

        item = iDbConnection->Database().ReadContactLC(aContactId);

        }

    CPbkContactItem* pbkItem = CPbkContactItem::NewL

        (item, FieldsInfo(), ContactNameFormat());

    // CPbkContactItem takes ownership of item

    CleanupStack::Pop(); // item

    CleanupStack::PushL(pbkItem);

    // Prep empty fields for use in the application.

    // See also CommitContactL.

    pbkItem->PrepareAfterLoadL();

    iDbConnection->CompressL();

    return pbkItem;

    }

EXPORT_C CPbkContactItem* CPbkContactEngine::ReadMinimalContactLC

        (TContactItemId aContactId)

    {

    iDbConnection->CancelCompress();

    CContactItem* item =

        iDbConnection->Database().ReadMinimalContactLC(aContactId);

    CPbkContactItem* pbkItem = CPbkContactItem::NewL

        (item, FieldsInfo(), ContactNameFormat());

    // CPbkContactItem takes ownership of item

    CleanupStack::Pop(); // item

    CleanupStack::PushL(pbkItem);

    // Prep empty fields for use in the application.

    // See also CommitContactL.

    pbkItem->PrepareAfterLoadL();

    iDbConnection->CompressL();

    return pbkItem;

    }

EXPORT_C CPbkContactItem* CPbkContactEngine::OpenContactL

        (TContactItemId aContactId)

    {

    PBK_DEBUG_PRINT(

        PBK_DEBUG_STRING("CPbkContactEngine(%x)::OpenContactL(aContactId=%d)"),

        this, aContactId);

    CPbkContactItem* pbkItem = OpenContactLCX(aContactId);

    CleanupStack::Pop(2);  // pbkItem, lock

    return pbkItem;

    }

EXPORT_C CPbkContactItem* CPbkContactEngine::OpenContactLCX

        (TContactItemId aContactId)

    {

    PBK_DEBUG_PRINT(

        PBK_DEBUG_STRING("CPbkContactEngine(%x)::OpenContactLCX(aContactId=%d)"),

        this, aContactId);

    iDbConnection->CancelCompress();

    CContactItem* item = iDbConnection->Database().OpenContactLX(aContactId);

    CleanupStack::PushL(item);

    CPbkContactItem* pbkItem =

        CPbkContactItem::NewL(item, FieldsInfo(), ContactNameFormat());

    // CPbkContactItem takes ownership of item

    CleanupStack::Pop(item);

    CleanupStack::PushL(pbkItem);

    // Prep empty fields for use in the application.

    // See also CommitContactL.

    pbkItem->PrepareAfterLoadL();

    return pbkItem;

    }

EXPORT_C void CPbkContactEngine::CommitContactL

        (CPbkContactItem& aContact, TBool aImmediateNotify/*=EFalse*/)

    {

    PBK_DEBUG_PRINT(

        PBK_DEBUG_STRING(

        "CPbkContactEngine(%x)::CommitContactL(aContact=%x, aImmediateNotify=%d)"),

        this, &aContact, aImmediateNotify);

    iDbConnection->CancelCompress();

    // Prepare contact for saving to the DB

    aContact.PrepareForSaveL();

    iDbConnection->Database().CommitContactL(aContact.ContactItem());

    // Undo PrepareForSaveL

    aContact.PrepareAfterLoadL();

    // Send immediate event

    SendImmidiateEventToAllObservers(EContactDbObserverEventContactChanged,

        aContact.ContactItem().Id(), aImmediateNotify);

    }

EXPORT_C void CPbkContactEngine::CloseContactL

        (TContactItemId aContactId)

    {