/*

* Copyright (c) 2008-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:  Implementation of the class which takes care of placing the correct texts in the header

*

*/

#include "ccappcommlauncherheaders.h"

#include "cmscontact.h"

#include <Pbk2PresentationUtils.h>

#include <RPbk2LocalizedResourceFile.h>

#include <Pbk2DataCaging.hrh>

const TInt KContactTypeNotSet = -1;

namespace {

/// These enumerations must have same values as in the specification

/// and in the qtn_phob_name_order. These are different compared to

/// TPbk2NameOrderInCenRep because TPbk2NameOrderInCenRep values

/// must be same as in old PbkEng TPbkNameOrder to keep data compatibility

/// of the CenRep.

enum TPbk2NameOrderInUiSpecification

    {

    EPbk2UiSpecFirstNameLastName,

    EPbk2UiSpecLastNameFirstName

    };

#ifdef _DEBUG

enum TPanicCode

    {

    EPanicInvalidNameConfiguration

    };

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbk2SortOrderManagerImpl");

    User::Panic(KPanicText,aReason);

    }

#endif // _DEBUG

/**

 * Gets a digit from a descriptor.

 *

 * @param aReaderToBuf  Resource reader pointed to a descriptor resource.

 * @return  The digit.

 */

TInt GetDigitFromDescriptorL( TResourceReader& aReaderToBuf )

    {

    HBufC* orderBuf = aReaderToBuf.ReadHBufCL();

    CleanupStack::PushL( orderBuf );

    // The setting should be 1 digit

    __ASSERT_DEBUG( orderBuf->Length() == 1,

        Panic( EPanicInvalidNameConfiguration ) );

    TInt result = KErrNotFound;

    TPtrC ptr( orderBuf->Des() );

    if ( ptr.Length() > 0 && TChar(ptr[0]).IsDigit() )

        {

        result = TChar(ptr[0]).GetNumericValue();

        }

    CleanupStack::PopAndDestroy( orderBuf );

    return result;

    }

} // namespace

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

// NewL, two-phase construction

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

//

CCCAppCommLauncherHeaderTextOrder* CCCAppCommLauncherHeaderTextOrder::NewL()

    {

    CCCAppCommLauncherHeaderTextOrder* self= new (ELeave) CCCAppCommLauncherHeaderTextOrder();

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    return self;

    }

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

// C++ (first phase) constructor

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

//

CCCAppCommLauncherHeaderTextOrder::CCCAppCommLauncherHeaderTextOrder()

    {

    for (TInt i=0; i < KCCAppCommLauncherHeaderTextOrderLastField - KCCAppCommLauncherHeaderTextOrderFirstField + 1; i++)

        {

        iGroupPriorities[i] = NULL;

        iIndividualPriorities[i] = NULL;

        }

    // Group 8

    SetPriority(CCmsContactFieldItem::ECmsImpp, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsUrlGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsUrlHome, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsUrlWork, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsSipAddress, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsEmailGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsEmailHome, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsEmailWork, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneHome, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneWork, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneHome, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneWork, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberHome, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberWork, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsAssistantNumber, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsCarPhone, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsPagerNumber, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsPushToTalk, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsShareView, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsVoipNumberGeneric, ETrue, 1);

    SetPriority(CCmsContactFieldItem::ECmsImpp, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsUrlWork, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsUrlHome, EFalse, 3);

    SetPriority(CCmsContactFieldItem::ECmsUrlGeneric, EFalse, 4);

    SetPriority(CCmsContactFieldItem::ECmsSipAddress, EFalse, 5);

    SetPriority(CCmsContactFieldItem::ECmsShareView, EFalse, 6);

    SetPriority(CCmsContactFieldItem::ECmsPushToTalk, EFalse, 7);

    SetPriority(CCmsContactFieldItem::ECmsEmailWork, EFalse, 8);

    SetPriority(CCmsContactFieldItem::ECmsEmailHome, EFalse, 9);

    SetPriority(CCmsContactFieldItem::ECmsEmailGeneric, EFalse, 10);

    SetPriority(CCmsContactFieldItem::ECmsAssistantNumber, EFalse, 11);

    SetPriority(CCmsContactFieldItem::ECmsPagerNumber, EFalse, 12);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberWork, EFalse, 13);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberHome, EFalse, 14);

    SetPriority(CCmsContactFieldItem::ECmsVideoNumberGeneric, EFalse, 15);

    SetPriority(CCmsContactFieldItem::ECmsCarPhone, EFalse, 16);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneWork, EFalse, 17);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneHome, EFalse, 18);

    SetPriority(CCmsContactFieldItem::ECmsLandPhoneGeneric, EFalse, 19);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneWork, EFalse, 20);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneHome, EFalse, 21);

    SetPriority(CCmsContactFieldItem::ECmsMobilePhoneGeneric, EFalse, 22);

    // Group 7

    SetPriority(CCmsContactFieldItem::ECmsLastName, ETrue, 2);

    SetPriority(CCmsContactFieldItem::ECmsMiddleName, ETrue, 2);

    SetPriority(CCmsContactFieldItem::ECmsFirstName, ETrue, 2);

    SetPriority(CCmsContactFieldItem::ECmsLastName, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsMiddleName, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsFirstName, EFalse, 3);

    // Group 6

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryGeneric, ETrue, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionGeneric, ETrue, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalGeneric, ETrue, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetGeneric, ETrue, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryGeneric, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionGeneric, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalGeneric, EFalse, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetGeneric, EFalse, 4);

    // Group 5

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryWork, ETrue, 4);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionWork, ETrue, 4);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalWork, ETrue, 4);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetWork, ETrue, 4);

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryWork, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionWork, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalWork, EFalse, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetWork, EFalse, 4);

    // Group 4

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryHome, ETrue, 5);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionHome, ETrue, 5);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalHome, ETrue, 5);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetHome, ETrue, 5);

    SetPriority(CCmsContactFieldItem::ECmsAddrCountryHome, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsAddrRegionHome, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsAddrLocalHome, EFalse, 3);

    SetPriority(CCmsContactFieldItem::ECmsAddrStreetHome, EFalse, 4);

    // Group 3 (prio 6)

    SetPriority(CCmsContactFieldItem::ECmsDepartment, ETrue, 6);

    SetPriority(CCmsContactFieldItem::ECmsCompanyName, ETrue, 6);

    SetPriority(CCmsContactFieldItem::ECmsJobTitle, ETrue, 6);

    SetPriority(CCmsContactFieldItem::ECmsNickname, ETrue, 6);

    SetPriority(CCmsContactFieldItem::ECmsDepartment, EFalse, 1);

    SetPriority(CCmsContactFieldItem::ECmsCompanyName, EFalse, 2);

    SetPriority(CCmsContactFieldItem::ECmsJobTitle, EFalse, 3);

    SetPriority(CCmsContactFieldItem::ECmsNickname, EFalse, 4);

    // Group 1 (prio 7)

    SetPriority(CCmsContactFieldItem::ECmsNote, ETrue, 7);

    SetPriority(CCmsContactFieldItem::ECmsNote, EFalse, 1);

    }

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

// Helper function for reading a descriptor from repository

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

//

HBufC* GetStringFromRepoLC(CRepository* aRepository, TUint32 aKey)

    {

    HBufC* prioStr = HBufC::NewLC(NCentralRepositoryConstants::KMaxUnicodeStringLength);

    TInt trueLength = 0;

    TPtr ptr = prioStr->Des();

    TInt error = aRepository->Get(aKey, ptr, trueLength);

    if (error == KErrOverflow)

        {

        CleanupStack::PopAndDestroy(prioStr);

        prioStr =  HBufC::NewLC(trueLength);

        User::LeaveIfError(aRepository->Get(aKey, ptr));

        }

    else if (error != KErrNone)

        {

#ifdef _DEBUG 

        CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::getStringFromRepoLC - Header text priority variation error (repository field)"));   

        CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::getStringFromRepoLC - err: %d"), error );

        CEikonEnv::Static()->InfoMsg(_L("Header text priority variation error. See logs."));

#endif//_DEBUG

        CleanupStack::PopAndDestroy(prioStr);

        return 0;

        }

    return prioStr;

    }

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

// ConstructL, second phase constructor

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

//

void CCCAppCommLauncherHeaderTextOrder::ConstructL()

    {

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

        {

        iHeaderRows.AppendL(0);

        iHeaderRowsClipped.AppendL(0);

        iHeaderTypes[i] = KContactTypeNotSet;

        }

    CRepository* prioOrderRepo = CRepository::NewLC(KCRUidCCACommLauncher);

    HBufC* prioStr = 0;

    HBufC* prioStr1 = GetStringFromRepoLC(prioOrderRepo, KHeaderGroupPriorities);

    User::LeaveIfNull(prioStr1);

    HBufC* prioStr2 = GetStringFromRepoLC(prioOrderRepo, KHeaderGroupPriorities2);

    if (prioStr2)

        {

        prioStr = HBufC::NewL(prioStr1->Length() + prioStr2->Length());

        prioStr->Des().Append(*prioStr1);

        prioStr->Des().Append(*prioStr2);

        CleanupStack::PopAndDestroy(prioStr2);

        CleanupStack::PopAndDestroy(prioStr1);

        CleanupStack::PushL(prioStr);

        }

    else

        {

        prioStr = prioStr1;

        }

    TLex groupPrioLex(*prioStr);

    while (groupPrioLex.Offset() < prioStr->Length() - 1)

        {

        TPtrC nameToken = groupPrioLex.NextToken();

        CCmsContactFieldItem::TCmsContactField type;

        if (MapStringToContactField(nameToken, type) == KErrNone)

            {

            TPtrC numToken = groupPrioLex.NextToken();

            TPtrC numToken2 = groupPrioLex.NextToken();

            TLex groupPrioNumLex(numToken);

            TLex individualPrioNumLex(numToken2);

            TInt priority = 0;

            if (groupPrioNumLex.Val(priority) == KErrNone)

                {

                SetPriority(type, ETrue, priority);

                }

#ifdef _DEBUG_

            else

                {

                CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::ConstructL - Priority value is not a number: %S"), &numToken );

                CEikonEnv::Static()->InfoMsg(_L("Header text priority variation error. See logs."));

                }

#endif //_DEBUG_

            if (individualPrioNumLex.Val(priority) == KErrNone)

                {

                SetPriority(type, EFalse, priority);

                }

#ifdef _DEBUG_

            else

                {

                CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::ConstructL - Priority value is not a number: %S"), &numToken );

                CEikonEnv::Static()->InfoMsg(_L("Header text priority variation error. See logs."));

                }

#endif //_DEBUG_

            }

#ifdef _DEBUG 

        else

            {

            CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::ConstructL - Header text priority variation, field name not recognized)"));   

            CCA_DP(KCommLauncherLogFile, CCA_L("CCCAppCommLauncherHeaderTextOrder::ConstructL - field name: %S"), &nameToken );

            }

#endif //_DEBUG

        }

    CleanupStack::PopAndDestroy(prioStr);

    CleanupStack::PopAndDestroy(prioOrderRepo);

    // Open resource file for reading language specific default values

    RPbk2LocalizedResourceFile resFile;

    resFile.OpenLC( KPbk2RomFileDrive,

        KDC_RESOURCE_FILES_DIR, 

        Pbk2PresentationUtils::PresentationResourceFile() );

    // Read the name order value from the resource file

    TResourceReader reader;

    reader.SetBuffer( resFile.AllocReadLC( R_QTN_PHOB_NAME_ORDER ) );

    TInt orderInResFile = GetDigitFromDescriptorL( reader );

    CleanupStack::PopAndDestroy(); // reader

    CleanupStack::PopAndDestroy(); // resFile

    // Converting from TPbk2NameOrderInUiSpecification to TPbk2NameOrderInCenRep

    TInt orderInCenRep = EPbk2CenRepNameOrderUndefined;

    CRepository* sortOrderSettings = CRepository::NewLC(TUid::Uid(KCRUidPhonebook));

    sortOrderSettings->Get(KPhonebookNameOrdering, orderInCenRep);

    switch ( orderInResFile )

        {

        case EPbk2UiSpecLastNameFirstName:

            {

            orderInCenRep = EPbk2CenRepLastNameFirstName;

            break;

            }

        case EPbk2UiSpecFirstNameLastName: // FALL THROUGH

        // If the name order is not defined in the UI Specification,

        // and...

        default:

            {

            // ... also not defined in the CenRep,

            // then use the "First Name" "Last Name" order

            // for most number of languages.

            if ( EPbk2CenRepNameOrderUndefined == orderInCenRep )

                {

                orderInCenRep = EPbk2CenRepFirstNameLastName;

                }

            break;

            }

        } // end switch

    if (orderInCenRep == EPbk2CenRepLastNameFirstName)

        {

        SetPriority(CCmsContactFieldItem::ECmsMiddleName, EFalse, 1);

        SetPriority(CCmsContactFieldItem::ECmsFirstName, EFalse, 2);

        SetPriority(CCmsContactFieldItem::ECmsLastName, EFalse, 3);

        }

    else

        {

        SetPriority(CCmsContactFieldItem::ECmsFirstName, EFalse, 3);

        SetPriority(CCmsContactFieldItem::ECmsMiddleName, EFalse, 2);

        SetPriority(CCmsContactFieldItem::ECmsLastName, EFalse, 1);

        }

    CleanupStack::PopAndDestroy(sortOrderSettings);

    }

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

// Destructor

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

//

CCCAppCommLauncherHeaderTextOrder::~CCCAppCommLauncherHeaderTextOrder()

    {

    iHeaderRows.ResetAndDestroy();

    iHeaderRowsClipped.ResetAndDestroy();

    delete iCurrentDbName;

    }

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

// CCCAppCommLauncherHeaderTextOrder::SetPriority

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

//

void CCCAppCommLauncherHeaderTextOrder::SetPriority(CCmsContactFieldItem::TCmsContactField aContactField, TBool aGroup, TInt aPriority)

    {

    if (aGroup)

        {

        iGroupPriorities[aContactField -  KCCAppCommLauncherHeaderTextOrderFirstField] = aPriority;

        }

    else

        {

        iIndividualPriorities[aContactField -  KCCAppCommLauncherHeaderTextOrderFirstField] = aPriority;

        }

    }

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

// CCCAppCommLauncherHeaderTextOrder::GetPriority

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

//

TInt CCCAppCommLauncherHeaderTextOrder::GetPriority(CCmsContactFieldItem::TCmsContactField aContactField, TBool aGroup)

    {

    if (aGroup)

        {

        return iGroupPriorities[aContactField -  KCCAppCommLauncherHeaderTextOrderFirstField];

        }

    else

        {

        return iIndividualPriorities[aContactField -  KCCAppCommLauncherHeaderTextOrderFirstField];

        }

    }

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

// CCCAppCommLauncherHeaderTextOrder::GetTextForRow

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

//

const TDesC& CCCAppCommLauncherHeaderTextOrder::GetTextForRow(TInt aRow)

    {

    if (aRow >= 0 && aRow < iHeaderRowsClipped.Count() && aRow < iHeaderRows.Count())

        {

        if (iHeaderRowsClipped[aRow])

            {

            TPtr ptr(iHeaderRowsClipped[aRow]->Des());

            // Replace characters that can not be displayed correctly.

            Pbk2PresentationUtils::ReplaceNonGraphicCharacters(ptr, ' ');

            return *iHeaderRowsClipped[aRow];

            }

        else if (iHeaderRows[aRow])

            {

            TPtr ptr(iHeaderRows[aRow]->Des());

            Pbk2PresentationUtils::ReplaceNonGraphicCharacters(ptr, ' ');

            return *iHeaderRows[aRow];

            }

        }

    return KNullDesC();

    }

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

// CCCAppCommLauncherHeaderTextOrder::SelectContactFieldL

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

//

void CCCAppCommLauncherHeaderTextOrder::SelectContactFieldL(

    const CCmsContactField& aContactField, 

    TInt aTopGroupPriority)

    {

    CCmsContactFieldItem::TCmsContactField type = aContactField.Type();    

    const RPointerArray<CCmsContactFieldItem>& fields = aContactField.Items();    

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

        {

        for (TInt i2 = 0; i2 < KCCAppCommLauncherHeaderTextOrderLineCount; i2++)

            {

            if ( GetPriority(type, ETrue) == aTopGroupPriority &&

                      (iHeaderTypes[i2] < 0 || GetPriority(type, EFalse) > GetPriority((CCmsContactFieldItem::TCmsContactField)iHeaderTypes[i2], EFalse)) )

                {

                if(StrippedLengthL(*fields[i])) //Skip blank fields 

                    {

                    TInt typeMem = KContactTypeNotSet;

                    for (TInt i3 = i2; i3 < KCCAppCommLauncherHeaderTextOrderLineCount; i3++)

                        {

                        TInt typeTemp = iHeaderTypes[i3];

                        iHeaderTypes[i3] = typeMem;

                        typeMem = typeTemp;

                        }

                    iHeaderTypes[i2] = type;  

                    break;                    

                    }

                }

            }            

        }

    }

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

// CCCAppCommLauncherHeaderTextOrder::ProcessContactFieldsL

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

//

void CCCAppCommLauncherHeaderTextOrder::ProcessContactFieldsL(

    RArray<CCmsContactField> aCmsContactFields)

    {

    TInt topGroupPriority = 0;

    delete iCurrentDbName;

    iCurrentDbName = NULL;

    TInt count = aCmsContactFields.Count();

    TInt i;

    //1. Get the topmost group of fields containing displayable sdata

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

        {

        for(TInt j=0; j < aCmsContactFields[i].Items().Count(); j++ )

            {

            CCmsContactFieldItem::TCmsContactField type = aCmsContactFields[i].Type();

            if(StrippedLengthL(aCmsContactFields[i].ItemL(j)))

                {

                if ( GetPriority(type, ETrue) > topGroupPriority )

                    {

                    topGroupPriority = GetPriority(type, ETrue);  

                    }

                }