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

// This contains TE_RConnectionStep class which is

// the base class for all the RConnection multihoming test steps.

// Contains methods which simplify the API to RConnection, RSocket and 

// RHostResolver to be used by derived classes. This abstraction means 

// that the API can continue to evolve as it has done for a while without 

// impacting a large number of test cases - just alter this parent class.

//

//

/**

 @file

*/

#include "TE_RConnectionStep.h"

#include <commdbconnpref.h>

#include <dummynifvar.h>

#include <c32root.h>

#include <comms-infras/esocktestutils.h>

#include <cs_subconparams.h> 

#include <cs_subconevents.h>

#include <ecom/ecom.h>

#include <e32cons.h>

#include <comms-infras/es_commsdataobject.h>

#include <commdbconnpref.h>

#include <commsdattypeinfov1_1.h>

#include <comms-infras/connectionqueryset.h>

#ifdef SYMBIAN_OLD_EXPORT_LOCATION

#include <naptinterface.h>

#else

//after the header file relocation this header won't be exported, so it needs to be a user include.

#include "naptinterface.h"

#endif

#include <simtsy.h>

_LIT(KSimtsyName,"SIM");

TE_RConnectionStep::TE_RConnectionStep()

/**

 * Constructor for TS_RConnectonStep(). Does nothing.

 * @param none

 * @return doesn't it is a constructor

 */

{

}

TE_RConnectionStep::~TE_RConnectionStep()

/**

 * Destructor for TE_RConnectionStep(). Does nothing.

 */

{ 

	CActiveScheduler::Install(NULL);

	delete iScheduler;

}	

enum TVerdict TE_RConnectionStep::doTestStepPreambleL(void)

/**

 * Preamble called before every single test case which is derived from TE_RConnectionStep (unless overridden of course). Sets up addresses and other values to be used by the test code proper. Waits for any remaining interfaces from previous tests to close.

 * @param none

 * @return success (EPass) or failure (EFail) of initialisation

 */

{

	enum TVerdict result = EPass;

	_LIT(KPhbkSyncCMI, "phbsync.cmi");

	if (StartC32WithCMISuppressions(KPhbkSyncCMI) != KErrNone)

    	{

    	return EFail;

    	}

	iScheduler = new(ELeave) CActiveScheduler;

	CActiveScheduler::Install(iScheduler);

	/*

	 * Load the config from the .ini file

	 */

	if (KErrNone != ReadIniFile())

		result = EFail;

	iDummyNifSendAddr.SetAddress(KDummyNifLocalAddressBase + KDummyHungryNifReservedHostId);

	iDummyNifSendAddr.SetPort(iEchoPortNum);

	iHungryNifSendAddr.SetAddress(KDummyNifLocalAddressBase + KDummyHungryNifReservedHostId);

	iHungryNifSendAddr.SetPort(iEchoPortNum);

	_LIT(KNaptStatusCheck, "On");

	if (iNaptStatus.Compare(KNaptStatusCheck)!=0)

		{

		// Wait for all of the interfaces to close down

		RSocketServ ss;

		ss.Connect();

		CleanupClosePushL(ss);

		if (KErrNone != WaitForAllInterfacesToCloseL(ss))

			{

			INFO_PRINTF1(_L("Previous test case has left connections up that have not closed. Stopping them."));

			TBuf<200> errDesc;

			TInt err;

			if ((err = ESockTestUtils::StopAllInterfaces(errDesc)) == KErrNone)

				result = EPass;

			else

				{

				INFO_PRINTF3(_L("StopAllInterfaces() err=%d\n%S"), err, &errDesc);

				result = EFail;

			}

			}

		ss.Close();

		CleanupStack::Pop();

		}

	return result;

}

enum TVerdict TE_RConnectionStep::doTestStepPostambleL(void)

{

	if( iStatus && iStatus->IsActive() )

		{

		iStatus->Cancel();

		}

	delete iStatus;

	iStatus = NULL;

	CActiveScheduler::Install(NULL);

	REComSession::FinalClose();

	return EPass;

}

TInt TE_RConnectionStep::ReadIniFile(void)

/**

 * Opens the .ini file, reads the contents into some class members and then closes the file again

 * @return system wide error code

 */

{

	TInt result = KErrNone;

	TPtrC filename(_L("c:\\rconnectiontest.ini"));

	TBuf<64> tempBuf; // 16 is enough for an IP addr and the separating dots

	TPtrC temp(0,NULL);

	// this opens the file and loads everything in

	// LoadConfig(filename);

	// set the IAP values in the class members

	_LIT(KIapSection, "IAP");

	_LIT(KDummyNifIapKey, "DummyNifIapNumber");

	_LIT(KNtRasIapOnlyShortTimerKey, "DummyNifOnlyShortTimerIapNumber");

	_LIT(KDummyNifLongTimeoutIapKey, "DummyNifLongTimeoutIapNumber");

	_LIT(KDummyNifTwoBinderIapKey, "DummyNifTwoBinderIapNumber");

	_LIT(KHungryNifLongTimeoutIapKey, "HungryNifLongTimeoutIapNumber");

	_LIT(KHungryNifIapKey, "HungryNifIapNumber");

	_LIT(KDefaultIapKey, "DefaultIapNumber");

	_LIT(KBadNtRasIapKey, "BadNtRasIapNumber");

	_LIT(KMissingNifIapKey, "MissingNifIapNumber");

	_LIT(KTestNifIapKey, "TestNifIapNumber");

	_LIT(KDummyNifAgentIap, "DummyNifAgentIapNumber");

	_LIT(KSimTSYIap, "SimTSYIapNumber");

	_LIT(KStaticDnsDynamicAddr, "StaticDnsDynamicAddr");

	if (!(GetIntFromConfig(KIapSection, KDummyNifIapKey, iDummyNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KDummyNifLongTimeoutIapKey, iDummyNifLongTimeoutIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KDummyNifTwoBinderIapKey, iDummyNifTwoBinderIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KHungryNifLongTimeoutIapKey, iHungryNifLongTimeoutIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KHungryNifIapKey, iHungryNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KDefaultIapKey, iDefaultIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KNtRasIapOnlyShortTimerKey, iNtRasIapOnlyShortTimer)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KBadNtRasIapKey, iBadNtRasIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KMissingNifIapKey, iMissingNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KTestNifIapKey, iTestNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KDummyNifAgentIap, iDummyNifAgentIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KSimTSYIap, iSimTSYIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KStaticDnsDynamicAddr, iStaticDnsDynamicAddr)))

		result = KErrNotFound;

	// IAP numbers specifically used by the all interface notification tests

	_LIT(KAinIapSection, "AINIAPs");

	_LIT(KSecondHungryNifIapKey, "SecondHungryNifNumber");

	_LIT(KThirdHungryNifIapKey, "ThirdHungryNifNumber");

	_LIT(KSecondDummyNifIapKey, "SecondDummyNifNumber");

	_LIT(KThirdDummyNifIapKey, "ThirdDummyNifNumber");

	_LIT(KFourthDummyNifIapKey, "FourthDummyNifNumber");

	_LIT(KFifthDummyNifIapKey, "FifthDummyNifNumber");

	_LIT(KFNaptPublicIapKey, "NaptPublicIapNumber");

	_LIT(KFNaptPrivateIapKey, "NaptPrivateIapNumber");

	if (!(GetIntFromConfig(KAinIapSection, KSecondHungryNifIapKey, iSecondHungryNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KAinIapSection, KThirdHungryNifIapKey, iThirdHungryNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KAinIapSection, KSecondDummyNifIapKey, iSecondDummyNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KAinIapSection, KThirdDummyNifIapKey, iThirdDummyNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KAinIapSection, KFourthDummyNifIapKey, iFourthDummyNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KAinIapSection, KFifthDummyNifIapKey, iFifthDummyNifIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KFNaptPublicIapKey, iNaptPublicIap)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KIapSection, KFNaptPrivateIapKey, iNaptPrivateIap)))

		result = KErrNotFound;

	// set the timeout values in the class members

	_LIT(KTimeoutSection, "Timeouts");

	_LIT(KShortTimeoutKey, "ShortTimeout");

	_LIT(KMediumTimeoutKey, "MediumTimeout");

	_LIT(KLongTimeoutKey, "LongTimeout");

	if (!(GetIntFromConfig(KTimeoutSection, KShortTimeoutKey, iShortTimeout)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KTimeoutSection, KMediumTimeoutKey, iMediumTimeout)))

		result = KErrNotFound;

	if (!(GetIntFromConfig(KTimeoutSection, KLongTimeoutKey, iLongTimeout)))

		result = KErrNotFound;

	// other general set up stuff

	_LIT(KGeneralSection, "General");

	_LIT(KInterfaceName, "Interface");

	if (!(GetStringFromConfig(KGeneralSection, KInterfaceName, temp)))

		result = KErrNotFound;

	iInterfaceName.Copy(temp);

	_LIT(KNameServerAddr, "NameServerAddr");

	if (!GetStringFromConfig(KGeneralSection, KNameServerAddr, temp))

		result = KErrNotFound;

	iNameServerAddr.Input(temp);

	_LIT(KEchoPortKey, "EchoPort");

	if (!(GetIntFromConfig(KGeneralSection, KEchoPortKey, iEchoPortNum)))

		result = KErrNotFound;

	_LIT(KNaptTestServerPort, "NaptTestServerPort");

	if (!(GetIntFromConfig(KGeneralSection, KNaptTestServerPort, iNaptTestServerPort)))

		result = KErrNotFound;

	// set the address which we should connect TCP sockets to (addr of TCP echo server)

	_LIT(KTcpConfigSection, "TCP Config");

	_LIT(KTcpSendAddrKey, "TcpSendAddress");

	if (!GetStringFromConfig(KTcpConfigSection, KTcpSendAddrKey, temp))

		result = KErrNotFound;

	iEchoServerAddr.Input(temp);

	// set it's port to the echo port

	iEchoServerAddr.SetPort(iEchoPortNum);

	// Napt

	_LIT(KNaptTestServer, "NaptTestServer");

	if (!GetStringFromConfig(KGeneralSection, KNaptTestServer, temp))

		result = KErrNotFound;

	iNaptTestServAddr.Input(temp);

	// set it's port to the NaptTestServer port

	iNaptTestServAddr.SetPort(iNaptTestServerPort);

	// the name which we will attempt to resolve many many times

	_LIT(KTestNameKey, "TestName");

	if (!GetStringFromConfig(KTcpConfigSection, KTestNameKey, temp))

		result = KErrNotFound;

	iTestName = temp;

	// the address which we will pass in when using GetByAddress()

	_LIT(KLookupAddressKey, "LookupAddress");

	if (!GetStringFromConfig(KGeneralSection, KLookupAddressKey, temp))

		result = KErrNotFound;

	iLookupAddress.Input(temp);

	_LIT(KNaptStatus, "NaptStatus");

	if (!GetStringFromConfig(KGeneralSection, KNaptStatus, iNaptStatus))

		result = KErrNotFound;

	return result;

}

TInt TE_RConnectionStep::OpenSocketServer(RSocketServ& ss)

/**

 * Opens the socket server that is pointed to

 * @param ss the socket server to open

 * @return system wide error code

 */

    {

    INFO_PRINTF1(_L("Opening Socket server"));

	return (ss.Connect());

    }

void TE_RConnectionStep::CloseSocketServer(RSocketServ& ss)

/**

 * Closes the socket server that is pointed to

 * @param ss the socket server to close

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Closing Socket server"));

	ss.Close(); // Close() inherited from RHandleBase?

}

TInt TE_RConnectionStep::OpenConnection(RConnection& conn, RSocketServ& ss)

/**

 * Open the connection using the socket server too

 * @param conn the connection to open

 * @param ss the socket server within which the connection is to be opened

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Opening Connection"));

	return (conn.Open(ss));

}

TInt TE_RConnectionStep::OpenConnection(RConnection& conn, RSocketServ& ss, TName& name)

/**

 * Open the connection (passing the name provided)

 * @param conn - the connection to open

 * @param ss - the socket server within which the connection is to be opened

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Opening Connection"));

	return (conn.Open(ss, name));

}

TInt TE_RConnectionStep::StartConnection(RConnection& conn)

/**

 * Start a connection using the default comm db settings

 * @param conn the connection to start

 * @return system wide error code

 */

{

	TRequestStatus status;

	conn.Start(status);

	INFO_PRINTF1(_L("Starting Connection"));

	User::WaitForRequest(status);

	return status.Int();

}

TInt TE_RConnectionStep::StartConnectionSynchronous(RConnection& conn)

/**

 * Start a connection using the default comm db settings (using the synchronous call)

 * @param conn - the connection to start

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Starting Connection"));

	return (conn.Start());

}

void TE_RConnectionStep::StartConnectionAsynchronous(RConnection& conn, TRequestStatus& status)

/**

 * Start a connection using the default comm db settings (returning before it completes)

 * @param conn - the connection to start

 * @param system wide error code

 */

{

	INFO_PRINTF1(_L("Starting Connection"));

	conn.Start(status);

}

TInt TE_RConnectionStep::StartConnectionWithOverrides(RConnection& conn, TInt iap)

/**

 * Start a connection on the IAP as specified by the param, do this by 

 * building some database overrides.

 * @param conn - the connection to start

 * @param iap - which IAP to create the connection over

 * @return system wide error code

 */

{

	TRequestStatus status;

	TCommDbConnPref prefs;

	prefs.SetIapId(iap);

	prefs.SetDialogPreference(ECommDbDialogPrefDoNotPrompt);

	conn.Start(prefs, status);

	INFO_PRINTF1(_L("Starting Connection with over rides"));

	User::WaitForRequest(status);

	return status.Int();

}

TInt TE_RConnectionStep::StartConnectionWithOverridesSynchronous(RConnection& conn, TInt iap)

/**

 * Start a connection on the IAP as specified by the param, do this by building some 

 * database overrides. Use the synchronous start method

 * @param conn - the connection to start

 * @param iap - which IAP to create the connection over

 * @return system wide error code

 */

{

	TCommDbConnPref prefs;

	prefs.SetIapId(iap);

	INFO_PRINTF1(_L("Starting Connection with over rides"));

	prefs.SetDialogPreference(ECommDbDialogPrefDoNotPrompt);

	return (conn.Start(prefs));

}

void TE_RConnectionStep::StartConnectionWithOverridesAsynchronous(RConnection& conn, TCommDbConnPref& aPrefs, TInt iap, TRequestStatus& status)

/**

 * Start a connection on the IAP as specified by the param - return before it completes

 * @param conn - the connection to start

 * @param iap - which IAP to create the connection over

 * @return system wide error code

 */

{

	aPrefs.SetIapId(iap);

	aPrefs.SetDialogPreference(ECommDbDialogPrefDoNotPrompt);

	INFO_PRINTF1(_L("Starting Connection with over rides"));

	conn.Start(aPrefs, status);

}

void TE_RConnectionStep::CloseConnection(RConnection& conn)

/**

 * Close a connection

 * @param conn the connection to close

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Closing Connection "));

	conn.Close();

}

TInt TE_RConnectionStep::StopConnection(RConnection& conn)

/**

 * Force the connection to stop and remove the interface no matter what other connections are using it

 * @param conn the connection to stop

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Stopping Connection "));

	return (conn.Stop());

}

TInt TE_RConnectionStep::EnumerateConnections(RConnection& conn, TUint& num)

/**

 * Read how many connections (==interfaces?) exist at the moment

 * @param conn - to be used to read the count

 * @param num - on completion holds the number of connections

 * @return system wide error code

 */

{

	return (conn.EnumerateConnections(num));

}

TInt TE_RConnectionStep::GetTimeoutValues(RConnection& conn, TTimeoutValues &timeouts)

/**

 * Read the timeout values from commdb

 * @param conn - the connection to read the values from

 * @param timeouts - where to put the timeout vals

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Getting Timeout Values"));

	TInt ret = KErrNone;

	TInt tmp;

	if (KErrNone != (tmp = conn.GetIntSetting(_L("ModemBearer\\LastSessionClosedTimeout"), timeouts.iShortTimeout)))

		ret = tmp;

	if (KErrNone != (tmp = conn.GetIntSetting(_L("ModemBearer\\LastSocketClosedTimeout"), timeouts.iMediumTimeout)))

		ret = tmp;

	if (KErrNone != (tmp = conn.GetIntSetting(_L("ModemBearer\\LastSocketActivityTimeout"), timeouts.iLongTimeout)))

		ret = tmp;

	return ret;

}

TInt TE_RConnectionStep::AttachNormal(RConnection& conn, const TDesC8& info)

/**

 * Attach the connection supplied to the one described by the info

 * @param conn - the connection to be attached to something

 * @param info - the details of the connection to attach to

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Connection Attach Normal"));

	return conn.Attach(info, RConnection::EAttachTypeNormal);

}

TInt TE_RConnectionStep::AttachMonitor(RConnection& conn, const TDesC8& info)

/**

 * Attach the connection supplied to the one described by the info (as a monitor)

 * @param conn - the connection to be attached to something

 * @param info - the details of the connection to attach to

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Connection Attach Monitor"));

	return conn.Attach(info, RConnection::EAttachTypeMonitor);

}

void TE_RConnectionStep::ProgressNotification(RConnection& conn, TRequestStatus& status, 

											  TNifProgressBuf& progress, TUint aSelectedProgress)

/**

 * Request notification when the progress changed to that supplied

 * @param conn - the connection we are interested in the progress of

 * @param status - the status variable which should be updated eventually

 * @param aSelectedProgress - the progress we want

 * @return system wide error code

 */

{

	INFO_PRINTF1(_L("Connection Progress Notification "));

	conn.ProgressNotification(progress, status, aSelectedProgress);

}

void TE_RConnectionStep::ProgressNotification(RConnection& conn, TRequestStatus& status, 

											  TNifProgressBuf& progress)

/**

 * Request notification of the next progress change