/*

* Copyright (c) 2006-2008 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:  Handles all common logic for SVP and handles sessions.

*

*/

#ifndef SVPCONTROLLER_H

#define SVPCONTROLLER_H

#include <mcemanager.h>

#include <mcesessionobserver.h>

#include <mcedtmfobserver.h>

#include <mceinsessionobserver.h>

#include <mceinreferobserver.h>

#include <mceeventobserver.h>

#include <mcestreamobserver.h>

#include <mcereferobserver.h>

#include <mcetransactiondatacontainer.h>

#include <cconvergedcallprovider.h>

#include <mccpobserver.h> 

#include <mccpssobserver.h>

#include <mccpdtmfprovider.h>

#include <wlanmgmtclient.h>

#include "svpsessionobserver.h"

#include "svpemergencysession.h"

#include "svpconsts.h"

#include "svputdefs.h"

#include "svpsupplementaryservices.h"

#include "cipappphoneutils.h"               // KSVPMaxTerminalTypeLength

// FORWARD DECLARATIONS

class CSVPRtpObserver;

class CWlanMgmtClient;

/**

 *  SVP controller

 *

 *  Handles all common logic for SVP and handles sessions.

 *

 *  @lib svp.dll

 *  @since S60 3.2 

 */

class CSVPController : public CConvergedCallProvider,

                       public MSVPSessionObserver, 

                       public MMceSessionObserver,

                       public MMceEventObserver,

                       public MMceReferObserver,

                       public MMceInSessionObserver,

                       public MMceInReferObserver,

                       public MMceStreamObserver,

                       public MMceDtmfObserver,

                       public MCCPDTMFProvider, 

                       public MSIPObserver,

                       public MSIPProfileRegistryObserver

    {

public: // new functions

    /**

    * Two-phased constructor.

    */

    static CSVPController* NewL();

    /**

    * Destructor.

    */

    virtual ~CSVPController();

public: // functions from base classes

    /**

    * From SVPSessionObserver. Removes session from session array

    * @since S60 3.2

    * @param aSession Session to be removed from session array

    */

    void RemoveFromArray( CSVPSessionBase &aSession );

    /**

    * From SVPSessionObserver. Handles session cleanup

    * when Mt session creation fails in early stages

    * @since S60 3.2

    * @param aSession Session to be removed

    */

    void TerminateSession( CMceInSession &aSession );

    /**

    * From MMceSessionObserver. The state of the session has changed.

    * @since Series 60 3.2

    * @param aSession, the session that has changed.

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

    */

    void SessionStateChanged(

    			CMceSession& aSession,

    			TMceTransactionDataContainer* aContainer );

    /**

    * From MMceSessionObserver.The state of the connection used by the session has changed.

    * @since Series 60 3.2

    * @param aSession, the session that has changed.

    * @param aActive, ETrue if connection active, EFalse if connection inactive.

    */

    void SessionConnectionStateChanged(

                CMceSession& aSession,

                TBool aActive );

    /**

    * From MMceSessionObserver.An error has occurred concerning a specific session.

    * Note, that each error causes the session state to be ETerminated.

    * @since Series 60 3.2

    * @param aSession, The session raising the error.

    * @param aError, Error code

    */

	void Failed( CMceSession& aSession, TInt aError );

	/**

    * From MMceSessionObserver.An session update has been failed concerning a specific session.

    * Note, that each error causes the session state to be ETerminated.

    * @since Series 60 3.2

    * @param aSession, The session raising the error.

    * @param aContainer, if present, holds details of

    *        transaction causing update.

    */

	void UpdateFailed(

    			CMceSession& aSession,

    			TMceTransactionDataContainer* aContainer );

     /**

    * From MMceEventObserver. The state of the event has changed.

    * @since Series 60 3.2

    * @param aEvent, the event that has changed.

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

    */

    void EventStateChanged(

    			CMceEvent& aEvent,

				TMceTransactionDataContainer* aContainer );

	/**

	* From MMceEventObserver. The state of the event has changed.

	* @since Series 60 3.2

	* @param aEvent, event received notification.

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

	*/

	void NotifyReceived(

				CMceEvent& aEvent,

				TMceTransactionDataContainer* aContainer );

    /**

    * From MMceEventObserver. The state of the event used by the refer has changed.

    * @since Series 60 3.2

    * @param aEvent, the event that has changed.

    * @param aActive, ETrue if connection active, EFalse if connection inactive.

    */

    void EventConnectionStateChanged(

                CMceEvent& aEvent,

                TBool aActive );

	/**

	* From MMceEventObserver. An error has occurred concerning a specific SIP event.

	* Note, that each error causes the event state to be ETerminated.

	* @param aEvent, The event raising the error.

	* @param aError, Error code

	*/

    void Failed(CMceEvent& aEvent, TInt aError );

	/**

    * From MMceInSessionObserver. Incoming session invitation. 

    * The CMceInSession is given to the

	* application as a callback.

    * @since Series 60 3.2

    * @param aSession, pointer to the incoming session. Ownership is

	*	     transferred.

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

    */

	void IncomingSession(

                CMceInSession* aSession,

				TMceTransactionDataContainer* aContainer );

    /**

    * From MMceInSessionObserver.Incoming session update. 

    * The new updated CMceInSession is given to the

	* application as a callback.

    * @since Series 60 3.2

    * @param aOrigSession, the original session to be updated. 

    *        This instance cannot be used anymore, 

    *        all actions done using aUpdatedSession instance.

    * @param aUpdatedSession, pointer to the new updated session. Ownership is

	*	     transferred.

    * @param aContainer, if present, holds details of

    *        update transaction.

    */

	void IncomingUpdate(

				CMceSession& aOrigSession, 

				CMceInSession* aUpdatedSession,

				TMceTransactionDataContainer* aContainer );

	/**

    * From MMceInReferObserver. New incoming refer received.

	* @since Series 60 3.2

	* @param aRefer, the new inbound refer. Ownership is

	*		 transferred.

    * @param aReferTo SIP specific Refer-to header 

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

    */

    void IncomingRefer(

				CMceInRefer* aRefer,

				const TDesC8& aReferTo,

				TMceTransactionDataContainer* aContainer );

	/**

    * From MMceStreamObserver. The state of the stream has changed.

    * @since Series 60 3.2

    * @param aStream, the stream that has changed.

    */

    void StreamStateChanged( 

                   CMceMediaStream& aStream);

    /**

    * From MMceStreamObserver. The state of the sink has changed.

    * @since Series 60 3.2

    * @param aStream, the stream that uses the sink.

    * @param aSink, the sink that has changed.

    */

    void StreamStateChanged(

                    CMceMediaStream& aStream,

                    CMceMediaSink& aSink );

    /**

    * From MMceStreamObserver. The state of the source has changed.

    * @since Series 60 3.2

    * @param aStream, the stream that uses the source.

    * @param aSource, the source that has changed.

    */

    void StreamStateChanged(

                    CMceMediaStream& aStream,

                    CMceMediaSource& aSource );

    /**

    * From MMceReferObserver. state of the refer has changed.

    * @param aRefer, the refer that has changed.

    * @param aContainer, if present, holds details of

    *        transaction causing state change.

    */

    void ReferStateChanged(

    			CMceRefer& aRefer,

				TMceTransactionDataContainer* aContainer );

    /**

    * From MMceReferObserver. The state of the connection used by the refer has changed.

    * @param aRefer, the refer that has changed.

    * @param aActive, ETrue if connection active, EFalse if connection inactive.

    */

    void ReferConnectionStateChanged(

                CMceRefer& aRefer,

                TBool aActive );

	/**

	* From MMceReferObserver. An error has occurred concerning a specific SIP refer.

	* Note, that each error causes the event state to be ETerminated.

	* @param aRefer, The refer raising the error.

	* @param aError, Error code

	*/

	void Failed( CMceRefer& aRefer, TInt aError );

// from MConvergedCallProvider 

	/**

	* Initializes plug-in. All required parameters must be passed

	* with this function in order to use services.

	* Simplifies pluging construct removing need to pass parameters to ECom interface

	* @since Series60 3.2

	* @param aMonitor CCP observer

	* @param aSsObserver SS observer

	*/

	void InitializeL( const TUint32 aServiceId,

					  const MCCPObserver& aObserver, 

					  const MCCPSsObserver& aSsObserver );

   	/**

    * Initializes plug-in. All required parameters must be passed

    * with this function in order to use services.

    * Simplifies pluging construct removing need to pass parameters to ECom interface

    * @since Series60 3.2

    * @param aMonitor CCP observer

    * @param aSsObserver SS observer

    */

    void InitializeL( const MCCPObserver& aMonitor,

                      const MCCPSsObserver& aSsObserver );

    /**

    * Creates a new session and checks secure status from profile. Leaves with

    * ECCPErrorNetworkBusy if not enough WLAN bandwith.

    * @since Series60 3.2

    * @param aParameters Call parameters, SVP uses Service ID parameter

    * @param aRecipient Recipients address/number

    * @param aObserver Observer

    * @return MCCPCall

    */

    MCCPCall* NewCallL( const CCCPCallParameters& aParameters,

					    const TDesC& aRecipient,

					    const MCCPCallObserver& aObserver );

    /**

    * Returns Uid of plug-in which is on use.

    * @since Series60 3.2

    * @return Uid of plug-in

    */                        

    const TUid& Uid() const;

    /**

    * Creates a new Emergency call and add user-agent header.

    * @since Series60 3.2

    * @param aServiceId Service ID, obsolete!

    * @param aAddress Emergency number

    * @param aObserver Observer

    * @return MCCPEmergencyCall

    */

    MCCPEmergencyCall* NewEmergencyCallL( const TUint32 aServiceId,

                                          const TDesC&  aAddress,

                                          const MCCPCallObserver& aObserver );

    /**

    * Creates a new conference session.

    * @since Series60 3.2

    * @param aObserver Observer

    * @return MCCPConferenceCall

    */

    MCCPConferenceCall* NewConferenceL( const TUint32 aServiceId,

                              const MCCPConferenceCallObserver& aObserver );

    /**

    * Releases call

    * @since Series60 3.2

    * @param aCall Call to be removed

    * @return Symbian error code

    */

    TInt ReleaseCall( MCCPCall& aCall );

    /**

    * Releases emergency call

    * @since Series60 3.2

    * @param aCall Call to be removed

    * @return Symbian error code

    */

    TInt ReleaseEmergencyCall( MCCPEmergencyCall& aCall );

    /**

    * Releases conference call

    * @since Series60 3.2

    * @param aCall Call to be removed

    * @return Symbian error code

    */

    TInt ReleaseConferenceCall( MCCPConferenceCall& aCall );

    /**

    * Notifies Plug-In about transfer status.

    * @since Series 60 3.2

    * @param aAccept Boolean value is transfer accepted or not.

    * @return None

    */                      

    void AcceptTransfer( TBool aAccept );

    /**

    * Notification from UI to Multiple choices query

    * multiple choices response

    * @since Series 60 3.2

    * @param aIndex index of address where the call is to be forwarded

    * @return KErrNone if succesfull

    */  

    TInt ForwardCallToAddressL( const TInt aIndex );

    /**

    * Get Plug-In capabilities

    * @since Series 60 3.2

    * @return TUint32 On return contains the capability flags of plug-In

    */

    TUint32 Caps() const;

	/**

	* Get DTMF provider

	* @since Series 60 3.2

	* @param aObserver CCP Dtmf observer for informing events

	* @return Pointer to MCCPDTMFProvider if succesfull, NULL if not available

	*/

	MCCPDTMFProvider* DTMFProviderL( const MCCPDTMFObserver& aObserver );

	/**

	* Get extension provider

	* @since Series 60 3.2

    * @param aObserver observer for extension(custom) events

	* @return Pointer to MCCPExtensionProvider if succesfull, NULL if not available

	*/

	MCCPExtensionProvider* ExtensionProviderL( const MCCPExtensionObserver& aObserver );

    /**

    * Add an observer for DTMF related events.

    * Plug-in dependent feature if duplicates or more than one observers 

    * are allowed or not. Currently CCE will set only one observer.

    * @since S60 v3.2

    * @param aObserver Observer

    * @leave system error if observer adding fails

    */

    void AddObserverL( const MCCPDTMFObserver& aObserver );

    /**

    * Remove an observer.

    * @since S60 v3.2

    * @param aObserver Observer

    * @return KErrNone if removed succesfully. KErrNotFound if observer was not found.

    * Any other system error depending on the error.

    */

    TInt RemoveObserver( const MCCPDTMFObserver& aObserver );

// from MCCPDTMFProvider

    /**

	* Cancels asynchronous DTMF string sending.

	* @return KErrNone if successful, otherwise system wide error code

	* @since Series 60 3.2

	*/

	TInt CancelDtmfStringSending();

	/**

	* Starts the transmission of a single DTMF tone across a

	* connected and active call.

	* @since S60 3.2

	* @param aTone Tone to be played.

	* @return KErrNone if successful, otherwise another system wide error code

	*/

	TInt StartDtmfTone( const TChar aTone );

	/**

	* Stops playing current DTMF tone.

	* @since S60 3.2

    * @param none

	* @return KErrNone if successfull, otherwise another system wide error code

	*/

	TInt StopDtmfTone();

	/**

	* Plays DTMF string.

	* @since S60 3.2

	* @param aString String to be played.

	* @return KErrNone if successful, otherwise another system wide error code

	* KErrArgument if the specified string contains illegal DTMF characters

	*/

	TInt SendDtmfToneString( const TDesC& aString );

	/**

	* Continue or cancel sending DTMF string which was stopped with 'w'-character

	* in string.

	* @since S60 3.2

	* @param aContinue ETrue if sending of the DTMF string should continue,

	* EFalse if the rest of the DTMF string is to be discarded.

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

	TInt ContinueDtmfStringSending( const TBool aContinue );   

// from Mce DTMF observer

public: 

    /**

    * Incoming DTMF tone received.

    * @param aSession Session that tone was received.

    * @param aStream Stream that tone was received.

    * @param aTone Received tone.

    */

    void DtmfToneReceived( CMceSession& aSession,

                           CMceAudioStream& aStream,

                           const TChar& aTone );

    /**

    * DTMF event received.

    * @param aSession Session that event was received.

    * @param aStream Stream that event was received.

    * @param aSource Source that event was received.

    * @param aEvent Received event.

    */

    void DtmfEventReceived( CMceSession& aSession,

                            CMceAudioStream& aStream,

                            CMceMediaSource& aSource,

                            TMceDtmfEvent aEvent );

    /**

    * DTMF error occured. If error occurs, DTMFs becomes

    * unavailable for that source.

    * @param aSession Session that event was received.

    * @param aStream Stream that event was received.

    * @param aStream Stream that event was received.

    * @param aError Error code.

    */

    void DtmfErrorOccured( CMceSession& aSession,

                           CMceAudioStream& aStream,

                           CMceMediaSource& aSource,

                           TInt aError );

public: // methods from MSIPObserver

    /**

    * From MSIPObserver A SIP request has been received from the network. 

    * @since  Series 60 3.0

    * @param  aIapId The IapId from which the SIP request was received.