/*

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

*

*/

// INCLUDE FILES

#include "menusrveng.h"

#include "menusrv.h"

#include "menusrvsession.h"

#include "menusrvdef.h"

#include "menueng.h"

#include "timeout.h"

#include "menusrvappscanner.h"

#include "mcssatmonitor.h"

#include "menusrvfoldercrnotifier.h"

#include "mcsmenuiconutility.h"

#include "mcsmenuutils.h"

#include "menusrvengutils.h"

#include "mcsdrmhandler.h"

#include "mcscachehandler.h"

#include "mcschildrenhandler.h"

#include "mcsrunningappshandler.h"

#include "mcsgetlisthandler.h"

#include "menusrvobjectfilter.h"

#include "mcssuitehandler.h"

#include <mcsdef.h>

#include <mcsmenufilter.h>

_LIT( KRunning16, "running" );

// ==================== LOCAL FUNCTIONS ====================

/**

* Close Engine callback function.

* @param aSrvEng CMenuSrvEng as TAny*.

* @return KErrNone.

*/

LOCAL_C TInt CloseSrvEng( TAny* aSrvEng )

    {

    CMenuSrvEng* srvEng = (CMenuSrvEng*)aSrvEng;

    // The timed close should be the last one closing it!

    __ASSERT_DEBUG( 1 == srvEng->AccessCount(), User::Invariant() );

    srvEng->Close(); // Delete it.

    return KErrNone;

    }

/**

* Identity function to search in an array of TPtrC containing Attribute names.

* Identity is the name of attribute.

* @param aLeft Search term.

* @param aRight Array item.

* @return ETrue if names match.

*/

LOCAL_C TBool CmpAttrName(

		const TPtrC& aName1,

		const TPtrC& aName2 )

		    {

		    return ( KErrNone == aName1.Compare( aName2 ) );

		    }

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

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

// CMenuSrvEng::NewL

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

//

CMenuSrvEng* CMenuSrvEng::NewL

( CMenuSrv& aMenuSrv, const TDesC& aContentName )

    {

    CMenuSrvEng* srv = new (ELeave) CMenuSrvEng( aMenuSrv );

    CleanupClosePushL( *srv );

    srv->ConstructL( aContentName );

    CleanupStack::Pop( srv );

    return srv;

    }

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

// CMenuSrvEng::~CMenuSrvEng

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

//

CMenuSrvEng::~CMenuSrvEng()

    {

    __ASSERT_DEBUG( !iSessions.Count(), User::Invariant() );

    delete iGetlistHandler;

    delete iDrmHander;

    delete iChildrenHandler;

    delete iTimedClose;

    delete iCMenuSrvEngUtils;

    iSessions.Close();

    iContentName.Close();

    delete iAppScanner;

    delete iFolderNotifier;

    delete iMcsSatMonitor;

    delete iRunningAppsHandler;

    delete iCacheHandler;

    delete iSuiteHandler;

    delete iEng;

    iMenuSrv.EngineDeleted();

    }

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

// CMenuSrvEng::CMenuSrvEng

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

//

CMenuSrvEng::CMenuSrvEng( CMenuSrv& aMenuSrv ): iMenuSrv( aMenuSrv )

    {

    }

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

// CMenuSrvEng::ConstructL

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

//

void CMenuSrvEng::ConstructL( const TDesC& aContentName )

    {

    if ( !aContentName.Length() )

        {

        // A name is required - only dead engines have empty name.

        User::Leave( KErrArgument );

        }

    iContentName.CreateL( aContentName );

    iTimedClose = CTimeout::NewL

        ( CActive::EPriorityStandard, TCallBack( CloseSrvEng, (TAny*)this ) );

    iEng = CMenuEng::NewL( iContentName, *this );

    if (iContentName.Length())

        {

        iCacheHandler = CMcsCacheHandler::NewL( *iEng, *iCMenuSrvEngUtils );

        iMcsSatMonitor = CMcsSatMonitor::NewL( *iEng );

        iCMenuSrvEngUtils = CMenuSrvEngUtils::NewL( *iEng );

    #ifndef __TEST_DISABLE_APPSCAN

        iAppScanner = CMenuSrvAppScanner::NewL( *iEng ); // Start automatic update.

        iFolderNotifier =  CMenuSrvFolderCrNotifier::NewL( *iEng ); // Start automatic update.

    #endif

        iRunningAppsHandler = CMcsRunningAppsHandler::NewL( *iEng, 

        		*iCacheHandler );

        iDrmHander = CMcsDrmHandler::NewL( 

            *this,

            *iCMenuSrvEngUtils, 

            *iCacheHandler );

        iChildrenHandler = CMcsChildrenHandler::NewL(

            *this,

            *iCacheHandler);

        iSuiteHandler = CMcsSuiteHandler::NewL(*iEng, iContentName);

        iTimedClose->Cancel();

        iTimedClose->After( TTimeIntervalMicroSeconds32( KMenuSrvExitDelay ) );

        }

    }

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

// CMenuSrvEng::AddSessionL

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

//

void CMenuSrvEng::AddSessionL( CMenuSrvSession* aSession )

    {

    // In AddSessionL() / RemoveSession(), the refcount is

    // increased / decreased. This has no other purpose than sanity-checking.

    // Otherwise, the session count controls the lifetime of this object.

    __ASSERT_DEBUG( KErrNotFound == iSessions.Find( aSession ), \

        User::Invariant() );

    iSessions.AppendL( aSession );

    Open(); // Increase refcount.

    iTimedClose->Cancel(); // Stay alive.

    }

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

// CMenuSrvEng::RemoveSession

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

//

void CMenuSrvEng::RemoveSession( CMenuSrvSession* aSession )

    {

    TInt i = iSessions.Find( aSession );

    if ( KErrNotFound != i )

        {

        iSessions.Remove( i );

        Close(); // Decrease refcount.

        }

    if ( !iSessions.Count() )

        {

    	iTimedClose->Cancel();

        CActiveScheduler* currentScheduler = CActiveScheduler::Current();

        // No more sessions; schedule self-deletion.

        if (currentScheduler)

        	{

            // No more sessions; schedule self-deletion.

        	iTimedClose->After( TTimeIntervalMicroSeconds32( KMenuSrvExitDelay ) );

        	}

        else

        	{

        	// for Backup&Restore ActiveScheduler is closed ealier so we need

        	// to decrease refcount here (not in CloseSrvEng())

        	Close();

        	}

        }

    }

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

// CMenuSrvEng::EngineEvents

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

//

void CMenuSrvEng::EngineEvents( TInt aFolder, TInt aEvents )

    {

    // Broadcast to all sessions - for loop will do, we do not

    // expect any session to remove itself during this.

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

        {

        iSessions[i]->EngineEvents( aFolder, aEvents );

        }

    if (iDrmHander) 

        {

        iDrmHander->EngineEvents( aFolder, aEvents );    

        }

    if (iChildrenHandler)

    	{

    	iChildrenHandler->EngineEvents( aFolder, aEvents );

    	}

    if (iRunningAppsHandler)

    	{

    	iRunningAppsHandler->EngineEvents( aFolder, aEvents );

    	}    

    if( iCacheHandler && iCacheHandler->iAttrCache.Count() > 0 )

        {

        iCacheHandler->EngineEvents( aEvents );

        }

    }

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

// CMenuSrvEng::EngineError

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

//

void CMenuSrvEng::EngineError( TInt aErr )

    {

    // Unrecoverable engine error.

    // Broadcast to all sessions before killing ourselves.

    while ( iSessions.Count() )

        {

        CMenuSrvSession* session = iSessions[0];

        iSessions.Remove( 0 );

        Close(); // Decrease refcount.

        session->EngineError( aErr );

        }

    // No more sessions; schedule self-deletion.

    // We could close ourselves immediately, but that would cause the server

    // to exit immediately. Therefore, we use the delayed exit, but clear the

    // name so the server cannot find us and reuse.

    delete iDrmHander; iDrmHander = NULL;

    delete iChildrenHandler, iChildrenHandler = NULL;

    delete iMcsSatMonitor; iMcsSatMonitor = NULL;

    delete iRunningAppsHandler; iRunningAppsHandler = NULL;

    delete iAppScanner; iAppScanner = NULL;

    delete iFolderNotifier; iFolderNotifier = NULL;

    delete iSuiteHandler; iSuiteHandler = NULL;

    delete iEng; iEng = NULL;

    iContentName.Close();

    iTimedClose->Cancel();

    iTimedClose->After( TTimeIntervalMicroSeconds32( KMenuSrvExitDelay ) );

    }

// CMenuSrvEng::TreeReloaded

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

//

void CMenuSrvEng::EngineTreeReloaded()

	{

	if (iAppScanner)

		{

		iAppScanner->ScheduleScan();

		}

	}

void CMenuSrvEng::GetAttributeListL(

		  TInt aId,

		  RArray<TPtrC>& aList )

    {

    const CMenuEngObject& obj = iEng->ObjectL(aId);

    TPtrC name, value;

    TBool localized;

    for ( TInt ndx = 0; obj.GetAttribute( ndx, name, value, localized ); ndx++ )

        {

        if( !( name.Compare( KMenuAttrIconFile ) == KErrNone

            || name.Compare( KMenuAttrIconId ) == KErrNone

            || name.Compare( KMenuAttrMaskId ) == KErrNone

            || name.Compare( KMenuAttrIconSkinMajorId ) == KErrNone

            || name.Compare( KMenuAttrIconSkinMinorId ) == KErrNone ))

            {

            aList.AppendL(name);

            }  

        }      

    AppendExtendedAttrributesL( obj.Type() , aList );

    }

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

// CExtendedMenuItem::GetAttributeL

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

//

void CMenuSrvEng::GetAttributeL(

		 TInt aId,

		 const TDesC& aAttrName,

		 TBool& aAttrExists,

		 TDes& aAttrVal )

    {

    TBool dummy;

    TPtrC val(KNullDesC);

    aAttrExists = iEng->ObjectL(aId).FindAttribute( aAttrName, val, dummy);

    if( !aAttrExists )

        {

        aAttrExists = iCacheHandler->iAttrCache.Find( aId, aAttrName, aAttrVal );

        }

    if ( aAttrExists && val!=KNullDesC() )

        {

        aAttrVal = val;

        }

    else if( !aAttrExists )

    	{

    	GetExtendedAttributesL( aId, aAttrName, aAttrExists, aAttrVal );

    	}

    }

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

// CMenuSrvEng::InstalledSuiteExist

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

// 

TBool CMenuSrvEng::InstalledSuiteExist(const TDesC& aSuiteName)

	{

	return iSuiteHandler->HaveSuite(aSuiteName);

	}

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

// CMenuSrvEng::GetSuiteAttributeL

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

// 

void CMenuSrvEng::GetSuiteAttribute( const TDesC& aSuiteName, const TDesC& aAttrName, 

           TBool& aAttrExists, TDes& aAttrVal )

	{

	iSuiteHandler->GetAttribute(aSuiteName, aAttrName, 

			aAttrExists, aAttrVal);

	}

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

// CMenuSrvEng::GetRunningAppsL()

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

// 

void CMenuSrvEng::GetRunningAppsL( RArray<TUid>& aArray )

    {

	iRunningAppsHandler->GetRunningAppsL( aArray );

	}

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

// CMenuSrvEng::GetRunningAppsL()

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

// 

void CMenuSrvEng::GetExtendedAttributesL(TInt aId, 

    const TDesC& aAttrName, TBool& aAttrExists,

    TDes& aAttrVal )

    {

    TBool captionInfo(aAttrName.Compare( KMenuAttrShortName ) == KErrNone ||

    aAttrName.Compare( KMenuAttrLongName ) == KErrNone ||

    aAttrName.Compare( KMenuAttrTitleName ) == KErrNone );

    TBool addToCache( ETrue );

    if ( captionInfo )

        {

        CaptionInfoL( aId, aAttrName, aAttrExists, aAttrVal );

        addToCache = EFalse;

        }

    else if ( KErrNone == aAttrName.Compare( KMenuAttrDrmProtection ) )

        {

        AppDrmProtectionL( aId, aAttrExists, aAttrVal );

        }

    else if ( KErrNone == aAttrName.Compare( KRunningStatus ) )

        {

        GetAppRunningL( aId, aAttrExists, aAttrVal );

        }

    else if ( KErrNone == aAttrName.Compare( KChildrenCount ) )

        {

        FolderChildrenCountL( aId, aAttrExists, aAttrVal );

        }

    else if( KErrNone == aAttrName.Compare( KMenuAttrNative ) )

        {

        ApplicationNativeAttributeL( aId, aAttrExists, aAttrVal );

        }

    else // The attribute doesn't present for the item

        {

        aAttrExists = EFalse;

        aAttrVal = KNullDesC();

        }

    if( aAttrExists && addToCache )

        {

        AddToCacheL(aId, aAttrName, aAttrVal );

        }

    }

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

// CMenuSrvEng::ApplicationNativeAttributeL

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

//

void CMenuSrvEng::ApplicationNativeAttributeL(

		TInt aId, TBool & aAttrExists, TDes & aAttrVal )

	{

	const CMenuEngObject & obj = iEng->ObjectL(aId);

	iCMenuSrvEngUtils->IsNative(obj, aAttrExists, aAttrVal);

	}

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

// CMenuSrvEng::AddToCacheL

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

//

void CMenuSrvEng::AddToCacheL( TInt aId, const TDesC& aAttrName,

    TDes& aAttrVal )

    {

    CMenuSrvAttr* attr = CMenuSrvAttr::NewLC( aAttrName );

    attr->SetValueL( aAttrVal ); // Takes ownership.

    attr->SetId( aId ); // New in cache -> not changed.

    iCacheHandler->iAttrCache.AppendL( attr );

    CleanupStack::Pop( attr );

    }

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

// CMenuSrvEng::CaptionInfoL

// Functions only for KMenuTypeApp type.

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

//

void CMenuSrvEng::CaptionInfoL( TInt aId, const TDesC& aAttrName, 

    TBool& aExists, TDes& aAttrVal )

    {

    const CMenuEngObject& obj = iEng->ObjectL(aId);

    if ( obj.Type().Compare( KMenuTypeFolder ) == KErrNone )

        {

        TBool localized;

        TPtrC attrvalue; 

        TBool attrExists = obj.FindAttribute( KMenuAttrAppGroupName, attrvalue, localized );

        if ( attrExists )

            {

            aExists = ETrue;

            aAttrVal = attrvalue;

            AddToCacheL(aId, KMenuAttrLongName, aAttrVal );

            AddToCacheL(aId, KMenuAttrShortName, aAttrVal );

            AddToCacheL(aId, KMenuAttrTitleName, aAttrVal );

            }

        }

    else if ( obj.Type().Compare( KMenuTypeApp ) == KErrNone )

        {

        aAttrVal = AppCaptionInfoL( obj, aAttrName, aExists );

        AddToCacheL(aId, aAttrName, aAttrVal );

        }

    else

        {

        aExists = EFalse;

        aAttrVal = KNullDesC();

        }

    }

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

 // CMenuSrvEngUtils::AppDrmProtection

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

 //

 void CMenuSrvEng::AppDrmProtectionL( TInt aId, TBool& aExists, TDes& aAttrVal )

     {

     CMenuSrvEngUtils::TDRMProtectionInfo drmProt;

     if ( KErrNone != iCMenuSrvEngUtils->GetDrmProtectionL(

                                         aId,

                                         drmProt ) )

         {

         aExists = EFalse;

         aAttrVal = KNullDesC();

         }

     else

    	 {

		 aExists = ETrue;

		 switch ( drmProt )

		    {

		    case CMenuSrvEngUtils::EDRMUnknownProtection:

		        {

		        aAttrVal = KMenuDrmUnknown();

		        break;

		        }

		    case CMenuSrvEngUtils::EDRMNotProtected:

		        {

		        aAttrVal = KMenuDrmNotProtected();

		        break;

		        }

		    case CMenuSrvEngUtils::EDRMProtected:

		        {

		        aAttrVal = KMenuDrmProtected();

		        break;

		        }

		    case CMenuSrvEngUtils::EDRMRightsExpired:

		        {

		        aAttrVal = KMenuDrmRightsExpired();

		        break;

		        }

		    default:

		        {

		        User::Invariant();

		        aAttrVal = KNullDesC();

		        }

		    }

    	 }

     }

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

 // CMenuSrvEngUtils::AppCaptionInfoL

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

 //