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

    37

    38

	sin.sin_family = AF_INET;

    39

	/* Listen on all IPs */

    40

	sin.sin_addr.s_addr = host;

    41

	sin.sin_port = htons(port);

    42

    43

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

    44

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

    45

		return false;

    46

	}

    47

    48

	if (broadcast) {

    49

		/* Enable broadcast */

    50

		unsigned long val = 1;

    51

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

    52

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

    53

#endif

    54

	}

    55

    56

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

    57

    58

	return true;

    59

}

    60

    61

/**

    62

 * Close the given UDP socket

    63

 */

    64

void NetworkUDPSocketHandler::Close()

    65

{

    66

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

    67

    68

	closesocket(this->sock);

    69

	this->sock = INVALID_SOCKET;

    70

}

    71

    72

NetworkRecvStatus NetworkUDPSocketHandler::CloseConnection()

    73

{

    74

	this->has_quit = true;

    75

	return NETWORK_RECV_STATUS_OKAY;

    76

}

    77

    78

/**

    79

 * Send a packet over UDP

    80

 * @param p    the packet to send

    81

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

    82

 */

    83

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

    84

{

    85

	int res;

    86

    87

	p->PrepareToSend();

    88

    89

	/* Send the buffer */

    90

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

    91

    92

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

    93

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

    94

}

    95

    96

/**

    97

 * Receive a packet at UDP level

    98

 */

    99

void NetworkUDPSocketHandler::ReceivePackets()

   100

{

   101

	struct sockaddr_in client_addr;

   102

	socklen_t client_len;

   103

	int nbytes;

   104

	Packet p(this);

   105

	int packet_len;

   106

   107

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

   108

   109

	packet_len = sizeof(p.buffer);

   110

	client_len = sizeof(client_addr);

   111

   112

	/* Try to receive anything */

   113

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

   114

   115

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

   116

	if (nbytes > 2) {

   117

		p.PrepareToRead();

   118

   119

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

   120

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

   121

		if (nbytes != p.size) {

   122

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

   123

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

   124

   125

			return;

   126

		}

   127

   128

		/* Handle the packet */

   129

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

   130

	}

   131

}

   132

   133

   134

/**

   135

 * Serializes the NetworkGameInfo struct to the packet

   136

 * @param p    the packet to write the data to

   137

 * @param info the NetworkGameInfo struct to serialize

   138

 */

   139

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

   140

{

   141

	p->Send_uint8 (NETWORK_GAME_INFO_VERSION);

   142

   143

	/*

   144

	 *              Please observe the order.

   145

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

   146

	 */

   147

   148

	/* Update the documentation in udp.h on changes

   149

	 * to the NetworkGameInfo wire-protocol! */

   150

   151

	/* NETWORK_GAME_INFO_VERSION = 4 */

   152

	{

   153

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

   154

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

   155

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

   156

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

   157

		const GRFConfig *c;

   158

		uint count = 0;

   159

   160

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

   161

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

   162

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

   163

		}

   164

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

   165

   166

		/* Send actual GRF Identifications */

   167

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

   168

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

   169

		}

   170

	}

   171

   172

	/* NETWORK_GAME_INFO_VERSION = 3 */

   173

	p->Send_uint32(info->game_date);

   174

	p->Send_uint32(info->start_date);

   175

   176

	/* NETWORK_GAME_INFO_VERSION = 2 */

   177

	p->Send_uint8 (info->companies_max);

   178

	p->Send_uint8 (info->companies_on);

   179

	p->Send_uint8 (info->spectators_max);

   180

   181

	/* NETWORK_GAME_INFO_VERSION = 1 */

   182

	p->Send_string(info->server_name);

   183

	p->Send_string(info->server_revision);

   184

	p->Send_uint8 (info->server_lang);

   185

	p->Send_bool  (info->use_password);

   186

	p->Send_uint8 (info->clients_max);

   187

	p->Send_uint8 (info->clients_on);

   188

	p->Send_uint8 (info->spectators_on);

   189

	p->Send_string(info->map_name);

   190

	p->Send_uint16(info->map_width);

   191

	p->Send_uint16(info->map_height);

   192

	p->Send_uint8 (info->map_set);

   193

	p->Send_bool  (info->dedicated);

   194

}

   195

   196

/**

   197

 * Deserializes the NetworkGameInfo struct from the packet

   198

 * @param p    the packet to read the data from

   199

 * @param info the NetworkGameInfo to deserialize into

   200

 */

   201

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

   202

{

   203

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

   204

   205

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

   206

   207

	/*

   208

	 *              Please observe the order.

   209

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

   210

	 */

   211

   212

	/* Update the documentation in udp.h on changes

   213

	 * to the NetworkGameInfo wire-protocol! */

   214

   215

	switch (info->game_info_version) {

   216

		case 4: {

   217

			GRFConfig **dst = &info->grfconfig;

   218

			uint i;

   219

			uint num_grfs = p->Recv_uint8();

   220

   221

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

   222

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

   223

				this->Recv_GRFIdentifier(p, c);

   224

				this->HandleIncomingNetworkGameInfoGRFConfig(c);

   225

   226

				/* Append GRFConfig to the list */

   227

				*dst = c;

   228

				dst = &c->next;

   229

			}

   230

		} /* Fallthrough */

   231

		case 3:

   232

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

   233

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

   234

			/* Fallthrough */

   235

		case 2:

   236

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

   237

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

   238

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

   239

			/* Fallthrough */

   240

		case 1:

   241

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

   242

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

   243

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

   244

			info->use_password   = p->Recv_bool  ();

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

			}

   252

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

   253

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

   254

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

   255

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

   256

			info->dedicated      = p->Recv_bool  ();

   257

   258

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

   259

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

   260

	}

   261

}

   262

   263

/**

   264

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

   265

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

   266

 */

   267

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

   268

   269

/**

   270

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

   271

 * @param p the received packet

   272

 * @param client_addr the sender of the packet

   273

 */

   274

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

   275

{

   276

	PacketUDPType type;

   277

   278

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

   279

	this->has_quit = false;

   280

   281

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

   282

   283

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

   284

		UDP_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   285

		UDP_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   286

		UDP_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   287

		UDP_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   288

		UDP_COMMAND(PACKET_UDP_SERVER_REGISTER);

   289

		UDP_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   290

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   291

		UDP_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   292

		UDP_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   293

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   294

		UDP_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   295

   296

		default:

   297

			if (this->HasClientQuit()) {

   298

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

   299

			} else {

   300

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

   301

			}

   302

			break;

   303

	}

   304

}

   305

   306

/**

   307

 * Create stub implementations for all receive commands that only

   308

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

   309

 * socket where the packet came from.

   310

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

   311

 */

   312

#define DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(type) \

   313

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

   314

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

   315

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

   316

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

   317

}

   318

   319

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   320

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   321

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   322

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   323

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   324

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   325

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   326

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   327

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   328

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   329

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   330

   331

#endif /* ENABLE_NETWORK */