/*

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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:

*

*/

#ifndef _CMMCUSTOMMESSHANDLER_H

#define _CMMCUSTOMMESSHANDLER_H

// INCLUDES

#include "mmmmesshandlerbase.h"

#include "cmmphonetreceiver.h"

#include "muiccoperationbase.h"

#include "cmmuiccmesshandler.h"

// for internal testing

#include "nokiatsy_internal_variation.h"

#include <ctsy/rmmcustomapi.h>

// CONSTANTS

// Length of Sim info isi msg buffer

const TUint8 KSimInfoBufferSize = 20;

// Time related constants

const TUint16 KSecsInHour = 3600;

const TUint8 KMinsInHour = 60;

// Length if Gss Cs isi msg buffer

const TUint8 KGssCsBufferSize = 6;

// Call property buffer size

const TUint8 KCallPropBuffSize = 4;

// Value for information which value is not needed.

const TUint8 KZero = 0x00;

// Default length for product profile reading request

const TUint8 KDefaultPPlength = 0x01;

// Max length of network proveder name

const TUint8 KNwProviderNameLength = 0x19;

// Constants for remote address length

const TUint8 KRemoteAddressBcdSize = 18;

const TUint8 KRemoteAddressAsciiSize = 34;

const TUint8 KRemoteAddressConversionSize = 36;

// SS Request Complete Notifivation SS Status

const TUint8 KCustomApiSsGsmActive = 0x01;

const TUint8 KCustomApiSsGsmRegistered = 0x02;

const TUint8 KCustomApiSsGsmProvisioned = 0x04;

const TUint8 KCustomApiSsGsmQuiescent = 0x08;

const TUint8 KinfoPpTwoDigitDial = 0x0F;

//value for information which value is two

const TUint8 KTwo = 0x02;

//value for information which value is three

const TUint8 KThree = 0x03;

//value for information which value is four

const TUint8 KFour = 0x04;

//value for information which value is six

const TUint8 KSix = 0x06;

const TUint8 KCustomPadding = 0x00; //Padding byte

// Call Life Timer Constants

const TUint8 KCallLifeTimerDataAmount = 0x04;

const TInt KCallLifeTimerNotSet = -1;

const TUint8 KPmmGroupNokiaTsySize = 100;

// Maximum number of re-trials when requesting data from PMM.

const TUint8 KMaxPMMReadRequests = 0x03;

// These constants are needed for Viag Home Zone

const TUint8 KLengthOfSMSCNumber = 15;

const TUint8 KLengthOfSCPNumber = 15;

const TUint8 KLengthOfHzCzTag = 13;

const TUint8 KHomeZoneActiveBit = 0x01;

const TUint8 KCityZoneActiveBit = 0x02;

const TUint8 KCustomTransId = 6;

// MACROS

    //None

// DATA TYPES

    //None

// EXTERNAL DATA STRUCTURES

    //None

// FUNCTION PROTOTYPES

    //None

// FORWARD DECLARATIONS

class CMmSecurityMessHandler;

class CMmNetMessHandler;

class CMmPhoNetSender;

class TIsiReceiveC;

class CMmMessageRouter;

class CMmUiccMessHandler;

// CLASS DECLARATION

/**

*  CMmCustomMessHandler is used to create and send GSM specific

*  custom ISI messages to PhoNet via PhoNetSender.

*/

class CMmCustomMessHandler :

    public CBase,

    public MMmMessHandlerBase,

    public MMmMessageReceiver,

    public MUiccOperationBase

    {

    public:

    // Used for saving the ciphering information.

    struct TCiphListEntry

        {

        TBool iCiphStatus;

        TUint8 iTraId;

        };

    // Used for saving the enhanced cell information.

    class TECIDInfo

        {

        public: // data

        RMmCustomAPI::TMmCellInfo iCellInfo; // Cell Information

        TUint iMCC; // Mobile Country Code

        TUint iMNC; // Mobile Network Code

        TUint iCID; // Location area code

        TUint iLAC; // Cell identity

        };

    // This enumeration is needed because different Product Profile

    // requests can be made using the same INFO_PP_READ_REQ/RESP

    // messages. Used as a transaction ID.

    enum TProductProfileRequestType

        {

        EGetAlsPPSupport = 0,

        ECheckTwoDigitDialSupport

        };

    // This enumeration is needed because a SIM_READ_CI_RESP can come

    // as a response to a GetCipheringInfo-request, or triggered by

    // a NET_CIPHERING_IND indication which makes the same request.

    // Used as a transaction ID.

    enum TCipheringInfoRequestType

        {

        EGetCipheringInfo = 0,

        ENotifyCipheringInfo

        };

    // The SIM operations are grouped into the following types.

    // Used as ISA transaction IDs.

    enum TSIMOperationType

        {

        ESIMOperationTypeReadSimTopics = 0,

        ESIMOperationTypeDeleteSimTopic

        };

    enum TUiccSapIfStatus

        {

        EUiccSapIfStatus1 = 1,

        EUiccSapIfStatus2,

        EUiccSapIfStatus3

        };

    public: // Constructors and destructor

        /**

        * Creates a new GSM specific MessageHandler object instance.

        * @param aPhoNetSender: a pointer to a Phonet Sender object

        * @param aPhoNetReceiver:

        * @param aNetMessHandler: a pointer to the Net message handler

        * @param aSecurityMessHandler: a pointer to the security mess handler

        * @param aMessageRouter: a pointer to the message router

        * @return void

        */

        static CMmCustomMessHandler* NewL(

            CMmPhoNetSender* aPhoNetSender,

            CMmPhoNetReceiver* aPhoNetReceiver,

            CMmNetMessHandler* aNetMessHandler,

            CMmSecurityMessHandler* aSecurityMessHandler,

            CMmMessageRouter* aMessageRouter,

            CMmUiccMessHandler* aUiccMessHandler);

        /**

        * Destructor.

        * @return void

        */

        ~CMmCustomMessHandler();

        /**

        * Creates CallReleaseReq ISI message and sends it to Phonet.

        * @param TUint8 aTransactionId: unique transaction id

        * @param TUint8 aCallId: Call ID of this call (NOS Call ID)

        * @param TUint8 aCause: cause of releasing

        * @return TInt: success/failure value

        */

        TInt CallReleaseReq(

            TUint8 aTransactionId,

            TUint8 aCallId,

            TUint8 aCause );

        /**

        * Breaks received CallReleaseResp ISI message.

        * @param const TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void CallReleaseResp( const TIsiReceiveC& aIsiMsg );

        /**

        * MO alert indication, used for Remote Alerting Tone in Custom TSY

        * @param const TIsiReceiveC& aIsiMsg: The received ISI message

        * @return TInt: void : None

        */

        void CallMoAlertInd( const TIsiReceiveC& aIsiMsg );

        /**

        * Creates a NET_CS_WAKEUP_REQ ISI message and sends it to Phonet

        * @param TUint8 aTransId: transaction Id

        * @return TInt: success/failure value

        */

        TInt NetCsWakeupReq( TUint8 aTransId );

        /**

        * Breaks received NET_CS_WAKEUP_RESP ISI message

        * @param None

        * @return void : None

        */

        void NetCsWakeupResp();

        /**

        * Breaks received NET_CIPHERING_IND ISI message

        * @param TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void NetCipheringInd( const TIsiReceiveC& aIsiMsg );

        /**

        * Breaks received NET_MODEM_REG_STATUS_IND ISI message

        * @param TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void NetModemRegStatusInd( const TIsiReceiveC& aIsiMsg );

        /**

        * Read dynamic flags 2

        * @return void

        */

        TInt UiccReadDynamic2FlagsReq();

        /**

        * Read dynamic flags 2 response

        * @param aStatus Status

        * @param aFileData File data

        * @return void

        */

        void UiccReadDynamic2FlagsResp(

            TInt aStatus,

            const TDesC8& aFileData );

        /**

        * Write dynamic flags 2

        * @param aInfo Flags 2 data

        * @return void

        */

        TInt UiccWriteDynamic2FlagsReq( TUint8 aInfo );

        /**

        * Write dynamic flags 2 response

        * @param aInfo Flags 2 data

        * @return void

        */

        void UiccWriteDynamic2FlagsResp( TInt aStatus );

        /**

        * Breaks received CALL_TERMINATE_IND ISI messages

        * @param const TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void CallTerminateInd( const TIsiReceiveC& aIsiMsg );

        /**

        * Breaks received CALL_RELEASE_IND ISI messages

        * @param const TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void CallReleaseInd( const TIsiReceiveC& aIsiMsg );

        /**

        * Creates a INFO_PP_READ_REQ ISI messages and sends it to phone

        * @param TProductProfileRequestType aReqType: request type (used

        *        as transaction id)

        * @return void : KErrNone / Error value from phonet

        */

        TInt InfoPpReadReq( TProductProfileRequestType aReqType );

        /**

        * Breaks a INFO_PP_READ_RESP message

        * @param CIsiMsg* aIsiMsg: The received ISI message

        * @return void : None

        */

        void InfoPpReadResp( const TIsiReceiveC& aIsiMessage );

        /**

        * Creates a CALL_GSM_BLACKLIST_CLEAR_REQ ISI message and sends it to

        * Phonet

        * @param TUint8 aTransId: transaction Id

        * @return TInt : KErrNone or error code

        */

        TInt CallGsmBlackListClearReq( TUint8 aTransId );

        /**

        * Breaks received CALL_GSM_BLACKLIST_CLEAR_RESP ISI message

        * @return void : None

        */

        void CallGsmBlackListClearResp();

        /**

        * Breaks received SS_SERVICE_COMPLETED_IND ISI message

        * @param const TIsiReceiveC& aIsiMessage: The received ISI message

        * @return void : None

        */

        void SsServiceCompletedInd ( const TIsiReceiveC& aIsiMessage );

        /**

        * Creates a CALL_EMERGENCY_NBR_CHECK_REQ ISI messages and sends it to

        * phonet

        * @param TUint8 aTransId: Transaction Id

        * @param TMobileTelNumber&: telnumber

        * @param TCheckMode aCheckMode; check mode

        * @return TInt : KErrNone / Error value from phonet

        */

        TInt CallEmergencyNbrCheckReq( TUint8 aTransId,

            RMmCustomAPI::TMobileTelNumber& aNumber,

            RMmCustomAPI::TCheckMode aCheckMode );

        /**

        * Breaks a CALL_EMERGENCY_NBR_CHECK_RESP message

        * @param const TIsiReceiveC& aIsiMsg: The received ISI message

        * @return void : None

        */

        void CallEmergencyNbrCheckResp( const TIsiReceiveC& aIsiMsg );

        /**

        * Creates a SS_GSM_USSD_SEND_REQ ISI messages and sends it to IsaApi

        * @param TUint8 aTransId: Transaction Id

        * @return TInt : KErrNone / Error value from IsaApi

        */

        TInt SsGsmUssdSendReq( TUint8 aTransId );

        /**

        * Forwards a execution of SS_CANCEL_USSD_SEND_RESP message

        * @param const TIsiReceiveC& aIsiMessage: The received ISI message

        * @return void : None

        */

        void SsGsmUssdSendResp( const TIsiReceiveC& aIsiMessage );

        /**

        * Construct a NET_MODEM_REG_STATUS_GET_REQ ISI message and send

        * it through phonet.

        * @param TUint8 aTransId: Transaction Id

        * @return TInt: KErrNone / Error value from phonet

        */

        TInt NetModemRegStatusGetReq( TUint8 aTransId );

        /**

        * Construct a NET_SET_REQ message and send it through phonet.

        * @param TUint8 aTransId: Transaction Id

        * @return TInt: KErrNone / Error value from phonet

        */

        TInt NetSetReq( TUint8 aTransId );

        /**

        * Handles SsRequestComplete response ISI message

        * @return void : None

        */

        void SsRequestComplete();

        /**

        * Read field from SIM/USIM

        * @param aSimFileInfo File info

        * @return Error code

        */

        TInt UiccReadFieldReq( RMmCustomAPI::TSimFileInfo& aSimFileInfo );

        /**

        * Response to read field request

        * @param aStatus Status

        * @param aFileData File data

        * @return void

        */

        /**

        * Read ciphering indicator status from SIM/USIM

        * @param aTrId Transaction ID

        * @return Error code

        */

        TInt UiccReadCiReq( TInt aTrId );

        /**

        * Response to read CI request

        * @param aStatus Status

        * @param aTrId Transaction ID

        * @param aFileData File data

        * @return void

        */

        void UiccReadCiResp(

            TInt aStatus,

            TInt aTrId,

            const TDesC8& aFileData );

        /**

        * Read operator name from SIM/USIM

        * @return Error code

        */

        TInt UiccOperatorReq();

        /**

        * Response to read operator name request

        * @param aStatus Status

        * @param aFileData File data

        * @return none

        */

        /**

        * Disconnects UICC server from smartcard and

        * activates UICC SAP APDU interface

        * @return Error code

        */

        TInt UiccSimPowerOffReq();

        /**

        * Handles responses to SIM power off

        * @param aStatus Status

        * @return none

        */

        void UiccSimPowerOffResp( TInt aStatus );

        /**

        * Requests SIM warm reset

        * @return Error code

        */

        TInt UiccSimWarmResetReq();

        /**

        * Response to SIM warm reset

        * @param aStatus Status

        * @return none

        */

        void UiccSimWarmResetResp( TInt aStatus );

        /**

        * Requests Get ATR

        * @return Error code

        */

        TInt UiccSimGetAtrReq();

        /**

        * Handles responses to SIM Get ATR

        * @param aStatus Status

        * @param aFileData File data

        * @return none

        */

        void UiccSimGetAtrResp( TInt aStatus, const TDesC8& aFileData );

        /**

        * Connects UICC server to smartcard and

        * deactivates UICC SAP APDU interface

        * @return Error code

        */

        TInt UiccSimPowerOnReq();

        /**

        * Handles responses to SIM power off

        * @param aStatus Status

        * @return none

        */

        void UiccSimPowerOnResp( TInt aStatus );

        /**

        * Sends APDU to UICC

        * @param aApduParameters APDU parameters

        * @param aTraId transaction id

        * @return Error code

        */

        TInt UiccSendAPDUReq(

            const RMmCustomAPI::TApduParameters& aApduParameters,

            TInt aTraId );

        /**

        * Handles responses to UICC_APDU_RESP

        * @param aStatus Status

        * @param aFileData File data

        * @param aTraId transaction id

        * @return none

        */

        void UiccSendAPDUResp(

            TInt aStatus,

            const TDesC8& aFileData,

            TInt aTraId );