/*

* 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 CTestServer 

* class member functions.

*

*/

// INCLUDE FILES

#include <e32std.h>

#include <e32svr.h>

#include "TestEngineClient.h"

#include <StifTestModule.h>

#include <stifinternal/TestServerClient.h>

#include "TestServer.h"

#include "TestServerCommon.h"

#include <stifinternal/TestThreadContainerRunnerFactory.h>

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES  

// CONSTANTS

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// Struct to pass parameters to server thread

struct TThreadStartTestServer

    {

    TFileName  iName;         // Server name

    RThread    iServerThread; // The server thread

    RSemaphore iStarted;      // Startup syncronisation semaphore   

    TBool      iInNewThread;  // Is thread running in new process?

    TInt       iStartupResult;// Start-up result

    TBool      iUiTesting;    // Is it testserver for UI testing

    CTestThreadContainerRunnerFactory* iTestThreadContainerRunnerFactory; // Pointer to CTestThreadContainerRunner. Defined when

																		  // iUiTesting is true

    };

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

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

// None

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

/*

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

    Class: CTestServer

    Method: PanicServer

    Description: Panics the server. 

    Parameters: const TTestServerPanic aPanic: in: Panic code

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

void CTestServer::PanicServer( const TTestServerPanic aPanic )

    {

#ifdef USE_LOGGER

    // Check if logger is available, if so, use it.

    CStifLogger* log = (CStifLogger*) Dll::Tls();

    if ( log )

        {

        log->Log( CStifLogger::ERed, _L("TestServer.DLL Panic %d"), aPanic);

        }

#endif

    RDebug::Print( _L( "CTestServer::PanicServer" ) );

    _LIT( KTxtTestServer,"CTestServer" );

    User::Panic( KTxtTestServer,aPanic );

    }

/*

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

    Class: CTestServer

    Method: NewL

    Description: Returns new CTestServer object

    Parameters: const TFileName& aName: in: Server name

    Return Values: None

    Errors/Exceptions: Leaves if memory allocation, ConstructL or StartL leaves.

    Status: Approved

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

*/

CTestServer* CTestServer::NewL( const TFileName& aName )

    {

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

    CleanupStack::PushL( self );

    // Construct the server

    self->ConstructL( aName );

    // Start the server

    self->StartL( aName );

    CleanupStack::Pop( self );

    return self;

    }

/*

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

    Class: CTestServer

    Method: ConstructL

    Description: Second level constructor. Obtains pointer to library

    entrypoint.

    Parameters: const TFileName& aName: in: Server name

    Return Values: None

    Errors/Exceptions: Leaves if entrypoint can't be obtained.

    Status: Approved

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

*/

void CTestServer::ConstructL( const TFileName& aName )

    {

    // Construct heap buffer for configuration file

    iModuleNameBuffer = HBufC::NewL( aName.Length() );

    iModuleName.Set ( iModuleNameBuffer->Des() );

    iModuleName.Copy ( aName );

    iContainerIndex = CObjectConIx::NewL();

    }

/*

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

    Class: CTestServer

    Method: CTestServer

    Description: Constructor.

    Initialises non-zero member variables and base class with correct

    priority.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

CTestServer::CTestServer() : CServer2( CTestServer::ETestServerPriority ),

                             iModuleName(0, 0),

                             iSessionCount( 0 )

    {

    iFirstTime = ETrue;

    }

/*

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

    Class: CTestServer

    Method: ~CTestServer

    Description: Destructor

    Frees memory.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

CTestServer::~CTestServer()

    {

    delete iModuleNameBuffer;

    iModuleNameBuffer = NULL;

    delete iContainerIndex;

    iContainerIndex = NULL;

    }

/*

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

    Class: CTestServer

    Method: NewContainerL

    Description: Returns new container. Used to store subsessions

    Parameters: None

    Return Values: CObjectCon* New object container

    Errors/Exceptions: None

    Status: Approved

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

*/

CObjectCon* CTestServer::NewContainerL()

    {

    CObjectCon* container = iContainerIndex->CreateL();

    iSessionCount++;

    return container;

    }

/*

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

    Class: CTestServer

    Method: DeleteContainer

    Description: Deletes a container.

    Parameters: CObjectCon* aContainer: in: Container to be removed

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

void CTestServer::DeleteContainer( CObjectCon* aContainer )

    {

    iContainerIndex->Remove( aContainer );

    }

/*

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

    Class: CTestServer

    Method: SessionClosed

    Description: Inform Server that session is closed.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

void CTestServer::SessionClosed()

    {

    // Decrease session count

    iSessionCount--;

    // Check if last session is closed

    if ( iSessionCount <= 0 )

        {

        // Stop the active scheduler

        // Execution will continue in ThreadFunction()

        CActiveScheduler::Stop();

        }

    }

/*

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

    Class: CTestServer

    Method: NewSessionL

    Description: Returns new session.

    Parameters: const TVersion &aVersion: in: Version required

    Return Values: CSharableSession* New session

    Errors/Exceptions: Leaves if invalid version or CTestModule construction

                       leaves

    Status: Approved

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

*/

CSession2* CTestServer::NewSessionL( const TVersion& aVersion,

                                        const RMessage2& /*aMessage*/ ) const

    {

    // check version is ok

    TVersion v( KTestServerMajorVersionNumber,

                KTestServerMinorVersionNumber,

                KTestServerBuildVersionNumber

               );

    if( !User::QueryVersionSupported( v,aVersion ) )

        {

        User::Leave( KErrNotSupported );

        }

    return CTestModule::NewL( ( CTestServer* ) this );

    }

/*

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

    Class: CTestServer

    Method: ModuleName

    Description: Returns module name

    Parameters: None

    Return Values: const TDesC&* Module name

    Errors/Exceptions: None

    Status: Approved

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

*/

const TDesC& CTestServer::ModuleName() const

    {

    return iModuleName;

    }

/*

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

    Class: CTestServer

    Method: FirstTime

    Description: Is module already once initialised.

    Parameters: None

    Return Values: TBool Has module initialized?

    Errors/Exceptions: None

    Status: Approved

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

*/

//@spe const TBool CTestServer::FirstTime() const

TBool CTestServer::FirstTime() const

    {

    return iFirstTime;

    }

/*

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

    Class: CTestServer

    Method: ClearFirstTime

    Description: Clear module first time flag. 

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

void CTestServer::ClearFirstTime()

    {

    iFirstTime = EFalse;

    }

/*

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

    Class: CTestServer

    Method: ThreadFunction

    Description: The thread function, where Test Server lives in

    Parameters: TAny* aStarted: in: Start-up information

    Return Values: TInt Result from test module

    Errors/Exceptions: Clean-up stack can't be created because cannot

                       leave, error checks are done locally.

                       Panics if:

                       invalid start-up information

                       Test Server can't be started

    Status: Approved

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

*/

TInt CTestServer::ThreadFunction( TAny* aStarted )

    {

    __UHEAP_MARK;

    TInt error( KErrNone );

    // Get start-up information

    TThreadStartTestServer* startInfo = ( TThreadStartTestServer* ) aStarted;

    __ASSERT_ALWAYS( startInfo,PanicServer( ENoStartupInformation ) );

    // Create clean-up stack

    CTrapCleanup* tc = CTrapCleanup::New();

    __ASSERT_ALWAYS( tc, PanicServer(ECreateTrapCleanup));

    // Construct the logger

    TName path = _L("C:\\logs\\testframework\\testserver\\");

    TFileName name = _L("testserver_");

    name.Append ( startInfo->iName );

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

    TLoggerSettings loggerSettings;

    // Directory must create by hand if test server 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.iHardwareOutput = CStifLogger::EFile;

    loggerSettings.iEmulatorOutput = CStifLogger::EFile;

#else

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

    loggerSettings.iEmulatorFormat = CStifLogger::ETxt;

    loggerSettings.iHardwareOutput = CStifLogger::ERDebug;

    loggerSettings.iEmulatorOutput = CStifLogger::ERDebug;

#endif

    loggerSettings.iUnicode = EFalse;

    loggerSettings.iAddTestCaseTitle = EFalse;

    CStifLogger* logger = NULL;

    TRAP ( error, logger = CStifLogger::NewL( path, name, loggerSettings ) );

    // Thread Local Storage is used for get pointer to logger.

    Dll::SetTls ( logger );

    __TRACE( KInit,( _L( "TestServer.DLL server starting" ) ) );

    __TRACE( KInit,( CStifLogger::EBold, _L( "Loading module: %S"), &startInfo->iName ) );

    RLibrary module;

    TInt ret = KErrNone;

    TFileName newNameBuffer;

    TInt check = CheckModuleName( startInfo->iName, newNameBuffer );

    if( check == KErrNone )

        {

        // Load the module(TestScripter)

        ret = module.Load( newNameBuffer );

        }

    else

        {

        RemoveOptionalIndex(startInfo->iName, newNameBuffer);

        __TRACE(KInit, (CStifLogger::EBold, _L( "Valid module name is [%S] (extracted from [%S])"), &newNameBuffer, &startInfo->iName));

        // Load the module(Others)

        ret = module.Load(newNameBuffer);

        }

    // If test module loading fails, do not start server

    if( ret != KErrNone )

        {

         __TRACE( KError,( CStifLogger::ERed, _L( "Test module loading failed, code = %d" ), ret ) );

         __TRACE( KError,( _L( "Check that module is compiled properly and stored to correct directory and all DLLs that it requires are available" ) ) );