// Copyright (c) 2006-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:

// Name        : CSatTsy.cpp

// Part of     : Common SIM ATK TSY / commonsimatktsy

// Main entry point for Etel requests

// Version     : 1.0  

//

//  INCLUDE FILES

#include <etelsat.h>                // Etel SAT API

#include <satcs.h>                  // Etel SAT API

//#include "CMmPhoneTsy.h"			// Phone Tsy class

#include "CSatDataPackage.h"		// For data packages

//#include "MmTsy_numberOfSlots.h"    // Number of Slots

#include "cmmmessagemanagerbase.h"	// Message manager base

#include <ctsy/pluginapi/mmessagerouter.h>

#include <ctsy/serviceapi/mctsysatservice.h>

//#include "CMmMessageRouterBase.h"	// Message router

//#include "CMmSmsTsy.h"              // MmSmsTsy

//#include "CMmMessageManager.h"      // Message manager

#include "CSatTsy.h"				// Messaging class

#include "CSatCCTsy.h"              // SatCallControl class

#include "CSatIconTsy.h"            // SatIcon class

#include "CSatNotificationsTsy.h"   // SatNotifications class

#include "CSatNotifySetUpCall.h"    // CSatNotifySetUpCall    

#include "CSatEventDownloadTsy.h"   // SatEventDownload class

#include "CSatDataDownloadTsy.h"    // SatDataDownload class

#include "msattsy_ipcdefs.h"		// Sat Tsy specific request types

#include "TfLogger.h"               // For TFLOGSTRING

#include "TSatUtility.h"		    // Sat Tsy Utility class

#include "TTlv.h"					// TTlv class

#include "CSatTsyReqHandleStore.h"  // Request handle storage

#include "stktsy_number_of_slots.h"

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

// CSatTsy::NewL

// Two-phased constructor.

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

//

CSatTsy* CSatTsy::NewL

		(

		MMessageRouter& aMmMessageRouter,

		MCtsySatService& aSatService

		)

    {

    TFLOGSTRING("CSAT: CSatTsy::NewL");

	// Create subsession

    CSatTsy* subsession = new ( ELeave ) CSatTsy( aMmMessageRouter, aSatService );

    CleanupStack::PushL( subsession );

    subsession->ConstructL();

    CleanupStack::Pop();

	TFLOGSTRING("CSAT: CSatTsy::NewL, end of method");

    return subsession;

    }

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

// CSatTsy::~CSatTsy

// Destructor

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

// 

CSatTsy::~CSatTsy

		(

		// None

		)

    {

    TFLOGSTRING("CSAT: CSatTsy::~CSatTsy");

    // Unregister.

    iMessageManager->RegisterTsyObject(

		CMmMessageManagerBase::ESatTsyObjType, NULL );

    // Delete also specific TSY objects

    delete iSatCCTsy;

    delete iSatIconTsy;

    delete iSatNotificationsTsy;

    delete iSatDataDownloadTsy;

    delete iSatEventDownloadTsy;

	// Message router and message manager are deleted here

    delete iMessageManager;

    // Request handle store

    delete iSatReqHandleStore;

    TFLOGSTRING("CSAT: CSatTsy::~CSatTsy, end of method");

    }

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

// CSatTsy::CSatTsy

// C++ constructor

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

//

CSatTsy::CSatTsy

		( 

        MMessageRouter& aMmMessageRouter,

        MCtsySatService& aSatService

		): 

		iMessageRouter ( aMmMessageRouter ),

		iSatService(aSatService)

    {

    // None

    }

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

// CSatTsy::ConstructL

// Symbian 2nd phase constructor. Initialises internal attributes.

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

//

void CSatTsy::ConstructL

		( 

        )

    { 

    TFLOGSTRING("CSAT: CSatTsy::ConstructL");

    // Set pointer to the message router 

    iMessageManager = CMmMessageManagerBase::NewL(iMessageRouter);

    // Register

    iMessageManager->RegisterTsyObject(

		CMmMessageManagerBase::ESatTsyObjType, this );

    // Create request handle store

    iSatReqHandleStore = CSatTsyReqHandleStore::NewL( 

        ESatMaxNumOfRequests, iSatReqHandles );

	// Create IconTsy instance

	iSatIconTsy = CSatIconTsy::NewL( this );

	// Create NotificationsTsy instance

	iSatNotificationsTsy = CSatNotificationsTsy::NewL( 

        this, iSatReqHandleStore );              

    // Create CCTsy instance

    iSatCCTsy = CSatCCTsy::NewL( this, iSatNotificationsTsy );

    // Create DataDownloadTsy instance

    iSatDataDownloadTsy = CSatDataDownloadTsy::NewL( this );

    // Create EventDownloadTsy instance

	iSatEventDownloadTsy = CSatEventDownloadTsy::NewL( this );

    // Request to read Cbmids

#ifdef USING_CTSY_DISPATCHER

	//Commented out due to not seemingly doing anything as the STK TSY does not hold EF_cbmid cache

    //iSatDataDownloadTsy->CompleteReadCbmidsL( );

    // Request Network status (removed as no known completion)   

    //iMessageManager->HandleRequestL( ESatTsyNetStatus );

    // Check if guardians should be activated (removed as no known completion)

	//iMessageManager->HandleRequestL( ESatTsyCallControlActivation );

	//Check if the SIM card suppords USSD tlv's in the call control envelopes (removed as no known completion)

	//iMessageManager->HandleRequestL( ESatTsyUssdControlActivation );

	// Get the default bearer data

	iMessageManager->HandleRequestL( ESatTsyGetBearerCapability );

	//prime the cached version of this setting

	iMessageManager->HandleRequestL( ESatTsyUssdStatus);

#else

	iSatDataDownloadTsy->CompleteReadCbmidsL( );

	// Request Network status    

	iMessageManager->HandleRequestL( ESatTsyNetStatus );

	// Check if guardians should be activated

	iMessageManager->HandleRequestL( ESatTsyCallControlActivation );

	//Check if the SIM card suppords USSD tlv's in the call control envelopes

	iMessageManager->HandleRequestL( ESatTsyUssdControlActivation );

	// Get the default bearer data

	iMessageManager->HandleRequestL( ESatTsyGetBearerCapability );

#endif //USING_CTSY_DISPATCHER

	// Notify Licencee SIM ATK TSY that we are ready to receive messages

	iMessageManager->HandleRequestL( ESatTsyReady );

	// Get SMS Point to Point Data Download support status

    iMessageManager->HandleRequestL( ESatTsySmsPpDdlStatus );

	TFLOGSTRING("CSAT: CSatTsy::ConstructL, end of method");

    }

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

// CSatTsy::ExtFunc

// TRAP's all CSatTsy related Etel API requests in cases that they fail.

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

//

TInt CSatTsy::ExtFunc

		( 

		const TTsyReqHandle aTsyReqHandle,  

		const TInt aIpc,           

		const TDataPackage& aPackage        

		)

    {

    TFLOGSTRING3("CSAT: CSatTsy::ExtFunc ReqHandle=%d IPC=%d", aTsyReqHandle, 

        aIpc);

	TInt ret( KErrNone );

    // Some SAT functions need trapping so we use two level function where 

    // first one is just a trap harness

    // It is responsibility of IPC handling functions to always handle 

    // calling ReqComplete, ( it must either call it, or arrange it to 

    // be called in some way ), except in the case of Leave. It is also 

    // assumed that if after IPC handling function has called ReqComplete, 

    // then it doesn't Leave.

    TInt trapError( KErrNone );

    TRAP( trapError, ret = DoExtFuncL( aTsyReqHandle, aIpc, aPackage ) );

    if ( KErrNone != trapError )

        {

        TFLOGSTRING2("CSAT: CSatTsy::ExtFunc, trapError: %d", trapError );

        ReqCompleted( aTsyReqHandle, trapError );

        }

	else if ( KErrNone != ret )

        {

        TFLOGSTRING2("CSAT: CSatTsy::ExtFunc, ret: %d", ret);

        ReqCompleted( aTsyReqHandle, ret );

        }

    else										

	    {

        // Reset last Tsy request type

        iReqHandleType = ESatReqHandleUnknown;

        }

    return KErrNone;

    }

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

// CSatTsy::SaveReqHandle

// Saves the request handle

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

//

void CSatTsy::SaveReqHandle

		( 

		const TTsyReqHandle aTsyReqHandle,  

        const TSatRequestTypes aSatRequestType

		)

    {

    TFLOGSTRING3("CSAT: CSatTsy::SaveReqHandle ReqHandle=%d ReqHandleType=%d", 

        aTsyReqHandle, aSatRequestType);

    // Don't save the request handle if the type is unknown.

    if ( ESatReqHandleUnknown != aSatRequestType )

        {

        iSatReqHandleStore->SetTsyReqHandle( aSatRequestType, aTsyReqHandle );

        }

    }

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

// CSatTsy::ReqModeL

// Mode service function used by ETel, request mode. ReqModeL is called from 

// the server's CTelObject::ReqAnalyserL in order to check the type of request

// it has.

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

//

CTelObject::TReqMode CSatTsy::ReqModeL

		( 

		const TInt aIpc    

		)

    {

    TFLOGSTRING("CSAT: CSatTsy::ReqModeL.");

    CTelObject::TReqMode ret = 0;

    switch ( aIpc )

        {

        // Multiple Completion Services

        case ESatNotifyDisplayTextPCmd:

        case ESatNotifyGetInkeyPCmd:

        case ESatNotifyGetInputPCmd:

        case ESatNotifyPlayTonePCmd:

        case ESatNotifySetUpMenuPCmd:

        case ESatNotifySelectItemPCmd:

        case ESatNotifySendSmPCmd:

        case ESatNotifySendSsPCmd:

        case ESatNotifySendUssdPCmd:

        case ESatNotifySetUpCallPCmd:

        case ESatNotifyRefreshPCmd:

        case ESatNotifyRefreshRequiredParam:

        case ESatRefreshAllowed:        

        case ESatNotifyCallControlRequest:

        case ESatNotifySendDtmfPCmd:

        case ESatNotifyMoSmControlRequest:

        case ESatNotifySetUpEventListPCmd:

        case ESatNotifySetUpIdleModeTextPCmd:

        case ESatNotifyProactiveSimSessionEnd:

        case ESatNotifyLaunchBrowserPCmd:

        case ESatNotifyPollingIntervalPCmd:

        case ESatNotifyPollingOffPCmd:

        case ESatNotifyLanguageNotificationPCmd:

        case ESatNotifyLocalInfoPCmd:

        case ESatNotifyOpenChannelPCmd:

        case ESatNotifyGetChannelStatusPCmd:

        case ESatNotifyCloseChannelPCmd:

        case ESatNotifySendDataPCmd:

        case ESatNotifyReceiveDataPCmd:               

            {

            ret = KReqModeMultipleCompletionEnabled;

            break;

            }

        // Non-flow Controlled Services

        case ESatTerminalRsp:

        case ESatMenuSelection:

        case ESatEventDownload:

        case ESatGetIcon:

        case ESatGetImageInstance:

        case ESatGetClut:

        case ESatGetMeSideSatProfile:

        case ESatClientSatProfileIndication:

        case ESatSendMessageNoLogging:

            {

            break;

            }

        default:

            {

            TFLOGSTRING2("CSAT: CSatTsy::ReqModeL unsupported IPC %d", aIpc);

            User::Leave( KErrNotSupported );

            break;

            }

        }

    return ret;

    }

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

// CSatTsy::CancelService

// Cancels Sat requests

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

//

TInt CSatTsy::CancelService

		( 

		const TInt aIpc,           

		const TTsyReqHandle aTsyReqHandle   

		)

    {

    TFLOGSTRING3("CSAT: CSatTsy::CancelService ReqHandle=%d IPC=%d", 

        aTsyReqHandle, aIpc);

    TInt ret( KErrNotSupported );

	// When the clients close their sub-sessions (eg. by calling RLine::Close), 

    // they may not have cancelled all their outstanding asynchronous requests 

    // before closing.  It is up to the ETel server to clean up in this 

    // situation, so the server will find the list of outstanding requests 

    // related to that sub-session object and pass these outstanding IPC 

    // request numbers, one at a time, to the CancelService method in the TSY.

    switch ( aIpc )

        {

        case ESatTerminalRsp:

        case ESatMenuSelection:

        //case ESatSendMessageNoLogging:

            {

            ret = KErrNone;

            break;

            }

        case ESatNotifyCallControlRequest:

		case ESatNotifyMoSmControlRequest:        

        case ESatNotifyDisplayTextPCmd:

        case ESatNotifyGetInkeyPCmd:

        case ESatNotifyGetInputPCmd:

        case ESatNotifyPlayTonePCmd:

        case ESatNotifySetUpMenuPCmd:

        case ESatNotifySelectItemPCmd:

        case ESatNotifySetUpCallPCmd:

        case ESatNotifySendSmPCmd:

        case ESatNotifySendSsPCmd:

        case ESatNotifySendUssdPCmd:   

        case ESatNotifyRefreshPCmd:

        case ESatNotifyRefreshRequiredParam:

        case ESatNotifySetUpIdleModeTextPCmd:

        case ESatNotifySendDtmfPCmd:

        case ESatNotifyLaunchBrowserPCmd:

        case ESatNotifyLocalInfoPCmd:

        case ESatNotifyLanguageNotificationPCmd:

        case ESatNotifySetUpEventListPCmd:

        case ESatNotifyProactiveSimSessionEnd:

        case ESatNotifyOpenChannelPCmd:

        case ESatNotifyGetChannelStatusPCmd:

        case ESatNotifyCloseChannelPCmd:

        case ESatNotifySendDataPCmd:

        case ESatNotifyReceiveDataPCmd:       

            {

            ret = iSatNotificationsTsy->CancelService ( aIpc, aTsyReqHandle );

            break;

            }

        case ESatEventDownload:

            {

            ret = iSatEventDownloadTsy->CancelService ( aIpc, aTsyReqHandle );

            break;

            }

        // Following functions are not supported, hence they are completed

        // by DoExtFuncL function at once.

        // ETel server will not pass cancel function to SAT, because the 

        // request is not 'ON' in ETel.

        // They are listed here for future reference.

        //

        // ESatNotifyMoSmControlRequest

        // ESatEventDownload

        // ESatGetMeSideSatProfile

        default:

            {

            TFLOGSTRING2("CSAT: CSatTsy::CancelService invalid IPC %d", aIpc);

            ret = KErrGeneral; 

            break;           	

            }

        }

    return ret;

    }

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

// CSatTsy::RegisterNotification

// ETel Server subscribe notifications from NOS. RegisterNotification is called

// when the server recognises that this notification is being posted for the 

// first time on this sub-session object. It enables the TSY to "turn on" any 

// regular notification messages that it may receive from the phone.

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

//

TInt CSatTsy::RegisterNotification

		( 

		const TInt aIpc    // IPC number of request

		)

    {

    TFLOGSTRING("CSAT: CSatTsy::RegisterNotification.");

    // Initialize return value

    TInt ret( KErrNone );

    switch ( aIpc )

        {

        case ESatNotifyDisplayTextPCmd:

        case ESatNotifyGetInkeyPCmd:

        case ESatNotifyGetInputPCmd:

        case ESatNotifyPlayTonePCmd:

        case ESatNotifySetUpMenuPCmd:

        case ESatNotifySelectItemPCmd:

        case ESatNotifySendSmPCmd:

        case ESatNotifySendSsPCmd:

        case ESatNotifySendUssdPCmd:

        case ESatNotifySetUpCallPCmd:

        case ESatNotifyRefreshPCmd:

        case ESatNotifyRefreshRequiredParam:

        case ESatRefreshAllowed:        

        case ESatNotifyProactiveSimSessionEnd:

        case ESatNotifySetUpIdleModeTextPCmd:

        case ESatNotifyLaunchBrowserPCmd:

        case ESatNotifyCallControlRequest:

		case ESatNotifySendDtmfPCmd:

        case ESatNotifySetUpEventListPCmd:

        case ESatNotifyLanguageNotificationPCmd:

        case ESatNotifyLocalInfoPCmd:

        case ESatNotifyMoSmControlRequest:

        case ESatNotifyOpenChannelPCmd:

        case ESatNotifyGetChannelStatusPCmd:

        case ESatNotifyCloseChannelPCmd:

        case ESatNotifySendDataPCmd:

        case ESatNotifyReceiveDataPCmd:      

            {

            // Ret already set to KErrNone

            break;

            }

        default:

            {

            // Unknown or invalid IPC

            TFLOGSTRING2("CSAT: CSatTsy::RegisterNotification, \

                Unsupported IPC %d", aIpc);

            ret = KErrNotSupported;

            break;

            }

        }

    return ret;

    }

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

// CSatTsy::DeregisterNotification

// ETel server unsubscribe notifications from NOS. DeregisterNotification is 

// called when the server recognizes that this notification will not be posted 

// again because the last client to have a handle on this sub-session object  

// has just closed the handle. It enables the TSY to "turn off" any regular 

// notification messages that it may receive from the phone.

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

//

TInt CSatTsy::DeregisterNotification

		( 

		const TInt aIpc    // IPC number of request

		)

    {

    TFLOGSTRING("CSAT: CSatTsy::DeregisterNotification.");

    // Initialize return value

    TInt ret( KErrNone );

    switch ( aIpc )

        {

        case ESatNotifyDisplayTextPCmd:

        case ESatNotifyGetInkeyPCmd:

        case ESatNotifyGetInputPCmd:

        case ESatNotifyPlayTonePCmd:

        case ESatNotifySetUpMenuPCmd:

        case ESatNotifySelectItemPCmd:

        case ESatNotifySendSmPCmd:

        case ESatNotifySendSsPCmd:

        case ESatNotifySendUssdPCmd:

        case ESatNotifySetUpCallPCmd:

        case ESatNotifyRefreshPCmd:

        case ESatNotifyRefreshRequiredParam:

        case ESatRefreshAllowed:        

        case ESatNotifyProactiveSimSessionEnd:

        case ESatNotifySetUpIdleModeTextPCmd:

        case ESatNotifyLaunchBrowserPCmd:

        case ESatNotifyCallControlRequest:

		case ESatNotifySendDtmfPCmd:		

        case ESatNotifySetUpEventListPCmd:

        case ESatNotifyLanguageNotificationPCmd:

        case ESatNotifyLocalInfoPCmd:

        case ESatNotifyOpenChannelPCmd:

        case ESatNotifyGetChannelStatusPCmd:

        case ESatNotifyMoSmControlRequest:

        case ESatNotifyCloseChannelPCmd:

        case ESatNotifySendDataPCmd:

        case ESatNotifyReceiveDataPCmd: