/*

* Copyright (c) 2005-2006 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:  Source file for UPnP Browse UI Implementation

*

*/

// INCLUDE FILES

// System

#include <featmgr.h>

#include <AknIconArray.h>

#include <aknnavide.h>

#include <eikclbd.h>

#include <akntabgrp.h>

#include <StringLoader.h>

#include <hlplch.h>

#include <commondialogs.mbg>

#include <AknWaitDialog.h>

#include <upnpstring.h>

#include <AknDialog.h>

#include <akntitle.h>

#include <aknlists.h>

#include <aknnotewrappers.h> 

#include <mmf/common/mmfcontrollerpluginresolver.h>

#include <httperr.h>

// upnp stack api's

#include <upnpitem.h>

#include <upnpcontainer.h>

// upnpframework / avcontroller api

#include "upnpavcontroller.h"   //start browse session and rendering session

#include "upnpavdevice.h"

#include "upnpavbrowsingsession.h"

#include "upnpavrenderingsession.h"

// upnpframework / avcontroller helper api

#include "upnpconstantdefs.h" // upnp definitions

// upnpframework / xml parser api

#include "upnpxmlparser.h"

// upnpframework / utility class UPnPItemUtility

#include "upnpitemutility.h"

// upnpframework / internal api's

#include "upnpfiletransferengine.h"

#include "upnpmusicadapter.h"

#include "upnpbrowseplaylistfiller.h"

// common ui internal

#include "upnpcommonui.h"

#include <upnpcommonui.rsg>

#include <upnpcommonui.mbg>

#include "upnpcommonutils.h"

#include "upnplocalplayer.h"

#include "upnpbrowsedialog.h"

#include "upnpcommonui.hrh"

#include "upnpbrowsecacheitem.h"

#include "upnpimageplayer.h"

#include "upnpperiodic.h"

_LIT( KComponentLogfile, "commonui.txt");

#include "upnplog.h"

//CONSTANTS

_LIT( KAknCommonUIMbmFileName, "\\resource\\apps\\upnpcommonui.mbm" );

_LIT( KFormatString,  "%d\t%S\t\t" );

_LIT( KFormatString2, "%d\t%S\t\t%d" );

_LIT( KUPNP_HLP_REMOTE_DEVICES, "UPNP_HLP_REMOTE_DEVICES" ); 

_LIT( KUPNP_HLP_CONTENT_VIEW, "UPNP_HLP_CONTENT_VIEW" ); 

const TInt KBrowseBack = -1;

const TInt KBrowseRoot = -2;

const TInt KBrowseForward = -3;

const TInt KBrowseRequestCount = 20;

const TInt KWindowBrowseTricker = 3;

const TInt KImageTimerDelay = 800000;

const TInt KImageTimerInterval = 800000;

const TInt KLength = 100;

// CONSTANTS

enum TUPnPIconTypes

    {

    EUPnPIconFolder = 1,

    //EUPnPIconFolderLocked,

    EUPnPIconMusic,

    EUPnPIconVideo,

    EUPnPIconImage,

    EUPnPIconImageShowing,

    EUPnPIconOther,

    EUPnPIconLast

    };

enum TUPnPBrowseDirection

    {

    EBackward= 1,

    EForward

    };

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

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

// CUPnPBrowseDialog::NewL

// Two-phased constructor.

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

CUPnPBrowseDialog* CUPnPBrowseDialog::NewL( TInt aMenuResource,

                                            MUPnPAVController& aAVControl,

                                            const CUpnpAVDevice& aDevice, 

                                            CUPnPCommonUI& aCommonUI)

    {

    __LOG( "CUPnPBrowseDialog::NewL" );

    CUPnPBrowseDialog* self = new (ELeave) CUPnPBrowseDialog(

        aAVControl, aCommonUI, aDevice );

    CleanupStack::PushL( self );

    self->ConstructL( aMenuResource );

    CleanupStack::Pop( self );

    __LOG( "CUPnPBrowseDialog::NewL-END" );

    return self;

    }

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

// CUPnPBrowseDialog::ConstructL

// Symbian 2nd phase constructor can leave.

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

void CUPnPBrowseDialog::ConstructL( TInt aMenuResource )

    {

    // Register as an observer to file operations (browse results)

    __LOG( "CUPnPBrowseDialog::ConstructL" );

    iBrowseSession = &iAVControl.StartBrowsingSessionL( iSourceDevice );

    iBrowseSession->SetObserver( *this );

    iFirstResultArray = ETrue;

    CAknDialog::ConstructL( aMenuResource );

    iTargetDevice = CUpnpAVDevice::NewL();

    iImageControlTimer = CUPnPPeriodic::NewL( CActive::EPriorityUserInput );

    iError = KErrNone;

    iDlgPreLayoutDone = EFalse;

    iErrorForCancel = KErrNone;

    __LOG( "CUPnPBrowseDialog::ConstructL-END" );

    }

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

// CUPnPBrowseDialog::CUPnPBrowseDialog

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

// might leave.

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

CUPnPBrowseDialog::CUPnPBrowseDialog( MUPnPAVController& aAVControl,

                                      CUPnPCommonUI& aCommonUI,

                                      const CUpnpAVDevice& aDevice ):

                                      iCommonUI( aCommonUI ), 

                                      iAVControl( aAVControl ),

                                      iSourceDevice(aDevice)

    {

    __LOG( "CUPnPBrowseDialog::CUPnPBrowseDialog" );

    iBrowseRequestSent = EFalse;

    iChildDialogOpen = 0;

    iLastImageItemIndex = KErrNotFound;

    iMSDisappear = EFalse;

    iAction = CUPnPCommonUI::EUPnPNone;

    iCopyIndex = NULL;

    iRoot = ETrue;

    iIsMusicItem = EFalse;

    iHashKeyFlag = EFalse;

    __LOG( "CUPnPBrowseDialog::CUPnPBrowseDialog-END" );

    }

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

// CUPnPBrowseDialog::~CUPnPBrowseDialog

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

// might leave.

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

CUPnPBrowseDialog::~CUPnPBrowseDialog()

    {

    __LOG( "CUPnPBrowseDialog::~CUPnPBrowseDialog" );

    // Unregister as an observer to file operations (browse results)       

    TRAPD( err, DismissWaitNoteL() );

    if ( err != KErrNone )

        {

        __LOG( "CUPnPBrowseDialog::~CUPnPBrowseDialog \

                                                    delete WaitNote error" );

        } 

    if ( iCurrentFolderId && !iBrowseRequestSent )

        {

        TRAP_IGNORE( CacheItemUpdateL( *iCurrentFolderId, EFalse ) );

        }     

    delete iCurrentFolderId;

    delete iTargetDevice;

    delete iImagePlayer;

    iParentId.ResetAndDestroy();

    iParentName.ResetAndDestroy();

    iResultArray.Close();

    iBrowseCacheItems.ResetAndDestroy();

    iTempArray.Close();

    if ( iNaviPane && iNaviDecorator )

        {

        iNaviPane->Pop( iNaviDecorator );

        }

    delete iNaviDecorator;

    iSelectedItemsArray.ResetAndDestroy();

    if ( iImageControlTimer )  

        {

        iImageControlTimer->Cancel();

        delete iImageControlTimer;

        }    

    delete iLocalPlayer; 

    if( iBrowseSession )

        {

        iBrowseSession->CancelBrowse(); 

        iBrowseSession->RemoveObserver();

        iAVControl.StopBrowsingSession( *iBrowseSession );

        }

    __LOG( "CUPnPBrowseDialog::~CUPnPBrowseDialog-END" );

    }

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

// CUPnPBrowseDialog::DialogDismissedL();

// MProgressDialogCallback, progressbar callback function

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

void CUPnPBrowseDialog::DialogDismissedL( TInt aButtonId )

    {

    __LOG( "CUPnPBrowseDialog::DialogDismissedL" );

    // If button is cancel, inform observer parent class

    // that cancel has been made

    if( aButtonId == EEikBidCancel )

        {

        __LOG( "CUPnPBrowseDialog::DialogDismissedL: \

                Cancel was pressed.");

        iAction = CUPnPCommonUI::EUPnPNone;        

        iBrowseSession->CancelBrowse();

        iBrowseRequestSent = EFalse;

        TInt cachedItemIndex = CacheCheck( *iCurrentFolderId );

        if ( cachedItemIndex > -1 )

            {               

            delete iBrowseCacheItems[ cachedItemIndex ];

            iBrowseCacheItems[ cachedItemIndex ] = NULL;

            iBrowseCacheItems.Remove( cachedItemIndex );

            iBrowseCacheItems.Compress();

            }            

        // If button is cancel,

        // the browse dialog should not been displayed,leave it in the

        // function of PreLayoutDynInitL.

        iErrorForCancel = EEikBidCancel;     

        }

    __LOG( "CUPnPBrowseDialog::DialogDismissedL-END" );

    }

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

// CUPnPBrowseDialog::PreLayoutDynInitL();

// called by framework before dialog is shown

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

void CUPnPBrowseDialog::PreLayoutDynInitL()

    {

    __LOG( "CUPnPBrowseDialog::PreLayoutDynInitL" );

    // Browse dialog title text

    TUid titlePaneUid;

    titlePaneUid.iUid = EEikStatusPaneUidTitle;

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

    CEikStatusPaneBase::TPaneCapabilities titlesubPane =

        statusPane->PaneCapabilities( titlePaneUid );

    if ( titlesubPane.IsPresent() && titlesubPane.IsAppOwned() )

        {

        iTitlePane = (CAknTitlePane*) statusPane->ControlL( titlePaneUid );

        // Get device friendly name and replace illegal characters.

        HBufC8* tmpfriendlyname = 

        UPnPCommonUtils::ReplaceIllegalFilenameCharactersL( 

            iSourceDevice.FriendlyName() );

        CleanupStack::PushL( tmpfriendlyname );

        TPtrC8 friendlyname = *tmpfriendlyname;

        HBufC *tmpbuf = UpnpString::ToUnicodeL( 

            friendlyname.Left( KLength ) );

        CleanupStack::PushL( tmpbuf ); 

        iTitlePane->SetTextL( *tmpbuf );

        CleanupStack::PopAndDestroy( tmpbuf );

        CleanupStack::PopAndDestroy( tmpfriendlyname );

        }

    iListBox = static_cast<CAknSingleGraphicStyleListBox*>(

                                        Control( EUPnPBrowseListBoxId ) );

    iListBox->CreateScrollBarFrameL( ETrue );

    iListBox->ScrollBarFrame()->SetScrollBarVisibilityL( 

            CEikScrollBarFrame::EOff, CEikScrollBarFrame::EAuto );

    iListBox->ItemDrawer()->ColumnData()->EnableMarqueeL( ETrue );

    CAknIconArray* icons = new ( ELeave ) CAknIconArray( EUPnPIconLast );

    CleanupStack::PushL( icons );

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    TFileName mbmFileName( KAknCommonUIMbmFileName );

    TFileName dllName;

    Dll::FileName( dllName );

    TBuf<2> drive = dllName.Left( 2 ); // Drive letter followed by ':' 

    mbmFileName.Insert( 0, drive );

    AppendIconToArrayL( icons, 

        skin, 

        KAvkonBitmapFile, 

        KAknsIIDQgnIndiMarkedAdd, 

        EMbmAvkonQgn_indi_marked_add, 

        EMbmAvkonQgn_indi_marked_add_mask );

    // Folder icon

    AppendIconToArrayL( icons,

        skin, 

        mbmFileName, 

        KAknsIIDQgnPropFolderSmall, 

        EMbmUpnpcommonuiQgn_prop_mserv_folder_small, 

        EMbmUpnpcommonuiQgn_prop_mserv_folder_small_mask );

    // Music icon

    AppendIconToArrayL( icons,

        skin, 

        mbmFileName, 

        KAknsIIDDefault, 

        EMbmUpnpcommonuiQgn_prop_mserv_music, 

        EMbmUpnpcommonuiQgn_prop_mserv_music_mask );

    // Video icon

    AppendIconToArrayL( icons,

        skin,

        mbmFileName, 

        KAknsIIDDefault, 

        EMbmUpnpcommonuiQgn_prop_mserv_other_videos, 

        EMbmUpnpcommonuiQgn_prop_mserv_other_videos_mask );

    // Image icon

    AppendIconToArrayL( icons,

        skin, 

        mbmFileName, 

        KAknsIIDDefault, 

        EMbmUpnpcommonuiQgn_prop_mserv_other_images, 

        EMbmUpnpcommonuiQgn_prop_mserv_other_images_mask );

    //Image showing icon

    AppendIconToArrayL( icons,

        skin, 

        mbmFileName, 

        KAknsIIDDefault, 

        EMbmUpnpcommonuiQgn_graf_upnp_ext_renderer_list_icon, 

        EMbmUpnpcommonuiQgn_graf_upnp_ext_renderer_list_icon_mask );

    // Other icon

    AppendIconToArrayL( icons,

        skin, 

        KCommonDialogsBitmapFile, 

        KAknsIIDQgnPropFmgrFileSound, 

        EMbmCommondialogsQgn_prop_fmgr_file_other, 

        EMbmCommondialogsQgn_prop_fmgr_file_other_mask );

    iListBox->ItemDrawer()->ColumnData()->SetIconArray( icons );

    CleanupStack::Pop(icons);

    // Hide "No data" text

    iListBox->View()->SetListEmptyTextL( KNullDesC() );

    // Send browse request

    SendBrowseRequestL( KBrowseRoot );

    iDlgPreLayoutDone = ETrue;

    if( iError < KErrNone )

        {

        __LOG1( "CUPnPBrowseDialog::PreLayoutDynInitL leave %d", iError );

        User::Leave( iError );

        }  

    if( iErrorForCancel == EEikBidCancel )

        {

        User::Leave( EEikBidCancel );

        } 

    __LOG( "CUPnPBrowseDialog::PreLayoutDynInitL-END" );

    }

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

// CUPnPBrowseDialog::OkToExitL( TInt aButtonId )

// called by framework when the softkey is pressed

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

TBool CUPnPBrowseDialog::OkToExitL( TInt aButtonId )

    {

    __LOG( "CUPnPBrowseDialog::OkToExitL" );

    TBool returnValue = EFalse;

    TInt error = KErrNone;

    switch (aButtonId )

        {

        // Connection failed. Dialog must be closed

        case KErrDisconnected:

        case KErrSessionClosed: //fall through

            {

            // exit only if PreLayoutDynInitL is done

            if( iDlgPreLayoutDone )

                {

                return ETrue;

                }

            else

                {

                return EFalse;

                }

            }

        case EAknSoftkeyOptions:

            {

            SelectedArrayCheckL();

            DisplayMenuL(); 

            break;

            }

        case EUPnPStopCmd: 

            {

            StopImageControlL();

            break;

            }

        case EAknSoftkeyBack:

            {

            // Check if we are in the root 

            if ( !iParentId.Count() )

                {

                ClearTitleL();

                return ETrue;

                }

            else

                {

                if ( iBrowseRequestSent )

                    {                    

                    iBrowseSession->CancelBrowse();

                    iBrowseRequestSent = EFalse;

                    }   

                iListBox->ClearSelection();

                iSelectedItemsArray.ResetAndDestroy();

                SendBrowseRequestL( KBrowseBack );                    

                }           

            break;                               

            }

        case EUPnPPlayCmd: //for lsk only, play on external renderer

            {

            if( !iMusicPlay )

                {

                StopImageControlL();

                TRAP( error, PlayL( EFalse ) );

                if( KErrNone != error )

                    {

                    iMusicPlay = EFalse;

                    }    

                }

            break;

            }

        case EAknSoftkeyOpen: //fall thougth

        case EAknSoftkeyOk:

            {

            // Shift and Ok pressed so the external device dialog must not be

            // opened

            if ( iShiftAndOkPressed )

                {

                iShiftAndOkPressed = EFalse;

                return EFalse;

                }

            if ( !iResultArray.Count() || iImageControlActive )

                {

                return EFalse; // Do nothing if empty

                }

            else if ( iResultArray[iListBox->CurrentItemIndex()]->

                        ObjectType() == EUPnPContainer )

                {

                if ( !iBrowseRequestSent )

                    {

                    iListBox->ClearSelection();

                    iSelectedItemsArray.ResetAndDestroy();

                    SendBrowseRequestL( iListBox->CurrentItemIndex() );

                    }

                }

            else

                {

                // Play or Show on external device

                // Select device according to the media type

                TRAP( error, ShowPlayExtL() );

                /* if something happens, set iMusicPlay = EFalse,

                 * no matter what kinda of media file playing 

                 * before

                 */

                if( KErrNone != error )