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

//

//  INCLUDE FILES

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "CMmSIMTsyTraces.h"

#endif

#include "CMmSIMTsy.h"

#include <ctsy/pluginapi/cmmdatapackage.h>

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

CMmSIMTsy::CMmSIMTsy():

    iReqHandleType(ESIMTsyReqHandleUnknown)

    {

    }

void CMmSIMTsy::ConstructL(

    CMmCustomTsy* aMmCustomTsy )

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_CONSTRUCTL_1, "TSY: CMmSIMTsy::ConstructL");

    iMmCustomTsy = aMmCustomTsy;

    // Create req handle store

#ifdef REQHANDLE_TIMER

    iTsyReqHandleStore = CMmTsyReqHandleStore::NewL( iMmCustomTsy,

        iMmCustomTsy->iMmPhoneTsy, ESIMRequestTypeMaxNumOfRequests,

        iSIMReqHandles );

#else

   iTsyReqHandleStore = CMmTsyReqHandleStore::NewL(

        ESIMRequestTypeMaxNumOfRequests, iSIMReqHandles );

#endif // REQHANDLE_TIMER

    // By default VIAG parameters are not requested. This means that

    // when "SIM ready" indication is received, TSY will not check

    // if it needs to read VIAG parameters or not.

    iViagParamsReadRequested = EFalse;

    // Initialize pointer to NULL.

    iCurrentlyRetrievedCache = NULL;

    // create the o2 HomeZone dynamic cache

    // IGNORE if this fails due to Out-of-Memory problem

    TInt leaveCode;

    TRAP( leaveCode, iViagDynamicCache = new ( ELeave )

        CArrayFixFlat<RMmCustomAPI::TViagCacheRecordContent>( 

        ( KPhEngMaxViagHomeZones * KPhEngMaxCacheId ) ); );

    if ( leaveCode )

        {

        iViagDynamicCache = NULL;

        }

    else

        {

        // initialise

        RMmCustomAPI::TViagCacheRecordContent zero;

        zero.iLac = 0xFFFF;

        zero.iCellId = 0xFFFF;

        iViagDynamicCache->AppendL( zero, ( KPhEngMaxViagHomeZones * 

            KPhEngMaxCacheId ) );

        iViagHomeZoneCacheReady = EFalse;

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_CONSTRUCTL_3, "TSY: CMmSIMTsy::ConstructL: o2 HomeZone dynamic cache array created.");

        }

    }

CMmSIMTsy* CMmSIMTsy::NewL(

    CMmCustomTsy* aMmCustomTsy )

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_NEWL_1, "TSY: CMmSIMTsy::NewL");

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

    CleanupStack::PushL( self );

    self->ConstructL( aMmCustomTsy );

    CleanupStack::Pop( self );

    return self;

    }

CMmSIMTsy::~CMmSIMTsy()

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_DTOR_1, "TSY: CMmSIMTsy::~CMmSIMTsy()");

    // delete all CB ID related

    ResetAndDestroySimCbTopics();

    delete iTsyReqHandleStore;

    delete iViagDynamicCache; 

    delete iCurrentlyRetrievedCache; 

    }

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

// CMmSIMTsy::Init

// Initialisation method that is called from ETel Server.

// (other items were commented in a header).

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

//

void CMmSIMTsy::Init()

    {

    }

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

// CMmSIMTsy::SupportingIPC

// Tells whether the object supports given IPC.

// (other items were commented in a header).

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

//

TBool CMmSIMTsy::SupportingIPC(

    TInt  aIpc )

    {

    TInt ret( EFalse );

    switch ( aIpc )

        {

        case EReadViagHomeZoneParamsIPC:

        case EReadViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneUHZIUESettingsIPC:

        case ECustomStartSimCbTopicBrowsingIPC:

        case ECustomGetNextSimCbTopicIPC:

        case ECustomDeleteSimCbTopicIPC:

            ret = ETrue;

            break;

        default:

            ret = EFalse;

            break;

        }

    return ret;

    }

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

// CMmSIMTsy::DoExtFuncL

// Dispatches extension function requests.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::DoExtFuncL(

    const TTsyReqHandle aTsyReqHandle, 

    const TInt aIpc, 

    const TDataPackage& aPackage )

    {

    TInt ret( KErrGeneral );

    // Ensure the ReqHandleType is unset.

    // This will detect cases where this method indirectly calls itself

    // (e.g. servicing a client call that causes a self-reposting notification to complete and thus repost).

    // Such cases are not supported because iReqHandleType is in the context of this class instance,

    // not this request, and we don't want the values set by the inner request and the outer request

    // interfering with each other.

    __ASSERT_DEBUG(iReqHandleType==ESIMTsyReqHandleUnknown, User::Invariant());

    switch ( aIpc )

        {

        case EReadViagHomeZoneParamsIPC:

            ret = ReadViagHomeZoneParamsL(

                REINTERPRET_CAST( RMmCustomAPI::TViagParams*, aPackage.Ptr1() 

                ), REINTERPRET_CAST( RMmCustomAPI::TViagElement*,

                aPackage.Ptr2() ) );

            break;

        case EReadViagHomeZoneCacheIPC:

            ret = ReadDynamicViagHomeZoneCacheL( aTsyReqHandle, 

                REINTERPRET_CAST( RMmCustomAPI::TViagCacheRecordId*, 

                aPackage.Ptr1() ), REINTERPRET_CAST(

                RMmCustomAPI::TViagCacheRecordContent*, aPackage.Ptr2() ) );

            break;

        case EWriteViagHomeZoneCacheIPC:

            ret = WriteViagHomeZoneCacheL(

                REINTERPRET_CAST( RMmCustomAPI::TViagCacheRecordId*, 

                    aPackage.Ptr1() ), REINTERPRET_CAST( 

                    RMmCustomAPI::TViagCacheRecordContent*, aPackage.Ptr2() )

                    );

            break;

        case ECustomStartSimCbTopicBrowsingIPC:

            ret = StartSimCbTopicBrowsingL( aTsyReqHandle );

            break;

        case ECustomGetNextSimCbTopicIPC:

            ret = GetNextSimCbTopic( aTsyReqHandle, REINTERPRET_CAST( 

                  RMmCustomAPI::TSimCbTopic*, aPackage.Ptr1()) );

            break;

        case ECustomDeleteSimCbTopicIPC:

            ret = DeleteSimCbTopicL( aTsyReqHandle, REINTERPRET_CAST(TUint*, 

                aPackage.Ptr1() ) );

            break;

        case EWriteViagHomeZoneUHZIUESettingsIPC:

            ret = WriteViagHomeZoneUHZIUESettingsL( REINTERPRET_CAST(

                RMmCustomAPI::TViagUHZIUESettings*, aPackage.Ptr1() ) );

            break;

        default:

            ret = KErrNotSupported;

            break;

        }

    // save request handle

    if ( ESIMTsyReqHandleUnknown != iReqHandleType )

        {

#ifdef REQHANDLE_TIMER

        SetTypeOfResponse( iReqHandleType, aTsyReqHandle );

#else

        iTsyReqHandleStore->SetTsyReqHandle( iReqHandleType, aTsyReqHandle );

#endif // REQHANDLE_TIMER

        // We've finished with this value now. Clear it so it doesn't leak

        //  up to any other instances of this method down the call stack

        iReqHandleType = ESIMTsyReqHandleUnknown;

        }

    return ret;

    }

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

// CMmSIMTsy::ReqModeL

// Returns request mode for given IPC. Leaves with error code KErrNotSupported

// if the IPC number does not belong to some of the SIM API functions.

// (other items were commented in a header).

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

//

CTelObject::TReqMode CMmSIMTsy::ReqModeL(

    const TInt aIpc )

    {

    CTelObject::TReqMode ret = 0;

    switch ( aIpc )

        {

        case EReadViagHomeZoneParamsIPC:

        case EReadViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneUHZIUESettingsIPC:

        case ECustomStartSimCbTopicBrowsingIPC:

        case ECustomGetNextSimCbTopicIPC:

        case ECustomDeleteSimCbTopicIPC:

            ret = 0;    // flow control in tsy

            break;

        default:

            User::Leave( KErrNotSupported );

            break;

        }

    return ret;

    }

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

// CMmSIMTsy::NumberOfSlotsL

// Returns number of slots to be used for given IPC. Leaves with error code

// KErrNotSupported if the IPC number does not belong to some of the SIM

// API functions.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::NumberOfSlotsL(

    const TInt aIpc )

    {

    TInt numberOfSlots( KMmCustomDefaultSlots );

    switch ( aIpc )

        {

        case EReadViagHomeZoneParamsIPC:

        case EReadViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneCacheIPC:

        case EWriteViagHomeZoneUHZIUESettingsIPC:

        case ECustomStartSimCbTopicBrowsingIPC:

        case ECustomGetNextSimCbTopicIPC:

        case ECustomDeleteSimCbTopicIPC:

           numberOfSlots = KMmCustomDefaultSlots;

           break;

        default:

            // Unknown or invalid IPC

            User::Leave( KErrNotSupported );

            break;

        }

    return numberOfSlots;

    }

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

// CMmSIMTsy::CancelService

// When the clients close their sub-sessions (eg. by calling RPhone::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 function in the TSY.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::CancelService(

    const TInt aIpc, 

    const TTsyReqHandle aTsyReqHandle)

    {

    TInt ret( KErrGeneral );

    switch ( aIpc )

        {

        case EReadViagHomeZoneParamsIPC:

            ret = ReadViagHomeZoneParamsCancel();

            break;

        case EReadViagHomeZoneCacheIPC:

            ret = ReadViagHomeZoneCacheCancel( aTsyReqHandle );

            break;

        case EWriteViagHomeZoneCacheIPC:

            ret = WriteViagHomeZoneCacheCancel();

            break;

        case EWriteViagHomeZoneUHZIUESettingsIPC:

            ret = WriteViagHomeZoneUHZIUESettingsCancel();

            break;

        case ECustomGetNextSimCbTopicIPC:

        case ECustomDeleteSimCbTopicIPC:

            // operation cannot be cancelled on DOS side

            ret = KErrNone;

            break;

        default:

            ret = KErrGeneral;

            break;

        }

    return ret;

    }

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

// CMmSIMTsy::RegisterNotification

// Called when the server recognises this notification 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 DOS.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::RegisterNotification(

    const TInt )

    {

    // No supported notifications in CMmSimTsy

    return KErrNotSupported;

    }

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

// CMmSIMTsy::DeregisterNotification

// Called when the server recognises 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 DOS.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::DeregisterNotification(

    const TInt )

    {

    // No supported notifications in CMmSimTsy

    return KErrNotSupported;

    }

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

// CMmSIMTsy::ReadViagHomeZoneParamsL

// Reads VIAG Home Zone Parameters.

// If it has been requested before SIM is ready, the request is saved and will

// be done later. See methods CheckViagHomezoneParams and

// CMmPhoneTsy::CompleteNotifySimStatusReady.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::ReadViagHomeZoneParamsL(

    RMmCustomAPI::TViagParams* aViagParameters, 

    RMmCustomAPI::TViagElement* aViagElements )

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_READVIAGHOMEZONEPARAMSL_1, "TSY: CMmSIMTsy::ReadViagHomeZoneParamsL");

    TInt ret( KErrNone);

    if ( ESIMTsyReqHandleUnknown != iTsyReqHandleStore->GetTsyReqHandle(

        ESIMRequestTypeReadParams ) )

        {

        return KErrServerBusy;

        }

    // Count is already checked in CustomAPI

    iViagParams = aViagParameters;

    iViagElems = aViagElements;

    // If SIM is ready, then request VIAG homezone parameters.

    // If not ready, store pointers and send request when the

    // "SIM ready" indication is received.

    if ( iMmCustomTsy->Phone()->NosBootState()->iSIMReady )

        {

        // send request to DOS (no parameters)

        ret = iMmCustomTsy->Phone()->MessageManager()->HandleRequestL(

            EReadViagHomeZoneParamsIPC );

        }

    else

        {

        // SIM is not yet ready. TSY should send read request when SIM has

        // indicated that it is ready. See CheckViagHomezoneParams and

        // CMmPhoneTsy::CompleteNotifySimStatusReady.

        iViagParamsReadRequested = ETrue;

        }

    // If message is sent or we are waiting for adaptation indication SIM 

    // being ready. Then store handle.

    if ( KErrNone == ret )

        {

        iReqHandleType = ESIMRequestTypeReadParams;

        }

    return ret;

    }

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

// CMmSIMTsy::CheckViagHomezoneParamsL

// Reads VIAG Home Zone Parameters when it has been requested before

// SIM is ready.

// (other items were commented in a header).

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

//

void CMmSIMTsy::CheckViagHomezoneParamsL()

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_CHECKVIAGHOMEZONEPARAMSL_1, "TSY: CMmSIMTsy::CheckViagHomezoneParamsL");

    // Check if the request is pending

    if ( ESIMTsyReqHandleUnknown != iTsyReqHandleStore->GetTsyReqHandle(

        ESIMRequestTypeReadParams )  && iViagParamsReadRequested )

        {

        // Ensure that we wont flood SIM with mupltiple VIAG params

        // read requests, set flag to EFalse.

        iViagParamsReadRequested = EFalse;

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_CHECKVIAGHOMEZONEPARAMSL_2, "TSY: CMmSIMTsy::CheckViagHomezoneParamsL - Sending request" );

        // send request to DOS (no parameters)

        // Void return value, there is nothing to be done if request fails.

        (void) iMmCustomTsy->Phone()->MessageManager()->HandleRequestL(

            EReadViagHomeZoneParamsIPC );

        }

    else

        {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_CHECKVIAGHOMEZONEPARAMSL_3, "TSY: CMmSIMTsy::CheckViagHomezoneParamsL - VIAG homezone params not requested");

        }

    StartDynamicCachingL();

    }

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

// CMmSIMTsy::CompleteReadViagHomeZoneParamsResp

// Completes a ReadViagHomeZoneParams request (which was issued either by

// ReadViagHomeZoneParams or by CheckViagHomezoneParams).

// (other items were commented in a header).

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

//

void CMmSIMTsy::CompleteReadViagHomeZoneParamsResp(

    RMmCustomAPI::TViagParams* aParams, 

    RMmCustomAPI::TViagElements* aElems, 

    TInt aError )

    {

    TTsyReqHandle reqHandle = iTsyReqHandleStore->ResetTsyReqHandle(

        ESIMRequestTypeReadParams );

    if ( ESIMTsyReqHandleUnknown != reqHandle )

        {

        if ( aError == KErrNone && iViagParams && iViagElems )

            {

            *iViagParams = *aParams;

OstTraceDefExt1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_COMPLETEREADVIAGHOMEZONEPARAMSRESP_2, "TSY: CMmSIMTsy::CompleteReadViagHomeZoneParamsResp - iSmsC: %S", iViagParams->iSmsC );

OstTraceDefExt1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_COMPLETEREADVIAGHOMEZONEPARAMSRESP_3, "TSY: CMmSIMTsy::CompleteReadViagHomeZoneParamsResp - iScp: %S",  iViagParams->iScp );

OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_COMPLETEREADVIAGHOMEZONEPARAMSRESP_4, "TSY: CMmSIMTsy::CompleteReadViagHomeZoneParamsResp - iSubscribedZoneAndVersion: %d", iViagParams->iSubscribedZoneAndVersion );

            for ( TUint8 i = 0; i < RMmCustomAPI::KViagElementCount; i++ )

                {

                iViagElems[ i ].iCoordinates.iX = aElems->At(i).iCoordinates.iX;

                iViagElems[ i ].iCoordinates.iY = aElems->At(i).iCoordinates.iY;

                iViagElems[ i ].iCoordinates.iR2 = aElems->

                    At(i).iCoordinates.iR2;

                iViagElems[ i ].iCoordinates.iZoneId = aElems->

                    At(i).iCoordinates.iZoneId;

OstTraceDefExt2(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_COMPLETEREADVIAGHOMEZONEPARAMSRESP_8, "TSY: CMmSIMTsy::CompleteReadViagHomeZoneParamsResp - Element: %d, iZoneId: %d", i, aElems->At(i).iCoordinates.iZoneId );

                iViagElems[ i ].iName.Copy( aElems->At(i).iName );

                iViagElems[ i ].iActiveFlag = aElems->At(i).iActiveFlag;

OstTraceDefExt2(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_COMPLETEREADVIAGHOMEZONEPARAMSRESP_9, "TSY: CMmSIMTsy::CompleteReadViagHomeZoneParamsResp - Element: %d, iActiveFlag: %d", i, aElems->At(i).iActiveFlag );

                }

            }

        iMmCustomTsy->ReqCompleted( reqHandle, aError );

        }

    }

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

// CMmSIMTsy::ReadViagHomeZoneParamsCancel

// Cancels reading VIAG Home Zone parameters.

// (other items were commented in a header).

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

//

TInt CMmSIMTsy::ReadViagHomeZoneParamsCancel()

    {

OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CMMSIMTSY_READVIAGHOMEZONEPARAMSCANCEL_1, "TSY: CMmSIMTsy::ReadViagHomeZoneParamsCancel");

    // reset the pointer to client space

    iViagParams = NULL;

    iViagElems = NULL;

    // reset the req handle

    TTsyReqHandle reqHandle = iTsyReqHandleStore->ResetTsyReqHandle(

        ESIMRequestTypeReadParams );

    if ( ESIMTsyReqHandleUnknown != reqHandle )

    	{

    	// complete with cancel

    	iMmCustomTsy->ReqCompleted( reqHandle, KErrCancel );

    	}

    return KErrNone;