/*

* Copyright (c) 2002-2005 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 class provides the the implementation for CSuplSessionBase

*								 to provide the session objects for OMA SUPL Protocol Handler

*

*/

#ifndef C_COMASUPLSESSION_H

#define C_COMASUPLSESSION_H

// INCLUDES

#include <e32def.h>

#include <e32base.h>

#include <e32cmn.h> 

#include "epos_suplterminalparams.h"

#include "epos_comasupliapchangenotifier.h"

#include "epos_comasupletelnotifier.h"

#include "epos_csuplprotocolmanagerbase.h"

#include "epos_csuplsessionbase.h"

#include "lbs/epos_momasuplobserver.h"

#include "lbs/epos_comasuplpossessionbase.h"

#include "epos_comasuplasnmessagebase.h"

#include "epos_comasuplend.h"

#include "epos_momasuplconnobserver.h"

#include "epos_comasupluicompletionobserver.h"

#include "epos_comasupletelcompletionobserver.h"

#include "epos_momasuplprivacyobserver.h"

#include "epos_comasuplcompleteselfrequestor.h"

#include "epos_comasuplstate.h"

#include "epos_omasuplconstants.h"

#include "epos_comasuplsettingslauncher.h"

#include "epos_momasupltimeoutnotifier.h"

#include "epos_tomasuplposmethod.h"

#include "epos_momasupldialogtimeoutnotifier.h"

#include "epos_csuplsettingsinternal.h"

#include "EPos_CPosNetworkPrivacy.h"

class RMobilePhone;

class TOMASuplVersion;

class COMASuplSessionID;

class CSuplCommunicationManager;

class COMASuplConnRequestor;

class COMASuplTrace;

class COMASuplSettings;

class COMASuplState;

class COMASuplPosition;

class MOMASuplSessionObserver;

class TPositionInfo;

class COMASuplPosHandlerBase;

class COMASuplPosSessionBase;

class COMASuplSETCapabilities;

class COMASuplPOSRequestor;

class CSuplSettings;

class COMASuplTimeoutTimer;

class COMASuplDialogTimer;

class COMASUPLProtocolManager1;

class COMASuplAsnHandlerBase;

struct TCellIdInfo

    {

	    TInt iMNC;

	    TInt iMCC;

	    TInt iCid;

	    TInt iLac; 

    };

//class COMASuplETelNotifier;

/**

*  SUPL Session Object in OMA SUPL Protocol Handler plug-in

*  This class is responsible for processing and generating 

*  the OMA SUPL protocol messages

*

*  @lib EPosOMASUPLProtocolHandler.lib

*  @since S60 v3.1u

*/

class COMASuplSession : public CSuplSessionBase,

						public MOMASuplConnObserver,

                        public MOMASuplUICompletionObserver,

						public MCompleteSelfRequest,

						public MOMASuplMsgStateObserver,

						public MOMASuplObserver,

						public MOMASuplPrivacyObserver,

						public MOMASuplTimeOutNotifier,

                        public MOMASuplEtelCompletionObserver,

                        public MOMASuplIapChangeNotifierObserver,

                        public MOMASuplDialogTimeOutNotifier

{

  public:  // Constructors and destructor

	    // State Enums

	  enum TOMASuplSessionState

			{

				ESUPL_INITIALIZED = 0x001,

				ESUPL_CONNECTING,

				ESUPL_GENERATE,

				ESUPL_ENCODE,

				ESUPL_SEND,

				ESUPL_RECEIVED,

				ESUPL_SESSION_ERROR,

				ESUPL_TERMINATED

			};

			enum TOMASuplMsgType

			{

				ESUPL_START,

				ESUPL_RESPONSE,

				ESUPL_INIT,

				ESUPL_POSINIT,

				ESUPL_POS,

				ESUPL_END,

				ESUPL_AUTH_REQ,

				ESUPL_AUTH_RESP    	

			};

			// Request Type enum

			enum TOMASuplReqType

			{

				ESUPL_NETWORK,

				ESUPL_TERMINAL,

				ESUPL_INVALID_SESSION,

				ESUPL_NETWORK_INVALID_SESSION

			};

	public:  // Constructors and destructor        

			/**

			* NewL,Two-phased constructor.

			* @since S60 v3.1u

			* @param aCommManager,communication manager for sending packet to SLP CSuplCommunicationManager 

			* @param aMobilePhone,RMobilePhone

			* @param aSettings ,settings for holding HSLP IP address & IAP Id.

			* @param aRequestType,Type of request SET , NET or Invalid session

			* @param aSessionObserver,observer for this class.

			* @return None

			*/

		    static COMASuplSession* NewL(CSuplCommunicationManager& aCommManager,

																		RMobilePhone& aMobilePhone,

																		COMASuplSettings*& aSettings,

																		CSuplSettingsInternal* aSettingsStorage,

																		TOMASuplReqType aRequestType,

																		MOMASuplSessionObserver &aSessionObserver,

																		COMASuplPosHandlerBase *aPosHandler,

																		TDes& aIMSI,

																		COMASUPLProtocolManager1 &aProtoMgr,

																		TInt aIpcSessionId,

																		COMASuplAsnHandlerBase* aOMASuplAsnHandlerBase

                                    );

	private:        

			/**

			* Destructor.

			*/

			 ~COMASuplSession();

	public:

			/**

			* Delete Session Explicitly.

			* @since  S60 v3.1u

			* @param  None

			* @return None

			*/

			void DestroySession();

			/**

	        * Handles Pos handler unload.

	        * @since  S60 v3.1u

	        * @param  None

	        * @return None

	        */         

	         void PosPlugInUnloaded();

	public: //For all Observers

	        /**

	        * OperationComplete Method, Completion of any Async operation

	        * @since S60 v3.1u

	        * @param aErrorCode, Error code,if any

	        * @return None

	        */

			void OperationCompleteL(TInt aErrorCode);

			/**

	        * GetPositionComplete Method, Completion of get position opertaion from Pos Module

	        * @since S60 v3.1u

	        * @param aErrorCode, Error code,if any

	        * @return None

	        */

			void GetPositionComplete(TInt aError);

        	/** 

            * This callback method is used to notify the client about 

            * the completion of UI launch

            * @param aError - Error during Launch

            * @return None

            */

            /** 

            * This callback method is used to notify the client about 

            * the completion of UI

            * @return None

            */

            /** 

            * This callback method is used to notify the client about 

            * the completion of UI 

            * @return None

            */

	public: 			 

			/**

			* InitializeL Method.

			* @since S60 v3.1u

			* @param aRequestID, Request Identification number.

			* @return None

			*/

			virtual void InitializeL(TInt aRequestID);

			/**

			* CleanUp Method.

			* @since S60 v3.1

			* @param None

			* @return None

			*/

			virtual void CleanUp();

			/**

			* RunSuplSession Method.

			* @since S60 v3.1

			* @param aStatus, aSynchronous service request   

			* @param aAllowedCapabilities, Capabilities of SET

			* @param aSessionIdSeed, seed value of session

			* @param aRequestID, Request Identification number.

			* @return None

			*/

			virtual void RunSuplSessionL(TRequestStatus& aStatus, TBool aFirstReq, const TDesC& aHslpAddress, TBool aFallBack, TInt aAllowedCapabilities, 

										 TInt aSessionIdSeed, TInt aRequestID = 0);

			/**

			* RunSessionL, Starts the SUPL Sesssion for Terminal Initiated Location Request

			* @since S60 v3.1

			* @param       aStatus, 	  On completion, sets status of the request

			* @param       aAllowedCapabilities , Allowed capabilities of SET

			* @param 	   aSessionIdSeed, seed value of session

			* @Param:      aQop,  specifies the quality of position

			* @param       aRequestID , Request ID of Session

			* @return      None

			*/

		  virtual void  RunSuplSessionL(TRequestStatus& aStatus, TBool aFirstReq,

		                                        const TDesC& aHslpAddress, TBool aFallBack,

		  										TInt aAllowedCapabilities,TInt aSessionIdSeed,

		  										TSuplTerminalQop& aQop, TInt aRequestID = 0);

			/**

			* RunInvalidSessionL Method

			* @since S60 v3.1u

			* @param aSessionId, the invalid session Id received by COMASUPLProtocolManager1

			* @return None

			*/	 

			virtual void RunInvalidSessionL(COMASuplAsnMessageBase* aDecodedMsg);

			/**

			* HandleInvalidSLPSession Method

			* @since S60 v3.1u

			* @none

			* @return None

			*/	 

			void HandleInvalidSLPSession();

			/**

			* GetPosition Method.

			* @since S60 v3.1u

			* @param aSuplPosInfo,

			* @return TInt 

			*/

			virtual TInt GetPosition(TPositionInfo& aSuplPosInfo);        									 

			virtual TInt GetServerAddressL(TDes& ahslpAddress);

			/**

			* GetPosition Method.

			* @since S60 v3.1u

			* @param aSuplPosInfo,HPositionGenericInfo

			* @return TInt 

			*/

			virtual TInt GetPosition(HPositionGenericInfo& aSuplPosInfo);        									 

			/**

			* SetEncodedSuplInitL Method.

			* @since S60 v3.1u

			* @param aEncodedSuplInit A HBufC pointer holding the

			* encoded SUPL INIT packet

			* @return none

			*/

			void SetEncodedSuplInitL(HBufC8 *aEncodedSuplInit);       									 

		    void HandleCurrentNetworkChangeL(TInt aErrorCode, TBool aHomeNw);

		    void HandleRoamingCheckCompleteL(TInt aErrorCode, TBool aHomeNw);

            void HandleIapSettingsChangeL(TInt aErrorCode);

			/**

			* SuplIpcSessionID Method. Returns IPC session ID 

			* @since S60 v3.2

			* @param None

			* @return None

			*/

			TInt SuplIpcSessionID();

			/**

			* UpdateSuplUsage Method.  Updates SUPL usage 

			* @since S60 v3.2

			* @param None

			* @return None

			*/

			void UpdateSuplUsage();

			/**

			* SettingsChanged Method.  Updates flag to indicate that

            * settings has changed 

			* @since S60 v3.2

			* @param None

			* @return None

			*/

            void SettingsChanged();

    protected:  // New functions

    protected:  //COMASuplCompleteSelfRequestor

			/**

			* RequestCompleted Method.,Called after self complete completed

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

	    	void RequestCompletedL();

    private:

			/**

			* C++ default constructor.

			* @since S60 v3.1u

			* @param aMobilePhone,RMobilePhone 

			* @param aRequestType,Type of request SET , NET or Invalid session

			* @param aSessionObserver,observer for this class.

			* @return None

			*/

			COMASuplSession(RMobilePhone& aMobilePhone,

											TOMASuplReqType aRequestType,

											COMASuplPosHandlerBase *aPosHandler,

											MOMASuplSessionObserver& aSessionObserver,

											COMASuplSettings*& aSettings,

											COMASUPLProtocolManager1 &aProtoMgr,

											TInt aIpcSessionId,

											COMASuplAsnHandlerBase* aOMASuplAsnHandlerBase

                            );

			/**

			* By default Symbian 2nd phase constructor is private.

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void ConstructL(CSuplCommunicationManager &aCommManager, 

			                CSuplSettingsInternal* aSettingsStorage,

			                TDes& aIMSI);

	private:

			/**

			* GetLocalIPAddress Method. Reads Local IP address

			* @since S60 v3.1u

			* @param None,

			* @return TUint32, IPAddress in TUint32 form 

			*/

			TInt GetLocalIPAddress();	

			/**

			* UpdateSuplSessionIDL Method,Updates SLP sessionId,which got from SLP

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void UpdateSuplSessionIDL();	

			/**

			* UpdateSLPSessionID Method,Updates SLP sessionId,which got from SLP

			* @since S60 v3.1u

			* @param aSessionID,SLP Session id by which current sessions id to update.

			* @return None

			*/

			void UpdateSLPSessionIDL(COMASuplSessionID *aSessionID);

			/**

			* UpdateSLPSessionID Method,Updates SLP sessionId,which got from SLP

			* @since S60 v3.1u

			* @param aSessionID,SLP Session id by which current sessions id to update.

			* @return None

			*/

			void UpdateSETSessionIDL(COMASuplSessionID *aSessionID);

			/**

			* CreateCloneMessageL Method,Creates Clone of COMASuplAsnMessageBase

			* @since S60 v3.1u

			* @param @aDecodedAsnMessage,Clone to be create COMASuplAsnMessageBase

			* @return None

			*/

			void CreateCloneMessageL(COMASuplAsnMessageBase* aDecodedAsnMessage);

			/**

			* GenerateSuplMessage Method,generates SUPL Message

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void GenerateSuplMessageL();

			/**

			* GenerateSuplStartL Method,generates SUPL_START Message

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void GenerateSuplStartL();		

			/**

			* GenerateSuplPosInitL Method,generates SUPL_POS_INIT Message

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void GenerateSuplPosInitL();		

			/**

			* GenerateSuplEndL Method,generates SUPL_END Message

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void GenerateSuplEndL();				

			/**

			* GenerateSuplPosL Method,generates SUPL_POS Message

			* @since Series 60 3.1u

			* @param None

			* @return None

			*/

			void GenerateSuplPosL();				

			/**

			* ProcessSuplResponseL Method,processes SUPL_RESPONCE Message

			* @since S60 v3.1u

			* @param None

			* @return Message to be sent to SLP

			*/

			void ProcessSuplResponseL();		

			/**

			* ProcessSuplEndL Method.

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void ProcessSuplEndL();		

			/**

			* ProcessSuplPosL Method.

			* @since S60 v3.1u

			* @param None

			* @return None

			**/

			void ProcessSuplPosL();

			/**

			* ProcessSuplInitL Method.

			* @since S60 v3.1u

			* @param None

			* @return None

			**/

			void ProcessSuplInitL();

			/**

			* ProcessSuplAuthResponceL Method.

			* @since S60 v3.1

			* @param None

			* @return None

			**/

			void ProcessSuplAuthResponceL();

			/**

			* CancelAllOperations Method.

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void CancelAllOperations();		

			/**

			* CopySETCapabilities Method.

			* @since S60 v3.1u

			* @param None

			* @return None

			*/

			void CopySETCapabilities();