1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../../stdafx.h"

     6

#include "../../debug.h"

     7

#include "../../macros.h"

     8

#include "../../helpers.hpp"

     9

#include "packet.h"

    10

#include "udp.h"

    11

    12

/**

    14

 */

    15

    16

/**

    17

 * Start listening on the given host and port.

    18

 * @param host      the host (ip) to listen on

    19

 * @param port      the port to listen on

    20

 * @param broadcast whether to allow broadcast sending/receiving

    21

 * @return true if the listening succeeded

    22

 */

    23

bool NetworkUDPSocketHandler::Listen(const uint32 host, const uint16 port, const bool broadcast)

    24

{

    25

	struct sockaddr_in sin;

    26

    27

	/* Make sure socket is closed */

    28

	this->Close();

    29

    30

	this->sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);

    31

	if (!this->IsConnected()) {

    32

		DEBUG(net, 0, "[udp] failed to start UDP listener");

    33

		return false;

    34

	}

    35

    36

	/* set nonblocking mode for socket */

    37

	{

    38

		unsigned long blocking = 1;

    39

#ifndef BEOS_NET_SERVER

    40

		ioctlsocket(this->sock, FIONBIO, &blocking);

    41

#else

    42

		setsockopt(this->sock, SOL_SOCKET, SO_NONBLOCK, &blocking, NULL);

    43

#endif

    44

	}

    45

    46

	sin.sin_family = AF_INET;

    47

	/* Listen on all IPs */

    48

	sin.sin_addr.s_addr = host;

    49

	sin.sin_port = htons(port);

    50

    51

	if (bind(this->sock, (struct sockaddr*)&sin, sizeof(sin)) != 0) {

    52

		DEBUG(net, 0, "[udp] bind failed on %s:%i", inet_ntoa(*(struct in_addr *)&host), port);

    53

		return false;

    54

	}

    55

    56

	if (broadcast) {

    57

		/* Enable broadcast */

    58

		unsigned long val = 1;

    59

#ifndef BEOS_NET_SERVER // will work around this, some day; maybe.

    60

		setsockopt(this->sock, SOL_SOCKET, SO_BROADCAST, (char *) &val , sizeof(val));

    61

#endif

    62

	}

    63

    64

	DEBUG(net, 1, "[udp] listening on port %s:%d", inet_ntoa(*(struct in_addr *)&host), port);

    65

    66

	return true;

    67

}

    68

    69

/**

    70

 * Close the given UDP socket

    71

 */

    72

void NetworkUDPSocketHandler::Close()

    73

{

    74

	if (!this->IsConnected()) return;

    75

    76

	closesocket(this->sock);

    77

	this->sock = INVALID_SOCKET;

    78

}

    79

    80

NetworkRecvStatus NetworkUDPSocketHandler::CloseConnection()

    81

{

    82

	this->has_quit = true;

    83

	return NETWORK_RECV_STATUS_OKAY;

    84

}

    85

    86

/**

    87

 * Send a packet over UDP

    88

 * @param p    the packet to send

    89

 * @param recv the receiver (target) of the packet

    90

 */

    91

void NetworkUDPSocketHandler::SendPacket(Packet *p, const struct sockaddr_in *recv)

    92

{

    93

	int res;

    94

    95

	NetworkSend_FillPacketSize(p);

    96

    97

	/* Send the buffer */

    98

	res = sendto(this->sock, (const char*)p->buffer, p->size, 0, (struct sockaddr *)recv, sizeof(*recv));

    99

   100

	/* Check for any errors, but ignore it otherwise */

   101

	if (res == -1) DEBUG(net, 1, "[udp] sendto failed with: %i", GET_LAST_ERROR());

   102

}

   103

   104

/**

   105

 * Receive a packet at UDP level

   106

 */

   107

void NetworkUDPSocketHandler::ReceivePackets()

   108

{

   109

	struct sockaddr_in client_addr;

   110

	socklen_t client_len;

   111

	int nbytes;

   112

	Packet p;

   113

	int packet_len;

   114

   115

	if (!this->IsConnected()) return;

   116

   117

	packet_len = sizeof(p.buffer);

   118

	client_len = sizeof(client_addr);

   119

   120

	/* Try to receive anything */

   121

	nbytes = recvfrom(this->sock, (char*)p.buffer, packet_len, 0, (struct sockaddr *)&client_addr, &client_len);

   122

   123

	/* We got some bytes for the base header of the packet. */

   124

	if (nbytes > 2) {

   125

		NetworkRecv_ReadPacketSize(&p);

   126

   127

		/* If the size does not match the packet must be corrupted.

   128

		 * Otherwise it will be marked as corrupted later on. */

   129

		if (nbytes != p.size) {

   130

			DEBUG(net, 1, "received a packet with mismatching size from %s:%d",

   131

					inet_ntoa(client_addr.sin_addr), ntohs(client_addr.sin_port));

   132

   133

			return;

   134

		}

   135

   136

		/* Put the position on the right place */

   137

		p.pos = 2;

   138

		p.next = NULL;

   139

   140

		/* Handle the packet */

   141

		this->HandleUDPPacket(&p, &client_addr);

   142

	}

   143

}

   144

   145

   146

/**

   147

 * Serializes the GRFIdentifier (GRF ID and MD5 checksum) to the packet

   148

 * @param p   the packet to write the data to

   149

 * @param grf the GRFIdentifier to serialize

   150

 */

   151

void NetworkUDPSocketHandler::Send_GRFIdentifier(Packet *p, const GRFIdentifier *grf)

   152

{

   153

	uint j;

   154

	NetworkSend_uint32(p, grf->grfid);

   155

	for (j = 0; j < sizeof(grf->md5sum); j++) {

   156

		NetworkSend_uint8 (p, grf->md5sum[j]);

   157

	}

   158

}

   159

   160

/**

   161

 * Deserializes the GRFIdentifier (GRF ID and MD5 checksum) from the packet

   162

 * @param p   the packet to read the data from

   163

 * @param grf the GRFIdentifier to deserialize

   164

 */

   165

void NetworkUDPSocketHandler::Recv_GRFIdentifier(Packet *p, GRFIdentifier *grf)

   166

{

   167

	uint j;

   168

	grf->grfid = NetworkRecv_uint32(this, p);

   169

	for (j = 0; j < sizeof(grf->md5sum); j++) {

   170

		grf->md5sum[j] = NetworkRecv_uint8(this, p);

   171

	}

   172

}

   173

   174

   175

/**

   176

 * Serializes the NetworkGameInfo struct to the packet

   177

 * @param p    the packet to write the data to

   178

 * @param info the NetworkGameInfo struct to serialize

   179

 */

   180

void NetworkUDPSocketHandler::Send_NetworkGameInfo(Packet *p, const NetworkGameInfo *info)

   181

{

   182

	NetworkSend_uint8 (p, NETWORK_GAME_INFO_VERSION);

   183

   184

	/*

   185

	 *              Please observe the order.

   186

	 * The parts must be read in the same order as they are sent!

   187

	 */

   188

   189

	/* Update the documentation in udp.h on changes

   190

	 * to the NetworkGameInfo wire-protocol! */

   191

   192

	/* NETWORK_GAME_INFO_VERSION = 4 */

   193

	{

   194

		/* Only send the GRF Identification (GRF_ID and MD5 checksum) of

   195

		 * the GRFs that are needed, i.e. the ones that the server has

   196

		 * selected in the NewGRF GUI and not the ones that are used due

   197

		 * to the fact that they are in [newgrf-static] in openttd.cfg */

   198

		const GRFConfig *c;

   199

		uint count = 0;

   200

   201

		/* Count number of GRFs to send information about */

   202

		for (c = info->grfconfig; c != NULL; c = c->next) {

   203

			if (!HASBIT(c->flags, GCF_STATIC)) count++;

   204

		}

   205

		NetworkSend_uint8 (p, count); // Send number of GRFs

   206

   207

		/* Send actual GRF Identifications */

   208

		for (c = info->grfconfig; c != NULL; c = c->next) {

   209

			if (!HASBIT(c->flags, GCF_STATIC)) this->Send_GRFIdentifier(p, c);

   210

		}

   211

	}

   212

   213

	/* NETWORK_GAME_INFO_VERSION = 3 */

   214

	NetworkSend_uint32(p, info->game_date);

   215

	NetworkSend_uint32(p, info->start_date);

   216

   217

	/* NETWORK_GAME_INFO_VERSION = 2 */

   218

	NetworkSend_uint8 (p, info->companies_max);

   219

	NetworkSend_uint8 (p, info->companies_on);

   220

	NetworkSend_uint8 (p, info->spectators_max);

   221

   222

	/* NETWORK_GAME_INFO_VERSION = 1 */

   223

	NetworkSend_string(p, info->server_name);

   224

	NetworkSend_string(p, info->server_revision);

   225

	NetworkSend_uint8 (p, info->server_lang);

   226

	NetworkSend_uint8 (p, info->use_password);

   227

	NetworkSend_uint8 (p, info->clients_max);

   228

	NetworkSend_uint8 (p, info->clients_on);

   229

	NetworkSend_uint8 (p, info->spectators_on);

   230

	NetworkSend_string(p, info->map_name);

   231

	NetworkSend_uint16(p, info->map_width);

   232

	NetworkSend_uint16(p, info->map_height);

   233

	NetworkSend_uint8 (p, info->map_set);

   234

	NetworkSend_uint8 (p, info->dedicated);

   235

}

   236

   237

/**

   238

 * Deserializes the NetworkGameInfo struct from the packet

   239

 * @param p    the packet to read the data from

   240

 * @param info the NetworkGameInfo to deserialize into

   241

 */

   242

void NetworkUDPSocketHandler::Recv_NetworkGameInfo(Packet *p, NetworkGameInfo *info)

   243

{

   244

	static const Date MAX_DATE = ConvertYMDToDate(MAX_YEAR, 11, 31); // December is month 11

   245

   246

	info->game_info_version = NetworkRecv_uint8(this, p);

   247

   248

	/*

   249

	 *              Please observe the order.

   250

	 * The parts must be read in the same order as they are sent!

   251

	 */

   252

   253

	/* Update the documentation in udp.h on changes

   254

	 * to the NetworkGameInfo wire-protocol! */

   255

   256

	switch (info->game_info_version) {

   257

		case 4: {

   258

			GRFConfig **dst = &info->grfconfig;

   259

			uint i;

   260

			uint num_grfs = NetworkRecv_uint8(this, p);

   261

   262

			for (i = 0; i < num_grfs; i++) {

   263

				GRFConfig *c = CallocT<GRFConfig>(1);

   264

				this->Recv_GRFIdentifier(p, c);

   265

				this->HandleIncomingNetworkGameInfoGRFConfig(c);

   266

   267

				/* Append GRFConfig to the list */

   268

				*dst = c;

   269

				dst = &c->next;

   270

			}

   271

		} /* Fallthrough */

   272

		case 3:

   273

			info->game_date      = clamp(NetworkRecv_uint32(this, p), 0, MAX_DATE);

   274

			info->start_date     = clamp(NetworkRecv_uint32(this, p), 0, MAX_DATE);

   275

			/* Fallthrough */

   276

		case 2:

   277

			info->companies_max  = NetworkRecv_uint8 (this, p);

   278

			info->companies_on   = NetworkRecv_uint8 (this, p);

   279

			info->spectators_max = NetworkRecv_uint8 (this, p);

   280

			/* Fallthrough */

   281

		case 1:

   282

			NetworkRecv_string(this, p, info->server_name,     sizeof(info->server_name));

   283

			NetworkRecv_string(this, p, info->server_revision, sizeof(info->server_revision));

   284

			info->server_lang    = NetworkRecv_uint8 (this, p);

   285

			info->use_password   = (NetworkRecv_uint8 (this, p) != 0);

   286

			info->clients_max    = NetworkRecv_uint8 (this, p);

   287

			info->clients_on     = NetworkRecv_uint8 (this, p);

   288

			info->spectators_on  = NetworkRecv_uint8 (this, p);

   289

			if (info->game_info_version < 3) { // 16 bits dates got scrapped and are read earlier

   290

				info->game_date    = NetworkRecv_uint16(this, p) + DAYS_TILL_ORIGINAL_BASE_YEAR;

   291

				info->start_date   = NetworkRecv_uint16(this, p) + DAYS_TILL_ORIGINAL_BASE_YEAR;

   292

			}

   293

			NetworkRecv_string(this, p, info->map_name, sizeof(info->map_name));

   294

			info->map_width      = NetworkRecv_uint16(this, p);

   295

			info->map_height     = NetworkRecv_uint16(this, p);

   296

			info->map_set        = NetworkRecv_uint8 (this, p);

   297

			info->dedicated      = (NetworkRecv_uint8(this, p) != 0);

   298

   299

			if (info->server_lang >= NETWORK_NUM_LANGUAGES)  info->server_lang = 0;

   300

			if (info->map_set     >= NETWORK_NUM_LANDSCAPES) info->map_set     = 0;

   301

	}

   302

}

   303

   308

#define UDP_COMMAND(type) case type: this->NetworkPacketReceive_ ## type ## _command(p, client_addr); break;

   309

   310

/**

   311

 * Handle an incoming packets by sending it to the correct function.

   312

 * @param p the received packet

   313

 * @param client_addr the sender of the packet

   314

 */

   315

void NetworkUDPSocketHandler::HandleUDPPacket(Packet *p, const struct sockaddr_in *client_addr)

   316

{

   317

	PacketUDPType type;

   318

   319

	/* New packet == new client, which has not quit yet */

   320

	this->has_quit = false;

   321

   322

	type = (PacketUDPType)NetworkRecv_uint8(this, p);

   323

   324

	switch (this->HasClientQuit() ? PACKET_UDP_END : type) {

   325

		UDP_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   326

		UDP_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   327

		UDP_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   328

		UDP_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   329

		UDP_COMMAND(PACKET_UDP_SERVER_REGISTER);

   330

		UDP_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   331

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   332

		UDP_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   333

		UDP_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   334

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   335

		UDP_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   336

   337

		default:

   338

			if (this->HasClientQuit()) {

   339

				DEBUG(net, 0, "[udp] received invalid packet type %d from %s:%d", type,  inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   340

			} else {

   341

				DEBUG(net, 0, "[udp] received illegal packet from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   342

			}

   343

			break;

   344

	}

   345

}

   346

   348

 * Create stub implementations for all receive commands that only

   349

 * show a warning that the given command is not available for the

   350

 * socket where the packet came from.

   352

 */

   353

#define DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(type) \

   354

void NetworkUDPSocketHandler::NetworkPacketReceive_## type ##_command(\

   355

		Packet *p, const struct sockaddr_in *client_addr) { \

   356

	DEBUG(net, 0, "[udp] received packet type %d on wrong port from %s:%d", \

   357

			type, inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port)); \

   358

}

   359

   360

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   361

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   362

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   363

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   364

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   365

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   366

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   367

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   368

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   369

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   370

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   371

   372

#endif /* ENABLE_NETWORK */