/*

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

#define CMMCUSTOMTSY_H

#include <featmgr/featurecontrol.h>

#include "cmmphonetsy.h"

#include <ctsy/rmmcustomapi.h>

#include "CMmCustomExtInterface.h"

#include <ctsy/serviceapi/mcustomvendorextcomplete.h>

#include "CMmSubTsyBase.h"

#include "CMmTsyBase.h"

#include "MmTsy_numberOfSlots.h"

#include "MmTsy_timeoutdefs.h"

#include <f32file.h>

#include <hash.h>

#include "cmmvoicecalltsy.h"

// CONSTANTS

// Valid range: 10-16

#define BLOB_SIZE          16

#define METADATA_SIZE      2

// Rand database file paths

_LIT( KRandDb, "rand_db.cur" );

_LIT( KRandDbPrev, "rand_db.prv" );

// FORWARD DECLARATIONS

class CMmCustomExtInterface;

class CMmCustomVendorExt;

class CMmPacketTsy;

// CLASS DECLARATION

/**

 *  CMmCustomTsy contains mode-independent custom functionality and

 *  is an aggregate class for its subsystems.

 *

 */

NONSHARABLE_CLASS( CMmCustomTsy ) : public CMmTsyBase, 

    public MCustomVendorExtComplete

    {

    friend class CMmWimTsy;

    friend class CMmSimLockTsy;

    friend class CMmSIMTsy;

    friend class CMmCustomSecurityTsy;

    friend class CMmPhonebookStoreTsy;

    // TCustomRequestType enumerates indexes to Custom TSY's request handle

    // table. Request handles are stored there while waiting for

    // completion of the request.

    enum TCustomRequestType

        {

        ECustomTsyReqHandleUnknown,

        ECustomTsyNotifyDtmfEvent,

        ECustomTsyGetDiagnosticInfo,

        ECustomTsyGetRemoteAlertingToneStatus,

        ECustomTsyCallOrigin,

        ECustomTsyTerminateCall,

        ECustomTsyGetAlsBlocked,

        ECustomTsySetAlsBlocked,

        ECustomTsyNotifyAlsBlockedChanged,

        ECustomTsyNotifyNSPSStatus,

        ECustomTsyGetCipheringInfo,

        ECustomTsyNotifyCipheringInfoChange,

        ECustomTsyNetWakeup,

        ECustomTsyNotifySsAdditionalInfo,

        ECustomTsyNotifySsRequestComplete,

        ECustomTsyNotifyCacheReady,

        ECustomTsyGetPndCacheStatus,

        ECustomTsyGetAlsPpSupport,

        ECustomTsyCallGsmBlackListClear,

        ECustomTsyCheckEmergencyNumber,

        ECustomTsyGetOperatorName,

        ECustomTsyGetProgrammableOperatorLogo,

        ECustomTsySsNotification,

        ECustomTsyGetNetworkOperatorName,

        ECustomTsyCheckTwoDigitDialSupport,

        ECustomTsySatRefreshCompleteNotification,

        ECustomTsyResetNetServer,

        ECustomTsyNotifyNetworkConnectionFailure,

        ECustomTsyGetSimFileInfo,

        ECustomTsyGetLifeTimerInfo,

        ECustomTsyGet3GPBInfo,

        ECustomTsyGetSystemNetworkModes,

        ECustomTsySetSystemNetworkMode,

        ECustomTsyGetCurrentSystemNetworkMode,

        ECustomTsyIMSAuthenticate,

        ECustomTsyGetSimAuthenticationData,

        ECustomTsySetDriveMode,

        ECustomTsyNotifyRauEvent,

        ECustomTsyReadHSxPAStatus,

        ECustomTsyWriteHSxPAStatus,

        ECustomTsyNotifyHSxPAStatus,

        ECustomTsyNotifyIccCallForwardingStatusChange,

        ECustomTsyGetIccCallForwardingStatus,

        ECustomTsyGetCellInfo,

        ECustomTsyNotifyCellInfoChange,

        ECustomTsyGetSystemNetworkBand,

        ECustomTsySetSystemNetworkBand,

		ECustomTsyGetUSIMServiceSupport,

		ECustomTsyNotifyRemoteAlertingToneStatusChange,

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

        // own request handle record in iTsyReqHandleStore above the

        // following!

        ECustomTsyMaxNumOfRequests

        };

    private:

        /** used for queuing CheckAlsPpSupport requests */

        struct TCheckAlsPpSupportRequest

            {

            /** ETel request handle */

            TTsyReqHandle iReqHandle; 

            /** pointer to client-side    data */

            RMmCustomAPI::TAlsSupport* iRetSupport; 

            };

        /** used for queuing GetSimFileInfo requests */

        struct TGetSimFileInfoRequest

            {

            /** ETel request handle */

            TTsyReqHandle iReqHandle; 

            /** pointer to client-side data */

            TDes8* iSimFileInfo; 

            };

    public:

        /**

         * Two-phased constructor.

         *

         * @param aMmPhoneTsy Pointer to a MM PhoneTSY

         */

        static CMmCustomTsy* NewL( CMmPhoneTsy* aMmPhoneTsy );

        /**

         * Destructor

         */

        virtual ~CMmCustomTsy();

        /**

         * Deliver code.

         *

         * @param aCodes

         */

        void DeliverCodeL( RMobilePhone::TCodeAndUnblockCode aCodes );

        /**

         * Returns pointer to the Phone object

         *

         * @return Pointer to the Phone object

         */

        CMmPhoneTsy* Phone();

        /**

         * Returns pointer to CMmWim object.

         *

         * @return Pointer to base class of CMmWim object

         */

        CMmSubTsyBase* GetWimTsyPtr() { return iMmSubTsy[ESubTsyIdxWIM]; };

        /**

         * Returns pointer to CMmSs object.

         *

         * @return Pointer to base class of CMmSs object

         */

        CMmCustomExtInterface* GetActiveExtensionPtr()

            { return iMmCustomExtInterface; };

        /**

         * Returns pointer to CMmSimLockTsy object.

         *

         * @return Pointer to base class of CMmSimLockTsy object

         */

        CMmSubTsyBase* GetSimLockTsyPtr()

            { return iMmSubTsy[ESubTsyIdxSimLock]; };

        /**

         * Returns pointer to CMmSIMTsy object.

         *

         * @return Pointer to base class of CMmSIMTsy object

         */

        CMmSubTsyBase* GetSIMTsyPtr() { return iMmSubTsy[ESubTsyIdxSIM]; };

        /**

         * Returns pointer to CMmPacketTsy object.

         *

         * @return Pointer to base class of CMmPacketTsy object

         */

        CMmPacketTsy* PacketTsy()

            { return ( CMmPacketTsy* )iMmSubTsy[ESubTsyIdxPacket]; };

        /**

         * Gives pointer to the array of TSY's subsystems.

         *

         * @return Array of pointers to CMmSubTsyBase classes

         */

        virtual CMmSubTsyBase** GetSubsystemArrayPtr()

            { return &iMmSubTsy[0]; };

        /**

         * Gives the maximun number of TSY's subsystems.

         *

         * @return Number of subsystems

         */

        virtual TInt GetMaxNumberOfSubsystems() { return ESubTsyIdxMaxNum; };

        /**

         * TRAP's all CMmCustomTsy related Custom API requests in case that

         * they fail. This method functions only as a centralized TRAP for the

         * DoExtFuncL method that does the actual mapping of IPC number to

         * TSY method call.

         *

         * @param aTsyReqHandle Request handle

         * @param aIpc IPC number of the request

         * @param aPackage Reference to a data package

         * @return KErrNone/KErrNotSupported

         */

        TInt ExtFunc ( const TTsyReqHandle aTsyReqHandle,

            const TInt aIpc,

            const TDataPackage& aPackage );

        /**

         * Handles extended client requests. Uses TRAP to ensure functioning

         * on memory allocation failure.

         *

         * @param aTsyReqHandle Request handle

         * @param aIpc IPC number of the request

         * @param aPackage Reference to a data package

         * @return Error value

         */

        virtual TInt DoExtFuncL( const TTsyReqHandle aTsyReqHandle,

            const TInt aIpc,

            const TDataPackage& aPackage );

        /**

         * Returns request mode for given IPC number.

         *

         * @param aIpc An interprocess communication command identifier

         * @return The ReqMode corresponding to given IPC

         */

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

        /**

         * Returns number of slots to be used for given IPC.

         *

         * @param aIpc An interprocess communication command identifier

         * @return The number of slots reserved for a given IPC

         */

        virtual TInt NumberOfSlotsL( const TInt aIpc );

        /**

         * Returns security policy for given IPC.

         *

         * @param aIpc An interprocess communication command identifier

         * @return Security policy for this IPC

         */

        virtual TSecurityPolicy GetRequiredPlatSecCaps( const TInt aIpc );

        /**

         * Cancels request of which IPC number and request handle are given in

         * parameters.

         *

         * @param aIpc An interprocess communication command identifier

         * @param aTsyReqHandle Request handle

         * @return Error value

         */

        virtual TInt CancelService( const TInt aIpc,

            const TTsyReqHandle aTsyReqHandle );

        /**

         * Register given notification.

         *

         * @param aIpc An interprocess communication command identifier

         * @return TInt KErrNotSupported

         */

        virtual TInt RegisterNotification( const TInt aIpc );

        /**

         * Deregister given notification.

         *

         * @param aIpc An interprocess communication command identifier

         * @return TInt KErrNotSupported

         */

        virtual TInt DeregisterNotification( const TInt aIpc );

        /**

         * Completes a CompleteTerminateCall request

         *

         * @param aError Error code

         */

        void CompleteTerminateCall( TInt aError );

        /**

         * Completes the GetCipheringInfoRequest

         *

         * @param aCipherIndStatus Status of ciphering indicator

         * @param aErrorCode Error code

         */

        void CompleteGetCipheringInfo( TBool aCipherIndStatus,

            TInt aErrorCode );

        /**

         * Completes a NetWakeup request

         *

         * @param aErrorCode Error code

         */

        void CompleteNetWakeup( TInt aErrorCode );

        /**

         * Completes a NotifyCipheringInfoChange request

         *

         * @param aCipherIndStatus Status of ciphering indicator

         * @param aCipherStatus Status of ciphering

         * @param aErrorCode Error code

         */

        void CompleteNotifyCipheringInfoChange( TBool aCipherIndStatus,

            TBool aCipherStatus,

            TInt aErrorCode );

        /**

         * Completes a NotifyNSPSStatus request

         *

         * @param aNspsStatus Status of NSPS (On/Off)

         */

        void CompleteNotifyNSPSStatus( TBool aNspsStatus );

        /**

         * Completes a GetAlsBlocked request

         *

         * @param aBlockStatus Status of ALS block

         * @param aErrorCode Error code

         */

        void CompleteGetAlsBlocked(

            RMmCustomAPI::TGetAlsBlockStatus aBlockStatus,

            TInt aErrorCode );

        /**

         * Completes a SetAlsBlocked request

         *

         * @param aErrorCode Error code

         */

        void CompleteSetAlsBlocked( TInt aErrorCode );

        /**

         * Completes a NotifyAlsBlockedChanged request

         *

         */

        void CompleteNotifyAlsBlockedChanged();

        /**

         * Completes a NotifyAlsBlockedChanged request

         *

         * @param aAlsSupport

         * @param aErrorCode Error code

         */

        void CompleteGetAlsPpSupport( RMmCustomAPI::TAlsSupport aAlsSupport,

            TInt aErrorCode );

        /**

         * Completes a NotifyDtmfEvent request

         *

         * @param aInfo Dtmf info

         * @param aErrorCode Error code

         */

        void CompleteNotifyDtmfEvent( RMmCustomAPI::TDtmfInfo aInfo,

            TInt aErrorCode );

        /**

         * Completes a ClearCallBlackListL request

         *

         * @param aErrorCode Error code

         */

        void CompleteClearCallBlackList( TInt aErrorCode );

        /**

         * Completes emergency number checking request

         *

         * @param aTelNumber Emergency number or NULL if check failed

         * @param aErrorValue Error value

         */

        void CompleteCheckEmergencyNumber(

            RMmCustomAPI::TMobileTelNumber* aTelNumber,

            TInt aErrorValue );

        /**

         * Completes get network provider name request

         *

         * @param aName Network provider name

         * @param aError Error value

         */

        void CompleteGetNetworkOperatorName( TDes* aName, TInt aError );

        /**

         * Completes the notification of SAT refresh to the client

         *

         */

        void CompleteSatRefreshCompleteNotification();

        /**

         * Notify RAU event

         *

         * @param aEventStatus RAU event status

         * @return Symbian error value

         */

        TInt NotifyRauEvent( RMmCustomAPI::TRauEventStatus* aEventStatus );

        /**

         * Completes RAU event notification

         *

         * @param aEventStatus RAU event status

         */

        void CompleteNotifyRauEvent(

                RMmCustomAPI::TRauEventStatus aEventStatus,

                TInt aErrorCode );

        /**

         * Cancels RAU event Notification

         *

         * @param aTsyReqHandle TSY reqhandle

         * @return Symbian error value

         */

        TInt NotifyRauEventCancel();

#ifdef REQHANDLE_TIMER

        /**

         * Calls the needed complete method due timer expiration

         *

         * @param aReqHandleType Request handle type.

         * @param aError Error value

         * @param aIPC IPC value

         */

        void Complete( TInt aReqHandleType, TInt aError, TInt aIPC );

#endif // REQHANDLE_TIMER

        /**

         * Completes checking of two digit dial support

         *

         * @param aTwoDigitDialSupport Two digit dial support status

         * @param aErrorCode Error code

         */

        void CompleteCheckTwoDigitDialSupport(

            RMmCustomAPI::TTwoDigitDialSupport aTwoDigitDialSupport,

            TInt aErrorCode );

        /**

         * Completes a requested NotifySsNetworkEvent

         *

         * @param aSsTypeAndMode ss type and mode

         * @param aSsInfo ss info

         * @param aErrorCode Error code

         */

        void CompleteNotifySsNetworkEvent(

            RMmCustomAPI::TSsTypeAndMode& aSsTypeAndMode,

            RMmCustomAPI::TSsInfo& aSsInfo,

            TInt aErrorCode );

        /**

         * Completes GetOperatorName

         *

         * @param aOperatorNameInfo Programmable operator name info

         * @param aErrorValue Error value

         */

        void CompleteGetOperatorName(