/*

* Copyright (c) 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:  Provides additional functionality to the Logs UI application

*

*/

// INCLUDE FILES

#include <gulicon.h>

#include <aknnotewrappers.h> 

#include <aknlists.h>

#include "clogsuicontrolextension.h"

#include "clogspresencetablemanager.h"

#include "clogseventinfomanager.h"

#include "clogsextbrandfetcher.h"

#include "clogsextpresentityidfetcher.h"

#include "tlogseventinfo.h"

#include "clogsiconfileprovider.h"

#include "clogsextservicehandler.h"

#include "LogsConstants.hrh"    // for KLogsBuff128

#include "LogsConsts.h"         // for KMaxNbrOfRecentTrailIcons, KTab                        

#include "logsextconsts.h"

#include "tlogsextutil.h"

#include "simpledebug.h"

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

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

// NewL

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

//

CLogsUiControlExtension* CLogsUiControlExtension::NewL()

    {

    _LOG("CLogsUiControlExtension::NewL()" )

    CLogsUiControlExtension* self = CLogsUiControlExtension::NewLC();

    CleanupStack::Pop( self );

    return self;

    }

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

// NewLC

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

//

CLogsUiControlExtension* CLogsUiControlExtension::NewLC()

    {

    _LOG("CLogsUiControlExtension::NewLC()" )

    CLogsUiControlExtension* self = new( ELeave ) CLogsUiControlExtension;

    CleanupStack::PushL( self );

    self->ConstructL();

    return self;

    }

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

// ConstructL

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

//

void CLogsUiControlExtension::ConstructL()

    {

    _LOG("CLogsUiControlExtension::ConstructL() begin" )

    iLogEntryInfoManager = CLogsEventInfoManager::NewL();

    iPresenceTableManager = CLogsPresenceTableManager::NewL();

    _LOG("CLogsUiControlExtension::ConstructL() end" )

    }

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

// Constructor

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

//

CLogsUiControlExtension::CLogsUiControlExtension():    

    iListBox( NULL ),

    iLogsExtObserver( NULL ),

    iBrandFetcherArray( KBrandFetcherArrayGranularity ),    

    iPresentityIdFetcherArray( KPresentityIdFetcherArrayGranularity ),

    iServiceHandlerArray( KPresentityIdFetcherArrayGranularity ),

    iBitmap( NULL ),

    iBitmask( NULL )    

    {

    _LOG("CLogsUiControlExtension::CLogsUiControlExtension()" )

    }

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

// Destructor

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

//

CLogsUiControlExtension::~CLogsUiControlExtension()

    {

    _LOG("CLogsUiControlExtension::~CLogsUiControlExtension() begin" )

    delete iLogEntryInfoManager;        

    delete iPresenceTableManager;

    iBrandFetcherArray.ResetAndDestroy();           

    iPresentityIdFetcherArray.ResetAndDestroy();

    delete iBitmap;

    delete iBitmask;

    _LOG("CLogsUiControlExtension::~CLogsUiControlExtension()..." )

    _LOG("...iServiceHandlerArray.ResetAndDestroy")

    iServiceHandlerArray.ResetAndDestroy();

    _LOG("CLogsUiControlExtension::~CLogsUiControlExtension() end" )

    }

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

// Delete member data.

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

//

void CLogsUiControlExtension::DoRelease()

    {

    _LOG("CLogsUiControlExtension::DoRelease() begin" )    

    delete this;

    _LOG("CLogsUiControlExtension::DoRelease() end" )

    }

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

// functionality not supported by this dll - function does nothing

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

//    

void CLogsUiControlExtension::AppendIconsL( CAknIconArray* /*aArray*/ )

    {

    _LOG("CLogsUiControlExtension::AppendIconsL begin" )

    // Reset brand fetcher array. Brand fetchers and icons are reconstructed

    // again when when HandleAdditionalData() gets called. We cannot load

    // icons here because we don't know yet which icons to load.

    iBrandFetcherArray.ResetAndDestroy();

    iPresenceTableManager->ResetState();

    iServiceHandlerArray.ResetAndDestroy();

    _LOG("CLogsUiControlExtension::AppendIconsL end" )

    }

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

// functionality not supported by this dll - function does nothing

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

//

TBool CLogsUiControlExtension::GetIconIndexL( TContactItemId /*aContactId*/,

                                              TInt& /*aIndex*/ )

    {

    _LOG("CLogsUiControlExtension::GetIconIndexL begin" )

    _LOG("CLogsUiControlExtension::GetIconIndexL end" )

    return EFalse;

    }

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

// Sets the observer of the extension (probably a CLogsRecentListView object)

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

//

void CLogsUiControlExtension::SetObserver( MLogsExtObserver& aObserver )

    {

    _LOG("CLogsUiControlExtension::SetObserver begin" )

    iLogsExtObserver = &aObserver;

    _LOG("CLogsUiControlExtension::SetObserver end" )

    }

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

// Starts the additional data handling.

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

//

void CLogsUiControlExtension::HandleAdditionalData( 

    MLogsModel& aModel, 

    CAknDoubleGraphicStyleListBox& aListBox )

    {

    _LOG("CLogsUiControlExtension::HandleAdditionalDataL begin" )

    iListBox = &aListBox;    

    ResetPresentityIdFetcherArray();    

    TRAP_IGNORE( DoAdditionalDataHandlingL( aModel ) );    

    _LOG("CLogsUiControlExtension::HandleAdditionalDataL end" )        

    }

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

// Creates and starts all the icon fetching processes.

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

//

void CLogsUiControlExtension::DoAdditionalDataHandlingL( MLogsModel& aModel )

    {

    _LOG("CLogsUiControlExtension::DoAdditionalDataHandlingL begin" )

    CreateAndStartBrandFetchersL( aModel );    

    CreateAndStartPresentityIdFetchersL( aModel );           

    _LOG("CLogsUiControlExtension::DoAdditionalDataHandlingL end" )        

    }    

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

// Creates a service handler for a certain service if it not already 

// exists and issues the binding request.

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

//

void CLogsUiControlExtension::CreateAndBindServiceHandlerL( TUint32 aServiceId )

    {

    _LOG("CLogsUiControlExtension::CreateAndBindServiceHandlerL: begin" )

    if ( aServiceId && !ServiceHandlerExists( aServiceId ) )

        {            

        // create and bind the service handler

        _LOG("CLogsUiControlExtension::CreateAndBindServiceHandlerL:..." )

        _LOG("... !ServiceHandlerExists")

        CLogsExtServiceHandler* serviceHandler = 

            CLogsExtServiceHandler::NewLC( aServiceId, *this );                

        _LOG("CLogsUiControlExtension::CreateAndBindServiceHandlerL:..." )

        _LOG("...iServiceHandlerArray.AppendL( serviceHandler )")

        iServiceHandlerArray.AppendL( serviceHandler );

        CleanupStack::Pop( serviceHandler );        

        }

    _LOG("CLogsUiControlExtension::CreateAndBindServiceHandlerL: end" )

    }

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

// Creates and starts all the brand icon fetching processes.

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

//

void CLogsUiControlExtension::CreateAndStartBrandFetchersL( 

        MLogsModel& aModel )

    {

    for ( TInt i = 0 ; i < aModel.Count() ; i++ )

        {        

        // Here we go through the list of events an check whether the events

        // contain a service id or not.Then a brand fetcher is created for 

        // each service id.

        // PC-lint errors: #1013, #1055, #64

        // Explanation: error message occurs because the 'DataField' function

        // is flagged by __VOIP and RD_VOIP_REL_2_2 flags; as long as the 

        // entire logsserviceextension is flagged by __VOIP and 

        // RD_VOIP_REL_2_2 as well this does not cause any problems

        // get the serviceId

        TUint32 serviceId ( aModel.At(i)->LogsEventData()->ServiceId() );

        if ( serviceId && !BrandFetcherExists( serviceId ) )

            {

            // the manager adds a eventInfo object only if it does not

            // contain an eventinfo object with the given service id

            // --> this acts as a duplicate-elimination

            TRAP_IGNORE( iLogEntryInfoManager->AddEventEntryL( serviceId ) );

            // create and start the fetcher

            CLogsExtBrandFetcher* brandFetcher = 

                CLogsExtBrandFetcher::NewLC( serviceId, *this );

            iBrandFetcherArray.AppendL( brandFetcher );

            CleanupStack::Pop( brandFetcher );

            brandFetcher->Fetch();            

            }        

        }    

    }

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

// Creates and starts all the presence icon fetching processes.

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

//

void CLogsUiControlExtension::CreateAndStartPresentityIdFetchersL( 

        MLogsModel& aModel )

    {    

    _LOG("CLogsUiControlExtension::CreateAndStartPresentityIdFetchersL begin " ) 

    // go through all the log events and create the status entries 

    // (iPresenceTableManager takes care for duplication elimination and returns

    //  KErrAlreadyExists if one tries to add an entry that already exists)

    // create one presence fetcher for each status table entry and start them.

    // note: entries to the index table will only be added after the callback 

    // from the presencefw

    // the presence table manager decides which mappings are not needed

    // anymore by comparing the log ids of the current view to the 

    // log ids in the array of mappings; mappings which contain a log id

    // that cannot be found from 'aModel' will be deleted.

    iPresenceTableManager->RemoveUnneededMappings( aModel );

    for ( TInt i = 0 ; i < aModel.Count() ; i++ )

        {

        // PC-lint errors: #1013, #1055

        // Explanation: error message occurs because the 'DataField' function

        // is flagged by __VOIP and RD_VOIP_REL_2_2 flags; as long as the 

        // entire logsserviceextension is flagged by __VOIP and RD_VOIP_REL_2_2

        // as well this does not cause any problems

        TUint32 serviceId( aModel.At(i)->LogsEventData()->ServiceId() );

        TPtrC8 contactLink;

        TBool contactLinkRetrievalSuccess( EFalse );

        if ( KErrNone == aModel.At(i)->

                            LogsEventData()->GetContactLink( contactLink ) )

            {

            contactLinkRetrievalSuccess = ETrue;

            }

        if ( serviceId && contactLinkRetrievalSuccess )

            {

            //create the presentity id fetcher

            DoPresentityIdFetcherCreationL( serviceId, 

                                            contactLink, 

                                            aModel.At(i)->LogId() );

            }

        }        

    _LOG("CLogsUiControlExtension::CreateAndStartPresentityIdFetchersL end " )

    }

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

// Modifies the given icon string.

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

//

void CLogsUiControlExtension::ModifyIconString ( 

        TDes& aDes, 

        const MLogsEventGetter& aLogsEventGetter )

    {

    _LOGP("CLogsUiControlExtension::ModifyIconString begin originalstring=%S",

        &aDes)    

    // only make changes to log entries that contain a service id and

    // dont start looking for fetching results before the fetching

    // process has been started. (Fetching is initiated through 

    // HandleAdditionalDataL function call)

    TInt result( KErrNone );

    TRAP( result, DoIconStringModificationL( aDes, aLogsEventGetter ) );

    _LOGP("CLogsUiControlExtension::ModifyIconString resulting string=%S",

    	&aDes )

    _LOG("CLogsUiControlExtension::ModifyIconString end" )

    }   

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

// Makes the actual modifications to the string.

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

//

void CLogsUiControlExtension::DoIconStringModificationL(  

    TDes& aDes, 

    const MLogsEventGetter& aLogsEventGetter )

    {   

    _LOG("CLogsUiControlExtension::DoIconStringModificationL begin" )

    // use the parser to extract e.g. the service id from the data field of a

    // log event. the information should be tagged like this -> "SI=5", 

    // whereas "SI" is the identifier for a service id and "5" is its value

    // PC-lint errors: #1013

    // Explanation: error message occurs because the 'DataField' function

    // is flagged by __VOIP and RD_VOIP_REL_2_2 flags; as long as the 

    // entire logsserviceextension is flagged by __VOIP and RD_VOIP_REL_2_2

    // as well this does not cause any problems       

    TUint32 serviceId( aLogsEventGetter.LogsEventData()->ServiceId() );

    if ( serviceId <= 0 )

        {

        // without service id we cannont proceed any further...

        User::Leave( KErrNotFound );

        }

    TBool brandIconIndexAvailable( 

        iLogEntryInfoManager->BrandIconIndexAvailable( serviceId ) );

    TBool presenceIconIndexAvailable( EFalse );

    const TDesC* presentityId = 

        presentityId = LookupPresentityId( aLogsEventGetter.LogId() ); 

    //don't leave here: if the presentity id does not exist it means that

    //we cannot check the availability of that presentity from the 

    //presencetablemanager - but we can still try to set the 

    //brandicon index.

    if ( presentityId )

        {        

        _LOG("CLogsUiControlExtension::DoIconStringModificationL ...")

        _LOGP("...presentityId=%S", presentityId )

        if ( iPresenceTableManager )

            {

            _LOG("CLogsUiControlExtension::DoIconStringModificationL..." )

            _LOG("...iPresenceTableManager available")

            presenceIconIndexAvailable = 

                iPresenceTableManager->PresenceIconIndexAvailable( 

                    serviceId, *presentityId );                

            }

        }    

    // only create the HBufC if either brand- or presence index is available

    if ( brandIconIndexAvailable || presenceIconIndexAvailable )

        {

        // e.g. aDes = '0\ttext1\ttext2' whereas '\t' is the delimiter

        //create an empty local buffer of the same size as aDes

        HBufC* temp = HBufC::NewLC( KLogsBuff128 );

        TPtr tempDes( temp->Des() );

        //create the new icon string:

        //if no error occurred while creating the local string data->

        //update aDes with the modified version of the icon string

        //otherwise the original data will not be modified

        if ( brandIconIndexAvailable 

            && AddBrandIconIndex( tempDes, serviceId ) 

            && AddNonIndexData( aDes, tempDes ) )

            {

            aDes.Copy( *temp );

            }

        // make a copy of the original string (that might contain  

        // the modified brandicon index already)

        tempDes.Copy( aDes );            

        if ( presenceIconIndexAvailable 

            && AddPresenceIconIndex( tempDes, serviceId, *presentityId ) )

            {

            aDes.Copy( *temp );

            }

        //cleanup the local string buffer

        CleanupStack::PopAndDestroy( temp );

        temp = NULL;        

        }

    _LOG("CLogsUiControlExtension::DoIconStringModificationL end" )           

    }

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

// Adds the branding icon index.

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

//

TBool CLogsUiControlExtension::AddBrandIconIndex( TDes& aTempDes, 

                                                  const TUint32 aServiceId )

    {

    _LOG("CLogsUiControlExtension::AddBrandIconIndex begin" )   

    TBool result( EFalse );        

    TInt brandIndex( KErrNotFound );

    // Check if the brand icon for the specified service id can be found

    if ( iLogEntryInfoManager->GetBrandIconIndex( aServiceId, brandIndex ) )

        {

        //Add the brand icon index to the temp string

        aTempDes.Num( brandIndex );

        _LOGP("CLogsUiControlExtension::AddBrandIconIndex BrandIndex=%d",

            brandIndex )

        // e.g. aTempDes = '7'

        result = ETrue;

        }        

    _LOG("CLogsUiControlExtension::AddBrandIconIndex end" )  

    return result;

    }

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

// Copies that part of the global icon string to the local copy which contains

// the non-icon index related data.

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

//

TBool CLogsUiControlExtension::AddNonIndexData( 

        const TDesC& aDes, 

        TDes& aTempDes )

    {

    _LOG("CLogsUiControlExtension::AddNonIndexData begin" )  

    TBool result( EFalse );

    // find the first occurrence of the delimiter in the original

    // icon string

    TInt Position( aDes.Find( KTab ) );

    if ( KErrNotFound != Position )

        {

        // position has been found:

        // now copy 

        aTempDes.Append( aDes.Mid( Position ) );

        // e.g. aTempDes = '7\ttext1\ttext2'

        result = ETrue;

        }        

    _LOG("CLogsUiControlExtension::AddNonIndexData end" )  

    return result;    

    }

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

// Appends the trailing delimiters (if they do not already exist) and the 

// presence icon index.

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

//

TBool CLogsUiControlExtension::AddPresenceIconIndex( 

        TDes& aTempDes, 

        const TUint32 aServiceId,

        const TDesC16& aPresentityId )

    {

    _LOGP("CLogsUiControlExtension::AddPresenceIconIndex begin %d" , 

        aServiceId)     

    TBool result( EFalse );

    /// determine the number of trailing delimiters and add missing ones

    //  e.g. Given a) aTempDes = '7\ttext1\ttext2' and 

    //             b) KMaxNbrOfRecentTrailIcons == 2 

    //       --> Add two empty trailing icon indices

    //       Result: aTempDes = '7\ttext1\ttext2\t\t'

    // determine the number of delimiters

    TInt numberDelimiters = DetermineNumberDelimiters( aTempDes );