/*

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

*

*/

//  CLASS HEADER

#include "MT_CFScriptEngine.h"

//  EXTERNAL INCLUDES

#include <EUnitMacros.h>

#include <ECom/ECom.h>

#include <bautils.h>

#include "CFContextSubscription.h"

#include "CFContextSubscriptionImpl.h"

#include "CFContextObject.h"

#include "CFContextObjectImpl.h"

#include "CFScriptHandler.h"

//  INTERNAL INCLUDES

#include "CFTestDelay.h"

#include "cffakeenv.h"

#include "ScriptEventNotifierSession.h"

#include "basicoperationspluginconst.hrh"

#include "cfcommon.h"

#include "cfenvutils.h"

// CONSTANTS

const TUid KMT_CfScriptEngineUid = {0x7E577E57};

const TUid KMT_CfScriptEngineOtherUid = {0x074E074E};

const TUid KCFServerUid = {0x10282BC4};

_LIT( KCFPrivateFolder, "c:\\private\\10282BC4\\rules\\" );

// CONSTRUCTION

MT_CFScriptEngine* MT_CFScriptEngine::NewL()

    {

    MT_CFScriptEngine* self = MT_CFScriptEngine::NewLC();

    CleanupStack::Pop();

    return self;

    }

MT_CFScriptEngine* MT_CFScriptEngine::NewLC()

    {

    MT_CFScriptEngine* self = new( ELeave ) MT_CFScriptEngine();

    CleanupStack::PushL( self );

    self->ConstructL();

    return self;

    }

// Destructor (virtual by CBase)

MT_CFScriptEngine::~MT_CFScriptEngine()

    {

    // Enable screen saver

    CFEnvUtils::EnableScreenSaver( ETrue );

    }

// Default constructor

MT_CFScriptEngine::MT_CFScriptEngine()

    {

    }

// Second phase construct

void MT_CFScriptEngine::ConstructL()

    {

    // The ConstructL from the base class CEUnitTestSuiteClass must be called.

    // It generates the test case table.

    CEUnitTestSuiteClass::ConstructL();

    // Disable screen saver

    CFEnvUtils::EnableScreenSaver( EFalse );

    }

//  METHODS

void MT_CFScriptEngine::SetupEmptyL(  )

    {

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

    BaflUtils::EnsurePathExistsL( iFs, KCFPrivateFolder );

    iFileMan = CFileMan::NewL( iFs );

    iTestDelay = CCFTestDelay::NewL();

    }

void MT_CFScriptEngine::SetupL(  )

    {

    SetupEmptyL();

    iDummyScriptEngineSession = CScriptEventNotifierSession::NewL();

    iCFFakeEnv = CCFFakeEnv::NewL();    

    }

void MT_CFScriptEngine::Teardown(  )

    {

    TeardownNoFinalClose();

#ifdef __WINS__

    REComSession::FinalClose();

#endif

    }

void MT_CFScriptEngine::TeardownNoFinalClose(  )

    {    

    iTestDelay->Start(100000); // 0.1 seconds

    delete iDummyScriptEngineSession;

    iDummyScriptEngineSession = NULL;

    iTestDelay->Start(100000); // 0.1 seconds

    delete iTestDelay;

    iTestDelay = NULL;

    delete iCFFakeEnv;

    iCFFakeEnv = NULL;

    CleanupSystemDrive();

    delete iFileMan;

    iFs.Close();

    }

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

// MT_CFScriptEngine::LoadScriptFromFile

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

//

HBufC8* MT_CFScriptEngine::LoadScriptFromFile( const TDesC& aFilePath )

    {

    HBufC8* script = NULL;

    RFile file;

    TFileName fileName;

    fileName.Copy(_L("z:\\data\\cftestdata\\testscripts\\"));

    fileName.Append(aFilePath);

    TInt err = file.Open( iFs, fileName, EFileRead );

    if( err == KErrNone )

        {

        TInt size = 0;

        err = file.Size( size );

        if( err == KErrNone )

            {

            script = HBufC8::New( size );

            if( script )

                {

                TPtr8 scriptPtr = script->Des();

                err = file.Read( scriptPtr );

                if( err == KErrNone )

                    {

                    // Strip all unnecassary data from script

                    TInt pos = scriptPtr.FindF( KScriptStartTag );

                    if( pos != KErrNotFound )

                        {

                        scriptPtr.Copy( scriptPtr.MidTPtr( pos ) );

                        }

                    else

                        {

                        // Incorrect script

                        delete script;

                        script = NULL;

                        }

                    }

                else

                    {

                    delete script;

                    script = NULL;

                    }

                }

            }

        }

    // Cleanup

    file.Close();

    return script;

    }

TInt MT_CFScriptEngine::FindParameter(const RKeyValueArray& aArray,

    const TDesC& aKey, const TDesC& aValue)

    {

    TInt index = KErrNotFound;

    TBool found = EFalse;

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

        {

        if ( aArray[i]->Key() == aKey )

            {

            if ( index == KErrNotFound )

                {

                index = i;

                if ( aArray[i]->Value() == aValue )

                    {

                    found = ETrue;

                    }

                else

                    {

                    return -3; // found but wrong value!

                    }

                }

            else

                {

                index = -2; // Duplicate found!

                }

            }

        }

    if (found)

        {

        return index;

        }

    return KErrNotFound;

    }

TInt MT_CFScriptEngine::FindIndex( const RArray<TInt>& aArray, TInt aIndex )

    {

    TInt index = KErrNotFound;

    TBool found = EFalse;

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

        {

        if ( aArray[i] == aIndex )

            {

            if ( index == KErrNotFound )

                {

                index = i;

                found = ETrue;

                }

            else

                {

                index = -2; // Duplicate found!

                }

            }

        }

    if (found)

        {

        return index;

        }

    return KErrNotFound;

    }

void MT_CFScriptEngine::CleanupSystemDrive()

    {

    iFileMan->RmDir( KCFPrivateFolder );

    }

void MT_CFScriptEngine::MT_CCFScriptEvent_NewLL(  )

    {

    EUNIT_ASSERT_DESC( EFalse, "Test case not implemented!" );

    }

void MT_CFScriptEngine::MT_CCFScriptEvent_ScriptIdL(  )

    {

    EUNIT_ASSERT_DESC( EFalse, "Test case not implemented!" );

    }

void MT_CFScriptEngine::MT_CCFScriptEvent_IdentifierL(  )

    {

    EUNIT_ASSERT_DESC( EFalse, "Test case not implemented!" );

    }

void MT_CFScriptEngine::MT_CCFScriptEvent_ParametersL(  )

    {

    EUNIT_ASSERT_DESC( EFalse, "Test case not implemented!" );

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_NewLL(  )

    {

    // below                                        // CLEANUP<< fakeEnv

    CCFFakeEnv* fakeEnv = CCFFakeEnv::NewLC();

    CCFScriptHandler* instance

        = CCFScriptHandler::NewL( *fakeEnv, iFs, *fakeEnv, *fakeEnv );

    CleanupStack::PushL ( instance );

    EUNIT_ASSERT_DESC ( instance, "CCFScriptHandler not created!" );

    CleanupStack::PopAndDestroy( instance );

    CleanupStack::PopAndDestroy( fakeEnv );         // CLEANUP<< fakeEnv

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_NewLCL(  )

    {

    // below                                        // CLEANUP<< fakeEnv

    CCFFakeEnv* fakeEnv = CCFFakeEnv::NewLC();

    CCFScriptHandler* instance

        = CCFScriptHandler::NewLC( *fakeEnv, iFs, *fakeEnv, *fakeEnv );

    EUNIT_ASSERT_DESC ( instance, "CCFScriptHandler not created!" );

    MCFStarterObserver* observer = (MCFStarterObserver*) instance;

    observer->InitializePhaseL( CCFPhaseBase::ECFDeviceStarting );

    observer->InitializePhaseL( CCFPhaseBase::ECFDeviceStarted );

    observer->InitializePhaseL( CCFPhaseBase::ECFStartEnd );

    CleanupStack::PopAndDestroy( instance );

    CleanupStack::PopAndDestroy( fakeEnv );         // CLEANUP<< fakeEnv

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_RemoveScriptByIdL(  )

    {

    RThread thread;

    CleanupClosePushL(thread);

    // Define context

    CCFContextObject* co = CCFContextObject::NewLC();

    static _LIT_SECURITY_POLICY_PASS( alwaysPass );

    co->SetSourceL(_L("t"));

    co->SetTypeL(_L("t.p.app"));

    TInt err = iCFFakeEnv->DefineContext( co->Source(),

            co->Type(), alwaysPass, alwaysPass );

    EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

    // load script

    HBufC8* script = LoadScriptFromFile(_L("test-equals.xml"));

    TInt id = iCFFakeEnv->AddScript(

            _L("test-equals.xml"), *script, thread.SecureId(), thread);

    EUNIT_ASSERT_DESC( id >= 0, "Parse error!" );

    delete script;

    // CONTEXT 1

    co->SetValueL(_L("ok"));

    iCFFakeEnv->ClearFireClientEvent();

    err = iCFFakeEnv->PublishContext( *co, thread );

    EUNIT_ASSERT_DESC( err == KErrNone, "PublishContext failed!" );

    EUNIT_ASSERT_DESC( iCFFakeEnv->ClientEventFired(), "Script did not fire event!" );

    EUNIT_ASSERT_DESC( iCFFakeEnv->ScriptEventScriptId() == id,

         "Script ID does not match!" );

    EUNIT_ASSERT_DESC( iCFFakeEnv->ScriptEventIdentifier() == _L("startApp"),

        "Identifier does not match!" );

    err = iCFFakeEnv->RemoveScriptById( id, thread );

    EUNIT_ASSERT( err == KErrNone );

    // Check that original script does not cause events anymore

    co->SetValueL(_L("notok"));

    iCFFakeEnv->ClearFireClientEvent();

    err = iCFFakeEnv->PublishContext( *co, thread );

    EUNIT_ASSERT_DESC( err == KErrNone, "PublishContext failed!" );

    EUNIT_ASSERT_DESC( !iCFFakeEnv->ClientEventFired(),

         "Script did fired although wrong context value!" );

    co->SetValueL(_L("ok"));

    iCFFakeEnv->ClearFireClientEvent();

    err = iCFFakeEnv->PublishContext( *co, thread );

    EUNIT_ASSERT_DESC( err == KErrNone, "PublishContext failed!" );

    EUNIT_ASSERT_DESC( !iCFFakeEnv->ClientEventFired(),

         "Script did fire event!" );

    CleanupStack::PopAndDestroy( co );

    CleanupStack::PopAndDestroy( &thread );

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_RemoveScriptsBySessionL(  )

    {

    RThread thread;

    CleanupClosePushL(thread);

    // Define and publish context

    static _LIT_SECURITY_POLICY_PASS( alwaysPass );

    TInt err = iCFFakeEnv->DefineContext( _L("t"),

            _L("t.p.app"), alwaysPass, alwaysPass );

    EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

    HBufC8* script = LoadScriptFromFile(_L("test-equals.xml"));

    TInt id1 = iCFFakeEnv->AddScript(

            _L("test-equals.xml"), *script, KMT_CfScriptEngineUid, thread);

    EUNIT_ASSERT_DESC( id1 >= 0, "Parse error!" );

    delete script;

    // Define context

    err = iCFFakeEnv->DefineContext( _L("Sensor"),

            _L("X.RawValue"), alwaysPass, alwaysPass );

    EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

    script = LoadScriptFromFile(_L("test-greater.xml"));

    TInt id2 = iCFFakeEnv->AddScript(

        _L("test-greater.xml"), *script, KMT_CfScriptEngineOtherUid, thread,

        *iDummyScriptEngineSession, NULL );

    EUNIT_ASSERT_DESC( id2 >= 0, "Parse error!" );

    delete script;

    // Define contexts

    err = iCFFakeEnv->DefineContext( _L("Application.State"),

            _L("Foreground.Application"), alwaysPass, alwaysPass );

    EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

    err = iCFFakeEnv->DefineContext( _L("Application.State"),

            _L("Foreground.View"), alwaysPass, alwaysPass );

    EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

    script = LoadScriptFromFile(_L("test-and.xml"));

    TInt id3 = iCFFakeEnv->AddScript(

            _L("test-and.xml"),*script, KMT_CfScriptEngineUid, thread);

    EUNIT_ASSERT_DESC( id3 >= 0, "Parse error!" );

    delete script;

    TInt numRemoved = iCFFakeEnv->RemoveScriptsBySession( *iCFFakeEnv );

    const RArray<TInt>& scriptIds = iCFFakeEnv->GetEveryScriptId();

    EUNIT_ASSERT_DESC( scriptIds.Count() == 1,

        "Wrong count of Ids in array!" );

    // Check that all Ids are found

    EUNIT_ASSERT ( FindIndex( scriptIds, id2 ) >= 0 );

    CleanupStack::PopAndDestroy( &thread );

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_RemoveScriptByNameL()

    {

    _LIT( KScriptName1, "test-and.xml" );

    _LIT( KScriptName2, "test-or.xml" );

    HBufC8* script1 = LoadScriptFromFile( KScriptName1 );

    HBufC8* script2 = LoadScriptFromFile( KScriptName2 );

    EUNIT_ASSERT_DESC( script1 && script2, "Scripts not loaded" );

    if( script1 && script2 )

        {

        CleanupStack::PushL( script1 );

        CleanupStack::PushL( script2 );

        const TUid KClient1Uid = {0x12340001};

        const TUid KClient2Uid = {0x12340002};

        // Define needed contexts for scripts

        static _LIT_SECURITY_POLICY_PASS( alwaysPass );

        TInt err = iCFFakeEnv->DefineContext( _L("Application.State"),

            _L("Foreground.Application"), alwaysPass, alwaysPass );

        EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

        err = iCFFakeEnv->DefineContext( _L("Application.State"),

            _L("Foreground.View"), alwaysPass, alwaysPass );

        EUNIT_ASSERT_DESC( err == KErrNone, "DefineContext failed!" );

        // Test data

        RThread thread;

        CleanupClosePushL( thread );

        TInt id = 0;

        TInt scriptCount = 0;

        // Add script 1 from client 1

        id = iCFFakeEnv->AddScript( KScriptName1, *script1,

            KClient1Uid, thread );

        EUNIT_ASSERT_DESC( id >= 0, "Add script failed" );

        scriptCount = iCFFakeEnv->NumberOfScripts();

        EUNIT_ASSERT_DESC( scriptCount == id, "Invalid number of scripts" );

        // Add script 2 from client 1

        id = iCFFakeEnv->AddScript( KScriptName2, *script2,

            KClient1Uid, thread );

        EUNIT_ASSERT_DESC( id >= 0, "Add script failed" );

        scriptCount = iCFFakeEnv->NumberOfScripts();

        EUNIT_ASSERT_DESC( scriptCount == id, "Invalid number of scripts" );

        // Add script 1 from client 2

        id = iCFFakeEnv->AddScript( KScriptName1, *script1,

            KClient2Uid, thread );

        EUNIT_ASSERT_DESC( id >= 0, "Add script failed" );

        scriptCount = iCFFakeEnv->NumberOfScripts();

        EUNIT_ASSERT_DESC( scriptCount == id, "Invalid number of scripts" );

        // Add script 2 from client 2

        id = iCFFakeEnv->AddScript( KScriptName2, *script1,

            KClient2Uid, thread );

        EUNIT_ASSERT_DESC( id >= 0, "Add script failed" );

        scriptCount = iCFFakeEnv->NumberOfScripts();

        EUNIT_ASSERT_DESC( scriptCount == id, "Invalid number of scripts" );

        // Remove script 1 by name from client 1

        err = iCFFakeEnv->RemoveScriptByName( KScriptName1, KClient1Uid );

        EUNIT_ASSERT_DESC( err == KErrNone, "Invalid return value" );

        scriptCount = iCFFakeEnv->NumberOfScriptsByOwner( KClient1Uid );

        EUNIT_ASSERT_DESC( scriptCount == 1, "Invalid number of scripts" );

        // Remove script 1 by name from client 2

        err = iCFFakeEnv->RemoveScriptByName( KScriptName1, KClient2Uid );

        EUNIT_ASSERT_DESC( err == KErrNone, "Invalid return value" );

        scriptCount = iCFFakeEnv->NumberOfScriptsByOwner( KClient2Uid );

        EUNIT_ASSERT_DESC( scriptCount == 1, "Invalid number of scripts" );

        // Remove script 2 by name from client 1

        err = iCFFakeEnv->RemoveScriptByName( KScriptName2, KClient1Uid );

        EUNIT_ASSERT_DESC( err == KErrNone, "Invalid return value" );

        scriptCount = iCFFakeEnv->NumberOfScriptsByOwner( KClient1Uid );

        EUNIT_ASSERT_DESC( scriptCount == 0, "Invalid number of scripts" );

        // Remove script 2 by name from client 2

        err = iCFFakeEnv->RemoveScriptByName( KScriptName2, KClient2Uid );

        EUNIT_ASSERT_DESC( err == KErrNone, "Invalid return value" );

        scriptCount = iCFFakeEnv->NumberOfScriptsByOwner( KClient2Uid );

        EUNIT_ASSERT_DESC( scriptCount == 0, "Invalid number of scripts" );

        // Clean up

        CleanupStack::PopAndDestroy( &thread );

        CleanupStack::PopAndDestroy( script2 );

        CleanupStack::PopAndDestroy( script1 );

        }

    }

void MT_CFScriptEngine::MT_CCFScriptHandler_RemoveScriptByUidL()

    {

    _LIT( KScriptName1, "test-and.xml" );

    _LIT( KScriptName2, "test-or.xml" );

    HBufC8* script1 = LoadScriptFromFile( KScriptName1 );

    HBufC8* script2 = LoadScriptFromFile( KScriptName2 );

    EUNIT_ASSERT_DESC( script1 && script2, "Scripts not loaded" );

    if( script1 && script2 )

        {

        CleanupStack::PushL( script1 );

        CleanupStack::PushL( script2 );

        // Define needed contexts for scripts