/*

* 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 CMMPHONETSY_H

#define CMMPHONETSY_H

//  INCLUDES

#include <etelmm.h>

#include <et_phone.h>

#include <mmretrieve.h>

#include <pcktcs.h>

#include <e32property.h>

#include <centralrepository.h>

#include <ctsy/mltsyfactorybase.h>

#include "cmmmessagemanagerbase.h"

#include "MmTsy_timeoutdefs.h"

#include <ctsy/serviceapi/mmtsy_defaults.h>

#include <ctsy/tflogger.h>

#include "CMmPrivateUtility.h"

#include <ctsy/serviceapi/ctsydomainpskeys.h>

#include <ctsy/serviceapi/mctsysatservice.h>

#include <ctsy/pluginapi/mtelephonyaudiocontrolcallback.h>

#include <hwrmpower.h>

#include "BatteryInfoObserver.h"

#include "ChargingStatusObserver.h"

// FORWARD DECLARATIONS

#ifdef REQHANDLE_TIMER

class CResponseTimer;

class CResponseTimerStore;

#endif

class CMmConferenceCallTsy;

class CMmSmsTsy;

class CMmBroadcastTsy;

class CMmONStoreTsy;

class CMmENStoreTsy;

class CMmPhoneBookStoreTsy;

class CStorageInfoData;

class CTsySatMessagingBase;

class CMmUssdTsy;

class CMmCustomTsy;

class CMmPacketServiceTsy;

class CMmPhoneExtInterface;

class CMmTsyReqHandleStore;

class CMmCallList;

class CMmLineList;

class CMmPBList;

class CMmCallTsy;

class CHeartbeatRunner;

class CMmNetTsy;

class CMmDtmfTsy;

class CMmSupplServTsy;

class CMmSecurityTsy;

class CMmCustomSecurityTsy;

class CMmPhoneFactoryTsy;

class CMmDataPackage;

class MTelephonyAudioControl;

class CCtsySystemStatePluginHandler;

// CLASS DECLARATION

/**

 *  CMmPhoneTsy contains mode-independent phone functionality.

 *  Extension request handles and parameters are stored as attributes.

 */

NONSHARABLE_CLASS( CMmPhoneTsy ) : public CPhoneBase,

                                   public MTelephonyAudioControlCallback,

                                   public MBatteryInfoNotifier,

                                   public MChargingStatusNotifier

    {

    public: // Friend classes

        /** Classes which also implement RMobilePhone functionality

            are declared as friends */

        friend class CMmNetTsy;

        friend class CMmDtmfTsy;

        friend class CMmSupplServTsy;

        friend class CMmSecurityTsy;

    public: // Enumerations

        /** Phone request types*/

        enum TPhoneRequestTypes

            {

            EMultimodePhoneReqHandleUnknown, //0

            EMultimodePhoneNotifyModemDetected,

            EMultimodePhoneCapsChangeNotification,

            EMultimodePhoneNotifyDTMFCaps,

            EMultimodePhoneSendDTMFTones,

            EMultimodePhoneStartDTMFTone, //5

            EMultimodePhoneStopDTMFTone,

            EMultimodePhoneSendNetworkServiceRequest,

            EMultimodePhoneGetDetectedNetworksPhase1, 

            EMultimodePhoneNotifyNetworkRegistrationStatusChange, 

            EMultimodePhoneNotifyModeChange, //10

            EMultimodePhoneNotifyCurrentNetworkChange, 

            EMultimodePhoneNotifySignalStrengthChange, 

            EMultimodePhoneNotifyNetworkTimeInfoChange, 

            EMultimodePhoneNotifyNWSelectionSettingChange, 

            EMultimodePhoneNotifyNWTimeInfoChange, //15

            EMultimodePhoneSelectNetwork, 

            EMultimodePhoneSetNWSelectionSetting, 

            EMultimodePhoneSetCallForwardingStatus, 

            EMultimodePhoneGetIdentityServiceStatus,

            EMultimodePhoneSetCallBarringStatus, //20

            EMultimodePhoneSetSSPassword,

            EMultimodePhoneSetCallWaitingStatus,

            EMultimodePhoneSetFdnSetting,

            EMultimodePhoneGetFdnStatus,

            EMultimodePhoneNotifyCallForwardingStatusChange,

            EMultimodePhoneNotifyCallBarringStatusChange,

            EMultimodePhoneNotifyCallWaitingStatusChange,

            EMultimodePhoneNotifyAlsLineChange, 

            EMultimodePhoneNotifyFdnStatusChange, 

            EMultimodePhoneGetCallForwardingStatusPhase1,

            EMultimodePhoneGetCallBarringStatusPhase1,

            EMultimodePhoneGetCallWaitingStatusPhase1, 

            EMultimodePhoneNotifySecurityCapsChange,

            EMultimodePhoneGetLockInfo, 

            EMultimodePhoneNotifyLockInfoChange,

            EMultimodePhoneSetLockSetting,

            EMultimodePhoneChangeSecurityCode,

            EMultimodePhoneNotifySecurityEvent,

            EMultimodePhoneVerifySecurityCode,

            EMultimodePhoneAbortSecurityCode,

            EMultimodePhoneNotifyBatteryInfoChange,

            EMultimodePhoneNotifyStopInDTMFString,

            EMultimodePhoneNotifyCallServiceCapsChange,

            EMultimodePhoneNotifyCallForwardingActive,

            EMultimodePhoneNotifyIccAccessCapsChange,

            EMultimodePhoneGetCustomerServiceProfile,

            EMultimodePhoneGetServiceTable, 

            EMultimodePhoneGetPhoneStoreInfo, 

            EMultimodePhoneOutOfMemory, 

            EMultimodePhoneGetAlsLine,

            EMultimodePhoneSetAlsLine,

            EMultimodePhoneGetNITZInfo,

            EMultimodePhoneGetCellInfo,

            EMultimodePhoneNotifyCellInfoChange,

            EMultimodePhoneGetServiceProviderName,

            EMultimodePhoneGetNetworkRegistrationStatus,

            EMultimodePhoneGetSubscriberId,

            EMultimodePhoneNotifyNetworkSecurityLevelChange,

            EMultimodePhoneGetCipheringIndicatorStatus,

            EMultimodePhoneGetBatteryInfo,

            EMultimodePhoneGetPhoneId,

            EMultimodePhoneNotifyCurrentNetworkNoLocationChange, 

            EMultimodePhoneNotifyIndicatorChange,

            EMultimodePhoneGetAuthorizationInfoPhase1,

            EMultimodePhoneIMSAuthenticate,

            EMultimodePhoneGetMailboxNumbers,

            EMultimodePhoneEnumerateAPNEntries,

            EMultimodePhoneGetAPNname,    

            EMultimodePhoneGetIccMessageWaitingIndicators,

            EMultimodePhoneSetIccMessageWaitingIndicators,

            EMultimodePhoneNotifyIccMessageWaitingIndicatorsChange,

            EMultimodePhoneGetSecurityCodeInfoPin1,

            EMultimodePhoneGetSecurityCodeInfoPin2,

            EMultimodePhoneGetSecurityCodeInfoPuk1,

            EMultimodePhoneGetSecurityCodeInfoPuk2,

            EMultimodePhoneGetSecurityCodeInfoPhonePassword,

            EMultimodePhoneGetSecurityCodeInfoSPC,

            EMultimodePhoneGetSecurityCodeInfoPhonebookHiddenKey,

            EMultimodePhoneGetSecurityCodeInfoUSIMAppPin,

            EMultimodePhoneGetSecurityCodeInfoSecondUSIMAppPin,

            EMultimodePhoneGetSecurityCodeInfoUniversalPin,

            EMultimodePhoneGetSecurityCodeInfoUniversalPuk,

            EMultimodePhoneNotifySecurityCodeInfoChange,

            EMultimodePhoneAppendAPNName,

            EMultimodePhoneDeleteAPNName,

            EMultimodePhoneNotifyAPNListChange,

            EMultimodePhoneSetAPNControlListServiceStatus,

            EMultimodePhoneGetAPNControlListServiceStatus,

            EMultimodePhoneNotifyAPNControlListServiceStatusChange,

            EMultimodePhoneSendNetworkServiceRequestNoFdnCheck,

            EMultimodePhoneNotifySendNetworkServiceRequest,

            EMultimodePhoneNotifyAllSendNetworkServiceRequest,

            EMultimodePhoneGetCurrentActiveUSimApplication,             

            EMultimodePhoneTerminateAllCalls,

            EMultimodePhoneNotifyDtmfEvent, 

            // ATTENTION:: Declare constant for those requests that need

            // own request handle record in iTsyReqHandleStore above the

            // following!

            EMultimodePhoneMaxNumOfRequests

            };

        class CNosBootState : public CBase

            {

            public:

                TBool iSIMReady;

                TBool iADNReady;

                TBool iSecReady;

                TBool iCachingActive;

            };

        /**

        * Every KLifeTimeUpdateInterval sec of the call, life time duration param is updated

        */

        enum { KLifeTimeUpdateInterval = 10	};                    

     public: // From MTelephonyAudioControlCallback

        /**

         * Informs errors from the Telephony Audio Control

         *

         * @param aCallName Call where the error happened

         * @param aError The error code

         */

        void NotifyTelephonyAudioControlError( const TName& aCallName, 

                                               const TInt& aError );

        /**

         * This method returns the information when modem status is ready

         *

         * @return ETrue if the modem is ready

         */

         TBool IsModemStatusReady() const;

         CCtsySystemStatePluginHandler* SystemStatePluginHandler()

            {

             return iSystemStatePluginHandler;

            }

    private:

		  /** used for queuing GetServiceTable requests */

		  struct TServiceTableRequests

		      {

		      /** ETel request handle */

		      TTsyReqHandle iReqHandle;

		      /** Table to be cached */ 

		      RMobilePhone::TMobilePhoneServiceTable* iTable;

		      /** Table to be cached */

		      RMobilePhone::TMobilePhoneServiceTableV1* iTableData;	

		      };

          /** used for queuing GetSubscriberId requests */

          struct TSubscriberIdRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle; 

               /** pointer to client-side    data*/

               RMobilePhone::TMobilePhoneSubscriberId* iRetSubscrId; 

               };

          /** used for queuing GetPhoneId requests */

          struct TGetPhoneIdRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle; 

               /** pointer to client-side    data*/

               RMobilePhone::TMobilePhoneIdentityV1* iRetPhoneId; 

               };

          /**Used for queing GetServiceProviderName requests */       

          struct TServiceProviderNameRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle;

               /** pointer to client side data */

               RMobilePhone::TMobilePhoneServiceProviderNameV2*

                   iServiceProviderName;     

               };

          /** Service table request types */

          enum TServiceTableRequest

               {

               ENoRequest,

               ESIMRequest,

               EUSIMRequest

               };

          struct TCustomerServiceProfileIdRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle; 

               /** pointer to client-side    data */

               RMobilePhone::TMobilePhoneCspFileV1* iRetCspFile; 

               };

          struct TGetServiceTableRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle;

               /** Table to be cached */ 

               RMobilePhone::TMobilePhoneServiceTable* iTable;

               /** Table to be cached */

               RMobilePhone::TMobilePhoneServiceTableV1* iTableData; 

               //** Cache done for this req*/

               TBool iCaching;

               };

          struct TGetAlsLineRequest

               {

               /** ETel request handle */

               TTsyReqHandle iReqHandle; 

               /** pointer to client-side    data */

               RMobilePhone::TMobilePhoneALSLine* iALSLine; 

               };

    public:  // Constructors and destructor

        /**

         * Two-phased constructor.

         *          

         *

         * @param aMessageManager: Pointer to the message manager. The returned 

         * 		CMmPhoneTsy takes ownership of this parameter.

         * @param aMmPhoneFactoryTsy Pointer to the phone factory (which is needed

         * 		for Sim Atk TSY creation). The returned CMmPhoneTsy does not take

         * 		ownership of this parameter. 

         * @param aFactory Pointer Ltsy factory base. The returned CMmPhoneTsy

         * 		takes ownership of this parameter.

         * return created phone object 

         */

        IMPORT_C static CMmPhoneTsy* NewL(         

            CMmMessageManagerBase* aMessageManager,

            CMmPhoneFactoryTsy* aMmPhoneFactoryTsy,

            MLtsyFactoryBase* aFactory );

        /**

         * Destructor.

         */

        virtual ~CMmPhoneTsy();

        // New functions

        /**

         * Initialisation method that is called from ETel Server.

         *          

         *

         */

        virtual void Init();

        /**

         * Creates new object by name and returns a pointer to it.

         *          

         *

         * @param aNewName 

         * return pointer to the created object

         */

        virtual CTelObject* OpenNewObjectByNameL( const TDesC& aName );

        /**

         * Creates new Line object and returns a pointer to it. All 

         * objects opened from the phone are opened by name, hence 

         * this method is NOT SUPPORTED.

         *          

         *

         * @param aNewName 

         * return pointer to the created object

         */

        virtual CTelObject* OpenNewObjectL( TDes& aNewName );

        /**

         * Dispatches multimode API functions calls

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aIpc request IPC number

         * @param aPackage packaged request parameters

         * @return result of the request

         */

        virtual TInt ExtFunc( const TTsyReqHandle aTsyReqHandle, 

            const TInt aIpc, 

            const TDataPackage& aPackage );

        /**

         * Returns request mode for given IPC.

         *          

         *

         * @param aIpc IPC number

         * @return request mode

         */

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

        /**

         * Returns number of slots to be used for given IPC

         *          

         *

         * @param aIpc request IPC number

         * @return result of the request

         */

        virtual TInt NumberOfSlotsL( const TInt aIpc );

        /**

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

         * parameters

         *          

         *

         * @param aIpc request IPC number

         * @param aTsyReqHandle TSY request handle

         * @return result of the request

         */

        virtual TInt CancelService( const TInt aIpc, 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Fills the given pointer with phone information (core)

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aPhoneInfo phone information

         * @return Return value to the ETel Server

         */

        virtual TInt GetInfo( const TTsyReqHandle aTsyReqHandle, 

            RPhone::TPhoneInfo* aPhoneInfo );

        /**

         * Request for caps change notifications

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aCaps phone caps

         * @return Return value to the ETel Server

         */

        virtual TInt NotifyCapsChange( const TTsyReqHandle aTsyReqHandle, 

            RPhone::TCaps* aCaps );

        /**

         * Cancels caps change notifications

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @return Return value to the ETel Server

         */

        virtual TInt NotifyCapsChangeCancel( 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Controlled initialisation

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @return Return value to the ETel Server

         */

        virtual TInt ControlledInitialisation( 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Cancels controlled initialisation

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @return Return value to the ETel Server

         */

        virtual TInt ControlledInitialisationCancel( 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Request for modem detected notifications.

         *          

         *

         * @param aTsyReqHandle Request handle

         * @param aDetection Ptr to TModemDetection 

         * object

         * @return KErrNone

         */

        virtual TInt NotifyModemDetected( const TTsyReqHandle aTsyReqHandle, 

            RPhone::TModemDetection* aDetection );

        /**

         * Cancels modem detected notifications.

         *          

         *

         * @param aTsyReqHandle Request handle

         * @return KErrNone

         */

        virtual TInt NotifyModemDetectedCancel( 

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Fills the given pointer with phone capabilities (core)

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aCaps phone capabities

         * @return Return value to the ETel Server

         */

        virtual TInt GetCaps( const TTsyReqHandle aTsyReqHandle, 

            RPhone::TCaps *aCaps );

        /**

         * Fills the given pointer with phone status (core)

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aStatus phone status

         * @return Return value to the ETel Server

         */

        virtual TInt GetStatus( const TTsyReqHandle aTsyReqHandle, 

            RPhone::TStatus *aStatus );

        /**

         * Fills the given pointer with maximum number of supported lines

         *          

         *

         * @param aTsyReqHandle TSY request handle

         * @param aCount line count

         * @return Return value to the ETel Server

         */

        virtual TInt EnumerateLines( const TTsyReqHandle aTsyReqHandle, 

            TInt *aCount );