/*

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

*    Implements the application UI and the methods derived from 

*    MSatUiActionImplementer i.e. showing messages and asking input. 

*

*

*/

// INCLUDE FILES

#include    <barsread.h>

#include    <badesca.h> // for descriptor arrays

#include    <e32std.h>

#include    <eikenv.h>

#include    <eikapp.h>

#include    <StringLoader.h>

#include    <aknview.h>

#include    <aknnotedialog.h>

#include    <aknstaticnotedialog.h>

#include    <AknGlobalNote.h>

#include    <AknQueryDialog.h>

#include    <aknmessagequerydialog.h>

#include    <AudioPreference.h>

#include    <mdaaudiotoneplayer.h>

#include    <activitymanager.h>

#include    <AknIconArray.h>

#include    <AknPopupform.h>                //DisplayText icon popupform

#include    <eikcapc.h>                     //CEikCaptionedControl

#include    <txtrich.h>                     //CRichText

#include    <eikrted.h>                     //CEikRichTextEditor

#include    <hlplch.h>

#include    <aknsoundsystem.h>

#include    <AknWaitDialog.h>

#include    <akntitle.h>

#include    <AknUtils.h>

#include    <AknIconUtils.h>

#include    <aknconsts.h>

#include    <avkon.hrh>

#include    <SatUi.rsg>

#include    <msatuiadapter.h>

#include    <aknkeylock.h>

#include    "satui.hrh"

#include    "CSatUiApplication.h"

#include    "CSatUiViewAppUi.h"

#include    "CSatUiView.h"

#include    "CSatUiTextQueryDialog.h"

#include    "CSatUiMessageQueryIcon.h" 

#include    "CSatUiWaitDialog.h"

#include    "tflogger.h"

#include    <MProfile.h>

#include    <MProfileEngine.h>

#include    <MProfileTones.h>

#include    <TProfileToneSettings.h>

#include    <MProfileName.h>

#include    <MProfileExtraTones.h>

#include    <featmgr.h>                     // Used for FeatureManager

#include    <BTSapDomainPSKeys.h>           // For BT SAP connection state keys.

#include    <e32property.h>                 // Used for RProperty

#include    <aknnotewrappers.h>

#include    <aknlayout.cdl.h> 

#include    <aknlayoutscalable_avkon.cdl.h>

#include    <ctsydomainpskeys.h>

#include    <mda/common/resource.h>

#include    <ProfileEngineSDKCRKeys.h>

#include    <centralrepository.h>

// CONSTANTS

const TInt KSatActiveProfileOffline = 5; // value from ProfileEngine

const TInt K32TIntMaxValue = 0x7FFFFFFF;

// From UI spec 60 sec delay user response.

const TInt KNoResponseFromUserDelay = 60; 

const TInt KMicroSecondsInSecond = 1000000;

const TInt KClearScreenDelay = 3;

const TInt KMicroSecondsInTenthOfSecond = 100000;

const TInt K3Seconds = 3000000;

// Maximum length for sound file. 

const TInt KMaxSoundFileLength = 256;

// Audio sample is repeated indefinitely.

const TInt KSoundPlayerRepeatForever = KMdaRepeatForever;

// Used when dividing some values. Used only for preventing the use of magic 

// numbers

const TInt KDivideByEight = 8;

const TUint8 KGetInputStringMaxSize = 0xEF;

_LIT( K3Spaces, "   " );                    // Used for empty title.

const TInt KEmptyTitleLength( 3 );          // Length of empty title.                      

_LIT( KSatEmptySpace, " " );                // Used for empty item.

_LIT( KSatEmptyDes, "" );

const TUint8 KKeyZero = 0x30;

const TUint8 KKeyNine = 0x39;

const TUint8 KHwAsterisk = 0x2a;    // In hw scan code value for asterisk

// The max volume value from settings.

// From TProfileToneSettings.h

const TInt KMaxVolumeFromProfile( 10 );

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

// C++ default constructor can NOT contain any code, that

// might leave.

//

CSatUiViewAppUi::CSatUiViewAppUi():

    iHelp( EFalse ),

    iSetUpMenuFirst( ETrue ),

    iSelectItemFirst( ETrue ),

    iPreviousForeground( EFalse ),

    iViewLoopCounter( 0 ),

    iDuration( TTimeIntervalMicroSeconds( static_cast<TInt64>( 0 ) ) ),

    iReqWSBufferID( KErrNone )

    {

    }

// Symbian OS default constructor can leave.

void CSatUiViewAppUi::ConstructL()

    {

    TFLOGSTRING( "CSatUiViewAppUi::ConstructL() called" )

    BaseConstructL( EAknEnableSkin | EAknEnableMSK | EAknSingleClickCompatible );

    // Requests Window Server client buffer used by the application to

    // be of at least the given size.

    iReqWSBufferID = CAknEnv::Static()->RequestWsBuffer( KAknMaxWsBufferSize );

    TFLOGSTRING2( "iReqWSBufferID is %d", iReqWSBufferID )

    if ( BTSAPActivatedL() )

        {

        HBufC* sapText = 

            iCoeEnv->AllocReadResourceLC( R_QTN_OFFLINE_NOT_POSSIBLE_SAP );

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

        iForegroundControl = note;

        note->ExecuteLD( *sapText );

        iForegroundControl = NULL;

        CleanupStack::PopAndDestroy( sapText );

        Exit();

        }

    if ( ProfileState() == KSatActiveProfileOffline )

        {

        ShowNotAvailableNoteL();

        Exit();        

        }

    if ( StatusPane()->PaneCapabilities( TUid::Uid(

        EEikStatusPaneUidTitle ) ).IsPresent() )

        {

        CAknTitlePane* titlePane = STATIC_CAST( CAknTitlePane*,

            StatusPane()->ControlL( TUid::Uid( EEikStatusPaneUidTitle ) ) );

        titlePane->SetTextL( KNullDesC );

        titlePane->DrawNow();

        }

    TFLOGSTRING( "CSatUiViewAppUi::ConstructL() exit" )

    }

// Destructor.

CSatUiViewAppUi::~CSatUiViewAppUi()

    {

    TFLOGSTRING( "CSatUiViewAppUi::~CSatUiViewAppUi() called" )

    this->StopShowWaitNote();

    delete iTitle;

    delete iAppName;

    delete iPlayer;

    delete iTimer;    

    TFLOGSTRING( "CSatUiViewAppUi::~CSatUiViewAppUi() exit" )

    }

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

// CSatUiViewAppUi::CreateEmptyMenuL

// Creates empty menu. This is used in SIM originated commands.

// (other items were commented in a header).

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

//

void CSatUiViewAppUi::CreateEmptyMenuL()

    {

    TFLOGSTRING( "CSatUiViewAppUi::CreateEmptyMenuL() called" )

    // Create the menu item array with no content.

    CDesCArrayFlat* menuItems = new( ELeave ) CDesCArrayFlat( 1 );

    CleanupStack::PushL( menuItems );

    menuItems->Reset();

    menuItems->AppendL( KSatEmptySpace );

    // Create the empty next action indicator array.

    CArrayFixFlat<TSatAction>* menuActions =

        new( ELeave ) CArrayFixFlat<TSatAction>( 1 );

    CleanupStack::PushL( menuActions );

    menuActions->Reset();

    // Create empty title pane.

    HBufC* satTitle = HBufC::NewLC( KEmptyTitleLength );

    satTitle->Des().Append( K3Spaces );

    iSetUpMenuFirst = EFalse;

    iSetUpMenuView = CSatUiView::NewL( ETrue, this, ETrue );

    iSetUpMenuView->SetItemsL( satTitle, 

        *menuItems, 

        menuActions, 

        EFalse );

    // Hide list box.

    iSetUpMenuView->MakeListBoxVisible( EFalse );

    // Transfer ownership to CAknViewAppUi.

    AddViewL( iSetUpMenuView );

    iSetUpMenuView->SetAdapter( iAdapter );

    iActiveView = KSetUpMenuViewId; 

    // satTitle, menuActions, menuItems  

    CleanupStack::PopAndDestroy( satTitle );

    CleanupStack::PopAndDestroy( menuActions );

    CleanupStack::PopAndDestroy( menuItems );

    TFLOGSTRING( "CSatUiViewAppUi::CreateEmptyMenuL() exit" )

    }

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

// CSatUiViewAppUi::SetAdapter

// Sets the pointer to MSatUiAdapter object.

// (other items were commented in a header).

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

//

void CSatUiViewAppUi::SetAdapter(

    MSatUiAdapter* aAdapter )

    {

    iAdapter = aAdapter;

    }

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

// CSatUiViewAppUi::ShowWaitNoteL

// Displays the wait note.

// (other items were commented in a header).

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

//

void CSatUiViewAppUi::ShowWaitNoteL()

    {

    TFLOGSTRING( "CSatUiViewAppUi::ShowWaitNoteL() called" )

    if ( !iWaitNote )

        {

        iWaitNote = new(ELeave)CAknWaitDialog(

            (REINTERPRET_CAST(CEikDialog**,&iWaitNote)));

        iForegroundControl = iWaitNote;

        iWaitNote->ExecuteLD( R_SATUI_WAIT_NOTE );

        // iForegroundControl won't be clear until the wait dialog

        // closed. It will avoid we lose the chance to set focus for

        // the wait dialog when the switch of foreground/background

        // happened.

        }

    TFLOGSTRING( "CSatUiViewAppUi::ShowWaitNoteL() exit" )

    }

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

// CSatUiViewAppUi::ShowWaitNoteWithoutDelayL

// Displays the wait note without delay

// (other items were commented in a header).

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

//

void CSatUiViewAppUi::ShowWaitNoteWithoutDelayL()

    {

    TFLOGSTRING( "CSatUiViewAppUi::ShowWaitNoteWithoutDelayL() called" )

    if ( !iWaitNote )

        {

        iWaitNote = new(ELeave)CAknWaitDialog(

            (REINTERPRET_CAST(CEikDialog**,&iWaitNote)), ETrue );

        iForegroundControl = iWaitNote;

        iWaitNote->ExecuteLD( R_SATUI_WAIT_NOTE );

        // iForegroundControl won't be clear until the wait dialog

        // closed. It will avoid we lose the chance to set focus for

        // the wait dialog when the switch of foreground/background

        // happened.

        }

    TFLOGSTRING( "CSatUiViewAppUi::ShowWaitNoteWithoutDelayL() exit" )

    }

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

// CSatUiViewAppUi::StopShowWaitNote

// Removes the wait note from the screen.

// (other items were commented in a header).

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

//

void CSatUiViewAppUi::StopShowWaitNote()

    {

    TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() called" )

    if ( iNoteDialog )

        {

        iForegroundControl = NULL;

        TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() Closing \

            NoteDialog" )

        delete iNoteDialog;

        iNoteDialog = NULL;

        }

    if ( iWaitNote )

        {

        iForegroundControl = NULL;

        TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() Closing WaitNote" )

        // Process finished. The function was either ExecuteLD or RunLD.

        // This function call stops the execution of these function and 

        // causes the deletion of object

        TInt err(0);

        TRAP( err, iWaitNote->ProcessFinishedL() )

        TFLOGSTRING2(" 2nd: iWaitNote: %x ", iWaitNote )

        TFLOGSTRING2( "TRAP: %d", err )

        // Delete the object just in case. Seems that above method does not 

        // delete the object in some cases. e.g in very fast execution

        delete iWaitNote;

        iWaitNote = NULL;

        }

    if ( iBipWaitNote )

        {

        iForegroundControl = NULL;

        TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() Closing BIP note" )

        delete iBipWaitNote;

        iBipWaitNote = NULL;

        }

    if ( iPermanentNote )

        {

        TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() \

               iPermanentNote cleared" )

        // If iPermanentNote exists until wait note is stopped,

        // then dialog has been already removed.

        iPermanentNote->ExitSleepingDialog();

        delete iPermanentNote;

        iPermanentNote = NULL;

        }

    TFLOGSTRING( "CSatUiViewAppUi::StopShowWaitNote() exit" )

    }

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

// CSatUiViewAppUi::BTSAPActivatedL

// Check that if BT SAP connection activated.

// (other items were commented in a header).

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

//

TBool CSatUiViewAppUi::BTSAPActivatedL()

    {

    TFLOGSTRING( "CSatUiViewAppUi::BTSAPActivated() called" )

    TBool isActive( EFalse );

    FeatureManager::InitializeLibL();

    if ( FeatureManager::FeatureSupported( KFeatureIdBtSap ) )

        {

        TFLOGSTRING( "BTSAP is supported by ME" )

        TInt status( EBTSapNotConnected );

        TInt err = RProperty::Get( KPSUidBluetoothSapConnectionState, 

                                   KBTSapConnectionState, 

                                   status );

        if ( EBTSapNotConnected != status && !err )

            {

            TFLOGSTRING( "BTSAP is connected" )

            isActive = ETrue;

            }

        else

            {

            TFLOGSTRING3( "BTSAP status %d and error %d", status, err )

            }

        }

    else

        {

        TFLOGSTRING( "BTSAP is not supported by ME" )

        }

    FeatureManager::UnInitializeLib();

    TFLOGSTRING( "CSatUiViewAppUi::BTSAPActivated() exit" )

    return isActive;

    }

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

// CSatUiViewAppUi::CoeEnv

// Returns CoeEnv.

// (other items were commented in a header).

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

//

CCoeEnv* CSatUiViewAppUi::CoeEnv()

    {

    return iCoeEnv;

    }

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

// CSatUiViewAppUi::DisplayTextL

// Displays the text in a note. 

// (other items were commented in a header).

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

//

TSatUiResponse CSatUiViewAppUi::DisplayTextL(

    const TDesC& aText,

    const TDesC& aSimApplicationName,

    CFbsBitmap* aIconBitmapDisplayText,

    const TBool aSelfExplanatoryIcon,

    const TBool aSustainedText,

    const TTimeIntervalSeconds aDuration,

    const TBool aWaitUserToClear )

    {

    TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL called" )

    StopShowWaitNote();

    TSatUiResponse response( ESatSuccess );

    iHighPriorityEvent = EFalse;

    // Indication immediate response TLV for Display Text during MT call,

    // if it is immediate response, close dialog, otherwise leave it alone.

    iImmediateRsp = aSustainedText;

    TFLOGSTRING2( "CSatUiViewAppUi::DisplayTextL immediate rsp: %d", 

                   iImmediateRsp )    

    HBufC* header;

    if ( iHelp )

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL iHelp ETrue" )

        header = StringLoader::LoadLC(

            R_QTN_SAT_HELP_HEADER, iCoeEnv );

        iHelp = EFalse;

        }

    else

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL iHelp EFalse" )

        TFLOGSTRING2( "CSatUiViewAppUi::DisplayTextL length of \

            aSimApplicationName: %d", aSimApplicationName.Length() )

        if ( aSimApplicationName.Length() > 0 )

            {

            header = aSimApplicationName.AllocLC();

            }

        else

            {

            //Reads a resource string with memory allocation

            header = StringLoader::LoadLC( R_QTN_SAT_MESSAGE_HEADER, iCoeEnv );

            }

        }

    // Remove NULL characters from title

    RemoveNullCharacters( header );

    if ( aIconBitmapDisplayText )

        {

        //icon available use querydialog

        iDisplayTextIconDialog = CAknPopupForm::NewL();

        }

    CUserActivityManager* activityManager = 

        CUserActivityManager::NewL( EPriorityNormal );

    CleanupStack::PushL( activityManager );

    // Duration handling: 

    // If duration is given use that value for timeout.

    TTimeIntervalSeconds duration ( aDuration );

    // If user is expected to clear shown dialog and 

    // duration is NOT given use 60s timeout.

    if ( aWaitUserToClear && !aDuration.Int() )

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL wait user to clear" )

        duration = TTimeIntervalSeconds( KNoResponseFromUserDelay );

        }

    // If user is NOT expected to clear shown dialog and 

    // duration is NOT given use 3s timeout.

    else if ( !aDuration.Int() )

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL don't wait user \

            to clear" )

        duration = TTimeIntervalSeconds( KClearScreenDelay );

        }        

    // If not sustained or Clear after delay requested start timer

    if ( !aSustainedText || aDuration.Int() || !aWaitUserToClear )

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL No sustained text" )

        TFLOGSTRING2( "CSatUiViewAppUi::DisplayTextL duration: %d", 

            duration.Int() )

        // If duration is given start timer which doesn't 

        // care about user activity.        

        if ( aDuration.Int() )

            {

            CreateCallBackTimerL( duration.Int() * KMicroSecondsInSecond,

                DelayCallback );

            }

        // Otherwise start timer which takes account user activity.

        else

            {

            User::ResetInactivityTime();

            activityManager->Start( duration, 

                TCallBack( DispatchUserInactive, this ), 0 );            

            }

        }

    TInt userResponse;

    if ( aIconBitmapDisplayText )

        {

        TFLOGSTRING( "CSatUiViewAppUi::DisplayTextL have IconBitmap" )

        // Prepare dialog with icon

        iDisplayTextIconDialog->SetPopupFormType( EAknQuery );

        iDisplayTextIconDialog->PrepareLC( R_SATUI_MESSAGE_TEXT_ICON );

        iDisplayTextIconDialog->SetTitleL( *header );