/*

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

*

*/

#ifndef CMMSMSTSY_H

#define CMMSMSTSY_H

// INCLUDES

#include <etelmm.h>

#include <et_phone.h>          

#include "MmTsy_timeoutdefs.h" 

#include <ctsy/serviceapi/mctsysatservice.h>

//  FORWARD DECLARATIONS

class CMmSmsStorageTsy;

class CMmPhoneTsy;

class CMessStore;

class CMmSmsExtInterface;

class CMmSmsStorageTsy;

class CMmDataPackage;

class CSmsSendRequest;

class CListReadAllAttempt;

class CMmTsyReqHandleStore;

struct TSmsMsg;

struct TSmsParameters;

// CLASS DECLARATION

/**

*  CMmSmsTsy contains extended sms functionality that is mode-independent 

*  Extension request handles and parameters are stored as attributes

*/

NONSHARABLE_CLASS( CMmSmsTsy ) : public CSubSessionExtBase,

    public MCtsySatService

    {

    public:

        enum TSmsRequestTypes

            {     

            EMultimodeSmsReqHandleUnknown,          //0

            //SMS specific requests

            EMultimodeSmsReceiveMessage,

            EMultimodeSmsSetReceiveMode,

            EMultimodeSmsAckStored,

            EMultimodeSmsNackStored,

            EMultimodeSmsResumeReception,

            EMultimodeSmsSendMessage,

            EMultimodeSmsSendMessageNoFdnCheck,

            EMultimodeSmsSendSatMessage,

            EMultimodeSmsGetMessageStoreInfo,

            EMultimodeSmsReadSmspListPhase1,

            EMultimodeSmsStoreSmspList, 

            EMultimodeSmsNotifyReceiveModeChange,   

            EMultimodeSmsNotifyMoSmsBearerChange,

            EMultimodeSmsSetMoSmsBearer,

            EMultimodeSmsNotifySmspListChange, 

            //SMS storage specific requests

            EMultimodeSmsGetInfo,

            EMultimodeSimStSmsReadSms, 

            EMultimodeSimStSmsWriteSms,            

            EMultimodeSimStSmsEraseSms,

            EMultimodeSimStSmsEraseAllSms,

            EMultimodeSimSmsNotifyStoreEvent,

            EMultimodeSimStSmsReadAllSms, 

            EMultimodeSimStSmsGetNumOfLoc,

            EMultimodeSmsMaxNumOfRequests 

            };

    private:

        /** SMS routing activity */

        enum TSmsRoutingActivity

            {

            ERoutingNotActivated,

            ERoutingActivating,

            ERoutingActivated

            };

    public:

        /**

         * Two-phased constructor.

         * @param aMmPhone Pointer to the MmPhone

         * @return Pointer to the created CMmSmsTsy object

         */

        static CMmSmsTsy* NewL( CMmPhoneTsy* aMmPhone );

        /**

         * Destructor

         */

        ~CMmSmsTsy();

        /** 

         * Initialisation method that is called from ETel Server

         *          

         * 

         */

        virtual void Init();

        /**

         * New instances are created by given name

         *          

         * 

         * @param aName Name of the object to be created

         * @return Pointer to created object casted to CTelObject*

         */

        virtual CTelObject* OpenNewObjectByNameL( const TDesC& aName ); 

        /**

         * New instances are created by given name

         * 

         * 

         * @param aNewName Name of the object to be created

         * @return Pointer to created object casted to CTelObject*

         */

        virtual CTelObject* OpenNewObjectL( TDes& aNewName ); 

        /** 

         * Handles extended client requests by calling ExtFunc method

         *           

         * 

         * @param aTsyReqHandle Request handle

         * @param aIpc IPC number of request

         * @param aPackage Parameters for request

         * @return Error value

         */

        virtual TInt ExtFunc( const TTsyReqHandle aTsyReqHandle, 

            const TInt aIpc, 

            const TDataPackage& aPackage );

        /** 

         * When the ETel server receives an "extension" client request, 

         * it will pass the IPC request number down to the TSY in order to find

         * out what type of request it is

         *          

         * 

         * @param aIpc IPC number of request

         * @return Request mode for given IPC

         */

        virtual CTelObject::TReqMode ReqModeL( const TInt aIpc );

        /**

         * Returns number of slots to be used for given IPC

         *          

         * 

         * @param aIpc IPC number of request

         * @return Number of slots

         */

        virtual TInt NumberOfSlotsL( const TInt aIpc );

        /**

         * Cancels request that's IPC number and request handle are given in 

         * parameters

         *          

         * 

         * @param aIpc IPC number of request

         * @param aTsyReqHandle Request handle

         * @return Error value

         */

        virtual TInt CancelService( const TInt aIpc, 

            const TTsyReqHandle aTsyReqHandle );

        /** 

         * Register given notification

         *          

         * 

         * @param aIpc Number of slots

         * @return Error value

         */

        virtual TInt RegisterNotification( const TInt aIpc );

        /**

         * Deregister given notification

         *          

         * 

         * @param aIpc IPC number of request

         * @return Error value

         */

        virtual TInt DeregisterNotification( const TInt aIpc );

        /**

         * Return pointer to the SMS Storage sub-session

         *          

         * 

         * @return Pointer to SMS Storage sub-session

         */

        virtual CMmSmsStorageTsy* GetSmsStorageTsy();

        /**

         * Activate SMS routing

         *          

         * 

         */

        virtual void ActivateSmsRoutingL();

        /**

         * This method completes reception of incoming unstored SMS

         *          

         * 

         * @param aError Error code

         * @param aDataPackage A data package containing TBool (indicates if 

         * some errors have occured while handling or acknowledging incoming Sms) 

         * and a TSmsMsg* (pointer to Sms message)

         */

        virtual void CompleteReceiveMessage( TInt aError, 

            CMmDataPackage* aDataPackage );

        /**

         * Handle internally response for ActivateSmsRouting

         *          

         * 

         * @param aError Error code

         * @param aDataPackage Package data containing TUint8, 

         * status of the routing (active or not)

         */

        virtual void CompleteActivateSmsRouting( TInt aError, 

            CMmDataPackage* aDataPackage );

        /** 

         * Complete AckSmsStored request

         *          

         * 

         * @param aError Error code

         */

        virtual void CompleteAckSmsStored( TInt aError );

        /** 

         * Complete NackSmsStored request

         *          

         * 

         * @param aError Error code

         */

        virtual void CompleteNackSmsStored( TInt aError );

        /** 

         * Complete CompleteSendMessage request

         *          

         * 

         * @param aError Error code

         * @param aDataPackage

         */

        virtual void CompleteSendMessage( TInt aError, 

            CMmDataPackage* aDataPackage );

        /** 

         * Complete CompleteSendMessageNoFdnCheck request

         *          

         *

         * @param aError Error code

         * @param aDataPackage

         */

        virtual void CompleteSendMessageNoFdnCheck( TInt aError, 

            CMmDataPackage* aDataPackage );

        /**

         * From MCtsySatService

         * Send SAT SMS message to the network

         *          

         * 

         * @param aStkTsySatService Pointer to SAT service interface

         * @param aSmsTpdu Pointer to Sms TPDU

         * @param aScAddress Pointer to service address

         * @param aMobileTON Pointer to type of number

         * @param aMobileNPI Pointer to number plan

         * @param aMoreToSend True if there is more to send

         * @param aTsyReqHandle Request handle

         * @return KErrNone 

         */

        virtual TInt SendSatMessage( 

            MStkTsySatService& aStkTsySatService, 

            TDes8* aSmsTpdu, 

            TDes16* aScAddress, 

            RMobilePhone::TMobileTON* aMobileTON, 

            RMobilePhone::TMobileNPI* aMobileNPI, 

            TBool aMoreToSend, 

            TTsyReqHandle aTsyReqHandle );

        /**

         * Complete SendSatMessage request

         *          

         * 

         * @param aError Error code

         */

        virtual void CompleteSendSatMessage( TInt aError );

        /**

         * Complete ResumeSmsReception request

         *          

         * 

         * @param aError Error code

         */

        virtual void CompleteResumeSmsReception( TInt aError );

        /**

         * Complete get sms message store info

         *          

         * 

         * @param aError Error code

         * @param aDataPackage

         */

        virtual void CompleteGetMessageStoreInfo( TInt aError, 

            CMmDataPackage* aDataPackage );

        /**

         * Complete first phase of read all SMSP sets

         *          

         * 

         * @param aError Error code

         * @param aDataPackage

         */

        virtual void CompleteReadAllSmspPhase1( TInt aError, 

            CMmDataPackage* aDataPackage );

        /**

         * Handle internally SMS servers response to SMS Parameter update          

         * request (Store SMSP list)

         *          

         * 

         * @param aError Error code

         */

        virtual void InternalStoreSmspList( TInt aError );

        /**

         * Set SMS Storage TSY

         *          

         * 

         * @param aNewPointer Pointer to Storage Tsy

         */

        virtual void SetSmsStorageTsy( CMmSmsStorageTsy* aNewPointer );

        /**

         * Return number of SMS location on SIM card 

         *          

         * 

         * @return Number of SMS location on SIM card

         */

        virtual TInt16 GetSmsNumOfLoc();

        /**

         * Set Sms Number of Location on SIM Card

         *          

         * 

         * @param aSmsNumOfUsedEntries Number of SMS location

         */

        virtual void SetSmsNumOfLoc( TInt aSmsNumOfUsedEntries );

        /**

         * This method set Sms Send Attributes values for sending MMSAT 

         * message

         *          

         * 

         * @param aMmPhone

         * @param aSmsTpdu Pointer to Sms TPDU

         * @param aScAddress Pointer to service address

         * @param aMobileTON Pointer to type of number

         * @param aMobileNPI Pointer to number plan

         * @param aMoreToSend True if there is more to send

         * @return Error code

         */

        virtual TInt SendSatMessageL( 

            CMmPhoneTsy* aMmPhone,

            TDes8* aSmsTpdu,

            TDes16* aScAddress,

            RMobilePhone::TMobileTON* aMobileTON,

            RMobilePhone::TMobileNPI* aMobileNPI,

            TBool aMoreToSend );

        /**

         * Set the information about the CS hardware status: True if off-line, 

         * false if on-line

         *          

         * 

         * @param aIsOffline

         */

        void SetOffline( TBool aIsOffline );

        /**

         * Complete set bearer type for sending SMS messages 

         *          

         *

         * @param aResult Error value

         */

        void CompleteSetMoSmsBearer( TInt aResult );

#ifdef REQHANDLE_TIMER

        /**

         * Chooses the type of response, automatic or common

         *          

         * 

         * @param aReqHandleType Req handle type

         * @param aTsyReqHandle Req handle to be stored

         */

        void SetTypeOfResponse( const TInt aReqHandleType, 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Complete request because of timer expiration

         *          

         * 

         * @param aReqHandleType Request handle type

         * @param aError Error value

         */    

        virtual void Complete( TInt aReqHandleType, 

            TInt aError );

#endif // REQHANDLE_TIMER

    private:

        /**

         * C++ default constructor.

         */

        CMmSmsTsy();

        /**

         * By default Symbian 2nd phase constructor is private.

         */

        void ConstructL();

        /**

         * Resend an unsent message

         *          

         * 

         */

        void ResendSms();

        /** 

         * Handles extended client requests

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @param aIpc IPC number of request

         * @param aPackage Data Package

         * @return Error value

         */

        TInt DoExtFuncL( const TTsyReqHandle aTsyReqHandle, 

            const TInt aIpc, 

            const TDataPackage& aPackage );

        /**

         * Get SMS messaging capabilities

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @param aCaps Pointer to the messaging capabilities

         * @return KErrNone 

         */

        TInt GetCaps( const TTsyReqHandle aTsyReqHandle, 

            TDes8* aCaps );

        /**

         * Get receive mode

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @param aReceiveMode Pointer to receive mode

         * @return KErrNone 

         */

        TInt GetReceiveMode( const TTsyReqHandle aTsyReqHandle, 

            RMobileSmsMessaging::TMobileSmsReceiveMode* aReceiveMode );

        /**

         * Set receive mode

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @param aReceiveMode Pointer to receive mode

         * @return KErrNone 

         */

        TInt SetReceiveMode( const TTsyReqHandle aTsyReqHandle, 

            RMobileSmsMessaging::TMobileSmsReceiveMode const* aReceiveMode );

        /**

         * Set receive mode cancel

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @return KErrNone 

         */

        TInt SetReceiveModeCancel( const TTsyReqHandle aTsyReqHandle );

        /**

         * Notify from receive mode changes

         *          

         * 

         * @param aReceiveMode Pointer to receive mode

         * @return KErrNone 

         */

        TInt NotifyReceiveModeChange( 

            RMobileSmsMessaging::TMobileSmsReceiveMode* aReceiveMode );

        /**

         * Cancel notify reveice mode change request

         *          

         * 

         * @param aTsyReqHandle Request handle

         * @return KErrNone 

         */

        TInt NotifyReceiveModeChangeCancel( 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Complete notify reveice mode change request

         *          

         * 

         */

        void CompleteNotifyReceiveModeChange();

        /**

         * This method starts the reception of incoming unstored SMS

         *          

         * 

         * @param aTsyReqHandle Request handle