/*

* Copyright (c) 2005 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:  Contact list model implementation

*

*/

// INCLUDE FILES

#include    "CPEngContactListModBase.h"

#include    "CPEngContactListModItemContainer.h"

#include    "CPEngContactListModChangeMonitor.h"

#include    "CPEngContactListSettings.h"

#include    "MPEngContactListSettingsManager.h"

#include    "MPEngAttributeList2.h"

#include    "MPEngStorageManager.h"

#include    "PEngListLibraryPanics.h"

#include    "PEngContactIdsTools.h"

#include    "PresenceDebugPrint.h"

#include    <e32std.h>

#include    <bamdesca.h>

// CONSTANTS

// 1001 -  initial version

// 1002 -  store of the delta and monitor have now length of wv IDs,

static const TInt KListStoreVersion = 1002;

// Minimal size of the store entry for contact list model

// count of permanent,cached, and 2 change monitor arrays

static const TInt KListStoreMinSize = 16;

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

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

// CPEngContactListModBase::CPEngContactListModBase()

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

//

CPEngContactListModBase::CPEngContactListModBase(

    CPEngContactListSettings& aListSettings,

    MPEngContactListSettingsManager& aCntLstSettingsManager )

        : CPEngStoreEntry( StoreTypeForListType( aListSettings.BaseSettings().iContactListType ) ),

        iAccessCount( 1 ), // set initial access count to 1

        iSettings( &aListSettings ),

        iCntLstSettingsManager ( aCntLstSettingsManager )

    {

    iSize = KListStoreMinSize;

    }

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

// CPEngContactListModBase::ConstructL()

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

//

void CPEngContactListModBase::ConstructL( MPEngStorageManager& aStorageManager )

    {

    iStorageId = iSettings->Name().AllocL();

    iStorageId->Des().Fold();

    BaseConstructL( aStorageManager );      // CSI: 9 #

    iChangesMonitor = CPEngContactListModChangeMonitor::NewL( *this );

    iStorageManager->RetrieveL( *this );

    iCntLstSettingsManager.AddContactListSettingsObserverL( this );

    }

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

// CPEngContactListModBase::NewL()

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

//

CPEngContactListModBase* CPEngContactListModBase::NewL(

    CPEngContactListSettings& aListSettings,

    MPEngStorageManager& aStorageManager,

    MPEngContactListSettingsManager& aCntLstSettingsManager )

    {

    CPEngContactListModBase* self = NewLC( aListSettings,

                                           aStorageManager,

                                           aCntLstSettingsManager );

    CleanupStack::Pop();

    return self;

    }

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

// CPEngContactListModBase::NewL()

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

//

CPEngContactListModBase* CPEngContactListModBase::NewLC(

    CPEngContactListSettings& aListSettings,

    MPEngStorageManager& aStorageManager,

    MPEngContactListSettingsManager& aCntLstSettingsManager )

    {

    PENG_DP( D_PENG_LIT( "CPEngContactListModBase::NewLC() - %S" ),

             &aListSettings.Name() ) ;

    CPEngContactListModBase* self = new ( ELeave )

    CPEngContactListModBase( aListSettings,

                             aCntLstSettingsManager );

    CleanupClosePushL( *self );

    self->ConstructL( aStorageManager );

    return self;

    }

// Destructor

CPEngContactListModBase::~CPEngContactListModBase()

    {

    PENG_DP( D_PENG_LIT( "CPEngContactListModBase::~CPEngContactListModBase" ) ) ;

    // panic if object is still accessed

    __ASSERT_DEBUG( iAccessCount == 0 , Panic( ERefAccessedObjectDeleted ) );

    iCntLstSettingsManager.RemoveContactListSettingsObserver( this );

    iCntLstSettingsManager.RemoveModel( this );

    ResetLocalView();

    ResetNetworkView();

    iServerOrder.Reset();

    delete iChangesMonitor;

    delete iStorageId;

    }

// =============================================================================

// ===============Functions of MPEngContactListAdvance class ===================

// =============================================================================

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

// CPEngContactListModBase::ContactItemAdvance()

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

//

MPEngContactItemAdvance& CPEngContactListModBase::ContactItemAdvance(

    TInt aIndex,

    TPEngContactListView aView )

    {

    switch ( aView )

        {

        case EPEngCntListLocalView:

            {

            return *( iLocalView[ aIndex ] );

            }

        case EPEngCntListNetworkView:

            {

            return *( iNetworkView[ aIndex ] );

            }

        default:

            {

            Panic( EWrongViewId );

            return *( iNetworkView[ aIndex ] );

            }

        }

    }

// =============================================================================

// ===============Functions of MPEngContactList2 class =========================

// =============================================================================

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

// CPEngContactListModBase::AddContactL()

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

//

TInt CPEngContactListModBase::AddContactL( const TDesC& aContact,

                                           const TDesC& aNickName )

    {

    PENG_DP( D_PENG_LIT( "CPEngContactListModBase::AddIdL: %S, : %S" ),

             &this->StorageId(), &aContact );

    LeaveIfListUpdateInProgressL();

    iChangesMonitor->Reset();

    // Check if contact exists in the local list view

    TInt pos( KErrNotFound );

    if ( KErrNotFound != DoFindContact( iLocalView, aContact, pos ) )

        {

        // Contact already exists, leave

        User::Leave( KErrAlreadyExists );

        }

    // does contact exists in the network view

    TInt index ( DoFindContact( iNetworkView, aContact ) );

    if ( index != KErrNotFound )

        {

        // contact already exist on the network, it was probably removed

        // and now it is added, update nick name and reference

        iNetworkView[ index ]->UpdateNickNameL( aNickName );

        iLocalView.InsertL( iNetworkView[ index ], pos );

        iLocalView[ pos ]->Open( CPEngContactListModItemContainer::ELocalRef );

        }

    else

        {

        // Contact does not exist in any view, add it to the local one

        CPEngContactListModItemContainer* contact =

            CPEngContactListModItemContainer::NewNewNickLC( *this,

                                                            aContact,

                                                            aNickName );

        contact->SetFreshContact( ETrue );

        iLocalView.InsertL( contact, pos );

        iLocalView[ pos ]->Open( CPEngContactListModItemContainer::ELocalRef );

        CleanupStack::PopAndDestroy(); // contact

        }

    StoreContactListL();

    return pos;

    }

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

// CPEngContactListModBase::RemoveContactL()

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

//

void CPEngContactListModBase::RemoveContactL( const TDesC& aContact )

    {

    PENG_DP( D_PENG_LIT( "CPEngContactListModBase::RemoveIdL - %S : %S " ),

             &this->StorageId(), &aContact );

    LeaveIfListUpdateInProgressL();

    iChangesMonitor->Reset();

    // does contact exist in the local view?

    TInt pos( DoFindContact( iLocalView, aContact ) );

    if ( pos == KErrNotFound )

        {

        // nothing to delete

        return;

        }

    iLocalView[ pos ]->CloseRef( CPEngContactListModItemContainer::ELocalRef );

    iLocalView.Remove( pos );

    StoreContactListL();

    }

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

// CPEngContactListModBase::FindContact()

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

//

TInt CPEngContactListModBase::FindContact( const TDesC& aContact,

                                           TPEngContactListView aView ) const

    {

    switch ( aView )

        {

        case EPEngCntListLocalView:

            {

            return DoFindContact( iLocalView, aContact );

            }

        case EPEngCntListNetworkView:

            {

            return DoFindContact( iNetworkView, aContact );

            }

        case EPEngAddedContacts:

            {

            const TDesC& domain = iCntLstSettingsManager.UserDomain();

            return iChangesMonitor->FindContactIdInAdded( aContact, domain );

            }

        case EPEngRemovedContacts:

            {

            const TDesC& domain = iCntLstSettingsManager.UserDomain();

            return iChangesMonitor->FindContactIdInRemoved( aContact, domain );

            }

        default:

            {

            Panic( EWrongViewId );

            return KErrNotFound;

            }

        }

    }

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

// CPEngContactListModBase::Count()

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

//

TInt CPEngContactListModBase::Count( TPEngContactListView aView ) const

    {

    switch ( aView )

        {

        case EPEngCntListLocalView:

            {

            return iLocalView.Count();

            }

        case EPEngCntListNetworkView:

            {

            return iNetworkView.Count();

            }

        case EPEngAddedContacts:

            {

            return iChangesMonitor->CountAddedContactIds();

            }

        case EPEngRemovedContacts:

            {

            return iChangesMonitor->CountRemovedContactIds();

            }

        default:

            {

            Panic( EWrongViewId );

            return 0;

            }

        }

    }

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

// CPEngContactListModBase::ContactItem()

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

//

MPEngContactItem& CPEngContactListModBase::ContactItem( TInt aIndex,

                                                        TPEngContactListView aView )

    {

    return ContactItemAdvance( aIndex, aView );

    }

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

// CPEngContactListModBase::ContactItem()

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

//

const MPEngContactItem& CPEngContactListModBase::ContactItem(

    TInt aIndex,

    TPEngContactListView aView ) const

    {

    switch ( aView )

        {

        case EPEngCntListLocalView:

            {

            return *( iLocalView[ aIndex ] );

            }

        case EPEngCntListNetworkView:

            {

            return *( iNetworkView[ aIndex ] );

            }

        default:

            {

            Panic( EWrongViewId );

            return *( iNetworkView[ aIndex ] );

            }

        }

    }

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

// CPEngContactListModBase::RemovedContacts()

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

//

const MDesCArray& CPEngContactListModBase::RemovedContacts( ) const

    {

    return iChangesMonitor->RemovedContactIds();

    }

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

// CPEngContactListModBase::AddedContacts()

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

//

const MDesCArray& CPEngContactListModBase::AddedContacts( ) const

    {

    return iChangesMonitor->AddedContactIds();

    }

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

// CPEngContactListModBase::ListProperties()

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

//

MPEngContactListProperties& CPEngContactListModBase::ListProperties()

    {

    return *iSettings;

    }

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

// CPEngContactListModBase::RemoveAllContactIdsL()

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

//

void CPEngContactListModBase::RemoveAllContactsL()

    {

    // reset local view and leave only network view

    ResetLocalView();

    StoreContactListL();

    }

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

// CPEngContactListModBase::SuspendUpdateNotification()

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

//

void CPEngContactListModBase::SuspendUpdateNotification()

    {

    BufferServerSideNotifications();

    }

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

// CPEngContactListModBase::ReleaseUpdateNotification()

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

//

void CPEngContactListModBase::ReleaseUpdateNotification()

    {

    ReleaseServerSideBuffering();

    }

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

// CPEngContactListModBase::RollBackAllChangesL()

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

//

TInt CPEngContactListModBase::RollBackAllChangesL()

    {

    LeaveIfListUpdateInProgressL();

    RollbackL();

    return KErrNone;

    }

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

// CPEngContactListModBase::UpdateInProgress()

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

//

TBool CPEngContactListModBase::UpdateInProgress() const

    {

    return iStorageManager->Locked( *this, EStorageLockLevelHigh );

    }

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

// CPEngContactListModBase::UpdateInProgress()

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

//

TBool CPEngContactListModBase::UpdateRequired() const

    {

    TInt countLoc( iLocalView.Count() );

    TInt countNet( iNetworkView.Count() );

    if ( countLoc != countNet )

        {

        return ETrue;

        }

    for ( TInt x( 0 ) ; x < countLoc ; ++x )

        {

        if ( ( KErrNotFound == iNetworkView.Find( iLocalView[ x ] ) )

             ||

             ( iLocalView[ x ]->NewNick() )

           )

            {

            return ETrue;

            }

        }

    for ( TInt i( 0 ) ; i < countNet ; ++i )

        {

        if  ( KErrNotFound == iLocalView.Find( iNetworkView[ i ] ) )

            {

            return ETrue;

            }

        }

    return EFalse;

    }

// =============================================================================

// ===============Functions of CPEngStoreEntry class ===========================

// =============================================================================

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

// CPEngContactListModBase::ExternalizeL()

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

//

void CPEngContactListModBase::ExternalizeL( RWriteStream& aStream,

                                            TPEngStorageType aStorageType ) const

    {

    // what is the type of the list, if it is not mixed store all at once

    if ( EPEngMixedCachedVersionCon == StorageType() )

        {

        // whole list is cached, store it all

        ExternalizeContactsL( aStream, EPEngStorageBasicPermanent );

        ExternalizeContactsL( aStream, EPEngStorageBasicCached );

        iChangesMonitor->ExternalizeArrayL( aStream );

        return;

        }

    // write asked part

    switch ( aStorageType )

        {