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 core/udp.cpp Basic functions to receive and send UDP packets.

    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

	p->PrepareToSend();

    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(this);

   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

		p.PrepareToRead();

   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

		/* Handle the packet */

   137

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

   138

	}

   139

}

   140

   141

   142

/**

   143

 * Serializes the NetworkGameInfo struct to the packet

   144

 * @param p    the packet to write the data to

   145

 * @param info the NetworkGameInfo struct to serialize

   146

 */

   147

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

   148

{

   149

	p->Send_uint8 (NETWORK_GAME_INFO_VERSION);

   150

   151

	/*

   152

	 *              Please observe the order.

   153

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

   154

	 */

   155

   156

	/* Update the documentation in udp.h on changes

   157

	 * to the NetworkGameInfo wire-protocol! */

   158

   159

	/* NETWORK_GAME_INFO_VERSION = 4 */

   160

	{

   161

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

   162

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

   163

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

   164

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

   165

		const GRFConfig *c;

   166

		uint count = 0;

   167

   168

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

   169

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

   170

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

   171

		}

   172

		p->Send_uint8 (count); // Send number of GRFs

   173

   174

		/* Send actual GRF Identifications */

   175

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

   176

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

   177

		}

   178

	}

   179

   180

	/* NETWORK_GAME_INFO_VERSION = 3 */

   181

	p->Send_uint32(info->game_date);

   182

	p->Send_uint32(info->start_date);

   183

   184

	/* NETWORK_GAME_INFO_VERSION = 2 */

   185

	p->Send_uint8 (info->companies_max);

   186

	p->Send_uint8 (info->companies_on);

   187

	p->Send_uint8 (info->spectators_max);

   188

   189

	/* NETWORK_GAME_INFO_VERSION = 1 */

   190

	p->Send_string(info->server_name);

   191

	p->Send_string(info->server_revision);

   192

	p->Send_uint8 (info->server_lang);

   194

	p->Send_uint8 (info->clients_max);

   195

	p->Send_uint8 (info->clients_on);

   196

	p->Send_uint8 (info->spectators_on);

   197

	p->Send_string(info->map_name);

   198

	p->Send_uint16(info->map_width);

   199

	p->Send_uint16(info->map_height);

   200

	p->Send_uint8 (info->map_set);

   202

}

   203

   204

/**

   205

 * Deserializes the NetworkGameInfo struct from the packet

   206

 * @param p    the packet to read the data from

   207

 * @param info the NetworkGameInfo to deserialize into

   208

 */

   209

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

   210

{

   211

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

   212

   213

	info->game_info_version = p->Recv_uint8();

   214

   215

	/*

   216

	 *              Please observe the order.

   217

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

   218

	 */

   219

   220

	/* Update the documentation in udp.h on changes

   221

	 * to the NetworkGameInfo wire-protocol! */

   222

   223

	switch (info->game_info_version) {

   224

		case 4: {

   225

			GRFConfig **dst = &info->grfconfig;

   226

			uint i;

   227

			uint num_grfs = p->Recv_uint8();

   228

   229

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

   230

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

   231

				this->Recv_GRFIdentifier(p, c);

   232

				this->HandleIncomingNetworkGameInfoGRFConfig(c);

   233

   234

				/* Append GRFConfig to the list */

   235

				*dst = c;

   236

				dst = &c->next;

   237

			}

   238

		} /* Fallthrough */

   239

		case 3:

   240

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

   241

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

   242

			/* Fallthrough */

   243

		case 2:

   244

			info->companies_max  = p->Recv_uint8 ();

   245

			info->companies_on   = p->Recv_uint8 ();

   246

			info->spectators_max = p->Recv_uint8 ();

   247

			/* Fallthrough */

   248

		case 1:

   249

			p->Recv_string(info->server_name,     sizeof(info->server_name));

   250

			p->Recv_string(info->server_revision, sizeof(info->server_revision));

   251

			info->server_lang    = p->Recv_uint8 ();

   253

			info->clients_max    = p->Recv_uint8 ();

   254

			info->clients_on     = p->Recv_uint8 ();

   255

			info->spectators_on  = p->Recv_uint8 ();

   256

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

   257

				info->game_date    = p->Recv_uint16() + DAYS_TILL_ORIGINAL_BASE_YEAR;

   258

				info->start_date   = p->Recv_uint16() + DAYS_TILL_ORIGINAL_BASE_YEAR;

   259

			}

   260

			p->Recv_string(info->map_name, sizeof(info->map_name));

   261

			info->map_width      = p->Recv_uint16();

   262

			info->map_height     = p->Recv_uint16();

   263

			info->map_set        = p->Recv_uint8 ();

   265

   266

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

   267

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

   268

	}

   269

}

   270

   271

/**

   272

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

   273

 * @param type the packet type to create the case for

   274

 */

   275

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

   276

   277

/**

   278

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

   279

 * @param p the received packet

   280

 * @param client_addr the sender of the packet

   281

 */

   282

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

   283

{

   284

	PacketUDPType type;

   285

   286

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

   287

	this->has_quit = false;

   288

   289

	type = (PacketUDPType)p->Recv_uint8();

   290

   291

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

   292

		UDP_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   293

		UDP_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   294

		UDP_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   295

		UDP_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   296

		UDP_COMMAND(PACKET_UDP_SERVER_REGISTER);

   297

		UDP_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   298

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   299

		UDP_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   300

		UDP_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   301

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   302

		UDP_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   303

   304

		default:

   305

			if (this->HasClientQuit()) {

   306

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

   307

			} else {

   308

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

   309

			}

   310

			break;

   311

	}

   312

}

   313

   314

/**

   315

 * Create stub implementations for all receive commands that only

   316

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

   317

 * socket where the packet came from.

   318

 * @param type the packet type to create the stub for

   319

 */

   320

#define DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(type) \

   321

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

   322

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

   323

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

   324

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

   325

}

   326

   327

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   328

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   329

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   330

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   331

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   332

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   333

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   334

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   335

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   336

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   337

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   338

   339

#endif /* ENABLE_NETWORK */