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

/**

    13

 * @file udp.c Basic functions to receive and send UDP packets.

    14

 */

    15

    16

/**

    17

 * Start listening on the given host and port.

    18

 * @param udp       the place where the (references to the) UDP are stored

    19

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

    20

 * @param port      the port to listen on

    21

 * @param broadcast whether to allow broadcast sending/receiving

    22

 * @return true if the listening succeeded

    23

 */

    24

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

    25

{

    26

	struct sockaddr_in sin;

    27

    28

	/* Make sure socket is closed */

    29

	this->Close();

    30

    31

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

    32

	if (!this->IsConnected()) {

    33

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

    34

		return false;

    35

	}

    36

    37

	/* set nonblocking mode for socket */

    38

	{

    39

		unsigned long blocking = 1;

    40

#ifndef BEOS_NET_SERVER

    41

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

    42

#else

    43

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

    44

#endif

    45

	}

    46

    47

	sin.sin_family = AF_INET;

    48

	/* Listen on all IPs */

    49

	sin.sin_addr.s_addr = host;

    50

	sin.sin_port = htons(port);

    51

    52

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

    53

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

    54

		return false;

    55

	}

    56

    57

	if (broadcast) {

    58

		/* Enable broadcast */

    59

		unsigned long val = 1;

    60

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

    61

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

    62

#endif

    63

	}

    64

    65

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

    66

    67

	return true;

    68

}

    69

    70

/**

    71

 * Close the given UDP socket

    72

 * @param udp the socket to close

    73

 */

    74

void NetworkUDPSocketHandler::Close()

    75

{

    76

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

    77

    78

	closesocket(this->sock);

    79

	this->sock = INVALID_SOCKET;

    80

}

    81

    82

NetworkRecvStatus NetworkUDPSocketHandler::CloseConnection()

    83

{

    84

	this->has_quit = true;

    85

	return NETWORK_RECV_STATUS_OKAY;

    86

}

    87

    88

/**

    89

 * Send a packet over UDP

    90

 * @param udp  the socket to send over

    91

 * @param p    the packet to send

    92

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

    93

 */

    94

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

    95

{

    96

	int res;

    97

    98

	NetworkSend_FillPacketSize(p);

    99

   100

	/* Send the buffer */

   101

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

   102

   103

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

   104

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

   105

}

   106

   107

/**

   108

 * Receive a packet at UDP level

   109

 * @param udp the socket to receive the packet on

   110

 */

   111

void NetworkUDPSocketHandler::ReceivePackets()

   112

{

   113

	struct sockaddr_in client_addr;

   114

	socklen_t client_len;

   115

	int nbytes;

   116

	Packet p;

   117

	int packet_len;

   118

   119

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

   120

   121

	packet_len = sizeof(p.buffer);

   122

	client_len = sizeof(client_addr);

   123

   124

	/* Try to receive anything */

   125

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

   126

   127

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

   128

	if (nbytes > 2) {

   129

		NetworkRecv_ReadPacketSize(&p);

   130

   131

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

   132

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

   133

		if (nbytes != p.size) {

   134

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

   135

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

   136

   137

			return;

   138

		}

   139

   140

		/* Put the position on the right place */

   141

		p.pos = 2;

   142

		p.next = NULL;

   143

   144

		/* Handle the packet */

   145

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

   146

	}

   147

}

   148

   149

   150

/**

   151

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

   152

 * @param p   the packet to write the data to

   153

 * @param grf the GRFIdentifier to serialize

   154

 */

   155

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

   156

{

   157

	uint j;

   158

	NetworkSend_uint32(p, grf->grfid);

   159

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

   160

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

   161

	}

   162

}

   163

   164

/**

   165

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

   166

 * @param p   the packet to read the data from

   167

 * @param grf the GRFIdentifier to deserialize

   168

 */

   169

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

   170

{

   171

	uint j;

   172

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

   173

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

   174

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

   175

	}

   176

}

   177

   178

   179

/**

   180

 * Serializes the NetworkGameInfo struct to the packet

   181

 * @param p    the packet to write the data to

   182

 * @param info the NetworkGameInfo struct to serialize

   183

 */

   184

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

   185

{

   186

	NetworkSend_uint8 (p, NETWORK_GAME_INFO_VERSION);

   187

   188

	/*

   189

	 *              Please observe the order.

   190

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

   191

	 */

   192

   193

	/* Update the documentation in udp.h on changes

   194

	 * to the NetworkGameInfo wire-protocol! */

   195

   196

	/* NETWORK_GAME_INFO_VERSION = 4 */

   197

	{

   198

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

   199

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

   200

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

   201

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

   202

		const GRFConfig *c;

   203

		uint count = 0;

   204

   205

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

   206

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

   207

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

   208

		}

   209

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

   210

   211

		/* Send actual GRF Identifications */

   212

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

   213

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

   214

		}

   215

	}

   216

   217

	/* NETWORK_GAME_INFO_VERSION = 3 */

   218

	NetworkSend_uint32(p, info->game_date);

   219

	NetworkSend_uint32(p, info->start_date);

   220

   221

	/* NETWORK_GAME_INFO_VERSION = 2 */

   222

	NetworkSend_uint8 (p, info->companies_max);

   223

	NetworkSend_uint8 (p, info->companies_on);

   224

	NetworkSend_uint8 (p, info->spectators_max);

   225

   226

	/* NETWORK_GAME_INFO_VERSION = 1 */

   227

	NetworkSend_string(p, info->server_name);

   228

	NetworkSend_string(p, info->server_revision);

   229

	NetworkSend_uint8 (p, info->server_lang);

   230

	NetworkSend_uint8 (p, info->use_password);

   231

	NetworkSend_uint8 (p, info->clients_max);

   232

	NetworkSend_uint8 (p, info->clients_on);

   233

	NetworkSend_uint8 (p, info->spectators_on);

   234

	NetworkSend_string(p, info->map_name);

   235

	NetworkSend_uint16(p, info->map_width);

   236

	NetworkSend_uint16(p, info->map_height);

   237

	NetworkSend_uint8 (p, info->map_set);

   238

	NetworkSend_uint8 (p, info->dedicated);

   239

}

   240

   241

/**

   242

 * Deserializes the NetworkGameInfo struct from the packet

   243

 * @param p    the packet to read the data from

   244

 * @param info the NetworkGameInfo to deserialize into

   245

 */

   246

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

   247

{

   250

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

   251

   252

	/*

   253

	 *              Please observe the order.

   254

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

   255

	 */

   256

   257

	/* Update the documentation in udp.h on changes

   258

	 * to the NetworkGameInfo wire-protocol! */

   259

   260

	switch (info->game_info_version) {

   261

		case 4: {

   262

			GRFConfig **dst = &info->grfconfig;

   263

			uint i;

   264

			uint num_grfs = NetworkRecv_uint8(this, p);

   265

   266

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

   267

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

   268

				this->Recv_GRFIdentifier(p, c);

   269

				this->HandleIncomingNetworkGameInfoGRFConfig(c);

   270

   271

				/* Append GRFConfig to the list */

   272

				*dst = c;

   273

				dst = &c->next;

   274

			}

   275

		} /* Fallthrough */

   276

		case 3:

   279

			/* Fallthrough */

   280

		case 2:

   281

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

   282

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

   283

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

   284

			/* Fallthrough */

   285

		case 1:

   286

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

   287

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

   288

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

			}

   297

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

   298

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

   299

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

   300

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

   301

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

   305

	}

   306

}

   307

   308

/* Defines a simple (switch) case for each network packet */

   309

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

   310

   311

/**

   312

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

   313

 * @param p the received packet

   314

 * @param client_addr the sender of the packet

   315

 */

   316

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

   317

{

   318

	PacketUDPType type;

   319

   320

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

   321

	this->has_quit = false;

   322

   323

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

   324

   325

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

   326

		UDP_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   327

		UDP_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   328

		UDP_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   329

		UDP_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   330

		UDP_COMMAND(PACKET_UDP_SERVER_REGISTER);

   331

		UDP_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   332

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   333

		UDP_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   334

		UDP_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   335

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   336

		UDP_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   337

   338

		default:

   339

			if (this->HasClientQuit()) {

   340

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

   341

			} else {

   342

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

   343

			}

   344

			break;

   345

	}

   346

}

   347

   348

/*

   349

 * Create stub implementations for all receive commands that only

   350

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

   351

 * socket where the packet came from.

   352

 */

   353

   354

#define DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(type) \

   355

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

   356

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

   357

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

   358

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

   359

}

   360

   361

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   362

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   363

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   364

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   365

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   366

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   367

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   368

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   369

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   370

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   371

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   372

   373

#endif /* ENABLE_NETWORK */