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

//

#ifndef SATMESSHANDLER_H

#define SATMESSHANDLER_H

//  INCLUDES

#include <e32base.h>

#include "isi_sim.h"

#include "isi_atk.h"

#include <adaptation_conf.h>

#ifndef AFF_ISC_API_IN_USE

#include "pn_obj_auto.h"

#endif

// CONSTANTS

const TUint8 KTerminalResponseClass = 0xA0;

const TUint8 KTerminalResponseIns = 0x14;

const TUint8 KTerminalResponseP1 = 0x00;

const TUint8 KTerminalResponseP2 = 0x00;

const TUint8 KOneByteLengthLimit = 0x7F;

const TUint8 KFilePathLength = 8;

const TUint16 KFileMaxLength = 0xFFFF;

const TUint8 MEIsInTheIdleState = 0x00;

// SAT related traid constant must be defined, because

// otherwise it may happen that sat simservicetable req

// is directed to phonemesshander.

const TUint8 KSatSimServiceTableReqTraId = 0xaa;

// FORWARD DECLARATIONS

class CMmPhoNetSender;

class CTsySatMessaging;

// CLASS DECLARATION

/**

*  SAT message handler class.

*  Handles message sending and receiving to and from phonet.

*  

*/

class CSatMessHandler : public CBase 

    {

    public:  // Constructors and destructor

        /**

         * C++ default constructor.

         * @param aTsySatMessaging pointer to TsySatMessaging class

         * @param aPnSend Phonetsender for passing messages to phonet

         */

        CSatMessHandler( CTsySatMessaging* aTsySatMessaging, 

            CMmPhoNetSender* aPnSend );

        /**

         * Two-phased constructor.

         * @param aTsySatMessaging pointer to TsySatMessaging class

         * @param aPnSend Phonetsender for passing messages to phonet

         */

        static CSatMessHandler* NewL( CTsySatMessaging* aTsySatMessaging,

            CMmPhoNetSender* aPnSend );

        /**

         * Destructor.

         */

        virtual ~CSatMessHandler();

        // New functions

        /**

         * Display text response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactive command display text

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt DisplayTextTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult,

            TUint8 aAdditionalInfo );

        /**

         * Get Inkey response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactive command display text

         * @param aDcs Data Coding Scheme

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt GetInkeyTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TUint8 aDcs,

            TDes16& aAdditionalInfo );

        /**

         * Get Input response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details tlv

         * @param aGeneralResult result of the proactive command Get Input

         * @param aAdditionalInfo Additional info response might give

         * @param aTextString text string provided by the user

         * @param aDataCodingScheme data coding scheme for text string

         * @return phonet sender status

         */

        TInt GetInputTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TUint8 aAdditionalInfo,

            TDesC16& aTextString,

            TUint8 aDataCodingScheme );

        /**

         * Play Tone response method.

         *          

         * @param Unique transaction ID

         * @param aCommandDetails 

         * @param aGeneralResult result of the proactive command

         * @param aAdditionalInfo Additional info given in some cases

         * @return phonet sender status

         */

        TInt PlayToneTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Setup Menu response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactice command Setup Menu

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SetUpMenuTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Select Item response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactice command Select Item

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SelectItemTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Send SM response method.

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactice command Send SM

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SendSmTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails,

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Send SS response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details TLV

         * @param aGeneralResult result of the proactive command Send SS

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SendSsTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult,

            TDesC8& aAdditionalInfo );

        /**

         * Send DTMF response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aPCmdNumber Command number

         * @param aGeneralResult result of the proactice command Send SS

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SendDtmfTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Send USSD response method.

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param aGeneralResult result of the proactice command Send USSD

         * @param aAdditionalInfo Additional info response might give

         * @param aText input data, UCS2 string

         * @param aDCS data coding scheme

         * @return phonet sender status

         */

        TInt SendUssdTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8  aGeneralResult, 

            TDesC8& aAdditionalInfo, 

            TDesC& aText, 

            TUint8 aDCS );

        /**

         * Polling Interval response method

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactive command

         * @param aAdditionalInfo Additional info response might give

         * @param aNumOfUnits time interval

         * @return phonet sender status

         */

        TInt PollIntervalTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo,

            TUint8 aNumOfUnits );

        /**

         * Setup Call response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details TLV

         * @param aGeneralResult result of the proactive command Setup Call

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SetUpCallTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Refresh response method.

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param aGeneralResult result of the proactice command Refresh

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt RefreshTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult, 

            TUint8 aAdditionalInfo );

        /**

         * Menu Selection method.

         *          

         * @param aTransId Unique transaction ID

         * @param aItemIdentifier identifier of the selected menu item

         * @param aHelp help requested by the user indicator

         * @return phonet sender status

         */

        void MenuSelectionIndL( TUint8 aTransId, 

            TUint8 aItemIdentifier, 

            TUint8 aHelp );

        /**

         * Handles the proactive commands from phonet

         *          

         * @param aIsiMsg proactive command

         */

        virtual void SatMessageReceivedL( CIsiMsg* aIsiMsg );

        /**

         * Launch Browser terminal response method

         *          

         * @param aTransId transaction id

         * @param aPCmdNumber command number

         * @param aGeneralResult

         * @param aAdditionalInfo

         * @param aCmdQualifier

         * @return phonet sender status

         */

        virtual TInt LaunchBrowserTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails,         

            TUint8 aGeneralResult,      

            TUint8 aAdditionalInfo );

        /**

         * Converts Symbian OS general result to DOS general result

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param TUint8 aAtkResult result of the proactice command

         * @return phonet sender status

         */

        TUint8 ConvertGeneralResult( TUint8 aGeneralResult );

        /**

         * Test if a command was performed successfully

         *          

         * @param aGeneralResult

         * @return ETrue if command performed successfully, else EFalse

         */

        TBool CommandPerformedSuccessfully( TUint8 aGeneralResult );

        /**

         * SetupIdleModeText Terminal Response

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactive command display text

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SetUpIdleModeTextTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TUint8 aAdditionalInfo );

        /**

         * SetUpEventList response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aGeneralResult result of the proactive command display text

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt SetUpEventListTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails, 

            TUint8 aGeneralResult,

            TUint8 aAdditionalInfo );

        /**

         * PollingOff response method.

         *          

         * @param aPCmdNumber Unique transaction ID

         * @param aCommandDetails command details tlv

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt PollingOffTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TUint8 aAdditionalInfo );

        /**

         * LocalInfo response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details TLV

         * @param aGeneralResult result of the proactice command

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt LocalInfoTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TDes& aAdditionalInfo );

        /**

         * Timer management response method.

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details TLV

         * @param aGeneralResult result of the proactive command

         * @param aTimerValue[3] timer value in hours, minutes and seconds

         * @param aTimerId timer identifier 

         * @param aAdditionalInfo Additional info response might give

         * @return phonet sender status

         */

        TInt TimerMgmtTerminalRespL( TUint8 aTransId, 

            TDes8& aCommandDetails,

            TUint8 aGeneralResult,

            TUint8 aTimerValue[3],   

            TUint8 aTimerId,

            TUint8 aAdditionalInfo );

        /**

         * Timer expiration indication

         *          

         * @param aTransId Unique transaction ID

         * @param aTimerId timer identification

         * @param aTimerValue[3] timer value

         * @return TInt

         */

        TInt TimerExpirationInd ( TUint8 aTransId,

            TUint8 aTimerId,

            TUint8 aTimerValue[3] );

        /**

         * More time response

         *          

         * @param aTransId Unique transaction ID

         * @param aCommandDetails Command details TLV

         * @param aGeneralResult result of the proactive command

         * @return phonet sender status 

         */

        TInt MoreTimeTerminalRespL( TUint8 aTransId,

            TDes8& aCommandDetails,

            TUint8 aGeneralResult );

        /**

         * SendTerminalResponseL

         *          

         * @param aCommandDetails Command details TLV

         * @param aBerTlvSpecificData data to be sent

         * @return phonet sender status                        

         */

        TInt SendTerminalResponseL( TDes8& aCommandDetails,

            const TDesC8& aBerTlvSpecificData,

            TUint8 aTransId = 0 );

        /**

         * SimReadFieldReq

         *          

         * @param aTransId Unique transaction ID

         * @param aOffset

         * @param aLength

         * @param aSimFilePath

         * @return phonet sender status                        

         */

        TInt SimReadFieldReq( TUint8 aTransId, 

            TUint16 aOffset,

            TUint16 aLength,

            TDes8* aSimFilePath );

        /**

         * SimReadFieldResp

         *          

         * @param aIsiMsg

         */

        void SimReadFieldResp( CIsiMsg* aIsiMsg );

        /**

         * SendAtkEnvelopeNtf

         *          

         * @param aBerTlv TLV data of the envelope command 

         * @return phonet sender status

         */

        TInt SendAtkEnvelopeNtf( TUint8 aTransId, 

            const TDesC8& aBerTlv );

        /**

         * ReSendAtkEnvelopeNtf

         *          

         * @param aIsiMsg response to envelope 

         * @return KErrNone/KErrNotReady, no resending or resending.

         */

        TInt ReSendAtkEnvelopeNtf( CIsiMsg* aIsiMsg );

        /**

         * Send a Sms-Pp report with subblocks 

         *          

         * @param aTransId Unique transaction Id

         * @param aData data to be appended to the request

         */

        void SendSmsPpReportReq( TUint8 aTransId, 

            TDesC8& aData );

        /**

         * Sends atk event resp without sub blocks

         *          

         * @param aTransId Unique transaction Id

         * @param aError success code

         * @param aReceiverObject receiver guardian

         */

        TInt SendAtkEventCcResp( TUint8 aTransId, 

            TUint8 aError, 

            TUint8 aReceiverObject );

        /**

         * Sends atk event resp with sub blocks

         *          

         * @param aTransId Unique transaction Id

         * @param aData data to be sent

         * @param aReceiverObject receiver guardian

         */

        TInt SendAtkEventCcResp( TUint8 aTransId, 

            TDesC8& aData,

            TUint8 aReceiverObject );

        /**

         * Sets header of the message for atk messages

         *          

         * @param aMsg message to be sent

         * @param aReceiverObj receiver object of the message

         */

#ifndef AFF_ISC_API_IN_USE

        void SetAtkMsgHeaderInformation( CPnMsg& aMsg,

            TInt aReceiverObj = PN_OBJ_SIMSON_SERV );

#else

        void SetAtkMsgHeaderInformation( CPnMsg& aMsg,

            TInt aReceiverObj = 0x35 );

#endif

        /**

         * Parse message and read from it operator code,

         * locationAreaCode and cell id.

         *          

         * @param aIsiMsg received message

         */

        void NetRegStatusInd( CIsiMsg* aIsiMsg );

        /**

         * activate call guardians

         *          

         * @param aTransId Unique transaction Id

         * @param aCCstatus Is the CC supported in SIM or not

         * @return phonet sender status 

         */

        TInt NotifyGuardiansAboutCCstatusInCard( TUint8 aTransId,