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

//

#define SYMBIAN_NETWORKING_UPS

#include <comms-infras/ss_roles.h>

#include <comms-infras/ss_log.h>

#include <ss_glob.h>

#include <ss_std.h>

#include <comms-infras/ss_subconnflow.h>

#include "ss_flowrequest.h"

#include <es_prot.h>

#include "SS_rslv.H"

#include <comms-infras/nifif.h>

#include <comms-infras/ss_sapshim.h>

#include <comms-infras/ss_nodemessages_dataclient.h>

#include <es_mbuf.h>

#include <comms-infras/ss_msgintercept.h>

#ifdef _DEBUG

// Panic category for "absolutely impossible!" vanilla ASSERT()-type panics from this module

// (if it could happen through user error then you should give it an explicit, documented, category + code)

_LIT(KSpecAssert_ESockSSockS_RSLV, "ESockSSockS_RSLV");

#endif

#define MSG_PRM(prmIndex)		(prmIndex)

using namespace ESock;

using namespace Messages;

CHostResolver::CHostResolver(CSockSession* aSession, CPlayer* aPlayer, const TSubSessionUniqueId aSubSessionUniqueId)

: CSockSubSession(aSession, aPlayer, aSubSessionUniqueId),

  Messages::ASimpleNodeIdBase(),

  iPtrQryBuf(NULL, 0),

  iPtrQryResBuf(NULL, 0)

/**

Constructor - set up default options.

*/

	{

	LOG_NODE_CREATE(KESockFlowTag, CHostResolver)

    }

CHostResolver::~CHostResolver()

/**

Destructor

*/

	{

   	delete ipQryRespBuf; //-- delete query response buffer

   	delete ipQryBuf;     //-- delete query buffer

	LOG_NODE_DESTROY(KESockFlowTag, CHostResolver)

	}

void CHostResolver::InitiateDestruction()

	{

	// Remove the subsession from the session's subsession list.

    if(iSession)

		{

		iSession->SubSessions().Lock();

		Den::CSubSessionIx::TSubSessionHandle handle;

		if(iSession->SubSessions().Find(this, handle) == KErrNone)

			{

			iSession->PitBoss().RemoveSubSession(handle, iSession);

			}

		iSession->SubSessions().Unlock();

		}

	SetClosing();

    if (iRSP)

        {

//    	ASSERT(iFlowBinderControl);	// in OOM cases may not have been bound

		if(iFlowBinderControl)

			{

	  		iFlowBinderControl->Unbind();

			}

		delete iRSP;

        }

	if (!FlowRequestPending())

		delete this;

	}

CHostResolver * CHostResolver::NewLC(CProtocolRef* aProtRef, CSockSession *aSession, CPlayer* aPlayer, const TSubSessionUniqueId aSubSessionUniqueId)

/**

Create a new CHostresolver

*/

	{

	CHostResolver* h = new(ELeave) CHostResolver(aSession, aPlayer, aSubSessionUniqueId);

	CleanupStack::PushL(h);

	h->CreateL(aProtRef);

	ESOCK_DEBUG_REGISTER_GENERAL_NODE(ESockDebug::KHostResolverNodeUid, h);

	return h;

	}

void CHostResolver::CreateL(CProtocolRef* aProtRef)

	{

	CSockSubSession::ConstructL(aProtRef->Protocol());

	iBusy=EFalse;

	iAwaitingConnection=EFalse;

	iProtocolInfo = &(aProtRef->Info());

	}

void CHostResolver::FinalCompleteAllBlockedMessages(TInt aResult)

	{

	if(iBusy)

		{

		CompleteMessage(iBlockedReq, aResult);

		}

	}

void CHostResolver::ReceivedL(const TRuntimeCtxId& aSender, const TNodeId& aRecipient, TSignatureBase& aMessage)

    {

    (void) aRecipient;

	ESOCK_DEBUG_MESSAGE_INTERCEPT(aSender, aMessage, aRecipient);

    if (aMessage.IsMessage<TEBase::TError>())

    	{

    	//The first error would be from the flow request, any other error iIsFlowRequestPending must be false anyway

		if (FlowRequestPending())

			{

			TEBase::TError& errorMsg(static_cast<TEBase::TError&>(aMessage));

			CompleteFlowRequestMessage(errorMsg.iValue);

			SetFlowRequestPending(EFalse);

			}

		//We are no longer needed and the client has been completed too, tear us down.

		InitiateDestruction();

		}

    else if (aMessage.IsMessage<TCFDataClient::TBindTo>())

		{

		// An error here is propagated back to the waiting CFlowRequest

		TCFDataClient::TBindTo& bindToMsg(static_cast<TCFDataClient::TBindTo&>(aMessage));

		SetFlowRequestPending(EFalse);

		TInt err;

		if (IsClosing())

			{

			err = KErrAbort;

			}

		else

			{

			TRAP(err,BindToL(bindToMsg));

			}

		TCFDataClient::TBindToComplete bindCompleteMsg(err);

		RClientInterface::OpenPostMessageClose(Id(), aSender,

			bindCompleteMsg);

		CompleteFlowRequestMessage(err);

		if (IsClosing())

			{

			InitiateDestruction();

			}

		}

    else

        {

  		__ASSERT_DEBUG(EFalse, User::Panic(KSpecAssert_ESockSSockS_RSLV, 1));

        }

    }

void CHostResolver::BindToL(const TCFDataClient::TBindTo& aBindTo)

    {

    __ASSERT_DEBUG(iLowerControl==NULL, User::Panic(KSpecAssert_ESockSSockS_RSLV, 2));

#if defined(__GCCXML__)

    CSubConnectionFlowBase* flow = reinterpret_cast<CSubConnectionFlowBase*>(reinterpret_cast<Messages::ANode*>(aBindTo.iNodeId.Ptr()));

#else

    CSubConnectionFlowBase* flow = mcfnode_cast<CSubConnectionFlowBase>(reinterpret_cast<Messages::ANode*>(aBindTo.iNodeId.Ptr()));

#endif

    if (flow==NULL)

        {

        User::Leave(KErrArgument);

        }

    NM_LOG((KESockServerTag, _L8("CHostResolver %08x:\tSynchronous call: From=%08x To=%08x Func=BindToL"),

			this, static_cast<Messages::ANode*>(this), &aBindTo.iNodeId.Node()) )

	iFlowBinderControl = flow->GetBinderControlL();

	iLowerControl = iFlowBinderControl->GetControlL(KNullDesC8);

	iLowerDataSender = iFlowBinderControl->BindL(KNullDesC8, NULL, this);

#ifdef SYMBIAN_NETWORKING_UPS

	LOG(ESockLog::Printf(KESockConnectionTag, _L8("CHostResolver %08x:\tBindToL(%08x)"), this, &aBindTo.iNodeId.Node()) );

	LOG(ESockLogExternal::Printf(KCFNodeTag, KESockFlowTag, _L8("CHostResolver %08x:\tSynchronous call: Sender=%08x, Recipient=%08x, Function=BindToL"), this, static_cast<ANode*>(this), &aBindTo.iNodeId.Node()) );

	// UPS support

	InitialiseFlow(flow);

#endif

    LockToConnectionInfo();

    }

#ifdef SYMBIAN_NETWORKING_UPS

void CHostResolver::InitialiseFlow(CSubConnectionFlowBase* aFlow)

/**

Initialise the flow for Host Resolver UPS operation

@param aFlow Underlying flow to initialise

*/

	{

	CTransportFlowShim* shimFlow = Factories::factoryobject_cast<CTransportFlowShim>(aFlow);

    if (shimFlow)

    	{

    	// Pass the MProvdSecurityChecker down to the CTransportFlowShim so that it can perform

    	// the Platform Security check.

    	shimFlow->SecurityCheck(Session());

    	// Pass the thread/process id down to the CTransportFlowShim as these are required

    	// to perform UPS authorisation.

		TSoOwnerInfo info;

		GetOwnerInfo(info.iProcessId, info.iUid, info.iThreadId);

		shimFlow->SetOption(KSOLProvider, KSoOwnerInfo, TPckgC<TSoOwnerInfo>(info));

		//

		// In addition to KSoOwnerInfo, communicate an MPlatSecApiExt instance downwards in order

		// to allow dynamic retrieval of process and thread id (rather than the process/thread id

		// at the time of the subsession open.  It is not certain that our MPlatsecApiExt can

		// actually provide a valid process/thread id all the time, so the KSoOwnerInfo gives

		// default values for circumstances where MPlatsecApiExt).

		//

		// @TODO REQ1116 - clean this whole area up - especially the use of two mechanisms

		// "one in case the other doesn't always work".  Can we just use the dynamic one?

		//

		shimFlow->SetOption(KSOLProvider, KSoSetPlatSecApi, TPckgC<const MPlatsecApiExt*>(this));

    	}

	}

#endif

TBool CHostResolver::GetFlowAndSCPR(Messages::TNodeId& aFlow, Messages::TNodeId& aSCPR) const

    {

    if (iFlowBinderControl)

        {

    	aFlow = iFlowBinderControl->Flow()->Id();

    	aSCPR = iFlowBinderControl->Flow()->ControlProvider().RecipientId();

    	return ETrue;

        }

    return EFalse;

    }

HBufC8* CHostResolver::GetBuffer(HBufC8* apBuf, TInt aBufLenRequired)

/**

Allocate buffer on heap or reallocate it if required size is more than existing

@param    apBuf           pointer to the existing buffer. If NULL new bufeer will be allocated.

@param    aBufLenRequired reuired buffer length.

@return   pointer to the new buffer

@return   NULL in case of memory problems or other errors

*/

	{

    HBufC8* pBufResult = NULL;

    if(aBufLenRequired <= 0 )

		{

		PanicClient(KESockClientPanic, EBadDescriptorLength);

        return NULL; //-- invalid argument

		}

    if(!apBuf)

		{//-- the buffer is not allocated at all, try allocate it

		pBufResult = HBufC8::New(aBufLenRequired);

		}

    else

		{//-- the buffer is already allocated. Check its size and try to reallocate if

		//-- required size is bigger than existing. Otherwise do nothing.

		if(apBuf->Des().MaxSize() >= aBufLenRequired)

			pBufResult = apBuf; //-- do nothing, existing buffer is big enough

		else

			{  //-- delete and allocate new buffer to avoid data copying

			delete apBuf;

			pBufResult = HBufC8::New(aBufLenRequired);

			}

		}

    return pBufResult;

	}

TBool CHostResolver::GetQueryRespBuffer(void)

/**

Allocate or reallocate buffer for CHostResolver::Query() response data.

The length of the buffer obtained from Message().Ptr1(), as it is the 2nd parameter in RHostResolver::Query() that

shall contain pointer to the client's TPckgBuf query response data.

ipQryRespBuf is used for buffer pointer.

@return ETrue if the buffer has been successfully allocated (or increased)

*/

	{

    //-- obtain the length of the client's buffer and allocate the same buffer on our(server) side.

    //-- data there will be put by the protocol and then copied to the client side in QueryComplete.

    //-- we need to append sizeof(TDes8) to the buffer lenght because from client point of view the buffer is TPckgBuf<...>

    TInt len = iBlockedReq.GetDesLength(1) + sizeof(TDes8);

    ipQryRespBuf = GetBuffer(ipQryRespBuf, len); //-- claim buffer big enough for query response data

    if(ipQryRespBuf)

		{//-- memory allocated, store TPtr8 associated with buffer on the heap, which

		//-- can be used later in asynchonous environment by the protocol.

        iPtrQryResBuf.Set(ipQryRespBuf->Des());

        return ETrue;

		}

    else

		{//-- memory alocation failure

        iPtrQryResBuf.Set(NULL, 0, 0);

        return EFalse;

		}

	}

TBool CHostResolver::GetQueryBuffer(void)

/**

Allocate or reallocate buffer for CHostResolver::Query() data.

The length of the buffer obtained from Message().Ptr0(), as it is the 1st parameter in RHostResolver::Query() that

shall contain pointer to the client's TPckgBuf query data.

@return ETrue if the buffer has been successfully allocated (or increased)

*/

{

    TInt len = iBlockedReq.GetDesLength(0) + sizeof(TDes8);

//    TInt len = iBlockedReq.Client().GetDesLength(Message().Ptr0()) + sizeof(TDes8);

    ipQryBuf = GetBuffer(ipQryBuf, len); //-- claim buffer big enough for query data

    if(ipQryBuf)

    {//-- memory allocated, store TPtr8 associated with buffer on the heap, which

     //-- can be used later in asynchonous environment by the protocol.

        iPtrQryBuf.Set(ipQryBuf->Des());

        return ETrue;

    }

    else

    {//-- memory alocation failure

        iPtrQryBuf.Set(NULL, 0, 0);

        return EFalse;

    }

}

void CHostResolver::QueryL(void)

/**

Host Resolver Query implementation

Query the current protocol and obtain the result

*/

	{

	if (iBusy)

		{

		PanicClient(KESockClientPanic, ETwice);

		SetReturn(KErrInUse);

		return;

		}

	iBlockedReq=Message();

    //-- allocate or reallocate buffer for query and query  response.

    if(! GetQueryRespBuffer() || ! GetQueryBuffer())

		{//-- buffer hasn't been allocated

        SetReturn(KErrNoMemory);

		return;

		}

	//-- read query data from client's buffer to the CHostResolver's internal one

    //-- Ptr0() points to client's Query data buffer, Ptr1() - to the client's query response

   	SafeMessage().ReadL(0, iPtrQryBuf);

	iBusy=ETrue;

	iAwaitingConnection = EFalse;

	DontCompleteCurrentRequest();

	iCurrentOp=EHrQuery;

	iCount=0;

    //-- call CHostResolvProvdBase Query method implemented in appropriate protocol

    iRSP->Query(iPtrQryBuf, iPtrQryResBuf, iCount);

	}

void CHostResolver::QueryGetNext(void)

/**

Host Resolver QueryGetNext implementation.

Obtain the next query result.

*/

	{

	if (iBusy)

		{

		PanicClient(KESockClientPanic, ETwice);

		SetReturn(KErrInUse);

		return;

		}

	if(iCount<1)

		{//-- tried to call QueryGetNext() before Query()

		PanicClient(KESockClientPanic, ENoQueryFirst);

		SetReturn(KErrNotFound);

		return;

		}

	iBusy=ETrue;

	iBlockedReq=Message();

	DontCompleteCurrentRequest();

	//-- call CHostResolvProvdBase QueryGetNext method implemented in appropriate protocol

	if(iCurrentOp == EHrQuery)

		{	//-- iCount is incremented in QueryComplete,

        //-- iQryBuf isn't supposed to be in use here.

        //-- buffer for response ipQryRespBuf must have been allocated by CHostResolver::Query

        if(!ipQryRespBuf)

			{//-- buffer hasn't been allocated, it means memory problems

            SetReturn(KErrNoMemory);

			return;

			}

        iRSP->Query(iPtrQryBuf, iPtrQryResBuf, iCount);

		}

	}

void CHostResolver::GetByNameL()

/**

Start a get by name query

*/

	{

	if (iBusy)

		{

		PanicClient(KESockClientPanic, ETwice);

		SetReturn(KErrInUse);

		return;

		}

	SafeMessage().ReadL(MSG_PRM(0),iNameRec.iName);

	iBusy=ETrue;

	iAwaitingConnection = EFalse;

	iBlockedReq=Message();

	DontCompleteCurrentRequest();

	iCurrentOp=EHRGetByName;

	iCount=0;

	iNameRec.iFlags=iCount;

	iRSP->GetByName(iNameRec);

	}

void CHostResolver::Next()

/**

Retrieve next record

*/

	{

	if (iBusy)

		{

		PanicClient(KESockClientPanic, ETwice);

		SetReturn(KErrInUse);

		return;

		}

	if(iCount<1)

		{

		PanicClient(KESockClientPanic, ENoResolveFirst);

		SetReturn(KErrNotFound);

		return;

		}

	iBusy=ETrue;

	iBlockedReq=Message();

	DontCompleteCurrentRequest();

	iNameRec.iFlags=iCount;

	if(iCurrentOp==EHRGetByName)

		iRSP->GetByName(iNameRec);

	else

		iRSP->GetByAddress(iNameRec);

	}

void CHostResolver::GetByAddressL()

/**

Start a get by address query

*/

	{

	if (iBusy)

		{

		PanicClient(KESockClientPanic, ETwice);

		SetReturn(KErrInUse);

		return;

		}

	SafeMessage().ReadL(MSG_PRM(0),iNameRec.iAddr);

	iBusy=ETrue;

	iBlockedReq=Message();

	DontCompleteCurrentRequest();

	iCurrentOp=EHRGetByAddress;

	iCount=0;

	iNameRec.iFlags=iCount;

	iRSP->GetByAddress(iNameRec);

	}

void CHostResolver::GetHostName()

/**

Get the name of the local host