/*

* 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:    Implementation of CEqualizerPresetsDialog class

*

*/

// INCLUDE FILES   

#include <StringLoader.h>

#include <akntitle.h>  

#include <eikenv.h>

#include <bldvariant.hrh>

#include <aknnotewrappers.h>

#include <bautils.h>

#include <aknenv.h> 

#include <aknlists.h>

#include <data_caging_path_literals.hrh>

#include <eikclbd.h>

#include <AknIconArray.h> 

#include <avkon.hrh>

//LAF and Skin changes

#include <AknsUtils.h>

#include <e32base.h>

#include <AknsConstants.h>

#include <aknlayout.cdl.h>

#include <featmgr.h>

#include <hlplch.h>

#include <AudioEqualizerUtility.h>

#include <sysutil.h>

#include <AknGlobalNote.h>

#include <aknclearer.h>

#include <layoutmetadata.cdl.h>

#include <csxhelp/eq.hlp.hrh>

#include <Equalizer.rsg>  // Contains the resource definition

#include <equalizer.mbg>

#include "EqualizerPrivateConstants.h"

#include "EqualizerPresetsDialog.h" 

#include "EqualizerPresetListArray.h" 

#include "EqualizerEditingDialog.h" 

#include "Equalizer.hrh"

// CONSTANTS

//Used during building a new preset name   

_LIT( KEqrFormat, "%d)" );

_LIT( KEqrZero, "0" );

_LIT( KEqrParenthesis, "(" );  

// Used for checking if the new preset name contains illegal characters

_LIT(KEqrLessThan, "<");

_LIT(KEqrGreaterThan, ">");

_LIT(KEqrQuote, "\"");

_LIT(KEqrBackSlash, "\\");

_LIT(KEqrForwardSlash, "/");

_LIT(KEqrOrSymbol, "|");

_LIT(KEqrColon, ":");

_LIT(KEqrAsterisk, "*");

_LIT(KEqrQuestionMark, "?");

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

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

// CEqualizerPresetsDialog* CEqualizerPresetsDialog::NewL()

// Create instance of concrete ECOM interface implementation

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

// 

EXPORT_C CEqualizerPresetsDialog* CEqualizerPresetsDialog::NewL(

       CAudioEqualizerUtility* aAudEqUtility,

       TInt aCurrentActivePreset, 

       MEqualizerPresetActivationObserver& aEqrPresetActObserver)

    {

    CEqualizerPresetsDialog* self = new (ELeave) CEqualizerPresetsDialog(

        aAudEqUtility, aEqrPresetActObserver);

    CleanupStack::PushL(self); 

    self->ConstructL(aCurrentActivePreset);

    CleanupStack::Pop(self); 

    return self;

    }

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

// CEqualizerPresetsDialog::CEqualizerPresetsDialog(

//       CAudioEqualizerUtility*& aAudEqUtility,

//       MEqualizerPresetActivationObserver& aEqrPresetActObserver)

// First Phase Construction

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

// 

CEqualizerPresetsDialog::CEqualizerPresetsDialog(

       CAudioEqualizerUtility* aAudEqUtility,

       MEqualizerPresetActivationObserver& aEqrPresetActObserver):

       iAudEqUtility(aAudEqUtility),

       iEqrPresetActObserver(aEqrPresetActObserver)

    {

    }

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

// CEqualizerPresetsDialog::ConstructL()

// Second Phase Constructor

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

// 

void CEqualizerPresetsDialog::ConstructL(const TInt aCurrentActivePreset)

    {

    //Initially set these variable to EFalse

    iContextSensitiveMenu = EFalse;

    iIgnoreKeyEvents = EFalse;

    iRepository = CRepository::NewL(KCRUidMusicPlayerSettings);

    //Add the resource file

    // Find which drive this DLL is installed.

    TFileName fileName;

    // Get the full resource file

    TParse fp;

    // Add the resource dir

    fp.Set( KEqualizerResourceFileName, &KDC_APP_RESOURCE_DIR, NULL);

    // Get the filename with full path

    fileName = fp.FullName(); 

    //for localisation of resource file

    BaflUtils::NearestLanguageFile( iEikonEnv->FsSession(), fileName ); 

    iResourceFileOffset = iEikonEnv->AddResourceFileL( fileName );

    //Read text for preset "None" from rss file

    iPresetNoneText = StringLoader::LoadL(R_QTN_EQUALIZER_PRESET_NONE);

    iTitleText = StringLoader::LoadL(R_QTN_EQUALIZER_TITLE_TEXT);

    iItemArray = CEqualizerPresetListArray::NewL(iAudEqUtility, 

                                     aCurrentActivePreset);

    iItemArray->GetCurrentActivePreset(iActivePreset);

    CAknDialog::ConstructL(R_EQUALIZER_CONTAINER_MENUBAR);

    }

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

// CEqualizerPresetsDialog::~CEqualizerPresetsDialog()

// Destructor

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

//  

CEqualizerPresetsDialog::~CEqualizerPresetsDialog()

    {

    if (iResourceFileOffset)

        {

        iEikonEnv->DeleteResourceFile(iResourceFileOffset); 

        }

    delete iRepository;

    if (iAppTitleText)

        {

        // restore musicplayer's title

        CEikStatusPane* sp=iEikonEnv->AppUiFactory()->StatusPane();

        CAknTitlePane* tp=(CAknTitlePane*)sp->ControlL(TUid::Uid(EEikStatusPaneUidTitle));   

        tp->SetTextL(*iAppTitleText);        

	    delete iAppTitleText;

        }

    delete iPresetNoneText;

    delete iTitleText;

    delete iItemArray;

    }

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

// void CEqualizerPresetsDialog::BuildPresetNameL( TDes& aName) const

// Returns free folder name

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

//

void CEqualizerPresetsDialog::BuildPresetNameL( TDes& aName) const

    {

    //set name in the query box to "Preset"

    HBufC* defaultText = StringLoader::LoadLC(

        R_QTN_EQ_PRESET_DEFAULT_NAME);    

    TInt n(0);

    // Numbers start from 1

    TBool found( EFalse );

    TBuf<KMaxPresetNameLength> number;

    // The loop is iterated until a free folder name is found.

    FOREVER

        {

        found = EFalse;

        // Constructs a candidate for the name

        TBuf<KMaxPresetNameLength> newName;

        newName.Copy( *defaultText );

        if( n > 0 )

            // First new is without number ( New folder, New folder(01), New folder(02), ...)

            {

            // Creates the current number.

            number.Format( KEqrFormat, n );

            AknTextUtils::LanguageSpecificNumberConversion ( number );

            TInt leadingZeroLength( 0 );

            if( n < 10 )

                {

                leadingZeroLength = KEqrZero().Length();

                }

            // checks the total length of the costructed string

            if( ( number.Length() + newName.Length() + KEqrParenthesis().Length()

                  + leadingZeroLength ) > KMaxPresetNameLength )

                {

                User::Leave( KErrOverflow );

                }

            // Appends the first parenthesis

            newName.Append( KEqrParenthesis );

            if( n < 10 )

                {

                // Appends the leading zero ( always two digits 08, 09, 10, 11,...)

                 TBuf< 16 > zero(KEqrZero);

        		AknTextUtils::DisplayTextLanguageSpecificNumberConversion( zero );

                newName.Append( KEqrZero );

                }

            newName.Append( number );

            }

        found = SearchPresetL(newName);

        if( found == KErrNotFound )

            {

            aName = newName;

            CleanupStack::PopAndDestroy( defaultText); 

            return;

            }

        n++;

        }   

    }

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

// CEqualizerPresetsDialog::GetNewName(TInt aResourceId, TDes& presetName)

//

// This function is called to display the dialog box to get a new name

// during "Raname" or "Create new"

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

// 

TBool CEqualizerPresetsDialog::GetNewNameL(const TInt aResourceId, TDes& 

aPresetName) const

    {

    CAknTextQueryDialog* dlg;

    TBool ret = EFalse;

    while (1)

        {

        dlg = CAknTextQueryDialog::NewL(aPresetName); 

        if (dlg->ExecuteLD(aResourceId))

            {

            // Illegal characters in a preset name are < > \" \\ / | : * ?"

            if ( (aPresetName.FindC( KEqrLessThan ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrGreaterThan ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrQuote ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrBackSlash ) != KErrNotFound ) ||                 

                 (aPresetName.FindC( KEqrForwardSlash ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrOrSymbol ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrColon ) != KErrNotFound ) ||                 

                 (aPresetName.FindC( KEqrAsterisk ) != KErrNotFound ) ||

                 (aPresetName.FindC( KEqrQuestionMark ) != KErrNotFound )             

               )

                {

                HBufC* text = StringLoader::LoadLC(

                    R_QTN_FLDR_ILLEGAL_CHARACTERS);

                CAknInformationNote* note = new( ELeave ) CAknInformationNote(ETrue);

                note->ExecuteLD( *text );

                CleanupStack::PopAndDestroy(text);

                continue;

                }

            TInt error = SearchPresetL(aPresetName);    

            if (error != KErrNotFound)

                {

                // display error

                HBufC* label = StringLoader::LoadLC(

                    R_QTN_FLDR_NAME_ALREADY_USED, aPresetName );

                CAknInformationNote* note = new( ELeave )

                                         CAknInformationNote( ETrue );

                note->ExecuteLD( *label );

                CleanupStack::PopAndDestroy(label);

                continue;

                }

            // New name entered

            ret = ETrue;

            }

        // Break, in case user Cancels the data query or 

        // enters a valid name 

        break;

        }    

    return ret;

    }

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

// TPresetName CEqualizerPresetsDialog::GetHighlightedPresetInListBox() const

// This function returns the highlighted Preset in ListBox

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

//  

TPresetName CEqualizerPresetsDialog::GetHighlightedPresetInListBox() const

    {

    TInt selectedIndex = iListBox->CurrentItemIndex();

    CTextListBoxModel* model = iListBox->Model();

    TPresetName selectedItem(model->ItemText(selectedIndex));

    TPresetName highlightedPreset = 

             selectedItem.Right(selectedItem.Length()- iItemArray->GetPrefixLength());

    return highlightedPreset;  

    }

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

//void CEqualizerPresetsDialog::ActivateEqrPresetL(const TInt  aIndex, 

//const TDesC& aPreset)  const

//

//This function is used for the activation of a preset

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

//

void CEqualizerPresetsDialog::ActivateEqrPresetL(const TInt aIndex, 

const TDesC& aPreset) 

    {

    TInt err;

    // Store activated preset in central repository    

    SetCurrentPreset(aPreset);

    // Set the active preset in the equalizer item array

    iItemArray->SetCurrentActivePreset(aPreset);

    R_QTN_EQ_NOTE_INFO_PRESET_ACTIVATED, aPreset);

    CAknConfirmationNote* dialog = new(ELeave)CAknConfirmationNote();

    dialog->ExecuteLD(*activateNoteText);

    // Inform the engine

    if (aPreset.Compare(*iPresetNoneText) == 0)            

        {

        TRAP(err, iAudEqUtility->DisableEqualizerL());                

        }

    else

        {

        TRAP(err, iAudEqUtility->ApplyPresetL(GetEngineIndexL(aPreset)));

        }  

   if(!err)

	   {

	   iListBox->HandleItemAdditionL();

	   iListBox->SetCurrentItemIndexAndDraw(aIndex);

	   // To prevent two tickmarks from appearing sometimes

	   iListBox->DrawNow(); 

	   }

   }

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

//void CEqualizerPresetsDialog::RenameEqrPresetL(const TInt  aIndex, 

//const TDesC& aPreset)  const

//

//This function is used for the renaming of a preset

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

//

void CEqualizerPresetsDialog::RenameEqrPresetL(const TInt /*aIndex*/, 

const TDesC& aPreset) 

    {

    //Check if this is an active preset

    TPresetName activePresetName = CurrentPreset();

    if (aPreset.Compare(activePresetName) == 0)            

       {

        //Display Confirmation note                 

        HBufC* renameText = StringLoader::LoadLC(

        R_QTN_EQ_NOTE_ERR_PRESET_IN_USE_NO_RENAME);               

        CAknErrorNote* dialog = new(ELeave)CAknErrorNote();         

        dialog->ExecuteLD(*renameText);

        CleanupStack::PopAndDestroy(renameText);

        } 

    else

        {

        TPresetName presetName;

        presetName =  aPreset;

        TBool nameEnteredIsFine = 

        GetNewNameL(R_DIALOG_TEXT_RENAME_ITEM_NAME, presetName); 

        if (nameEnteredIsFine)

            {

            TInt engineIndex = GetEngineIndexL(aPreset);

            //Update Engine

            iAudEqUtility->GetPresetL(engineIndex);

            CAudioEqualizer& audioEqualizer = iAudEqUtility->Equalizer();

            iAudEqUtility->ModifyPresetL(engineIndex,presetName,

             audioEqualizer);

            //Update listbox

            // Sort the array of user-defined presets

            iItemArray->UpdateSortedArrayL(); 

            iListBox->SetCurrentItemIndex(SearchPresetL(presetName));

            iListBox->DrawNow();

            }

        }

   }

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

// void CEqualizerPresetsDialog::EditEqrPresetL(const TInt  aIndex, 

// const TDesC& aPreset)  const

//

// This function is used for the editing of a preset

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

//

void CEqualizerPresetsDialog::EditEqrPresetL(const TInt  /*aIndex*/, 

const TDesC& aPreset) 

    {

    //Set application name in the title pane to preset name.

    CEikStatusPane* sp=iEikonEnv->AppUiFactory()->StatusPane();

    CAknTitlePane* tp=(CAknTitlePane*)sp->ControlL(TUid::Uid(

    EEikStatusPaneUidTitle));

    tp->SetTextL(aPreset);

    TInt engineIndex = GetEngineIndexL(aPreset);

    //Update Engine

    TBool isActivePreset = (aPreset==CurrentPreset());

    DisplaySettingsL(iAudEqUtility, engineIndex, isActivePreset);

    }

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

// void CEqualizerPresetsDialog::CreateNewEqrPresetL(TInt&  aIndex, 

// TPresetName& aPreset) const

//

// This function is used for the creation of a new preset.

// @param aIndex The index of the preset in the ListBox. This is set

// to a the index in the ListBox if preset creation is successful. 

// If the creation is unscuccessful, then the parameter is not changed.

// @param aPreset The name of the preset created

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

//

void CEqualizerPresetsDialog::CreateNewEqrPresetL(TInt&  aIndex, 

TPresetName& aPreset) const

    {

    RFs fs; 

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

    CleanupClosePushL<RFs>( fs );

    if (SysUtil::FFSSpaceBelowCriticalLevelL(&fs,0))

        {

        ShowDiskFullNoteL(); // Phone memory full, show note

        }

    else

        {

        TPresetName presetName;

        BuildPresetNameL(presetName);

        TBool nameEnteredIsFine = GetNewNameL(R_DIALOG_TEXT_NEW_ITEM_NAME,

         presetName);

        if (nameEnteredIsFine)

            {

            //Update Engine

            CAudioEqualizer& audioEqualizer = iAudEqUtility->Equalizer();

            iAudEqUtility->CreatePresetL(presetName, audioEqualizer);

            //Set the level of all bands to 0.

            TInt numFreqBand = audioEqualizer.NumberOfBands();

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

                {

                audioEqualizer.SetBandLevelL(i+1, 0);

                }

            iItemArray->UpdateSortedArrayL();            

            //Update AudioEqualizerUtility object, setting the level of all

            // bands to 0 

            iAudEqUtility->ModifyPresetL(GetEngineIndexL(presetName),

                                 presetName, audioEqualizer);

            //Set the focus to the new preset 

            iListBox->HandleItemAdditionL();

            iListBox->SetCurrentItemIndex(SearchPresetL(presetName));                 

            iListBox->DrawNow();

            aPreset = presetName;

            aIndex = iItemArray->MdcaCount()-1;  

	          }

        }

        CleanupStack::PopAndDestroy();

    }

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

//void CEqualizerPresetsDialog::DeleteEqrPresetL(const TInt  aIndex, 

//const TDesC& aPreset)  const

//

//This function is used for the deletion of a preset

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

//

void CEqualizerPresetsDialog::DeleteEqrPresetL(const TInt aIndex,

const TDesC& aPreset)

    {

    //Check if this is an active preset

    TPresetName activePresetName = CurrentPreset();

    if (aPreset.Compare(activePresetName) == 0)     

        {

        //Display error note                   

        HBufC* renameText =

         StringLoader::LoadLC(R_QTN_EQ_NOTE_ERR_PRESET_IN_USE);

        CAknErrorNote* dialog = new(ELeave)CAknErrorNote();

        dialog->ExecuteLD(*renameText);

        CleanupStack::PopAndDestroy(renameText);

        } 

    else

        {

        //Delete?\n%U" §qtn.query.common.conf.delete?

        HBufC* text = 

        StringLoader::LoadLC( R_QTN_QUERY_COMMON_CONF_DELETE, 

        aPreset);

        // Show confirmation note

        CAknQueryDialog* dlg = CAknQueryDialog::NewL();

        TInt result( 

        dlg->ExecuteLD( R_EQUALIZER_CONFIRMATION_QUERY, *text ) );

        CleanupStack::PopAndDestroy(text); // text

        if ( result )

            {