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

// This file contains the method definitions for all EtelMM subsessions that

// provide messaging functionality.

// 

//

/**

 @file

*/

// From core API

#include <et_clsvr.h>

#include <etelext.h>

// Multimode header files

#include <etelmm.h>

#include <mmlist.h>

#include <mmretrieve.h>

#include "mm_hold.h"

/************************************************************************/

//

//  RMobileSmsMessaging

//

/************************************************************************/

EXPORT_C RMobileSmsMessaging::RMobileSmsMessaging() :

	iSmsMessagingPtrHolder(NULL)

/** 

	Standard constructor.

	This member is internal and not intended for public use.

*/

	{

	}

EXPORT_C TInt RMobileSmsMessaging::Open(RMobilePhone& aPhone)

/**

	This member function opens a SMS Messaging object. The name of the sub-session 

	opened in the TSY will equal the string defined by the KETelSmsMessaging LIT 

	definition. 

	@param aPhone An existing RMobilePhone session.

	@return KErrNone if successful.

@capability None

*/

	{

	RSessionBase* session=&aPhone.SessionHandle();

	__ASSERT_ALWAYS(session!=NULL,PanicClient(EEtelPanicNullHandle));

	TInt subSessionHandle=aPhone.SubSessionHandle();

	__ASSERT_ALWAYS(subSessionHandle!=NULL,PanicClient(EEtelPanicNullHandle));

	TRAPD(ret,ConstructL()); 

	if (ret)

		return ret;

	TPtrC name(KETelSmsMessaging);	

	SetSessionHandle(*session);

	TIpcArgs args(&name,TIpcArgs::ENothing,subSessionHandle);

	ret = CreateSubSession(*session,EEtelOpenFromSubSession,args);

	if (ret)

		Destruct();

	return ret;

	}

EXPORT_C void RMobileSmsMessaging::Close()

/**

	This method closes a RMobileSmsMessaging subsession

@capability None

*/

 	{

	CloseSubSession(EEtelClose);

	Destruct();

	}

EXPORT_C void RMobileSmsMessaging::ConstructL()

/**	Constructor. */

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder==NULL,PanicClient(EEtelPanicHandleNotClosed));

	iSmsMessagingPtrHolder = CSmsMessagingPtrHolder::NewL(CSmsMessagingPtrHolder::EMaxNumberSmsPtrSlots,CSmsMessagingPtrHolder::EMaxNumberSmsPtrCSlots);

	}

EXPORT_C void RMobileSmsMessaging::Destruct()

/** Destructor. */

	{

	delete iSmsMessagingPtrHolder;

	iSmsMessagingPtrHolder = NULL;

	ResetSessionHandle();

	}

RMobileSmsMessaging::TMobileSmsAttributesV1::TMobileSmsAttributesV1() 

:	iFlags(0), 

	iDataFormat(EFormatUnspecified),

	iCdmaTeleservice(0),

	iCdmaServiceCategory(0)

/** Constructor. */

	{

	}

EXPORT_C RMobileSmsMessaging::TMobileSmsReceiveAttributesV1::TMobileSmsReceiveAttributesV1() 

:	iStatus(EMtMessageUnknownStatus),

	iStoreIndex(0)

/** Constructor. */

	{

	iExtensionId=KETelMobileSmsReceiveAttributesV1;

	}

EXPORT_C RMobileSmsMessaging::TMobileSmsSendAttributesV1::TMobileSmsSendAttributesV1() 

:	iMsgRef(0),

	iMore(EFalse)

/** Constructor. */

	{

	iExtensionId=KETelMobileSmsSendAttributesV1;

	}

EXPORT_C RMobileSmsMessaging::TMobileSmsCdmaSendAttributesV4::TMobileSmsCdmaSendAttributesV4() 

:	iMsgRef(0), 

	iMore(EFalse),

	iAddressAuthentication(0)

/** Constructor. */

	{

	iExtensionId=KETelMobileSmsCdmaSendAttributesV4;

	}

EXPORT_C RMobileSmsMessaging::TMobileSmsCapsV1::TMobileSmsCapsV1() 

:	iSmsMode(0), 

	iSmsControl(0)

/** Constructor. */

	{

	iExtensionId=KETelExtMultimodeV1;

	}

EXPORT_C TInt RMobileSmsMessaging::GetCaps(TDes8& aCaps) const

/**

	This member function gets a class that reflects the SMS messaging capabilities

	of the phone.

	@param aCaps On return, a TMobileSmsCapsV1Pckg with the SMS messaging capabilities

	of the phone.

	@return KErrNone if successful.

	@see TMobileSmsCapsV1

@capability None

*/

	{

	return Get(EMobileSmsMessagingGetCaps, aCaps);

	}

EXPORT_C TInt RMobileSmsMessaging::GetReceiveMode(TMobileSmsReceiveMode& aReceiveMode) const

/**

	This member function retrieves the current setting of the TSY-phone incoming 

	SMS receive mode. This setting dictates how the phone will handle incoming 

	SMS messages before passing them on to TSY.

	@param aReceiveMode On return, the current receive mode.

	@return KErrNone if successful.

@capability None

*/

	{

	TPckg<TMobileSmsReceiveMode> ptr1(aReceiveMode);

	return Get(EMobileSmsMessagingGetReceiveMode, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::SetReceiveMode(TRequestStatus& aReqStatus, TMobileSmsReceiveMode aReceiveMode) const

/**

	This member function sets the setting of the TSY-phone incoming SMS receive 

	mode. This setting dictates how the phone will handle incoming SMS messages 

	before passing them on to TSY.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingSetReceiveMode) 

	to cancel a previously placed asynchronous SetReceiveMode() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aReceiveMode The receive mode to set.

@capability WriteDeviceData

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iSmsMessagingPtrHolder->iReceiveMode = aReceiveMode;

	TPtrC8& ptr1=iSmsMessagingPtrHolder->SetC(CSmsMessagingPtrHolder::ESlot1SetReceiveMode,iSmsMessagingPtrHolder->iReceiveMode);

	Set(EMobileSmsMessagingSetReceiveMode, aReqStatus, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::NotifyReceiveModeChange(TRequestStatus& aReqStatus, TMobileSmsReceiveMode& aReceiveMode)

/**

	This member function is used to notify the client if there is a change to the 

	setting of the TSY-Phone receive mode.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingNotifyReceiveModeChange) 

	to cancel a previously placed asynchronous NotifyReceiveModeChange() request.

	@param aReqStatus On return, KErrNone if successful

	@param aReceiveMode On return, the new SMS receive mode.

@capability None

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	TPtr8& ptr1=iSmsMessagingPtrHolder->Set(CSmsMessagingPtrHolder::ESlot1NotifyReceiveModeChange,aReceiveMode);

	Get(EMobileSmsMessagingNotifyReceiveModeChange, aReqStatus, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::ReceiveMessage(TRequestStatus& aReqStatus, TDes8& aMsgData, TDes8& aMsgAttributes) const

/**

	This member function will be used to wait for the next incoming SMS message. 

	Once this member function completes, the client should immediately repost 

	it if they want to receive the next incoming SMS message.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingReceiveMessage) 

	to cancel a previously placed asynchronous ReceiveMessage() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aMsgData On completion, the message data.

	@param aMsgAttributes On completion, a TMobileSmsReceiveAttributesV1Pckg containing 

	the message attributes.

	@see TMobileSmsReceiveAttributesV1

@capability NetworkServices

@capability ReadUserData

*/

	{

	Get(EMobileSmsMessagingReceiveMessage, aReqStatus, aMsgData, aMsgAttributes);

	}

EXPORT_C void RMobileSmsMessaging::AckSmsStored(TRequestStatus& aReqStatus, const TDesC8& aMsgData, TBool aFull) const

/**

	When the client receives an unstored SMS, it will use this member function 

	to return a positive acknowledgment if it manages to successfully decode and 

	store that SMS. If the client wishes to send a SMS-DELIVER-REPORT in response 

	to the received SMS-DELIVER , than the aMsgData parameter will be used to 

	hold the TPDU defined for a SMS-DELIVER-REPORT (for RP-ACK) in GSM 03.40.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingAckSmsStored) 

	to cancel a previously placed asynchronous AckSmsStored() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aMsgData Holds the TPDU defined for a SMS-DELIVER-REPORT (for RP-ACK) 

	in GSM 03.40.

	@param aFull Indicates whether, after storing the acknowledged message, the 

	client-side message store is now full or not. If client sets it to ETrue then 

	it is informing the TSY that the store is full (or almost full) and that it 

	does not want to receive any more messages until it calls ResumeSmsReception().

@capability NetworkServices

@capability NetworkControl

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iSmsMessagingPtrHolder->iAckSmsStoredFull = aFull;

	TPtrC8& ptr1=iSmsMessagingPtrHolder->SetC(CSmsMessagingPtrHolder::ESlot1AckSmsStored,iSmsMessagingPtrHolder->iAckSmsStoredFull);

	Set(EMobileSmsMessagingAckSmsStored, aReqStatus, aMsgData ,ptr1);

	}

EXPORT_C void RMobileSmsMessaging::NackSmsStored(TRequestStatus& aReqStatus, const TDesC8& aMsg, TInt aRpCause) const

/** When the client receives an unstored SMS, it will use this member function 

	to return a negative acknowledgment if it fails to decode and/or store that 

	SMS.

	This TPDU will contain the TP error cause that prevents the client from acknowledging 

	the SMS. The client should also provide the RP error cause by placing it in 

	the aRpCause parameter. 

	In GSM mode, once a client has rejected a received SMS due to storage full, 

	the network will keep this message for later and suspend the forwarding of 

	any further received SMS to this MS.

	In CDMA mode, the network will save the message but it will repeat sending 

	of the message to the MS until either the MS eventually accepts it or the 

	retry limit is reached.

	If retry limit is reached the network will tell the originator of the message 

	that the transmission failed. In either case, when client-side memory is freed-up, 

	the client must call ResumeSmsReception() in order to tell the phone and possibly 

	the network that SMS can be received again.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingNackSmsStored) 

	to cancel a previously placed asynchronous NackSmsStored() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aMsg Holds the TPDU defined for a SMS-DELIVER-REPORT (for RP-ERROR) 

	in GSM 03.40.

	@param aRpCause Contain one of the MS related extended error codes.

@capability NetworkServices

@capability NetworkControl

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iSmsMessagingPtrHolder->iNackSmsStoredCause = aRpCause;

	TPtrC8& ptr1=iSmsMessagingPtrHolder->SetC(CSmsMessagingPtrHolder::ESlot1NackSmsStored,iSmsMessagingPtrHolder->iNackSmsStoredCause);

	Set(EMobileSmsMessagingNackSmsStored, aReqStatus, aMsg, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::ResumeSmsReception(TRequestStatus& aReqStatus) const

/**

	This member functions resumes the reception of SMS messages.

	SMS reception can become suspended because SMS storage is full. Therefore 

	if client-side storage is full, the client must stop receiving unstored messages. 

	However, if the user deletes some client-side stored SMS messages, the client 

	must use this member function to tell the TSY to inform a GSM network that 

	messages can be received again or the phone that CDMA messages can be accepted 

	again.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingResumeSmsReception) 

	to cancel a previously placed asynchronous ResumeSmsReception() request.

	@param aReqStatus On return, KErrNone if successful.

@capability NetworkServices

@capability NetworkControl

*/

	{

	Blank(EMobileSmsMessagingResumeSmsReception, aReqStatus);

	}

EXPORT_C void RMobileSmsMessaging::SendMessage(TRequestStatus& aReqStatus,  const TDesC8& aMsgData, TDes8& aMsgAttributes) const

/**

	This member function sends an SMS message to the network.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingSendMessage) 

	to cancel a previously placed asynchronous SendMessage() request.

	@param aReqStatus On return, KErrNone if successful, KErrNotSupported if the 

	phone does not support outgoing SMS, KErrMMEtelFormatNotSupported if the phone 

	does not support the client's chosen message data format, any of the KErrGsmSms… 

	extended errors if the phone is in GSM mode and this is the error returned 

	by the GSM network/service centre, Any of the KErrCdmaSms… extended errors 

	if the phone is in CDMA mode and this is the error returned by the CDMA network/service 

	centre. Please note that the last three examples are "extended" errors and 

	will only be returned to those clients that request them. Clients that only 

	understand core Symbian OS and ETel errors will receive KErrGeneral for any 

	error cases that the TSY can not interpret.

	@param aMsgData The message data

	@param aMsgAttributes A TMobileSmsSendAttributesV1Pckg with the message attributes. 

	The fields required will probably be message data format, destination and 

	possibly a new service centre address. On return, for either successful or 

	failed transmission, the message reference number assigned to this sent message 

	will be placed by the TSY in the iMsgRef field. Also, if the SMS was sent 

	during GSM or WCDMA mode, then the SMS-SUBMIT-REPORT will be placed by the 

	TSY in the iSubmitReport field.

	@see TMobileSmsSendAttributesV1

@capability NetworkServices

@capability WriteUserData

*/

	{

	SetAndGet(EMobileSmsMessagingSendMessage, aReqStatus,aMsgData,aMsgAttributes);

	}

EXPORT_C void RMobileSmsMessaging::SendMessageNoFdnCheck(TRequestStatus& aReqStatus,  const TDesC8& aMsgData, TDes8& aMsgAttributes) const

/**

	Sends an outgoing SMS to the network. 

	The number used for sending the SMS is not checked against those in the 

	Fixed Dialling Number list even if the FDN service is enabled.

	@param aMsgData Supplies the TPDU to send

	@param aMsgAttributes Supplies the attributes of the outgoing message

@capability NetworkServices

@capability NetworkControl

*/

	{

	SetAndGet(EMobileSmsMessagingSendMessageNoFdnCheck, aReqStatus,aMsgData,aMsgAttributes);

	}

EXPORT_C void RMobileSmsMessaging::SetMoSmsBearer(TRequestStatus& aReqStatus, TMobileSmsBearer aBearer) const

/**

	This member function sets the bearer type (GSM or GPRS) for sending SMS messages.

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingSetMoSmsBearer) 

	to cancel a previously placed asynchronous SetMoSmsBearer() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aBearer The bearer type to set.

@capability WriteDeviceData

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iSmsMessagingPtrHolder->iSmsBearer = aBearer;

	TPtrC8& ptr1=iSmsMessagingPtrHolder->SetC(CSmsMessagingPtrHolder::ESlot1SetMoSmsBearer,iSmsMessagingPtrHolder->iSmsBearer);

	Set(EMobileSmsMessagingSetMoSmsBearer, aReqStatus, ptr1);

	}

EXPORT_C TInt RMobileSmsMessaging::GetMoSmsBearer(TMobileSmsBearer& aBearer) const

/**

	This member function is used to retrieve the current setting for the bearer 

	type (GSM or GPRS) used for sending SMS messages. 

	@param aBearer On return, the current bearer type.

	@return KErrNone if successful.

@capability None

*/

	{

	TPckg<TMobileSmsBearer> ptr1(aBearer);

	return Get(EMobileSmsMessagingGetMoSmsBearer, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::NotifyMoSmsBearerChange(TRequestStatus& aReqStatus, TMobileSmsBearer& aBearer)

/**

	This member function is used t notify the client if there is a change to the 

	setting for the bearer type used for sending SMS messages. 

	Use RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingNotifyMoSmsBearerChange) 

	to cancel a previously placed asynchronous NotifyMoSmsBearerChange() request.

	@param aReqStatus On return, KErrNone if successful.

	@param aBearer On completion, the new bearer.

@capability None

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	TPtr8& ptr1=iSmsMessagingPtrHolder->Set(CSmsMessagingPtrHolder::ESlot1NotifyMoSmsBearerChange,aBearer);

	Get(EMobileSmsMessagingNotifyMoSmsBearerChange, aReqStatus, ptr1);

	}

//

// SMS related storage

//

EXPORT_C TInt RMobileSmsMessaging::EnumerateMessageStores(TInt& aCount) const

/**

	This request gets the number of phone-side SMS message stores supported by 

	the phone in the aCount parameter.

	@param aCount On return, the number of phone-side SMS message stores.

	@return KErrNone if successful.

@capability None

*/

	{

	TPckg<TInt> ptr1(aCount);

	return Get(EMobileSmsMessagingEnumerateMessageStores, ptr1);

	}

EXPORT_C void RMobileSmsMessaging::GetMessageStoreInfo(TRequestStatus& aReqStatus, TInt aIndex, TDes8& aInfo) const

/**

	This request gets information about the SMS message store.

	Use	RTelSubSessionBase::CancelAsyncRequest(EMobileSmsMessagingGetMessageStoreInfo) 

	to cancel a previously placed asynchronous GetMessageStoreInfo() request.

	@param aReqStatus On return, KErrNone if successful

	@param aIndex The index of the store, valid values are between 0 and (n-1), 

	where n is given by the EnumerateMessageStores() request.

	@param aInfo On comletion, a RMobilePhoneStore::TMobilePhoneStoreInfoV1Pckg 

	holding the SMS message store info.

	@see RMobilePhoneStore::TMobilePhoneStoreInfoV1

@capability None

*/

	{

	__ASSERT_ALWAYS(iSmsMessagingPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iSmsMessagingPtrHolder->iGetMessageStoreInfoIndex = aIndex;

	TPtrC8& ptr1=iSmsMessagingPtrHolder->SetC(CSmsMessagingPtrHolder::ESlot1GetMessageStoreInfo,iSmsMessagingPtrHolder->iGetMessageStoreInfoIndex);

	SetAndGet(EMobileSmsMessagingGetMessageStoreInfo, aReqStatus, ptr1, aInfo);

	}

//

// SMS Parameter Storage

//