// Copyright (c) 2007-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:

// suplproxymodule.cpp

// This file provides the class implementation of the ECOM plug-in 

// interface for the LBS Supl Proxy Protocol Module.

// 

//

#include <ecom/implementationproxy.h>

#include "lbsdevloggermacros.h"

#include <lbs/lbsadmin.h>

#include <lbscommon.h>

#include <lbspositioninfo.h>

#include "suplproxymodule.h"

#include "lbssuplproxyserverreturncodes.h"

#include <lbs/lbsnetclasstypes.h>  

#include <lbs/epos_eomasuplposerrors.h>

#include <lbs/lbsassistancereferencelocation.h>

#include <lbs/lbsassistancedatabuilderset.h>

#include <centralrepository.h>

#include <lbs/lbsgpsmeasurement.h>

#include <lbssatellite.h>

/** The unique ID of this plug-in implementation.

 This corresponds to the implementation UID specified in the .rss file

 for this protocol module.

 */

const TInt KPluginUidValue = 0x102871EC;

//Uid of the supl proxy protocol module dll

const TInt KSPPModuleDllUid = 0x102871ED;

/** The UID for the central repository file used by the supl proxy protocol module */

const TUid KLbsSuplProxyProtocolModuleCenRepUid = {0x102871ED};

/** The entry in cen rep where the reference location source UID is placed */

const TUint32 KLbsRefLocationSource = 0x00000001;

/** The entry in cen rep where the TI plugin UID is placed */

const TUint32 KLbsTiPluginImpl = 0x00000002;

/** 

 Static public constructor.

 @param aObserver Plug-in parameters, which includes a reference to this protocol module's observer.

 @return A new instance of the CSuplProxyProtocol class.

 */

CSuplProxyProtocol* CSuplProxyProtocol::NewL(TAny* aParam)

    {

    LBSLOG(ELogP1, "CSuplProxyProtocol::NewL() Begin\n");

    TLbsNetProtocolModuleParams* param =

            reinterpret_cast<TLbsNetProtocolModuleParams*> (aParam);

    CSuplProxyProtocol* self = new (ELeave) CSuplProxyProtocol(static_cast<MLbsNetworkProtocolObserver2&>(param->Observer()));

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    LBSLOG(ELogP1, "CSuplProxyProtocol::NewL() End\n");

    return self;

    }

/** 

 Standard destructor.

 */

CSuplProxyProtocol::~CSuplProxyProtocol()

    {

    LBSLOG(ELogP1, "CSuplProxyProtocol::~CSuplProxyProtocol() Begin\n");

    delete iRequestBuffer;

    delete iServer;

    if (iSuplTiApiWrapper)

        {

        iSuplTiApiWrapper->CloseSession();

        delete iSuplTiApiWrapper;

        }

    iLbsNetSessions.ResetAndDestroy();

    LBSLOG(ELogP1, "CSuplProxyProtocol::~CSuplProxyProtocol() End\n");

    }

/** 

Request to cancel a previous privacy verification request.

@param aCancelInfo The information required to cancel the request.

*/	

void CSuplProxyProtocol::CancelVerifyLocationRequest(CCancelSuplProxyPrivacyRequestInfo* aCancelInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::CancelVerifyLocationRequest() Begin\n");

	TInt requestId = aCancelInfo->GetRequestId();

	TInt cancelReason = aCancelInfo->CancelReason();

	// Complete the session

	CSuplProxyPrivacyRequestInfo* request = iRequestBuffer->FindRequest(requestId);

	if (request)

		{

		TLbsNetSessionId sessionId(TUid::Uid(KPluginUidValue),requestId);

		LBSLOG2(ELogP1, "-->ProcessSessionComplete(0x%x)\n", sessionId.SessionNum());

		iObserver.ProcessSessionComplete(sessionId,cancelReason);	

		request->SetIsSessionCompleteAutomatic(EFalse);

		}

	// Cancel any waiting requests with this ID in the buffer

	iRequestBuffer->CancelAnyOutstandingRequestById(requestId, cancelReason);

    //Remove the positioning session object from the list. 

    //[added during a privacy session to help differentiate an MTLR &

    //triggered session at a later stage]

    TInt index = iLbsNetSessions.Find(requestId,CLbsNetSession::IsSessionNumMatch);

    if (index >= 0) //has already been added during an earlier verifylocationrequest

        {

        CLbsNetSession* netSession = iLbsNetSessions[index];

        LBSLOG2(ELogP1, "CSuplProxyProtocol::CancelVerifyLocationRequest() Removing sppm session object 0x%x to array\n", requestId);

        iLbsNetSessions.Remove(index);

        delete netSession;

        }

	// We're done with this now, so delete

	delete aCancelInfo;

	LBSLOG(ELogP1, "CSuplProxyProtocol::CancelVerifyLocationRequest() End\n");

	}

/** 

Request to get the next session ID to use for a new privacy request.

@param aSessionId Reference to a TLbsNetSessionId to populate with the new session ID.

*/	

void CSuplProxyProtocol::GetNextSessionId(TLbsNetSessionId& aSessionId)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::GetNextSessionId() Begin\n");

	aSessionId = iNextSessionId;

	if (iNextSessionId.SessionNum() == KMaxTInt)

		{

		iNextSessionId.SetSessionNum(0);

		}

	iNextSessionId.IncrSession();

	LBSLOG(ELogP1, "CSuplProxyProtocol::GetNextSessionId() End\n");

	}

/** 

Send a privacy notification request to the LBS sub-system.

@param aRequestInfo The information about this request.

*/	

void CSuplProxyProtocol::NotifyLocationRequest(CSuplProxyPrivacyRequestInfo* aRequestInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::NotifyLocationRequest() Begin\n");

	ProcessRequest(aRequestInfo);

	LBSLOG(ELogP1, "CSuplProxyProtocol::NotifyLocationRequest() End\n");

	}

/** 

Notifies the LBS sub-system that a previous privacy verification request timed out in the network.

@param aRequestInfo The information about this request.

*/	

void CSuplProxyProtocol::NotifyVerificationTimeout(CSuplProxyPrivacyRequestInfo* aRequestInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::NotifyVerificationTimeout() Begin\n");

	ProcessRequest(aRequestInfo);

	LBSLOG(ELogP1, "CSuplProxyProtocol::NotifyVerificationTimeout() End\n");

	}

/** 

Sends a privacy verification request to the LBS sub-system.

@param aRequestInfo The information about this request.

*/	

void CSuplProxyProtocol::VerifyLocationRequest(CSuplProxyPrivacyRequestInfo* aRequestInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::VerifyLocationRequest() Begin\n");

	ProcessRequest(aRequestInfo);

	LBSLOG(ELogP1, "CSuplProxyProtocol::VerifyLocationRequest() End\n");

	}

/** 

Sends a privacy request to the LBS sub-system.

@param aRequestInfo The information about this request.

*/	

void CSuplProxyProtocol::PrivacyLocationRequest(CSuplProxyPrivacyRequestInfo* aRequestInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::PrivacyLocationRequest() Begin\n");

	ProcessRequest(aRequestInfo);

	LBSLOG(ELogP1, "CSuplProxyProtocol::PrivacyLocationRequest() End\n");

	}

/**

Completes the privacy request session. This is part of the call made from the client side, so 

The client gets notified of this.

@param aRequestId The session of the privacy request to be completed

@param aReason The reason for which is completed

*/

void CSuplProxyProtocol::CompletePrivacyRequest(TUint32 aRequestId, 

												TInt aReason)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::CompletePrivacyRequest() Begin\n");

	CSuplProxyPrivacyRequestInfo* request = iRequestBuffer->FindRequest(aRequestId);

	if (request)

		{

		// Need to complete the message for LBS

		TLbsNetSessionId sessionId(TUid::Uid(KPluginUidValue),aRequestId);

		if(aReason != KErrNone)	// only terminate the session in anomalous situations. In other cases we expect a location request

			{

            LBSLOG2(ELogP1, "-->ProcessSessionComplete(0x%x)\n", sessionId.SessionNum());

			iObserver.ProcessSessionComplete(sessionId,aReason);	 

			request->SetIsSessionCompleteAutomatic(EFalse);

			//Remove the positioning session data object - incase it had been added

			//[added during a privacy session to help differentiate an MTLR &

			//triggered session at a later stage]

           TInt requestId = request->GetRequestId();

           TInt index = iLbsNetSessions.Find(requestId, CLbsNetSession::IsSessionNumMatch);

           if (index >= 0)

               {

               CLbsNetSession* netSession = iLbsNetSessions[index];

               LBSLOG2(ELogP1, "CSuplProxyProtocol::CompletePrivacyRequest() Removing sppm session object 0x%x to array\n", aRequestId);

               iLbsNetSessions.Remove(index);

               delete netSession;               

               }//if

			}//if

		// Complete the request if it is awaiting a response.

		if (request->IsResponseRequired())

			{

			request->CompleteRequest(KRequestCancelledByClient);

			}

		// Remove the request and delete

		iRequestBuffer->RemoveRequest(request);

		delete request;

		}

	LBSLOG(ELogP1, "CSuplProxyProtocol::CompletePrivacyRequest() End\n");

	}

/**

Signals that a client has disconnected a privacy session from the server.

Normally the disconnect will be because the client has closed the privacy session, but it may also 

be because the client panicked. 

We must clean up any outstanding requests the client had here.

@param aSession Session object for the client that disconnected.

*/

void CSuplProxyProtocol::PrivacySessionDisconnected(const CSession2* aSession, TInt aReason)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::PrivacySessionDisconnected() Begin\n");

	// Complete the privacy session

	CSuplProxyPrivacyRequestInfo* request = iRequestBuffer->FindRequest(aSession);

	if (request)

		{

		TInt requestId = request->GetRequestId();

		TLbsNetSessionId sessionId(TUid::Uid(KPluginUidValue),requestId);

		if(aReason != KErrNone) // only terminate the session in anomalous situations. In other cases we expect a location request

	            {

                LBSLOG2(ELogP1, "-->ProcessSessionComplete(0x%x)\n", sessionId.SessionNum());

	            iObserver.ProcessSessionComplete(sessionId,aReason);     

	            request->SetIsSessionCompleteAutomatic(EFalse);

	            //Remove the positioning session data object - incase it had been added

	            //[added during a privacy session to help differentiate an MTLR &

	            //triggered session at a later stage]

	           TInt index = iLbsNetSessions.Find(requestId, CLbsNetSession::IsSessionNumMatch);

	           if (index >= 0)

	               {

	               CLbsNetSession* netSession = iLbsNetSessions[index];

	               LBSLOG2(ELogP1, "CSuplProxyProtocol::PrivacySessionDisconnected() Removing sppm session object 0x%x to array\n", requestId);

	               iLbsNetSessions.Remove(index);

	               delete netSession;	              

	               }//if

	            }//if

		}

	// Check if any buffered requests need to be cancelled

	iRequestBuffer->CancelAnyOutstandingRequestBySession(aSession);

    iRequestBuffer->RemoveRequest(request);

    delete request;

	LBSLOG(ELogP1, "CSuplProxyProtocol::PrivacySessionDisconnected() End\n");	

	}

void CSuplProxyProtocol::EndPrivacySession(TInt aRequestId, TInt aReason)

	{

	TLbsNetSessionId sessionId(TUid::Uid(KPluginUidValue),aRequestId);

	LBSLOG2(ELogP1, "-->ProcessSessionComplete(0x%x)\n", sessionId.SessionNum());

	iObserver.ProcessSessionComplete(sessionId,aReason);

	}

/** 

Called by the Network Gateway in response to our privacy requests.

@param aSessionId The ID of the session.

@param aResponse Response information for this privacy session.

*/	

void CSuplProxyProtocol::RespondPrivacyRequest(const TLbsNetSessionId& aSessionId, const TLbsPrivacyResponse& aResponse, TInt /*aReason*/)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::RespondPrivacyRequest() Begin\n");

	// Locate the request in the buffer

	CSuplProxyPrivacyRequestInfo* request = iRequestBuffer->FindRequest(aSessionId.SessionNum());

	if (request)

		{

		// Complete the active request if it is awaiting a response

		if (request->IsResponseRequired())

			{

			// If this is a verification being accepted, timestamp the positioning session object. 

			// If a notification arrives shortly from the same requestor we will not create a new positioning session object

			// since that notification is simply the SUPL FW's post-verification notification for the same privacy request.

			TInt index = iLbsNetSessions.Find(aSessionId,CLbsNetSession::IsSessionMatch);

            if (index >= 0) 

                {

                TTime currentTime;

                currentTime.UniversalTime();

                CLbsNetSession* netSession = iLbsNetSessions[index];

                netSession->SetResponseTimeStamp(currentTime);

                }

			if(request->ConvertResponseCode())

				{

                request->CompleteRequest((aResponse == EPrivacyResponseAccepted) ? KErrNone : KErrAccessDenied);

				}

			else

				{

				request->CompleteRequest(aResponse);

				}

			// Only need to respond once, so clear the flag.

			request->SetIsResponseRequired(EFalse);

			}

		// If privacy request was not accepted then close the LBS session

		if(request->IsSessionCompleteAutomatic() && (EPrivacyResponseAccepted != aResponse))

			{

			// Notify network gateway that this session is complete

            LBSLOG2(ELogP1, "-->ProcessSessionComplete(0x%x)\n", aSessionId.SessionNum());

			iObserver.ProcessSessionComplete(aSessionId, KErrNone);		

			request->SetIsSessionCompleteAutomatic(EFalse);

			// Remove the request and delete

			iRequestBuffer->RemoveRequest(request);

			delete request;

	        //Remove the positioning session object from the list. 

            //[added during a privacy session to help differentiate an MTLR &

            //triggered session at a later stage]

			TInt index = iLbsNetSessions.Find(aSessionId,CLbsNetSession::IsSessionMatch);

            if (index >= 0) 

                {

                CLbsNetSession* netSession = iLbsNetSessions[index];

                LBSLOG2(ELogP1, "CSuplProxyProtocol::RespondPrivacyRequest() Removing sppm session object 0x%x to array\n", aSessionId);

                iLbsNetSessions.Remove(index);

                delete netSession;                

                }

            }

		}

	else

		{

		LBSLOG(ELogP2, "CSuplProxyProtocol::RespondPrivacyRequest() Unexpected response\n");

		}

	LBSLOG(ELogP1, "CSuplProxyProtocol::RespondPrivacyRequest() End\n");

	}

//---------------------------------------------------------------------------

// SPI methods for Positioning Requests:

//---------------------------------------------------------------------------

/**

Send a response to a location request to the network.

@see CLbsNetworkProtocolBase::RespondLocationRequest()

*/

void CSuplProxyProtocol::RespondLocationRequest(const TLbsNetSessionId& aSessionId, TInt aReason, 

												const TPositionInfoBase& aPosInfo)

	{

	LBSLOG(ELogP1, "CSuplProxyProtocol::RespondLocationRequest() Begin\n");

	// This class needs to be able to deal with multiple sessions (MOLR/MTLR) at once 

	// and each session can have an outstanding request 

	// we need to complete the right one here =)

    // Find and complete the outstanding location request

    TInt index = iLbsNetSessions.Find(aSessionId,CLbsNetSession::IsSessionMatch);

    if (index >= 0)

        {

        LBSLOG(ELogP1, "CSuplProxyProtocol - found matching request\n");

        CLbsNetSession* netSession = iLbsNetSessions[index];

        switch (netSession->Type())

            {

            case CLbsNetSession::EPosRequestTypeGetPosition:

                {

                LBSLOG(ELogP1, "Outstanding EPosRequestTypeGetPosition request\n");

                // assert there really is a message to complete

                __ASSERT_DEBUG(!netSession->Msg().IsNull(),User::Invariant());      

                if(aReason == KErrNone)

                    {

					// Fill in what we have of the position structure that was passed to us

					TInt clientPosSize = netSession->Msg().GetDesLength(0);

					__ASSERT_DEBUG(clientPosSize >= 0,User::Invariant()); 

					TInt posInfoSize = aPosInfo.PositionClassSize();

					TInt copySize = (clientPosSize < posInfoSize? clientPosSize : posInfoSize);

					if(copySize > 0)

					    {

                        HBufC8* buffer = HBufC8::New(copySize);

                        if(buffer)

                            {

                            TPtr8 ptr = buffer->Des();

                            const TUint8* FromAddr = reinterpret_cast<const TUint8*>(&aPosInfo);

                            ptr.Copy(FromAddr, copySize);

                            TInt err = netSession->Msg().Write(0, buffer->Des(), 0);	

                            __ASSERT_DEBUG(err == KErrNone, User::Invariant());

                            delete buffer;

                            }

					    }

                    }

                netSession->Msg().Complete(aReason);

                break;

                }

            case CLbsNetSession::EPosRequestTypeRrlpGetLocation:

                {

                LBSLOG(ELogP1, "Outstanding EPosRequestTypeRrlpGetLocation request\n");

                __ASSERT_DEBUG(netSession->PosProtocolResponseObserver()!=NULL,User::Invariant());

                // passed back to the appropriate subsession for encoding and returning to client in pospayload

                netSession->PosProtocolResponseObserver()->HandleRrlpLocationResponse(aReason, aPosInfo);

                break;

                }

            case CLbsNetSession::EPosRequestTypeSuplInfoAssData:

                {

                LBSLOG(ELogP1, "Outstanding EPosRequestTypeSuplInfoAssData request\n");

                // the location request was issued simply to receive the currently required Assistance Data Mask

                __ASSERT_DEBUG(netSession->PosProtocolResponseObserver()!=NULL,User::Invariant());                

                // inform the suplproxyinforetriever expecting an update of the required assistance data mask

                // of the error

                netSession->PosProtocolResponseObserver()->HandleSetAssistanceDataMask(aReason, netSession->GetAssistanceDataMask());

                break;

                }

            case CLbsNetSession::EPosRequestTypeNone:

                {

                LBSLOG(ELogP1, "Outstanding EPosRequestTypeNone request\n");

                // if no matching request is found we ignore it since the request 

                // may have been cancelled 

                break;

                }

            default:

                {

                LBSLOG(ELogP1, "Outstanding request bad type\n");

                // something has gone wrong

                __ASSERT_DEBUG(EFalse,User::Invariant());

                }

            } // switch (netSession->Type())

        // the outstanding request has been processed

        netSession->SetType(CLbsNetSession::EPosRequestTypeNone);

        } // if (index >= 0)

	LBSLOG(ELogP1, "CSuplProxyProtocol::RespondLocationRequest() End\n");

	}

/**

 Send a request for GPS assistance data to the network. LBS does not currently send valid infomation 

 in the sessionIdArray. 

 @see CLbsNetworkProtocolBase::RequestAssistanceData()

 */

void CSuplProxyProtocol::RequestAssistanceData(TLbsAsistanceDataGroup aDataRequestMask, const TLbsNetSessionIdArray& /* aSessionIdArray */)

    {

    LBSLOG(ELogP1, "CSuplProxyProtocol::RequestAssistanceData() Begin\n");

    if (aDataRequestMask != EAssistanceDataNone)

        {

        // if mask is non-zero and we have any outstanding location requests, 

        // need to complete them with KErrOMASuplPosInfo here.

        CompleteMatchingRequest(CLbsNetSession::EPosRequestTypeGetPosition,KErrOMASuplPosInfo);

        }

    //Store the details reg the latest assistance data request in all the session objects

    for (TInt index = iLbsNetSessions.Count() - 1; index >= 0; index--)

        {

        //Update the masks for all the sessions that have started a positioning session.

        //ie. all sessions except MTLRs that are currently processing privacy session.

        //This exception is required as we create an entry for MTLRs in iLbsNetSessions 

        //in advance during its priv session 

        if (iLbsNetSessions[index]->PosSessionStarted())

            {

            //reset the flag relating to the outstanding assistance data info from LBS

            if (iLbsNetSessions[index]->Type() == CLbsNetSession::EPosRequestTypeSuplInfoAssData)

                {

                iLbsNetSessions[index]->SetType(CLbsNetSession::EPosRequestTypeNone);

                }

            //Update all the sessions with the latest assistance data requested.

            iLbsNetSessions[index]->SetAssistanceDataMask(aDataRequestMask);

            __ASSERT_DEBUG(iLbsNetSessions[index]->PosProtocolResponseObserver()!=NULL,User::Invariant());

            //Inform the observer (expecting a location response) that a fresh assistance data request has arrived.