// 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:

//

/**

 @file

 @internalComponent

*/

#include <charconv.h>

#include <utf.h>

#include <obex.h>

#include <obextransportinfo.h>

#include <obex/transport/obextransportcontrollerbase.h>

#include <obex/internal/obextransportconstants.h>

#include <obex/internal/obexinternalheader.h>

#include <obex/internal/obexpacket.h>

#include "logger.h"

#include "obexsetpathdata.h"

#include "OBEXUTIL.H"

#include "obexheaderutil.h"

#include "authentication.h"

#include "obexpacketsignaller.h"

#include "obexpackettimer.h"

#include "obexnotifyhandlerclient.h"

#include "obexerrorengine.h"

#ifdef __FLOG_ACTIVE

_LIT8(KLogComponent, "OBEX");

#endif

// Constant used to identify if the last received response code field

// has been populated (i.e., if the first response has been received

// from the OBEX server).  The response code field is only 7 bits (+ the

// 'final bit') so the use of this 16 bit number will ensure the value

// for KUnpopulatedResponseCode never overlaps with an actual code.

const static TUint16 KUnpopulatedResponseCode = 0xffff;

// For debug builds check that when an underlying error is set

// it has not already been set since the start of the client operation

// and check that a last error has been set when the operation completes.

#define SET_LAST_ERROR(_error) __ASSERT_DEBUG(!iIsLastErrorSet, IrOBEXUtil::Fault(ELastErrorSetTwice)); iErrorEngine->SetLastError(CObexErrorEngine::_error); iIsLastErrorSet = ETrue

#define CHECK_LAST_ERROR_IS_SET __ASSERT_DEBUG(iIsLastErrorSet, IrOBEXUtil::Fault(ELastErrorNotSet)); iIsLastErrorSet = EFalse

// Constructor - set initial values

CObexClient::CObexClient() : CObex()

	{

	iCurrentOperation = EOpIdle;

	iConnectionID = KConnIDInvalid;

	iLastReceivedResponseOpcode = static_cast<TObexResponse>(KUnpopulatedResponseCode);

	}

void CObexClient::ConstructL(TObexTransportInfo& aObexTransportInfo)

	{

	CObex::ConstructL(aObexTransportInfo);

	iNotifyHandler = new(ELeave)CObexNotifyHandlerClient(*this);

	iTransportController->SetOwner(*iNotifyHandler);

	//	iHeaderSet is used to store headers received in Put Response

	iHeaderSet = CObexHeaderSet::NewL();

	iHeader = CObexHeader::NewL();

	iPacketProcessSignaller = CObexPacketSignaller::NewL();

	iErrorEngine = CObexErrorEngine::NewL();

	iPacketTimer = CObexPacketTimer::NewL(*this);

	}

/** Destructor. 

@publishedAll

@released

*/

EXPORT_C CObexClient::~CObexClient()

	{

	LOG_LINE

	LOG_FUNC

	Error(KErrCompletion);

	delete iHeader;

	delete iHeaderSet;

	delete iPacketProcessSignaller;

	delete iNotifyHandler;

	delete iErrorEngine;

	delete iPacketTimer;

	}

/** A call back from the the service with the password required for use with generating 

the challenge response. 

@param aPassword Password

@leave KErrNotReady if this function is not called from a MObexAuthChallengeHandler::GetUserPasswordL callback.

@publishedAll

@released

*/

EXPORT_C void CObexClient::UserPasswordL(const TDesC& aPassword)

	{

	LOG_LINE

	LOG_FUNC

	//now have a password, get a nonce, and get it hashed then reply

	FLOG(_L("CObexClient::UserPasswordL\n\r"));

	if (GetConnectState() == EWaitForUserInput)

		{

		PrepareChallResponseL( aPassword); 

		TObexInternalHeader hdr;

		hdr.Set(TObexInternalHeader::EAuthResponse, CONST_CAST(TUint8*, iOutgoingChallResp.Ptr()), iOutgoingChallResp.Size());

		FLOG(_L("CObexClient::UserPasswordL EAuth heaqder added\n\r")); 

		if(iTransportController->SendPacket().InsertData(hdr))

			{

			SetConnectState(EWaitForFinalResponse);

			iTransportController->SendPacket().SetFinal();

			SendRequestPacket();

			FLOG(_L("CObexClient::UserPasswordL packet sent\n\r")); 

			}

		else

			{

			LEAVEIFERRORL(KErrGeneral);

			}

		}

	else

		{

		LEAVEIFERRORL(KErrNotReady);

		}

	}

/** Allocates and constructs a new OBEX client object.

The received protocol information object, aObexProtocolInfoPtr, specifies the transport protocol to use:

For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo 

for Bluetooth, TObexUsbProtocolInfo for USB.

@param aObexProtocolInfoPtr Protocol information object describing the transport to use

@return New OBEX client object 

@publishedAll

@released

*/

EXPORT_C CObexClient* CObexClient::NewL(TObexProtocolInfo& aObexProtocolInfoPtr)

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	TObexProtocolPolicy defaultProtocolPolicy;	// no packet sizing policy specified, so use default	

	TObexTransportInfo*  transportInfo = IrOBEXUtil::CreateTransportInfoL(aObexProtocolInfoPtr, defaultProtocolPolicy);

	CleanupStack::PushL(transportInfo);

	CObexClient* client = CObexClient::NewL(*transportInfo);

	CleanupStack::PopAndDestroy(transportInfo);

	return client;

	}

/** Allocates and constructs a new OBEX client object with packet sizing information.

The received protocol information object, aObexProtocolInfoPtr, specifies the transport protocol to use:

For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo 

for Bluetooth, TObexUsbProtocolInfo for USB.

The aObexProtocolPolicy parameter specifies the packet sizing policy for this OBEX object.

@param aObexProtocolInfoPtr Protocol information object describing the transport to use

@param aObexProtocolPolicy Protocol policy object specifying the packet sizes to use

@return New OBEX client object 

@publishedAll

@released

*/

EXPORT_C  CObexClient* CObexClient::NewL(TObexProtocolInfo& aObexProtocolInfoPtr, TObexProtocolPolicy& aObexProtocolPolicy)

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	TObexTransportInfo*  transportInfo = IrOBEXUtil::CreateTransportInfoL(aObexProtocolInfoPtr, aObexProtocolPolicy);

	CleanupStack::PushL(transportInfo);

	CObexClient* client = CObexClient::NewL(*transportInfo);

	CleanupStack::PopAndDestroy(transportInfo);

	return client;

	}

/** Allocates and constructs a new OBEX client object with packet sizing information.

The received transport information object, aObexTransportInfo, specifies the transport protocol packet sizes to use:

For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo 

for Bluetooth, TObexUsbProtocolInfo for USB.

@param aObexTransportInfo  Transport information object describing the transport and packet sizes to use

@return New OBEX client object 

@capability WriteDeviceData If the TObexIrV3TransportInfo is passed as the argument

                            and the associated name is valid.

@publishedAll

@released

*/

EXPORT_C  CObexClient* CObexClient::NewL(TObexTransportInfo& aObexTransportInfo)

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	CObexClient* self = new(ELeave) CObexClient();

	CleanupStack::PushL(self);

	self->ConstructL(aObexTransportInfo);

	CleanupStack::Pop(self);

	return(self);

	}

/** OBEX CONNECT operation to any available remote machine, specifying an object 

to pass.

@param aObject OBEX object to pass to the remote machine

@param aStatus Asynchronous status word. On completion, KErrNone if it was 

successful, or a system-wide error code 	

@publishedAll

@released

*/

EXPORT_C void CObexClient::Connect(CObexBaseObject& aObject, TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::Connect no password but some header data\r\n"));

		EmptyHeaderSet();

		iChallenge = EFalse;

		OBEX_TRAP(Error, ClientCommandL(EOpConnect, static_cast<TAny*>(&aObject), aStatus));

		}

	}

/** OBEX CONNECT operation to any available remote machine, specifying an object 

to pass and a password.

@param aObject OBEX object to pass to the remote machine

@param aPassword Password to access remote machine

@param aStatus Asynchronous status word. On completion, KErrNone if it was 

successful, or a system-wide error code 

@publishedAll

@released

*/

EXPORT_C void CObexClient::ConnectL(CObexBaseObject& aObject, const TDesC& aPassword, 

								   TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::Connect with password and some header info\r\n"));

		EmptyHeaderSet();

		delete iChallPassword;

		iChallPassword = NULL;

		iChallPassword = HBufC8::NewL(aPassword.Size());

		TPtr8 ptr = iChallPassword->Des();

		CnvUtfConverter::ConvertFromUnicodeToUtf8(ptr, aPassword);

		iChallenge = ETrue;

		OBEX_TRAP(Error, ClientCommandL(EOpConnect, static_cast<TAny*>(&aObject), aStatus));

		}

	}

/** OBEX CONNECT operation to any available remote machine, specifying a password.

@param aPassword Password to access remote machine

@param aStatus On completion, KErrNone if it was successful, or a system-wide 

error code 

@publishedAll

@released

*/

EXPORT_C void CObexClient::ConnectL(const TDesC& aPassword, TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::Connect with password but no header info\r\n"));

		EmptyHeaderSet();

		delete iChallPassword;

		iChallPassword = NULL;

		iChallPassword = HBufC8::NewL(aPassword.Length());

		TPtr8 ptr = iChallPassword->Des();

		CnvUtfConverter::ConvertFromUnicodeToUtf8(ptr, aPassword);

		iChallenge = ETrue;

		OBEX_TRAP(Error, ClientCommandL(EOpConnect, NULL, aStatus));

		}

	}

/** OBEX CONNECT operation to any available remote machine.

@param aStatus Asynchronous status word. On completion, KErrNone if it was 

successful, or a system-wide error code 

@publishedAll

@released

*/

EXPORT_C void CObexClient::Connect(TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("\tno password no header"));

		EmptyHeaderSet();

		iChallenge = EFalse;

		OBEX_TRAP(Error, ClientCommandL(EOpConnect, NULL, aStatus));

		}

	}

/** OBEX DISCONNECT operation.

This terminates the OBEX connection, and closes the transport on receiving 

any response from the server. 

@param aStatus Asynchronous status word. On completion, KErrNone on normal 

disconnection, or KErrDisconnected if the server dropped the transport before 

sending an OBEX response (which is valid behaviour). 

@publishedAll

@released

*/

EXPORT_C void CObexClient::Disconnect(TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::Disconnect\r\n"));

		EmptyHeaderSet();

		OBEX_TRAP (Error, ClientCommandL(EOpDisconnect, NULL, aStatus));

		}

	}

/** OBEX PUT operation.

Any valid header that is also present in aObject’s header mask will be sent 

to the server, along with the object body specified by the implementation 

of aObject. 

@param aObject OBEX object to put

@param aStatus Asynchronous status word. On completion, KErrNone if the server 

accepted the object and received it fully, or the appropriate file error if 

the data file could not be opened 

@publishedAll

@released

*/

EXPORT_C void CObexClient::Put(CObexBaseObject& aObject, TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("\tnot already active"));

		EmptyHeaderSet();

		OBEX_TRAP(Error, ClientCommandL(EOpPut, static_cast<TAny*>(&aObject), aStatus));

		}

	}

/** OBEX GET operation.

The caller specifies in aObject the headers to send to the server to specify 

the object to get: normally just a name is expected. If the server can serve 

the request, the object it returns will be loaded into aObject on completion. 

All headers returned by the server that are also allowed by the object’s 

header mask will be loaded into the relevant attributes of aObject. Any object 

body is stored according to the implementation type of the CObexBaseObject 

passed.

@param aObject OBEX object to get; on completion, the retrieved object

@param aStatus Asynchronous status word. On completion, KErrNone if the server 

passed back an OBEX object, or the appropriate file error if the data file 

could not be opened 

@publishedAll

@released

*/

EXPORT_C void CObexClient::Get(CObexBaseObject& aObject, TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::Get\r\n"));

		EmptyHeaderSet();

		OBEX_TRAP(Error, ClientCommandL(EOpGet, static_cast<TAny*>(&aObject), aStatus));

		}

	}

/** OBEX SETPATH operation.

This changes the remote device's current path. 

@param aPathInfo Information to send in the SETPATH command. If you do not 

which to send a name, make sure CObex::TSetPathInfo::iNamePresent is set to 

false.

@param aStatus Asynchronous status word. On completion, KErrNone if successful, 

or a system-wide error code 

@publishedAll

@released

*/

EXPORT_C void CObexClient::SetPath(TSetPathInfo& aPathInfo, TRequestStatus& aStatus)

	{

	LOG_LINE

	LOG_FUNC

	if(!AlreadyActive(aStatus))

		{

		FLOG(_L("CObexClient::SetPath\r\n"));

		EmptyHeaderSet();

		OBEX_TRAP(Error, ClientCommandL(EOpSetPath, static_cast<TAny*>(&aPathInfo), aStatus));

		}

	}

/** OBEX ABORT operation.

The function sends the OBEX abort command to the remote machine if a multi-packet 

operation (i.e. PUT or GET) is in progress. An operation in progress will 

complete with KErrAbort. 

@publishedAll

@released

*/

EXPORT_C void CObexClient::Abort()

	{

	LOG_LINE

	LOG_FUNC

	if(iPendingRequest &&(iCurrentOperation == EOpPut 

							|| iCurrentOperation == EOpGet || iCurrentOperation == EOpGetResponse))

		{

		// We have two phase abort, async. abort request, followed by async. response

		// To achive this without extra members we use extra operations in TOperation

		// EOpAbortNoFBit for the asynchronous request

		// EOpAbort for waiting for the response

		iCurrentOperation = EOpAbortNoFBit;

		}

	}

/**

This function can be called following the successful completion of a Put,

and will return a reference to a CObexHeaderSet containing all the headers

that were contained in the final Put response packet returned from the 

peer Obex server.

The headers in the header set will be deleted by any subsequent call to 

CObexClient functions that trigger Obex commands (ie. Connect, Disconnect, 

Put, Get, SetPath).

The reference should not be retained beyond the end of the lifetime of the

CObexClient object.

@publishedAll

@released

@return const reference to a Headerset containing headers returned in final

Put response packet.

*/

EXPORT_C const CObexHeaderSet& CObexClient::GetPutFinalResponseHeaders()

	{

	LOG_LINE

	LOG_FUNC

	return *iHeaderSet;

	}

/** Sets a final packet observer.

This replaces any previous observer.  The observer will receive a callback

when a final packet for a put or get request begins to be sent and 

another when the send completes.  Although the start and finish callbacks

are guaranteed to be in order, no guarantees are made about the ordering

with respect to the completion of the put or get request.

This does not transfer ownership.

@publishedAll

@released

@param aObserver The observer to receive packet process events.  This may

				 be NULL.

*/

EXPORT_C void CObexClient::SetFinalPacketObserver(MObexFinalPacketObserver* aObserver)

	{

	iPacketProcessSignaller->SetFinalPacketObserver(aObserver);

	}

/** Get last server response code

This method returns the last received OBEX response code.

The method must not be called prior to a response notification being received by the

client application.  If the method is called a panic will be raised. 

@return The last received OBEX response code.

@panic ENoResponseCodeToReturn   Panics if the method is called prior to a response being received from the OBEX server.  

@publishedAll

@released

*/

EXPORT_C TObexResponse CObexClient::LastServerResponseCode() const

	{	

	LOG_LINE

	LOG_FUNC

	// If the last received response code has not been set (i.e., no response has been received) then panic

	// the client.

	__ASSERT_ALWAYS(iLastReceivedResponseOpcode != KUnpopulatedResponseCode, IrOBEXUtil::Panic(ENoResponseCodeToReturn));

	return iLastReceivedResponseOpcode;

	}

/** Sets the Command Idle Time-out.