/*

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

*

*/

#include "creator_virtualphonebook.h" 

#include "creator_traces.h"

#include "creator_contactsetcache.h"

#include <CVPbkContactStoreUriArray.h>

#include <VPbkContactStoreUris.h>

#include <TVPbkContactStoreUriPtr.h>

#include <MVPbkContactGroup.h>

#include <MVPbkContactStore.h>

#include <CVPbkContactManager.h>

#include <MVPbkContactStoreList.h>

#include <MVPbkContactStoreListObserver.h>

#include <MVPbkContactOperationBase.h>

#include <MVPbkStoreContact.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkContactFieldData.h>

#include <MVPbkFieldType.h>

#include <MVPbkContactFieldTextData.h>

#include <MVPbkContactFieldBinaryData.h>

#include <MVPbkContactFieldDateTimeData.h>

#include <CVPbkContactViewDefinition.h>

#include <MVPbkContactView.h>

#include <VPbkContactView.hrh>

#include <VPbkEng.rsg>

typedef struct {

TInt iFieldCode;

TInt iRandomType;

} FieldInfo;

static const TInt RND_TYPE_UNDEF = -99;

FieldInfo CreatorVPbkMiscTextFields[] = {        

        {R_VPBK_FIELD_TYPE_FIRSTNAME, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_FIRSTNAMEREADING, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_LASTNAME, (TInt) CCreatorEngine::ESurname},

        {R_VPBK_FIELD_TYPE_LASTNAMEREADING, (TInt) CCreatorEngine::ESurname},

        {R_VPBK_FIELD_TYPE_COMPANYNAME, (TInt) CCreatorEngine::ECompany},

        {R_VPBK_FIELD_TYPE_JOBTITLE, (TInt) CCreatorEngine::EJobTitle},

        {R_VPBK_FIELD_TYPE_PREFIX, (TInt) CCreatorEngine::EPrefix},

        {R_VPBK_FIELD_TYPE_SUFFIX, (TInt) CCreatorEngine::ESuffix},

        {R_VPBK_FIELD_TYPE_SECONDNAME, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_ADDRLABELGEN, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRPOGEN, (TInt) CCreatorEngine::EPobox},

        {R_VPBK_FIELD_TYPE_ADDREXTGEN, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRSTREETGEN, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRLOCALGEN, (TInt) CCreatorEngine::ECity},

        {R_VPBK_FIELD_TYPE_ADDRREGIONGEN, (TInt) CCreatorEngine::EState},

        {R_VPBK_FIELD_TYPE_ADDRPOSTCODEGEN, (TInt) CCreatorEngine::EPostcode},

        {R_VPBK_FIELD_TYPE_ADDRCOUNTRYGEN, (TInt) CCreatorEngine::ECountry},

        {R_VPBK_FIELD_TYPE_ADDRLABELHOME, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRPOHOME, (TInt) CCreatorEngine::EPobox},

        {R_VPBK_FIELD_TYPE_ADDREXTHOME, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRSTREETHOME, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRLOCALHOME, (TInt) CCreatorEngine::ECity},

        {R_VPBK_FIELD_TYPE_ADDRREGIONHOME, (TInt) CCreatorEngine::EState},

        {R_VPBK_FIELD_TYPE_ADDRPOSTCODEHOME, (TInt) CCreatorEngine::EPostcode},

        {R_VPBK_FIELD_TYPE_ADDRCOUNTRYHOME, (TInt) CCreatorEngine::ECountry},

        {R_VPBK_FIELD_TYPE_ADDRLABELWORK, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRPOWORK, (TInt) CCreatorEngine::EPobox},

        {R_VPBK_FIELD_TYPE_ADDREXTWORK, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRSTREETWORK, (TInt) CCreatorEngine::EAddress},

        {R_VPBK_FIELD_TYPE_ADDRLOCALWORK, (TInt) CCreatorEngine::ECity},

        {R_VPBK_FIELD_TYPE_ADDRREGIONWORK, (TInt) CCreatorEngine::EState},

        {R_VPBK_FIELD_TYPE_ADDRPOSTCODEWORK, (TInt) CCreatorEngine::EPostcode},

        {R_VPBK_FIELD_TYPE_ADDRCOUNTRYWORK, (TInt) CCreatorEngine::ECountry},

        {R_VPBK_FIELD_TYPE_POC, (TInt) CCreatorEngine::EPhoneNumber},

        {R_VPBK_FIELD_TYPE_SWIS, (TInt) CCreatorEngine::EPhoneNumber},

        {R_VPBK_FIELD_TYPE_SIP, (TInt) CCreatorEngine::EPhoneNumber},

        {R_VPBK_FIELD_TYPE_DTMFSTRING, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_NOTE,(TInt)  CCreatorEngine::EMemoText},

        {R_VPBK_FIELD_TYPE_MIDDLENAME, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_DEPARTMENT, (TInt) CCreatorEngine::ECompany},

        {R_VPBK_FIELD_TYPE_ASSTNAME, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_SPOUSE, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_CHILDREN, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_SYNCCLASS, RND_TYPE_UNDEF},

        {R_VPBK_FIELD_TYPE_LOCPRIVACY, RND_TYPE_UNDEF},

        {R_VPBK_FIELD_TYPE_GENLABEL, (TInt) CCreatorEngine::EFirstName},

        {R_VPBK_FIELD_TYPE_WVADDRESS, (TInt) CCreatorEngine::EPhoneNumber},

        {R_VPBK_FIELD_TYPE_RINGTONE, RND_TYPE_UNDEF},

        {R_VPBK_FIELD_TYPE_THUMBNAILPIC, RND_TYPE_UNDEF},

        {R_VPBK_FIELD_TYPE_CALLEROBJTEXT, (TInt) CCreatorEngine::EFirstName}

        };

TInt CreatorVPbkBinaryFields[] = {

        R_VPBK_FIELD_TYPE_CALLEROBJIMG//,

        //R_VPBK_FIELD_TYPE_THUMBNAILPATH

        };

TInt CreatorVPbkDateTimeFields[] = {

        R_VPBK_FIELD_TYPE_ANNIVERSARY

        };

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

TInt CreatorVPbkPhoneNumberFields[] =

    {

    R_VPBK_FIELD_TYPE_LANDPHONEGEN,

    R_VPBK_FIELD_TYPE_LANDPHONEHOME,

    R_VPBK_FIELD_TYPE_LANDPHONEWORK,                        

    R_VPBK_FIELD_TYPE_MOBILEPHONEGEN,

    R_VPBK_FIELD_TYPE_MOBILEPHONEHOME,

    R_VPBK_FIELD_TYPE_MOBILEPHONEWORK,

    R_VPBK_FIELD_TYPE_FAXNUMBERGEN,

    R_VPBK_FIELD_TYPE_FAXNUMBERHOME,

    R_VPBK_FIELD_TYPE_FAXNUMBERWORK,

    R_VPBK_FIELD_TYPE_PAGERNUMBER,           

    R_VPBK_FIELD_TYPE_VIDEONUMBERGEN,

    R_VPBK_FIELD_TYPE_VIDEONUMBERHOME,

    R_VPBK_FIELD_TYPE_VIDEONUMBERWORK,

    R_VPBK_FIELD_TYPE_VOIPGEN,

    R_VPBK_FIELD_TYPE_VOIPHOME,

    R_VPBK_FIELD_TYPE_VOIPWORK,

    R_VPBK_FIELD_TYPE_ASSTPHONE,

    R_VPBK_FIELD_TYPE_CARPHONE

    };

TInt CreatorVPbkUrlFields[] =

    {

    R_VPBK_FIELD_TYPE_URLGEN,

    R_VPBK_FIELD_TYPE_URLHOME,

    R_VPBK_FIELD_TYPE_URLWORK

    };

TInt CreatorVPbkEmailFields[] =

    {

    R_VPBK_FIELD_TYPE_EMAILGEN,

    R_VPBK_FIELD_TYPE_EMAILHOME,

    R_VPBK_FIELD_TYPE_EMAILWORK

    };

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

CVirtualPhonebookParameters::CVirtualPhonebookParameters()

    {

    LOGSTRING("Creator: CVirtualPhonebookParameters::CVirtualPhonebookParameters");

    iGroupName = HBufC::New(KPhonebookFieldLength);  

    }

CVirtualPhonebookParameters::~CVirtualPhonebookParameters()

    {

    LOGSTRING("Creator: CVirtualPhonebookParameters::~CVirtualPhonebookParameters");

    delete iGroupName;   

    iContactFields.ResetAndDestroy();

    iContactFields.Close();

    iLinkIds.Reset();

    iLinkIds.Close();

    }

void CVirtualPhonebookParameters::ParseL(CCommandParser* /*parser*/, TParseParams /*aCase = 0*/)

	{

	}

TInt CVirtualPhonebookParameters::ScriptLinkId() const

    {

    return iLinkId;

    }

void CVirtualPhonebookParameters::SetScriptLinkId(TInt aLinkId)

    {

    iLinkId = aLinkId;

    }

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

CCreatorVirtualPhonebook* CCreatorVirtualPhonebook::NewL(CCreatorEngine* aEngine)

    {

    CCreatorVirtualPhonebook* self = CCreatorVirtualPhonebook::NewLC(aEngine);

    CleanupStack::Pop(self);

    return self;

    }

CCreatorVirtualPhonebook* CCreatorVirtualPhonebook::NewLC(CCreatorEngine* aEngine)

    {

    CCreatorVirtualPhonebook* self = new (ELeave) CCreatorVirtualPhonebook;

    CleanupStack::PushL(self);

    self->ConstructL(aEngine);

    return self;

    }

CCreatorVirtualPhonebook::CCreatorVirtualPhonebook()

    {    

    iAddAllFields = EFalse;

    }

void CCreatorVirtualPhonebook::ConstructL(CCreatorEngine* aEngine)

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::ConstructL");

    iContactLinkArray = CVPbkContactLinkArray::NewL();

    iContactsToDelete = CVPbkContactLinkArray::NewL();

    iContactGroupsToDelete = CVPbkContactLinkArray::NewL();

    iEngine = aEngine;

    SetDefaultParameters();

    // initialize virtual phonebook

    CVPbkContactStoreUriArray* uriArray = CVPbkContactStoreUriArray::NewLC();

    uriArray->AppendL( TVPbkContactStoreUriPtr(VPbkContactStoreUris::DefaultCntDbUri()));

    iContactManager = CVPbkContactManager::NewL( *uriArray, &CCoeEnv::Static()->FsSession());

    CleanupStack::PopAndDestroy(uriArray);

    //When the contact manager is created, the stores is opened

    MVPbkContactStoreList& storeList = iContactManager->ContactStoresL();

    iWaiter = CAsyncWaiter::NewL();

    //MVPbkContactStoreListObserver must give as parameter    

    storeList.OpenAllL(*this);

    // wait for OpenComplete() callback

    iWaiter->StartAndWait();

    _LIT(dbUri, "cntdb://c:contacts.cdb");

    const TVPbkContactStoreUriPtr uri = TVPbkContactStoreUriPtr(dbUri);

    iStore = storeList.Find(uri);    

    iOpCounter = 0;    

    }

TBool CCreatorVirtualPhonebook::IsActive()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::IsActive");

    return iOperation != NULL;

    }

void CCreatorVirtualPhonebook::CancelOperation()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::CancelOperation");

    iCancelCbRequested = ETrue;    

    }

CCreatorVirtualPhonebook::~CCreatorVirtualPhonebook()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::~CCreatorVirtualPhonebook");

    // this is done only once per phonebook operation

    if ( iContactsToDelete && iContactsToDelete->Count() )

        {

        TRAP_IGNORE( StoreLinksForDeleteL( *iContactsToDelete, KUidDictionaryUidContacts ) );

        }

    delete iContactsToDelete;

    if ( iContactGroupsToDelete && iContactGroupsToDelete->Count() )

        {

        TRAP_IGNORE( StoreLinksForDeleteL( *iContactGroupsToDelete, KUidDictionaryUidContactGroups ) );

        }

    delete iContactGroupsToDelete;

    iPreviousDeleteLinks.ResetAndDestroy();

    delete iOperation;

    TInt err = 0;

    TRAP(err, CompactPbkDatabaseL( ETrue ));

    if(iContactResults)

    	{

    	delete iContactResults;

    	}

    delete iContactLinkArray;

    delete iContactGroupsInStore;

    if(iContactManager)

    	{

    	TRAP(err, iContactManager->ContactStoresL().CloseAll(*this));

    	delete iContactManager;

    	}

    if(iWaiter)

    	{

    	delete iWaiter;    

    	}

    if (iParameters)

    	{

        delete iParameters;

    	}

    }

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

TBool CCreatorVirtualPhonebook::AskDataFromUserL(TInt aCommand, TInt& aNumberOfEntries)

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::AskDataFromUserL");

    TBool ret = CCreatorPhonebookBase::AskDataFromUserL(aCommand, aNumberOfEntries);

    if(ret && aCommand == ECmdCreatePhoneBookEntryContacts && !iDefaultFieldsSelected)    

        {

        iAddAllFields = iEngine->YesNoQueryDialogL(_L("Add all the other fields to contacts?"));

        }

    return ret;

    }

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

void CCreatorVirtualPhonebook::DeleteAllL()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteAllL");

    // Delete all contacts, not contact groups

    //get field types

    const MVPbkFieldTypeList& fieldList = iStore->StoreProperties().SupportedFields();

    // get all contact links, results will be set to iContactResults

    MVPbkContactOperationBase* operation = iContactManager->FindL( _L(""), fieldList , *this );

    if ( operation )

        {

        iWaiter->StartAndWait(); //Making asynchronous FindL to synchronous

        delete operation;

        }

    while( iContactResults->Count() && 

           !iCancelCbRequested &&

           HasOtherThanGroupsL( iContactResults ) )

        {

        // delete all found contacts

        DeleteContactsL( iContactResults, EFalse );

        if ( !iCancelCbRequested )

            {

            // find next set of contacts to delete

            MVPbkContactOperationBase* operation = iContactManager->FindL( _L(""), fieldList , *this );

            if ( operation )

                {

                iWaiter->StartAndWait(); //Making asynchronous FindL to synchronous

                delete operation;

                }

            }

        }

    if ( iCancelCbRequested && iEngine )

        {

        // User cancelled, must callback to finish terminatio sequence

        iEngine->CancelComplete();

        }

    else

        {

        // contacts deleted, remove the Creator internal contact registry

        // (no callback required)

        CDictionaryFileStore* store = iEngine->FileStoreLC();

        if ( store )

            {

            store->Remove( KUidDictionaryUidContacts );

            store->CommitL();        

            }

        CleanupStack::PopAndDestroy( store );

        }    

    }

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

void CCreatorVirtualPhonebook::DeleteAllCreatedByCreatorL()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteAllCreatedByCreatorL");

    DeleteItemsCreatedWithCreatorL( KUidDictionaryUidContacts );

    }

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

void CCreatorVirtualPhonebook::DeleteAllGroupsL()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteAllGroupsL");

    User::LeaveIfNull( iStore );

    MVPbkContactLinkArray* groups = iStore->ContactGroupsLC();

    DeleteContactsL( groups, ETrue );

    CleanupStack::PopAndDestroy(); // cannot use groups as parameter

    }

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

void CCreatorVirtualPhonebook::DeleteAllGroupsCreatedByCreatorL()

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteAllGroupsCreatedByCreatorL");

    DeleteItemsCreatedWithCreatorL( KUidDictionaryUidContactGroups );

    }

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

void CCreatorVirtualPhonebook::DeleteContactsL( MVPbkContactLinkArray* aContacts, TBool aGroup )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteContactsL");

    const MVPbkContactLink* link( NULL );

    delete iOperation;

    iOperation = NULL;

    TInt i(0);

    while ( aContacts && i < aContacts->Count() && !iCancelCbRequested )

        {

        link = &aContacts->At( i++ );

        if ( aGroup == IsContactGroupL( *link ) )

            {

            iOperation = iContactManager->RetrieveContactL( *link, *this );

            // see VPbkSingleContactOperationComplete

            if ( iOperation )

                {

                iWaiter->StartAndWait();

                delete iOperation;

                iOperation = NULL;

                }            

            }

        link = NULL;

        }

    }

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

void CCreatorVirtualPhonebook::DeleteItemsCreatedWithCreatorL( TUid aStoreUid )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DeleteItemsCreatedWithCreatorL");

    __ASSERT_ALWAYS( aStoreUid == KUidDictionaryUidContacts || 

                     aStoreUid == KUidDictionaryUidContactGroups,

                     User::Panic( _L("CCreatorVPb"), KErrArgument ) );

    CDictionaryFileStore* store = iEngine->FileStoreLC();

    User::LeaveIfNull( store );

    if ( store->IsPresentL( aStoreUid ) )

        {

        TRAP_IGNORE( DoDeleteItemsCreatedWithCreatorL( aStoreUid, store ) );

        if ( iCancelCbRequested && iEngine )

            {

            iEngine->CancelComplete();

            }

        else

            {

            // contacts deleted, remove the Creator internal contact registry

            store->Remove( aStoreUid );

            store->CommitL();            

            }

        }

    CleanupStack::PopAndDestroy( store );

    }

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

void CCreatorVirtualPhonebook::DoDeleteItemsCreatedWithCreatorL( TUid aStoreUid, CDictionaryFileStore* aStore )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::DoDeleteItemsCreatedWithCreatorL");

    RDictionaryReadStream in;

    in.OpenLC( *aStore, aStoreUid );

    MVPbkContactLinkArray* contactsToDelete = NULL;

    // fetch contact links from store

    while ( ( contactsToDelete = iContactManager->CreateLinksLC( in ) ) != NULL && // will leave with KErrEof

            !iCancelCbRequested ) 

        {

        DeleteContactsL( contactsToDelete, aStoreUid == KUidDictionaryUidContactGroups );

        // PopAndDestroy for contactsToDelete causes E32USER-CBase:90

        // however there is no mem-leak even if not deleting contactsToDelete object

        }

    CleanupStack::PopAndDestroy(); // in

    }

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

TBool CCreatorVirtualPhonebook::HasOtherThanGroupsL( MVPbkContactLinkArray* aContacts )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::HasOtherThanGroupsL");

    TBool result( EFalse );

    TInt i(0);

    while ( aContacts && i < aContacts->Count() && !iCancelCbRequested && !result )

        {

        if ( !IsContactGroupL( aContacts->At( i++ ) ) )

            {

            result = ETrue;

            }

        }

    return result;

    }

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

void CCreatorVirtualPhonebook::VPbkSingleContactOperationComplete(

                MVPbkContactOperationBase& /*aOperation*/,

                MVPbkStoreContact* aContact )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::VPbkSingleContactOperationComplete");

    // This callback is currently used only for deleting a contact

    // See DeleteContactsL

    TRAP_IGNORE( 

            aContact->PushL();

            aContact->DeleteL( *this );

            CleanupStack::PopAndDestroy( aContact );

        );

    }

void CCreatorVirtualPhonebook::VPbkSingleContactOperationFailed(

                MVPbkContactOperationBase& /*aOperation*/, 

                TInt /*aError*/ )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::VPbkSingleContactOperationFailed");

    iWaiter->Cancel();

    }

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

void CCreatorVirtualPhonebook::StoreLinksForDeleteL( MVPbkContactLinkArray& aLinks, TUid aStoreUid )

    {

    LOGSTRING("Creator: CCreatorVirtualPhonebook::StoreLinksForDeleteL");

    CDictionaryFileStore* store = iEngine->FileStoreLC();

    User::LeaveIfNull( store );

    // backup previous contact links from store

    // otherwise they would be overwritten when calling out.WriteL

    MVPbkContactLinkArray* previousLinks( NULL );

    if ( store->IsPresentL( aStoreUid ) )

        {

        RDictionaryReadStream in;

        in.OpenLC( *store, aStoreUid );        

        TRAP_IGNORE( 

            while ( ( previousLinks = iContactManager->CreateLinksLC( in )) != NULL ) // will leave with KErrEof

                {

                CleanupStack::Pop(); // previousLinks

                iPreviousDeleteLinks.Append( previousLinks );

                previousLinks = NULL;

                }

            );

        CleanupStack::PopAndDestroy(); // in

        }

    RDictionaryWriteStream out;       

    out.AssignLC( *store, aStoreUid );