/*

* 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:     This file implements the Screen Saver Animation Plugin which

*                is used by Screen Saver application to load animation 

*                screen savers.

*

*/

#include <eikenv.h>

#include <bautils.h>

#include <apgcli.h>

#include <data_caging_path_literals.hrh>

#include <centralrepository.h>

#include <DRMHelper.h>

#include <aknnotewrappers.h> 

#include <aknnavi.h>

#include <aknnavide.h>

#include <npupp.h>

#include <cecombrowserplugininterface.h>

#include <browserplugininterface.h>

#include <mmf/common/mmfcontrollerpluginresolver.h>

#include <DRMHelperServerInternalCRKeys.h>

#include <NPNExtensions.h>

#include <screensaveranimplugin.rsg>

#include <coecntrl.h>

#include "ScreenSaverAnimPluginInternalCRKeys.h"

#include "ScreenSaverAnimPlugin.h"

#include "ScreenSaverAnimPluginContainer.h"

#include "ScreenSaverAnimSettingDialog.h"

#include "NpnImplementation.h"

#include "ScreenSaverAnimPluginHelper.h"

// Constants

#ifdef SCREENSAVER_LOG_ENABLED         

const TInt KMaxBufLen = 64;

#endif

const TInt KSixteenBytes = 128;

const TInt KUrlMaxLen = 1024;

// Animation Timeout values

const TInt KMinDurationValue = 5;

const TInt KMaxDurationValue = 60;

const TInt KDefaultDurationValue = 5;

// Backlight Values

const TInt KMinBackLightValue = 0;

const TInt KMaxBackLightValue = 30;

const TInt KDefaultBackLightValue = 0;

const TInt KScreensaverAnimPluginInterfaceUid = 0x102750CB;  

_LIT( KResourceFileName, "Z:ScreenSaverAnimPlugin.rsc" );

CScreenSaverAnimSettingObject::CScreenSaverAnimSettingObject()

    {

    iAnimationTimeout = KDefaultDurationValue;

    iLightsTimeout = KDefaultBackLightValue;

    }

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

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

// CScreenSaverAnimPlugin::NewL

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

//

CScreenSaverAnimPlugin* CScreenSaverAnimPlugin::NewL()

    {

    CScreenSaverAnimPlugin* self = new ( ELeave ) CScreenSaverAnimPlugin;

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CScreenSaverAnimPlugin::~CScreenSaverAnimPlugin

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

//   

CScreenSaverAnimPlugin::~CScreenSaverAnimPlugin()

    {    

    if ( iResourceOffset != 0 )

        {

        iEikEnv->DeleteResourceFile( iResourceOffset );

        }        

    UnregisterForDrmExpiry();       

    NotifyCenrepChangeCancel();     

    UnInitializeCenRep();

    // Final place to delete plug-in. Plug-in is deleted here

    // if plug-in notices runtime error.

    SetPluginDeleted();

    delete iDrmHelper;

    delete iSettingObject;

    delete iScreensaverName;

    }

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

// CScreenSaverAnimPlugin::InitializeL

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

//  

TInt CScreenSaverAnimPlugin::InitializeL( MScreensaverPluginHost *aHost )

    {     

    if ( !aHost )

        {

        return KErrCancel;

        }

#ifdef SCREENSAVER_LOG_ENABLED                 

    _LIT( msg, "InitializeL called " );    

    PrintDebugMsg( msg );

#endif    

    iScreenSaverHost = aHost;   

    iScreenSaverHost->UseRefreshTimer( EFalse );

#ifdef SCREENSAVER_LOG_ENABLED             

    _LIT( cenrepmsg, "before NotifyCenrepChangeL" );    

    PrintDebugMsg( cenrepmsg );    

#endif    

    NotifyCenrepChangeL();

#ifdef SCREENSAVER_LOG_ENABLED             

    _LIT( cenrepmsg1, "After NotifyCenrepChangeL" );    

    PrintDebugMsg( cenrepmsg1 );    

#endif    

    iScreenSaverHost->OverrideStandardIndicators();    

    iScreenSaverHost->ExitPartialMode(); 

#ifdef SCREENSAVER_LOG_ENABLED             

    _LIT( FindPluginLmsg, "before FindPluginL" );    

    PrintDebugMsg( FindPluginLmsg );    

#endif    

    TRAPD( err, FindPluginL( iSettingObject->iFileName ) )

    if ( err != KErrNone )

        {

        return err;

        }

#ifdef SCREENSAVER_LOG_ENABLED             

    _LIT( FindPluginLmsg1, "After FindPluginL" );    

    PrintDebugMsg( FindPluginLmsg1 );        

#endif    

    return KErrNone;

    }

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

// CScreenSaverAnimPlugin::Draw

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

// 

TInt CScreenSaverAnimPlugin::Draw(CWindowGc& /*aGc*/)

    {     

    return KErrNone;    

    }

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

// CScreenSaverAnimPlugin::SetWindow

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

//    

TInt CScreenSaverAnimPlugin::SetWindow( CCoeControl* aParent )

    {

    iParentControl = aParent;

    NPWindow window;

    TInt ret = KErrNone;

    window.window = STATIC_CAST( MPluginAdapter*, this ); 

    iNPPinstance->ndata = STATIC_CAST( MPluginAdapter*, this ); 

    window.x = 0;   /* Position of top left corner relative */

    window.y = 0;   /* to a netscape page.*/

    if ( aParent )

        {

        window.width = aParent->Rect().Width(); /* Max window size */

        window.height = aParent->Rect().Height();

        window.type = NPWindowTypeDrawable;                

        }

    if ( iPluginFuncs && !iPluginFuncs->setwindow( iNPPinstance, &window ) )

        {

        ret = KErrNone;

        }  

    else

        {

        ret = KErrGeneral;   

        }

    return ret;

    }

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

// CScreenSaverAnimPlugin::Name

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

//     

const TDesC16& CScreenSaverAnimPlugin::Name() const

    {

    if ( iScreensaverName )

        {

        return *iScreensaverName;

        }

    else

        {

        return KNullDesC;

        }

    }

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

// CScreenSaverAnimPlugin::Capabilities

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

//    

TInt CScreenSaverAnimPlugin::Capabilities()

    {

    return EScpCapsConfigure;

    }

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

// CScreenSaverAnimPlugin::PluginFunction

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

// 

TInt CScreenSaverAnimPlugin::PluginFunction(

            TScPluginCaps aFunction,

            TAny* /*aParam*/)

    { 

    if ( aFunction == EScpCapsSelectionNotification  

		|| aFunction == EScpCapsPreviewNotification )

        {

        _LIT( msg, "Plugin function called Sel Notify" );    

        PrintDebugMsg( msg );

        if ( iSettingObject->iFileName.Length() == 0  || UpdateFileName() )

            {

            // File is not configured yet or deleted/renamed,

            // pop the settings dialog

            TInt err = KErrNone;

            TRAP( err, PopSettingsDialogL() );

            return err;

            }            

        else

            {

            return KErrNone;

            }      

        }

    if ( aFunction == EScpCapsConfigure )

        {

        _LIT( msg, "Plugin function called Configure" );    

        PrintDebugMsg( msg );   

        UpdateFileName();           

        TInt err = KErrNone;

        TRAP( err, PopSettingsDialogL() );

        return err;

        }    

    return KErrNone;                                                

    }  

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

// CScreenSaverAnimPlugin::HandleScreensaverEventL

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

//  

TInt CScreenSaverAnimPlugin::HandleScreensaverEventL(

            TScreensaverEvent aEvent,

            TAny* /*aData*/ )

    {

    if ( aEvent == EScreensaverEventDisplayChanged )

        {

        // Display Changed is called when there is a change in the size

        // of the window and when the parent control is set for the 

        // first time.        

        TScreensaverDisplayInfo* displayInfo = new( ELeave ) 

                               TScreensaverDisplayInfo;

        displayInfo->iSize = sizeof( TScreensaverDisplayInfo );

        iScreenSaverHost->DisplayInfo( displayInfo );

        iParentControl = displayInfo->iParent;

        delete displayInfo;

        }

    if ( aEvent == EScreensaverEventStopping )

        {

#ifdef SCREENSAVER_LOG_ENABLED                     

        _LIT( KStopEventMsg, "Stop Event" );

        PrintDebugMsg( KStopEventMsg );

#endif          

        // Delete the Plugin

        SendEndEvent();

        DeletePlugin();

        }

    if ( aEvent == EScreensaverEventStarting )

        {

#ifdef SCREENSAVER_LOG_ENABLED                     

        _LIT( KStartEventMsg, "Start Event" );

        PrintDebugMsg( KStartEventMsg );

#endif          

        // Check for drm rights

        // If the file is not valid, suspend and return

        if ( iDrmHelper )

            {

            TBool yes = EFalse;   

            iDrmHelper->CanSetAutomated( 

                     iSettingObject->iFileName, yes );

            if ( !yes )

                {

                iScreenSaverHost->RevertToDefaultSaver();

                return KErrNotFound;

                }

            } 

        if ( iScreenSaverHost )

            {

            iScreenSaverHost->RequestTimeout(

                iSettingObject->iAnimationTimeout );

            }        

#ifdef SCREENSAVER_LOG_ENABLED                     

        _LIT( KStartMsg, "Starting" );

        PrintDebugMsg( KStartMsg );

#endif        

        // Reset plugin creation error

        // The plugin cannot leave or return error

        // The plugin sets the error using pluginFinishedL

        iPluginError = KErrNone;

        // Create the plugin 

        TRAPD( err,CreatePluginL() );

        if ( err != KErrNone )

            {

            DeletePlugin();

            return err;

            }

        // Check whether the plugin has 

        // reported any error using PluginFinishedL    

        if ( iPluginError )

            {

            SetPluginDeleted();

            return iPluginError;

            }

#ifdef SCREENSAVER_LOG_ENABLED

        _LIT( KStartedMsg, "Started" );

        PrintDebugMsg( KStartedMsg );

#endif        

        // send an event to plugins       

        if ( iPluginFuncs )

            {

            NPAnimationEvent event;

            event = NPStartAnimation;

            iPluginFuncs->setvalue( iNPPinstance, 

                                    ( NPNVariable )NPNScreenSaverAnimationEvent, 

                                    &event );     

            }

        // Request lights only if set - otherwise it will turn off lights

        // (e.g. in preview). Not nice.

        TInt nLights = iSettingObject->iLightsTimeout;

        if ( nLights > 0 )

            {

            iScreenSaverHost->RequestLights( nLights );

            }

        }

    if ( aEvent == EScreensaverEventTimeout )

        {

#ifdef SCREENSAVER_LOG_ENABLED

        _LIT( KTimeoutEventMsg, "Timeout Event" );

        PrintDebugMsg( KTimeoutEventMsg );

#endif          

        // Delete the Plugin

        SendEndEvent();

        DeletePlugin();

        iScreenSaverHost->Suspend( -1) ;

        }

    return KErrNone;

    }  

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

// CScreenSaverAnimPlugin::GetAnimSettings

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

//  

TInt CScreenSaverAnimPlugin::GetAnimSettings()

    {   

    // Read the file last, since if it is missing the reading will be

    // stopped and settings all wrong

    TInt err = iAnimPluginSession->Get( KScreenSaverAnimationTimeOut,

                                        iSettingObject->iAnimationTimeout );

    if ( iSettingObject->iAnimationTimeout < KMinDurationValue ||

         iSettingObject->iAnimationTimeout > KMaxDurationValue )

        {

        // Out of range set it to default

        iSettingObject->iAnimationTimeout = KDefaultDurationValue;

        }

    if ( err != KErrNone )

        {

        return err;

        }

    err = iAnimPluginSession->Get( KScreenSaverLightsTimeOut,

                                   iSettingObject->iLightsTimeout );

    if ( iSettingObject->iLightsTimeout < KMinBackLightValue ||

         iSettingObject->iLightsTimeout > KMaxBackLightValue )

        {

        // Out of range set it to default

        iSettingObject->iLightsTimeout = KDefaultBackLightValue;

        }

    if ( err != KErrNone )

        {

        return err;

        }

    // read the file from central repository and return

    err = iAnimPluginSession->Get( KScreenSaverAnimatedFileName,

                           iSettingObject->iFileName );

    if ( err != KErrNone )

        {

        return err;

        }

    if ( !BaflUtils::FileExists( iEikEnv->FsSession(), 

                                iSettingObject->iFileName ) )

        {

        return KErrNotFound;

        }

    TBool yes = EFalse;

    if ( iDrmHelper )

        {

        TInt err = iDrmHelper->CanSetAutomated( 

                 iSettingObject->iFileName, yes );

        if ( !yes )

            {

            return KErrNotFound;

            }

        }

    return err;

    }

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

// CScreenSaverAnimPlugin::SetAnimSettings

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

//

TInt CScreenSaverAnimPlugin::SetAnimSettings() const

    {

    TInt err = KErrNone;

    err = iAnimPluginSession->Set( KScreenSaverAnimatedFileName, 

                          iSettingObject->iFileName );

    if ( err != KErrNone )                          

        {

        return err;

        }

    err = iAnimPluginSession->Set( KScreenSaverAnimationTimeOut,

                          iSettingObject->iAnimationTimeout );

    if ( err != KErrNone )

        {

        return err;

        }

    err = iAnimPluginSession->Set( KScreenSaverLightsTimeOut,

                          iSettingObject->iLightsTimeout );

    return err;

    } 

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

// CScreenSaverAnimPlugin::RegisterForDrmExpiry

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

//

TInt CScreenSaverAnimPlugin::RegisterForDrmExpiry()

    {

    TInt err = iDrmHelper->SetAutomatedType( 

             CDRMHelper::EAutomatedTypeScreenSaver );

    if ( err == KErrNone )

        {

        return iDrmHelper->SetAutomatedSilent( iSettingObject->iFileName,

                            ETrue ); 

        }

    else

        {

        return err;

        }

    }

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

// CScreenSaverAnimPlugin::UnregisterForDrmExpiry

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

//

TInt CScreenSaverAnimPlugin::UnregisterForDrmExpiry()

    {   

    if ( iDrmHelper )

        {

        iDrmHelper->SetAutomatedType( 

             CDRMHelper::EAutomatedTypeScreenSaver );

        return iDrmHelper->RemoveAutomated( iSettingObject->iFileName );