/*

* 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: This module contains implementation of 

* CTestEngineServer class member functions.

*

*/

// INCLUDE FILES

#include <e32std.h>

#include <e32svr.h>

#include <f32file.h>

#include "TestEngine.h"

#include "TestEngineClient.h"

#include "TestEngineCommon.h"

#include <stifinternal/TestServerClient.h>

#include "TestModuleController.h"

#include "TestCaseController.h"

#include "TestReport.h"

#include "Logging.h"

#include "SettingServerClient.h"

//--PYTHON-- begin

#include "StifPython.h"

#include "StifPythonFunEng.h"

//--PYTHON-- end

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES  

// None

// CONSTANTS

_LIT( KTestModule, "TestModule=" );

_LIT( KTestCaseFile, "TestCaseFile=" );

_LIT( KTestCaseNumber, "TestCaseNumber=" );

_LIT( KTestCaseTitle, "TestCaseTitle=" );

_LIT( KStateCode, "StateCode=" );

_LIT( KStateName, "StateName=" );

// MACROS

// None

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

struct TThreadStartTestEngine

    {   

    RThread    iEngineThread; // The server thread

    RSemaphore iStarted;      // Startup syncronisation semaphore   

    };

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

// None

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

/*

-------------------------------------------------------------------------------

    Class: CTestEngine

    Function: ErrorPrint

    Description: ErrorPrint

    Parameters: const TInt aPriority: in: Priority of error

                TPtrC aError: in: Error description

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::ErrorPrint( const TInt aPriority, 

                              TPtrC aError )

    {

    TErrorNotification error;

    TErrorNotificationPckg errorPckg ( error );

    error.iModule = _L("TestEngine");

    error.iPriority = aPriority;

    error.iText = aError;

    ErrorPrint( errorPckg );

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModule

    Method: ErrorPrint

    Description: Sends error notification

    Parameters: TErrorNotificationPckg aError: in: Error

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::ErrorPrint( TErrorNotificationPckg aError )

    {

    // Add new item to end of queue

     if ( iErrorQueue.Append ( aError() ) != KErrNone )

            {

            RDebug::Print (_L("Error message lost"));

            return;

            }

    ProcessErrorQueue();

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModule

    Method: ProcessErrorQueue

    Description: Process error queue

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::ProcessErrorQueue()

    {

    // If message is available, complete first item from queue

    if ( iErrorMessageAvailable )

        {

        if ( iErrorQueue.Count() > 0 )

            {

            TErrorNotification err = iErrorQueue[0];

            TErrorNotificationPckg errPckg(err);

            iErrorQueue.Remove(0);

        	TInt r( KErrNone );

            TRAP( r, iErrorMessage.WriteL( 0, errPckg ) );

            // Do not handle errors

            iErrorMessageAvailable = EFalse;

            iErrorMessage.Complete( KErrNone );

            }

        }

    }

/*

-------------------------------------------------------------------------------

    Function: LeaveIfErrorWithNotify

    Description: If error leave with notify

    Parameters: TInt aCode: in: Error code

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::LeaveIfErrorWithNotify( TInt aCode )

      {

      LeaveIfErrorWithNotify ( aCode, _L("Check testengine log") );

      }

/*

-------------------------------------------------------------------------------

    Function: LeaveIfErrorWithNotify

    Description: If error leave with notify

    Parameters: TInt aCode: in: Error code

                const TDesC& aText: in: Descriptive text

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::LeaveIfErrorWithNotify( TInt aCode,

                                          const TDesC& aText )

    {

    if ( aCode != KErrNone )

        {

           LeaveWithNotifyL ( aCode, aText );

        }

    }

/*

-------------------------------------------------------------------------------

    Function: LeaveWithNotifyL

    Description: Leave with notify

    Parameters: TInt aCode: in: Error code

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::LeaveWithNotifyL( TInt aCode )

    {

    LeaveWithNotifyL ( aCode, _L("Check testengine log") );

    }

/*

-------------------------------------------------------------------------------

    Function: LeaveWithNotifyL

    Description: Leave with notify

    Parameters: TInt aCode: in: Error code

                const TDesC& aText: in: Descriptive text

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngine::LeaveWithNotifyL( TInt aCode,

                                   const TDesC& aText )

    {

    ErrorPrint ( 0, aText );

    User::Leave ( aCode );

    }

#define LOGGER iLogger

/*

-------------------------------------------------------------------------------

    Function: ThreadFunction

    Description: The thread function, where Test Engine lives in.

    Parameters: TAny* aStarted: in: Start info

    Return Values: TInt: Returns always KErrNone

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

TInt CTestEngineServer::ThreadFunction( TAny* aStarted )

    {

//    __UHEAP_MARK;

    // Create cleanup stack

    CTrapCleanup* cleanup = CTrapCleanup::New();

    __ASSERT_ALWAYS( cleanup, PanicServer( ECreateTrapCleanup ) );

    // Get start-up information

    TThreadStartTestEngine* startInfo = ( TThreadStartTestEngine* ) aStarted;

    __ASSERT_ALWAYS( startInfo, PanicServer( ENoStartupInformation ) );

    // Construct and install active scheduler

    CActiveScheduler* scheduler = new CActiveScheduler;

    __ASSERT_ALWAYS( scheduler, PanicServer( EMainSchedulerError ) );

    CActiveScheduler::Install( scheduler );

    // Construct server, an active object

    CTestEngineServer* server = NULL;

    TRAPD( err, server = CTestEngineServer::NewL() );

    __ASSERT_ALWAYS( !err, PanicServer( ESvrCreateServer ) );

    // Inform that we are up and running

    startInfo->iStarted.Signal();

    // Global mutex(handling according to the name)

    RMutex startupMutex;

    // Try to create global mutex, CREATE

    TInt ret = startupMutex.CreateGlobal( KStifTestServerStartupMutex );

    if( ret != KErrNone )

        {

        // Mutex already create, OPEN

        ret = startupMutex.OpenGlobal( KStifTestServerStartupMutex );

        }

    if( ret != KErrNone )

        {

        // Not able to create or open mutex

        return ret;

        }

    // Start handling requests

    CActiveScheduler::Start();

    startupMutex.Close();

    // Should come here after RTestEngineServer is closed

    delete server;

    delete scheduler;

    delete cleanup;

//    __UHEAP_MARKEND;

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestEngineServer

    Method: CTestEngineServer

    Description: Default constructor

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

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestEngineServer::CTestEngineServer() :

    CServer2( CTestEngineServer::ETestEngineServerPriority ),

    iSessionCount( 0 )

    {

    }

/*

-------------------------------------------------------------------------------

    Class: CTestEngineServer

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: Leaves if CObjectConIx::NewL leaves

                       Leaves if CStifLogger::NewL leaves

                       Leaves if StartL leaves

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestEngineServer::ConstructL()

    {

    // Create container

    iContainerIndex = CObjectConIx::NewL();

    // Create logger, in Wins use HTML in HW default logger

    TLoggerSettings loggerSettings;

    // Directory must create by hand if test engine log wanted

    loggerSettings.iCreateLogDirectories = EFalse;

    loggerSettings.iOverwrite = ETrue;

    loggerSettings.iTimeStamp = ETrue;

    loggerSettings.iLineBreak = ETrue;

    loggerSettings.iEventRanking = EFalse;

    loggerSettings.iThreadId = EFalse;

    loggerSettings.iHardwareFormat = CStifLogger::ETxt;

#ifndef FORCE_STIF_INTERNAL_LOGGING_TO_RDEBUG

    loggerSettings.iEmulatorFormat = CStifLogger::EHtml;

    loggerSettings.iEmulatorOutput = CStifLogger::EFile;

    loggerSettings.iHardwareOutput = CStifLogger::EFile;

#else

    RDebug::Print( _L( "STIF Test Engine logging forced to RDebug" ) );

    loggerSettings.iEmulatorFormat = CStifLogger::ETxt;

    loggerSettings.iEmulatorOutput = CStifLogger::ERDebug;

    loggerSettings.iHardwareOutput = CStifLogger::ERDebug;

#endif

    loggerSettings.iUnicode = EFalse;

    loggerSettings.iAddTestCaseTitle = EFalse;

    iLogger = CStifLogger::NewL( _L( "C:\\logs\\testframework\\testengine\\"),

                                    _L( "testengine" ),

                                    loggerSettings );

    // Start Server

    StartL( KTestEngineName );

    __TRACE(KVerbose, (_L( "CTestEngineServer::ConstructL: Server Created" ) ) );

    }

/*

-------------------------------------------------------------------------------

    Class: CTestEngineServer

    Method: NewL

    Description: Two-phased constructor.

    Parameters: None

    Return Values: CTestEngineServer* : pointer to CTestEngineServer object

    Errors/Exceptions: Leaves if construction of CBufferArray fails

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestEngineServer* CTestEngineServer::NewL()

    {

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

    CleanupStack::PushL( self );      

    self->ConstructL();

    CleanupStack::Pop();

    return self;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestEngineServer

    Method: ~CTestEngineServer

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestEngineServer::~CTestEngineServer()

    {

    delete iContainerIndex; 

    __TRACE(KAlways, ( _L( "---------------- Log Ended ----------------" ) ) );

    delete iLogger;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestEngineServer

    Method: NewContainerL

    Description: Create new container

    Parameters: None

    Return Values: None

    Errors/Exceptions: Leaves if called CreateL method leaves

    Status: Approved

-------------------------------------------------------------------------------

*/