// Copyright (c) 2005-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        : CSatNotifySendSm.cpp

// Part of     : Common SIM ATK TSY / commonsimatktsy

// SendSm notification functionality of Sat Tsy

// Version     : 1.0

//

//INCLUDES

#include <satcs.h>                  // Etel SAT IPC definitions

#include "CSatTsy.h"                // Tsy class header

#include "CSatNotifySendSm.h"       // Tsy class header

#include "CSatNotificationsTsy.h"   // Class header

#include "CBerTlv.h"                // Ber Tlv data handling

#include "TTlv.h"					// TTlv class

#include "CSatDataPackage.h"        // Parameter packing 

#include "TfLogger.h"               // For TFLOGSTRING

#include "TSatUtility.h"            // Utilities

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

#include "cmmmessagemanagerbase.h"  // Message manager class for forwarding req.

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

// CSatNotifySendSm::NewL

// Two-phased constructor.

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

//  

CSatNotifySendSm* CSatNotifySendSm::NewL

        ( 

        CSatNotificationsTsy* aNotificationsTsy 

        )

    {

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

   	CSatNotifySendSm* const satNotifySendSm = 

        new ( ELeave ) CSatNotifySendSm( aNotificationsTsy );

    CleanupStack::PushL( satNotifySendSm );

    satNotifySendSm->ConstructL();

    CleanupStack::Pop( satNotifySendSm );

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

    return satNotifySendSm;

    }

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

// CSatNotifySendSm::~CSatNotifySendSm

// Destructor

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

//  

CSatNotifySendSm::~CSatNotifySendSm

        ( 

		// None

        )

    {

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

    }

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

// CSatNotifySendSm::CSatNotifySendSm

// Default C++ constructor

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

//  

CSatNotifySendSm::CSatNotifySendSm

        ( 

        CSatNotificationsTsy* aNotificationsTsy 

        ) : iNotificationsTsy ( aNotificationsTsy )

    {

    // None

    }

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

// CSatNotifySendSm::ConstructL

// Symbian 2nd phase constructor

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

//  

void CSatNotifySendSm::ConstructL

        (

        // None

        )

    {

    TFLOGSTRING("CSAT: CSatNotifySendSm::ConstructL, does nothing");

    }

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

// CSatNotifySendSm::Notify

// This request allows a client to be notified of a Send Sm proactive command.

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

//

TInt CSatNotifySendSm::Notify

        (

        const TTsyReqHandle aTsyReqHandle,

        const TDataPackage& aPackage

        )

    {

    TFLOGSTRING("CSAT: CSatNotifySendSm::Notify");

    // Save data pointer to client side for completion

    iSendSmV1Pckg = reinterpret_cast<RSat::TSendSmV1Pckg*>( 

        aPackage.Des1n() );

    // Save the request handle

    iNotificationsTsy->iSatTsy->SaveReqHandle( aTsyReqHandle, 

		CSatTsy::ESatNotifySendSmPCmdReqType );

    // Check if requested notification is already pending

    iNotificationsTsy->NotifySatReadyForNotification( KSendShortMessage );     

    return KErrNone;

    }

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

// CSatNotifySendSm::CancelNotification

// This method cancels an outstanding asynchronous NotifySendSm request.

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

//

TInt CSatNotifySendSm::CancelNotification

        (

        const TTsyReqHandle aTsyReqHandle 

        )

    {

    TFLOGSTRING("CSAT: CSatNotifySendSm::CancelNotification");   

    // Reset the request handle

    TTsyReqHandle reqHandle = iNotificationsTsy->iSatReqHandleStore->

        ResetTsyReqHandle( CSatTsy::ESatNotifySendSmPCmdReqType );

	// Reset the data pointer

	iSendSmV1Pckg = NULL;

	// Complete the request with KErrCancel

	iNotificationsTsy->iSatTsy->ReqCompleted( aTsyReqHandle, KErrCancel );

    return KErrNone;    

    }

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

// CSatNotifySendSm::CompleteNotifyL

// This method completes an outstanding asynchronous NotifySendSm request. 

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

//

TInt CSatNotifySendSm::CompleteNotifyL

        (

        CSatDataPackage* aDataPackage,  

        TInt aErrorCode                 

        )

    {

    TFLOGSTRING("CSAT: CSatNotifySendSm::CompleteNotifyL");

    TInt ret( KErrNone );

	TBuf<1> additionalInfo;

	// Unpack parameters

    TPtrC8* data;

    aDataPackage->UnPackData( &data );

	// Reset req handle. Returns the deleted req handle

    TTsyReqHandle reqHandle = iNotificationsTsy->iSatReqHandleStore->

    	ResetTsyReqHandle( CSatTsy::ESatNotifySendSmPCmdReqType );

	// Get ber tlv

	CBerTlv berTlv;

	berTlv.SetData( *data );

	// Get command details tlv

	CTlv commandDetails;

	berTlv.TlvByTagValue( &commandDetails, KTlvCommandDetailsTag );

	// Store command details tlv

	iNotificationsTsy->iTerminalRespData.iCommandDetails.Copy( 

		commandDetails.Data() );

	TUint8 pCmdNumber( commandDetails.GetShortInfo( ETLV_CommandNumber ) );	   	

    // In case the request was ongoing, continue..

    if ( CSatTsy::ESatReqHandleUnknown != reqHandle )

        {

        // Complete right away if error has occured, otherwise continue..

        if ( KErrNone == aErrorCode )

			{

			// Fill the send sm structure             

			RSat::TSendSmV1& sendSmV1 = ( *iSendSmV1Pckg )();

			// Command number

			sendSmV1.SetPCmdNumber( pCmdNumber  );

			sendSmV1.iSmsTpdu.Zero();

			CTlv smsTpduTlv;

			// Get TPdu tlv

			TInt returnValue( berTlv.TlvByTagValue( &smsTpduTlv, 

			    KTlvSmsTpduTag ) );

			if ( KErrNone == returnValue )

				{

				// Tpdu TLV length

				TUint16 smsTpduLength( smsTpduTlv.GetLength() );

				// Set pointer to Tpdu

				TPtrC8 smsTpdu = smsTpduTlv.GetData( ETLV_SmsTPdu );

				// Check that TP-UDL is valid

				ret = CheckTpdu( smsTpdu );

				if ( KErrCorrupt == ret )

					{

					TFLOGSTRING("CSAT: CSatNotifySendSm::CompleteNotifyL,\

					    Invalid data");

					additionalInfo.Zero();

                    additionalInfo.Append( KNoCause );

					CreateTerminalRespL( pCmdNumber, 

					    RSat::KCmdDataNotUnderstood, additionalInfo );                            

                    }

				else if ( KErrNone == ret && smsTpduLength )

					{

					// Copying the TTpdu

					sendSmV1.iSmsTpdu.Append( smsTpdu );

					}

				// Checking if packing is required for the SMS message or not

				// Packing: see ETSI 3.38 and 3.40

				if ( ( KSmsPackingRequiredMask & iNotificationsTsy->

                    iTerminalRespData.iCommandDetails[KCommandQualifier] )

					&& ( KErrNone == ret ) )

					{

					// Packing required

					if ( smsTpduLength )

						{

						// Call method to pack sms

						ret = PackSms( smsTpdu, sendSmV1.iSmsTpdu );

						if ( KErrNone != ret )

							{

							TFLOGSTRING("CSAT: CSatNotifySendSm::\

							    CompleteNotifyL, Invalid TPDU");

							// TPDU is invalid or packing cannot be requested 

							// if tpdu is something else than SMS-SUBMIT

							additionalInfo.Zero();

                            additionalInfo.Append( KNoCause );

							CreateTerminalRespL( pCmdNumber,                  

								RSat::KCmdDataNotUnderstood, additionalInfo );         

							ret = KErrCorrupt;

							}

						else

							{

							// Do nothing

							}					

						}

					else

						{

						TFLOGSTRING("CSAT: CSatNotifySendSm::CompleteNotifyL,\

						    Packing not required");

						}

					}

				else

					{

					// Do nothing

					}

				}

			else

				{

				TFLOGSTRING("CSAT: CSatNotifySendSm::CompleteNotifyL,\

				    Missing TPDU");

				// TPdu is missing, returning response immediately

				additionalInfo.Zero();

                additionalInfo.Append( KNoCause );

				CreateTerminalRespL( pCmdNumber, 

				    RSat::KErrorRequiredValuesMissing, additionalInfo );

				ret = KErrCorrupt;

				}

			if ( KErrNone == ret )

				{

				SetAlphaIdAndAddressData( &berTlv, sendSmV1 );

				// Iconid 

				TSatUtility::FillIconStructure( berTlv, sendSmV1.iIconId );

				} 

			} // End of if ( KErrNone == aErrorCode )

        else

        	{

        		ret = aErrorCode;

        	}

        iNotificationsTsy->iSatTsy->ReqCompleted( reqHandle, ret );   

        } // End of if ( CSatTsy::ESatReqHandleUnknown != reqHandle )

	else

		{

		TFLOGSTRING("CSAT: CSatNotifySendSm::CompleteNotifyL,\

		    Request not ongoing");

		// Request not on, returning response immediately

		additionalInfo.Zero();

        additionalInfo.Append( KNoCause );       

		CreateTerminalRespL( pCmdNumber, RSat::KMeUnableToProcessCmd, 

			additionalInfo );					 

		}

	return ret;

	}

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

// CSatNotifySendSm::TerminalResponseL

// Called by ETel server, passes terminal response to NAA

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

//

TInt CSatNotifySendSm::TerminalResponseL

        (

        TDes8* aRsp 

        )

    {  

    TFLOGSTRING( "CSAT::CSatNotifySendSm::TerminalResponseL" );

    TInt ret( KErrNone );

    TBuf<1> additionalInfo;

    RSat::TSendSmRspV1Pckg* aRspPckg = 

        reinterpret_cast<RSat::TSendSmRspV1Pckg*>( aRsp );

    RSat::TSendSmRspV1& rspV1 = ( *aRspPckg ) ();

    // Get Proactive command number

    TUint8 pCmdNumber( rspV1.PCmdNumber() );

    TFLOGSTRING2( "CSAT::CSatNotifySendSm::TerminalResponseL: GeneralResult: \

        %d", static_cast<TUint8>( rspV1.iGeneralResult ) );

    // Check that general result value is valid

    if ( ( RSat::KSuccess != rspV1.iGeneralResult ) && 

         ( RSat::KMeUnableToProcessCmd  != rspV1.iGeneralResult ) && 

         ( RSat::KCmdBeyondMeCapabilities != rspV1.iGeneralResult )&& 

         ( RSat::KSmsRpError != rspV1.iGeneralResult ) && 

         ( RSat::KInteractionWithCCPermanentError != rspV1.iGeneralResult ) && 

         ( RSat::KModifiedByCallControl != rspV1.iGeneralResult ) && 

         ( RSat::KSuccessRequestedIconNotDisplayed != rspV1.iGeneralResult ) )        

        {

        TFLOGSTRING( "CSAT::CSatNotifySendSm::TerminalResponseL,\

            Invalid General result" );

        // Invalid general result

        ret = KErrCorrupt;

        }

    // If there is ME (Mobile Entity) error or network error, additional info

    // is needed

    if ( ( RSat::KMeProblem == rspV1.iInfoType ) || 

         ( RSat::KSatNetworkErrorInfo == rspV1.iInfoType ) || 

         ( RSat::KControlInteraction == rspV1.iInfoType ) )        

        {

        // Check the length of additional info

        if ( 0 == rspV1.iAdditionalInfo.Length() )

            {

            TFLOGSTRING( "CSAT::CSatNotifySendSm::TerminalResponseL,\

                Invalid Additional Info" );

            // No info

            ret = KErrCorrupt;

            }

        else

            {

            additionalInfo.Append( rspV1.iAdditionalInfo[0] );

			}

        }

	else

		{

		// Do nothing

		}

    // Creating the info message

	TInt response = CreateTerminalRespL( pCmdNumber, static_cast<TUint8>( 

	    rspV1.iGeneralResult ), additionalInfo );

	if(KErrNone == ret)

		ret = response;

	return ret;

    }

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

// CSatNotifySendSm::CreateTerminalRespL

// Constructs SendSm specific part of terminal response and calls 

// DOS to send the actual message.

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

//

TInt CSatNotifySendSm::CreateTerminalRespL

		( 

        TUint8 aPCmdNumber,        

        TUint8 aGeneralResult,      

        TDesC16& aAdditionalInfo		

		)

    {

    TFLOGSTRING( "CSAT::CSatNotifySendSm::CreateTerminalRespL" );

    // Create and append response data

    TTlv tlvSpecificData;

    // Create General Result TLV here

    tlvSpecificData.AddTag( KTlvResultTag );

    // General result

    tlvSpecificData.AddByte( aGeneralResult );

    if ( ( RSat::KMeUnableToProcessCmd == aGeneralResult ) ||

         ( RSat::KNetworkUnableToProcessCmd == aGeneralResult ) ||

         ( RSat::KSmsRpError == aGeneralResult ) ||

         ( RSat::KInteractionWithCCPermanentError == aGeneralResult ) )

        {

		if( aAdditionalInfo.Length() > 0 )

	        {

	        TFLOGSTRING( "CSAT::CSatNotifySendSm::CreateTerminalRespL,\

	            Unsuccessful result" );

	        // If there is ME, Network or SMS error, append additional info

	        tlvSpecificData.AddByte( static_cast<TUint8>( aAdditionalInfo[0] ) );

	        }

		}

    else

    	{

    	// Do nothing

    	}

	// Prepare data

    iNotificationsTsy->iTerminalRespData.iPCmdNumber = aPCmdNumber;

    TPtrC8 data = tlvSpecificData.GetDataWithoutTopLevelTag();

    // Pack data

    CSatDataPackage dataPackage;

	dataPackage.PackData( &iNotificationsTsy->iTerminalRespData, &data );

    // Forward request to the DOS

    return iNotificationsTsy->iSatTsy->MessageManager()->HandleRequestL( 

		ESatTerminalRsp, &dataPackage );

    }

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

// CSatNotifySendSm::SetAlphaIdAndAddressData

// Set Alpha id and Address into send sm structure

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

//

void CSatNotifySendSm::SetAlphaIdAndAddressData

		(

		CBerTlv* aBerTlv,

		RSat::TSendSmV1& aSendSmV1

		)

	{

	TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData" );

	TInt returnValue;

	TPtrC8 sourceString; // Used in unicode conversions

	// Alpha id string (optional)

	aSendSmV1.iAlphaId.iAlphaId.Zero();

	CTlv alphaIdTlv;

	returnValue = aBerTlv->TlvByTagValue( &alphaIdTlv, 

	    KTlvAlphaIdentifierTag ) ;

	if ( KErrNone == returnValue )

		{

		// Alpha id tlv found

		if ( alphaIdTlv.GetLength() )

			{

			// Get alpha id text

			sourceString.Set( alphaIdTlv.GetData( ETLV_AlphaIdentifier ) );

			// Convert and set alpha id

			TSatUtility::SetAlphaId( sourceString, 

			    aSendSmV1.iAlphaId.iAlphaId );

			}

		// Alpha Tag present

		if ( aSendSmV1.iAlphaId.iAlphaId.Length() )

			{

			aSendSmV1.iAlphaId.iStatus = RSat::EAlphaIdProvided;

			}

		else

			{

			TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData,\

			    Alpha ID is NULL" );

			aSendSmV1.iAlphaId.iStatus = RSat::EAlphaIdNull;

			}

		}

	else 

		{

		TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData,\

		    Alpha ID not present" );

		aSendSmV1.iAlphaId.iStatus = RSat::EAlphaIdNotPresent;

		}

	// The address data object holds the RP_Destination_Address of the Service 

	// Centre. If no RP_Destination_Address is transferred, then the ME shall 

	// insert the default Service Centre address (below).

	aSendSmV1.iAddress.iTelNumber.Zero();

	CTlv addressTlv;

	// Get address tlv. Includes SCA number. (optional)

	returnValue = aBerTlv->TlvByTagValue( &addressTlv, KTlvAddressTag );

	if ( KErrNone == returnValue )

		{

		if ( 0 < addressTlv.GetLength() )

		    {		

			// Initialize ton and npi

			RSat::TTypeOfNumber ton;

			RSat::TNumberingPlan npi;

			// Call utility function that maps received TON and NPI to 

			// RSat values

			TSatUtility::TonAndNpi( 

			addressTlv.GetShortInfo( ETLV_TonAndNpi ), &ton, &npi );

			// Set TON and NPI

			aSendSmV1.iAddress.iTypeOfNumber = ton;

			aSendSmV1.iAddress.iNumberPlan = npi;    

			TBuf8<RSat::KMaxMobileTelNumberSize> tempScaNumber;

			// set pointer to address tlv

			sourceString.Set( addressTlv.GetData( 

			    ETLV_DiallingNumberString ) ); 

			if ( sourceString.Length() )

				{

				// Semi-octet presentation used

				// Converting back to ASCII format

				TSatUtility::BCDToAscii( sourceString, tempScaNumber );

				aSendSmV1.iAddress.iTelNumber.Copy( tempScaNumber );

				TFLOGSTRING2("CSAT: SendSm, SCA number: %S", 

					&aSendSmV1.iAddress.iTelNumber );

				}

       		else

      			{

      			TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData\

      			    Address TLV found, TON/NPI present, but number epmpty" );

        		// Address TLV found, TON/NPI present, but number epmpty.

       			aSendSmV1.iAddress.iTypeOfNumber = RSat::EUnknownNumber;

        		aSendSmV1.iAddress.iNumberPlan = RSat::EUnknownNumberingPlan;

      			}

		    }

		else

		    {

		    TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData\

		        Address TLV found, but the Value part doesn't exist");

		    // Address TLV found, but the Value part doesn't exist

		    aSendSmV1.iAddress.iTypeOfNumber = RSat::EUnknownNumber;

		    aSendSmV1.iAddress.iNumberPlan = RSat::EUnknownNumberingPlan;

		    }

		}

	else

	    {

	    TFLOGSTRING( "CSAT::CSatNotifySendSm::SetAlphaIdAndAddressData\

	        Address TLV not found");

	    // Address TLV not found

	    aSendSmV1.iAddress.iTypeOfNumber = RSat::ETypeOfNumberNotSet;

	    aSendSmV1.iAddress.iNumberPlan = RSat::ENumberingPlanNotSet;  

	    }	

	}

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

// CSatNotifySendSm::CheckTpdu

// This method Checks TPDU validity

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