// Copyright (c) 2005-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 <ss_std.h>

#include <ss_glob.h>

#include <comms-infras/ss_roles.h>

#include "ss_msgs.h"

#include <es_ini.h>

#include <comms-infras/ss_log.h>

#include <ecom/ecom.h>

#include <ss_protprov.h>

#include <comms-infras/idquerynetmsg.h> //just to get Uids

#include <comms-infras/ss_tiermanagerutils.h>

#include <metadatabase.h> //CMDBSession

#include <elements/cftransportmsg.h>

#include <elements/nm_address_internal.h>

#include <elements/sd_msgs.h>

#include "ss_connectionserver.h"

#include <comms-infras/ss_common.h>

#include <comms-infras/ss_tiermanager.h>

#include <cfforwardmsg.h>

#include "ss_tierthreadmap.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_thrd, "ESockSSocks_thrd");

#endif

using namespace CommsFW;

using namespace ESock;

using namespace Messages;

using namespace Den;

//

// CWorkerThread class definitions

//

CWorkerThread* CWorkerThread::NewL(TCFModuleInfo* aModuleInfo)

	{

	CleanupStack::PushL(TCleanupItem(CCommonWorkerThread::DeleteHBufC8, aModuleInfo->iIniData));

	CWorkerThread* self = new (ELeave) CWorkerThread;

	CleanupStack::PushL(self);

	self->ConstructL(aModuleInfo);

	CleanupStack::Pop(self);

	CleanupStack::PopAndDestroy();	// aModuleInfo->iIniData

	return self;

	}

CWorkerThread::CWorkerThread()

:	CCommonWorkerThread(),

	iEskMaskList(KEskMaskListGranularity)

	{

	}

CWorkerThread::~CWorkerThread()

	{

	iTransportUsers.Shutdown(EFalse);

	iEskMaskList.Close();

	}

CPlayer* CWorkerThread::Player() const

	{

	return static_cast<CPlayer*>(CCommonWorkerThread::Player());

	}

CPitBoss& CWorkerThread::PitBoss() const

	{

	return static_cast<CPitBoss&>(CCommonWorkerThread::PitBoss());

	}

/**

The worker thread secondary construction will create the relevant Player/Dealer

instances needed as well as the channel handler to the Root Server. If and only if it

is the main thread it will also create the PitBoss.

@note If it has a Dealer and is not the main thread it is a WorkerDealer.

*/

TInt SocketServerShutDownCb(TAny*)

	{

	SocketServer::ShutDown();

	return KErrNone;

	}

void CWorkerThread::ConstructL(TCFModuleInfo* aModuleInfo)

	{

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ConstructL Determining roles")));

	CCommonWorkerThread::ConstructL(*aModuleInfo, *Den::CShutdownWatchDog::NewL(this, TCallBack(SocketServerShutDownCb, NULL)));

#ifdef ESOCK_HOME_THREAD_CHECK_ENABLED

	iOwnThread = RThread().Id();

#endif

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ConstructL Init SockManGlobals")));

	iSockManGlobals = CSockManData::NewL(*iGlobals, this);

	SocketServer::InitL(this);

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ConstructL Init ProtocolManager")));

	ProtocolManager::InitL();

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ConstructL Done Init ProtocolManager")));

	if(iPlayer)

		{

		SockManGlobals()->InstallFactoryContainersL();

		}

	LOG(ESockLog::Printf(_L("CWorkerThread::ConstructL Done")));

	}

/** Will read the .ESK masks from the inidata, to determine which .ESK files to load. */

void CWorkerThread::DoDeterminePlayerRoleL(HBufC8* aIniData, Den::TPlayerRole& aPlayerRole)

	{

	_LIT8(KEskMaskLabel, "EskMask");

	_LIT8(KEskMaskLabelNumFormat, "EskMask%d");

	_LIT8(KPlayerRoleLabel, "PlayerRole");

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::DetermineRoleL building .ESK mask list.")));

	TPtrC8 currentEskMaskPtr;

	TBuf8<KEskMaskLabelLength> currentEskMask;

	currentEskMask.Format(KEskMaskLabel);

	TEskMask currentMaskEntry;

	TInt i=0;

	do

		{

		if(GetVarFromIniData(*aIniData, KNullDesC8, currentEskMask, currentEskMaskPtr))

			{

			LOG(ESockLog::Printf(KESockBootingTag, _L8("Found EskMask under heading [IniData]: %S"), &currentEskMaskPtr));

			// Sanity check length

			if(currentEskMaskPtr.Length()>KMaxEskMaskLength)

				{

				LOG(ESockLog::Printf(KESockBootingTag, _L8("EskMask%d under heading [IniData] contains value of more than %d characters"), i, KMaxEskMaskLength));

#ifdef _DEBUG

				Panic(ECorruptIniData);

#endif

				// leave if ini data corrup rather than panic unless debug

				User::Leave(KErrCorrupt);

				}

			// Add entry to list of EskMasks

			currentMaskEntry.Copy(currentEskMaskPtr);

			iEskMaskList.AppendL(currentMaskEntry);

			}

		else

			{

			/* If first iteration and nothing found in "EskMask" it is a critical error.

			For EskMask0..max it is merely cause for breaking the loop */

			if(i==0)

				{

				LOG(ESockLog::Printf(KESockBootingTag, _L("EskMask under heading [IniData] not found")));

				// leave if ini data corruprather than panic unless debug

#ifdef _DEBUG

				Panic(ECorruptIniData);

#endif

				User::Leave(KErrCorrupt);

				}

			else

				{

				/* Break out of loop, if we didnt find EskMask<n> no reason to waste

				time searching for EskMask<n+1> */

				LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::DetermineRoleL No more ESK masks found.")));

				break;

				}

			}

		// Getting ready for next one

		++i;

		currentEskMask.Format(KEskMaskLabelNumFormat, i);

		}

	while(i<KEskMaskLabelMax);

	TInt playerRole = (iWorkerId == TCFWorkerThreadPublicInfo::EIpPlayerThread)?		// defaults for legacy configurations

		(TCFPlayerRole::EDataPlane | TCFPlayerRole::ESubConnPlane | TCFPlayerRole::EConnPlane | TCFPlayerRole::EMetaConnPlane | TCFPlayerRole::ETierMgrPlane | TCFPlayerRole::ETierResolver | TCFPlayerRole::EPrePlanarArchitecture):

		(TCFPlayerRole::EDataPlane | TCFPlayerRole::ESubConnPlane | TCFPlayerRole::EConnPlane | TCFPlayerRole::EMetaConnPlane | TCFPlayerRole::ETierMgrPlane | TCFPlayerRole::EPrePlanarArchitecture);

	if(GetVarFromIniData(*aIniData, KNullDesC8, KPlayerRoleLabel, playerRole))

		{

		if((playerRole != 0) &&

			((playerRole & ~(TCFPlayerRole::EDataPlane | TCFPlayerRole::ESubConnPlane | TCFPlayerRole::EConnPlane | TCFPlayerRole::EMetaConnPlane | TCFPlayerRole::ETierMgrPlane | TCFPlayerRole::ETierResolver)) == 0))	// no unknown flags

			{

			}

		else

			{

			LOG(ESockLog::Printf(KESockBootingTag, _L("PlayerType=%04x - unsupported type (must be OR of TPlayerRole flags or unspecified for legacy"), playerRole));

#ifdef _DEBUG

			Panic(ECorruptIniData);

#endif

			// leave if ini data corrupt rather than panic if not debug

			User::Leave(KErrCorrupt);

			}

		}

	aPlayerRole = TCFPlayerRole(playerRole, aPlayerRole.Kindex());

	}

CCommonPitBoss* CWorkerThread::DoCreatePitBossL(CCommonWorkerThread* aWorkerThread)

	{

	return CPitBoss::NewL(static_cast<CWorkerThread*>(aWorkerThread));

	}

CCommonPlayer* CWorkerThread::DoCreatePlayerL(CCommonWorkerThread* aWorkerThread,TPlayerRole aPlayerRole)

	{

	CPlayer* player = CPlayer::NewL(static_cast<CWorkerThread*>(aWorkerThread),aPlayerRole);

//	CleanupStack::PushL(player);

//	CleanupStack::Pop(player);

	return player;

	}

CCommonDealer* CWorkerThread::DoCreateDealerL(CCommonWorkerThread* aWorkerThread, Den::TPlayerRole aPlayerRole)

	{

	CCommonDealer* dealer = NULL;

	if (aPlayerRole.HasRole(TCFPlayerRole::ETierResolver))

		{

		CConnectionServer* cs = CConnectionServer::NewL(static_cast<CWorkerThread*>(aWorkerThread));

		CleanupStack::PushL(cs);

		dealer = CCommonDealer::NewL(cs);

		CleanupStack::Pop(cs);

		cs->SetDealer(dealer);

		}

	else

		{

		CSocketServer* ss = CSocketServer::NewL(static_cast<CWorkerThread*>(aWorkerThread));

		CleanupStack::PushL(ss);

		if (IsMainThread())

			{

			dealer = CCommonDealer::NewL(ss);

			}

		else

			{

			dealer = CCommonWorkerDealer::NewL(ss);

			}

		CleanupStack::Pop(ss);

		ss->SetDealer(dealer);

		}

	return dealer;

	}

/**

Takes the total list of .ESK files and generates a new local list containing only the file names

matching the .ESK list for this worker. Then creates a new ini data instance with the local list to be

used by the protocol manager for initialisation.

@see CESockIniData

*/

void CWorkerThread::ProcessMatchingEskFilesL(const COwnEntryList* aEskFiles)

	{

	LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ProcessMatchingEskFilesL: %d files"), aEskFiles->Count()));

	TInt i;

	for(i=0;i<iEskMaskList.Count();i++)

		{

		LOG(ESockLog::Printf(KESockBootingTag, _L("CWorkerThread::ProcessMatchingEskFilesL: mask %S"), &iEskMaskList[i]));

		}

	// The Gordian Knot of global data remains only half slashed... Also future work may eliminate the sharing of iEskData

	// through this, rather than PitBoss()?

	CESockIniData** iniData = &SockManGlobals::Get()->iEskData;

	delete *iniData;

	*iniData = NULL;

	// Build a private, filtered copy of the total set of ESK files

	CommsFW::COwnEntryList* ownEskFiles = new(ELeave) COwnEntryList(6);

	CleanupStack::PushL(ownEskFiles);

	TParse parsed;

	const TInt cnt = aEskFiles->Count();

	for(i = 0; i < cnt; ++i)

		{

		const COwnEntryList::TOwnEntry& entry = aEskFiles->operator[](i);

		parsed.Set(entry.iName, NULL, NULL);

		TPtrC nameAndExt = parsed.NameAndExt();

		for(TInt j=0; j<iEskMaskList.Count(); ++j)

			{

			if(nameAndExt.MatchF(iEskMaskList[j]) >= 0)

				{

				LOG(ESockLog::Printf(KESockBootingTag, _L("- matched %S"), &entry.iName));

				ownEskFiles->AddL(entry);

				break; // Stop inner loop

				}

			}

		}

	iEskMaskList.Close();

	LOG(ESockLog::Printf(KESockBootingTag, _L8("CWorkerThread::ProcessMatchingEskFilesL: %d files matched"), ownEskFiles->Count()));

	if(ownEskFiles->Count() == 0 && (!iPlayer || static_cast<CPlayer*>(iPlayer)->HasDataPlane()))

		{

		// Threads with data planes must have one or more matching ESK files (otherwise

		// they have no function and surely result from configuration errors)

		User::Leave(KErrCorrupt);

		}

	// The ini data processing lives in the global protocol manager, for legacy reasons

	*iniData = CESockIniData::NewL(ownEskFiles);

	CleanupStack::Pop(ownEskFiles);

	delete ownEskFiles;

	if (iPlayer)

		{

		if(static_cast<CPlayer*>(iPlayer)->HasDataPlane())

			{

			ProtocolManager::ProcessIniDataL();

			}

		}

	}

void CWorkerThread::DoProcessWorkerIntroductionL(const TWorkerIntroductionMsg& aMsg)

	{

	TBuf8<TWorkerIntroductionMsg::KMaxIntroductionInfoSize> eskFilesList;

	aMsg.IntroductionInfo(eskFilesList);

	CommsFW::COwnEntryList* const* eskFiles = reinterpret_cast<CommsFW::COwnEntryList* const*>(eskFilesList.Ptr());

	TRAPD(ret, ProcessMatchingEskFilesL(*eskFiles));

	if (ret != KErrNone)

		{

		LOG(ESockLog::Printf(KESockBootingTag, _L("ERROR %d processing Esk files"), ret));

	#ifdef _DEBUG

		RDebug::Printf("CWorkerThread::DoProcessWorkerIntroductionL ERROR %d processing Esk files", ret);

		Panic(EMisconfigured);

	#endif

		// Leave if problem with EskFiles instead of panic unless debug

		User::Leave(KErrCorrupt);

		}

	}

void CWorkerThread::DoFillIntroMessage(TWorkerId /*aPeerId*/, TWorkerIntroductionMsg& aIntroMsg)

	{

	if(IsMainThread())

		{

		const CommsFW::COwnEntryList* eskList = PitBoss().GetCompleteList();

		TPtrC8 ptr((TUint8*)&eskList, sizeof(TAny*)); //Yes, pointer to pointer

		aIntroMsg.SetIntroductionInfo(ptr);

		}

	else

		{

		TPckg<TBool> defaultOptDealer(DefaultOptimalDealer());

		aIntroMsg.SetIntroductionInfo(defaultOptDealer);

	}

	}

/**

Deals with binding requests from the Root Server. Note that although the Root Server allows

multiple identical bindings ESock does not allow this and will panic if the binding already exists.

Bindings are expressed in ESock by worker transport objects stored in an array. Since all sub-module

names are unique across all ESock instances (they are the individual owning worker ID converted to text)

they can be used here. I.e. the remote end sub-module is converted back to int and used to insert the

CWorkerTransport into an array in the position corresponding to the remote end sub-module name/number.

As for responding to the bind request there are two cases:

    -# This worker is a "peer Player: Immediately introduce ourselves, including cookies

	-# This worker is the Main thread: Wait to receive its introduction message, which carries the ESK file list.

@see CWorkerTransport

*/

void CWorkerThread::CFBindMessageReceived(const TCFBindMsg& aMsg)

	{

    __CFLOG_SMADDR2(( KESockComponentTag, KESockServerTag, _L8("W%d: CFBindMessageReceived %S <=> %S"),

		WorkerId(),

		&aMsg.SubModule1()->Printable(__FullModName1),

		&aMsg.SubModule2()->Printable(__FullModName2) ));

	TWorkerId bindId;

	TInt err = DecodePeerId(aMsg.SubModule1(), aMsg.SubModule2(), bindId);

	__ASSERT_DEBUG(bindId <=  TWorkerThreadPublicInfo::EMaxWorkerThreadId, User::Panic(KSpecAssert_ESockSSocks_thrd, 1));

	if(err == KErrNone)

		{

		if(iTransport->PeerReachable(bindId))

			{

			LOG(ESockLog::Printf(_L8("%d Already exists. Error in configuration of cmi files"),bindId));

			Panic(EDuplicateWorkerId); //Must panic b/c the new module will be left in a half bound state and will tend to get out of hand

			}

		else

			{

			err = iTransport->EstablishTransportToPeer(bindId, aMsg.ChannelInput(), aMsg.ChannelOutput());

			if(err == KErrNone)

				{

				iTransport->SetLastRequestIdConcerningPeer(bindId, aMsg.Identifier());

				// If we're binding to the main thread then wait for its intro, with the all-important ESK file list

				if(bindId != TWorkerThreadPublicInfo::EMainThread)

					{

					SendIntroMessage(aMsg.SubModule2()->Module(), bindId);

					// If we have a player then follow up with a bucket of our own cookies (always a good way to make friends

					// with the new neighbour...). Only "planar architecture" configurations share their cookies; this allows

					// bindings between legacy threads for purposes of Dealer -> Player forwarding only.

					// @TODO - either we stop forwarding from optimal Dealers to Players or we have to add of indicating which

					// bindings are for sharing planes and which are for simply forwarding requests. Probably we should do the

					// former - if someone asks for "optimal IP data" then why should they be able to send SMS from that session?

					Messages::TNodeId dataFC;

					Messages::TNodeId subConnFC;

					Messages::TNodeId connFC;

					Messages::TNodeId metaConnFC;

					Messages::TNodeId tierManagerFC;

					if(Player())

						{

						const TPlayerRole& role = Player()->PlayerRole();

						if(!role.HasRole(TCFPlayerRole::EPrePlanarArchitecture))

							{

							// It's safe to simply copy the cookies we know of here - we cannot yet have learnt of any others so they must be ours

							CSockManData* globs = Player()->SockManGlobals();

							if(role.HasRole(TCFPlayerRole::EDataPlane))

								{

								dataFC = globs->GetPlaneFC(TCFPlayerRole(TCFPlayerRole::EDataPlane));

								}

							if(role.HasRole(TCFPlayerRole::ESubConnPlane))

								{

								subConnFC = globs->GetPlaneFC(TCFPlayerRole(TCFPlayerRole::ESubConnPlane));

								}

							if(role.HasRole(TCFPlayerRole::EConnPlane))

								{

								connFC = globs->GetPlaneFC(TCFPlayerRole(TCFPlayerRole::EConnPlane));

								}

							if(role.HasRole(TCFPlayerRole::EMetaConnPlane))

								{

								metaConnFC = globs->GetPlaneFC(TCFPlayerRole(TCFPlayerRole::EMetaConnPlane));

								}

							if(role.HasRole(TCFPlayerRole::ETierMgrPlane))

								{

								tierManagerFC = globs->GetPlaneFC(TCFPlayerRole(TCFPlayerRole::ETierMgrPlane));

								}

							}

						}

                    NM_LOG_START_BLOCK(KESockComponentTag, _L8("PeerIntro"));

                    NM_LOG((KESockComponentTag, _L8("CFBindMessageReceived(): Sending Cookies to peer #%d "), bindId));

                    NM_LOG_ADDRESS_EXT(KESockComponentTag, dataFC, _L8("dataFC: "));

                    NM_LOG_ADDRESS_EXT(KESockComponentTag, subConnFC, _L8("scFC: "));

                    NM_LOG_ADDRESS_EXT(KESockComponentTag, connFC, _L8("cnFC: "));

                    NM_LOG_ADDRESS_EXT(KESockComponentTag, metaConnFC, _L8("mcFC: "));

                    NM_LOG_ADDRESS_EXT(KESockComponentTag, tierManagerFC, _L8("tmFC: "));

				    NM_LOG_END_BLOCK(KESockComponentTag, _L8("PeerIntro"));

					TWorkerCookiesMsg cookieMsg(dataFC, subConnFC, connFC, metaConnFC, tierManagerFC);

					PostMessage(bindId, cookieMsg);

					if(!IsMainThread())

						{

						if(Player()->HasConnPlane())

							{

							SendObjectBrokerIntroductionMessage(bindId);

							}

						}

					}

				}

			}

		}

	/* Main dealer only completes when it has received the introduction response messages from peers,

	dumb players respond immediately. */

	if(err!=KErrNone || !IsMainThread())

		{

		TCFBindCompleteMsg respMsg(aMsg.Identifier(), err);

		VERIFY_RESULT(iChannelHandler->Send(respMsg), KErrNone);

		}

	}

void CWorkerThread::SendObjectBrokerIntroductionMessage(const CommsFW::TWorkerId& aPeerId)

	{

	// Share our central object broker node with a worker

	__ASSERT_DEBUG(Player(), User::Panic(KSpecAssert_ESockSSocks_thrd, 2));

	__ASSERT_DEBUG(Player()->HasConnPlane(), User::Panic(KSpecAssert_ESockSSocks_thrd, 3));

	TBrokerIntroductionMsg brokerIntroMsg(SockManGlobals()->iCommsFactoryContainerBroker);

	PostMessage(aPeerId, brokerIntroMsg);

	}

void CWorkerThread::DoCompleteUnbinding(CommsFW::TWorkerId aWorker)

	{

	TCFPlayerRole ourRole(TCFPlayerRole::EAllPlanes | TCFPlayerRole::ETierResolver);

	TPlaneUnboundMsg unboundMsg(ourRole);

	PostMessage(aWorker, unboundMsg);

	CSockManData* globs = SockManGlobals();

	globs->iFCMap.DropFCOfPeer(TCFPlayerRole(TCFPlayerRole::EAllPlanes), aWorker);

	CommsFW::TCFUnbindCompleteMsg respMsg(iTransport->LastRequestIdConcerningPeer(aWorker), KErrNone);

	iTransport->DropTransportToPeer(aWorker);

	VERIFY_RESULT(iChannelHandler->Send(respMsg), KErrNone);

	}

/**

It is possible for client applications outside of the Comms Process to send messages to

an ESock Worker thread. This is done through the Root Server SendMessage method.

The message is received by the destination ESock Worker in the CFMessageForward member,

which will deal with it accordingly.

Supported message type is TCFMessageType::EFactoryMsg destined for one or more

CProtocolFamilyFactoryBase instances from globals->iProtocolFamilyFactories. ESock will

traverse through this list and deliver (by calling SendMessage()) the message content to

every instance present there.

The message content for such a message sent to an ESock Worker is required to be based on

the CNetMessage class.

@note Completion of the client request the responsibility of the recipient.

@see RRootServ::SendMessage

*/

void CWorkerThread::CFMessageForward(const CommsFW::TCFForwardMsg& aMessage)

	{

	const RMessage2& msg = aMessage.Msg();

	if ( !SockManGlobals::Get()->iProtocolFamilyFactories )

		{

		msg.Complete( KErrNotReady );

		return;

		}

	TInt len = msg.GetDesLength(2);

	SMetaDataECom* pInstance = NULL;

	TInt nErr=KErrArgument;

	TPtr8 pDataPtr(0,0);

	RBuf8 buf;

	if( len >= 0 )

		{

		nErr = buf.Create( len );

		if ( nErr == KErrNone )

			{

			pDataPtr.Set( const_cast<TUint8*>(buf.Ptr()), 0, buf.MaxLength() );

			nErr = msg.Read( 2, pDataPtr );

			}

		if ( nErr == KErrNone )

			{