1

/* $Id$ */

     2

     3

/**

     4

 * @file core/udp.cpp Basic functions to receive and send UDP packets.

     5

 */

     6

     7

#ifdef ENABLE_NETWORK

     8

     9

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

    10

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

    13

#include "packet.h"

    14

#include "udp.h"

    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

	SetNonBlocking(this->sock);

    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

	SetNonBlocking(this->sock); // Some OSes seem to loose the non-blocking status of the socket

   114

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

   115

   116

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

   117

	if (nbytes > 2) {

   118

		p.PrepareToRead();

   119

   120

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

   121

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

   122

		if (nbytes != p.size) {

   123

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

   124

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

   125

   126

			return;

   127

		}

   128

   129

		/* Handle the packet */

   130

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

   131

	}

   132

}

   133

   134

   135

/**

   136

 * Serializes the NetworkGameInfo struct to the packet

   137

 * @param p    the packet to write the data to

   138

 * @param info the NetworkGameInfo struct to serialize

   139

 */

   140

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

   141

{

   142

	p->Send_uint8 (NETWORK_GAME_INFO_VERSION);

   143

   144

	/*

   145

	 *              Please observe the order.

   146

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

   147

	 */

   148

   149

	/* Update the documentation in udp.h on changes

   150

	 * to the NetworkGameInfo wire-protocol! */

   151

   152

	/* NETWORK_GAME_INFO_VERSION = 4 */

   153

	{

   154

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

   155

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

   156

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

   157

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

   158

		const GRFConfig *c;

   159

		uint count = 0;

   160

   161

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

   162

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

   163

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

   164

		}

   165

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

   166

   167

		/* Send actual GRF Identifications */

   168

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

   169

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

   170

		}

   171

	}

   172

   173

	/* NETWORK_GAME_INFO_VERSION = 3 */

   174

	p->Send_uint32(info->game_date);

   175

	p->Send_uint32(info->start_date);

   176

   177

	/* NETWORK_GAME_INFO_VERSION = 2 */

   178

	p->Send_uint8 (info->companies_max);

   179

	p->Send_uint8 (info->companies_on);

   180

	p->Send_uint8 (info->spectators_max);

   181

   182

	/* NETWORK_GAME_INFO_VERSION = 1 */

   183

	p->Send_string(info->server_name);

   184

	p->Send_string(info->server_revision);

   185

	p->Send_uint8 (info->server_lang);

   186

	p->Send_bool  (info->use_password);

   187

	p->Send_uint8 (info->clients_max);

   188

	p->Send_uint8 (info->clients_on);

   189

	p->Send_uint8 (info->spectators_on);

   190

	p->Send_string(info->map_name);

   191

	p->Send_uint16(info->map_width);

   192

	p->Send_uint16(info->map_height);

   193

	p->Send_uint8 (info->map_set);

   194

	p->Send_bool  (info->dedicated);

   195

}

   196

   197

/**

   198

 * Deserializes the NetworkGameInfo struct from the packet

   199

 * @param p    the packet to read the data from

   200

 * @param info the NetworkGameInfo to deserialize into

   201

 */

   202

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

   203

{

   204

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

   205

   206

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

   207

   208

	/*

   209

	 *              Please observe the order.

   210

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

   211

	 */

   212

   213

	/* Update the documentation in udp.h on changes

   214

	 * to the NetworkGameInfo wire-protocol! */

   215

   216

	switch (info->game_info_version) {

   217

		case 4: {

   218

			GRFConfig **dst = &info->grfconfig;

   219

			uint i;

   220

			uint num_grfs = p->Recv_uint8();

   221

   222

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

   223

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

   224

				this->Recv_GRFIdentifier(p, c);

   225

				this->HandleIncomingNetworkGameInfoGRFConfig(c);

   226

   227

				/* Append GRFConfig to the list */

   228

				*dst = c;

   229

				dst = &c->next;

   230

			}

   231

		} /* Fallthrough */

   232

		case 3:

   233

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

   234

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

   235

			/* Fallthrough */

   236

		case 2:

   237

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

   238

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

   239

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

   240

			/* Fallthrough */

   241

		case 1:

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

			}

   253

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

   254

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

   255

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

   256

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

   257

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

   258

   259

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

   260

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

   261

	}

   262

}

   263

   264

/**

   265

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

   266

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

   267

 */

   268

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

   269

   270

/**

   271

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

   272

 * @param p the received packet

   273

 * @param client_addr the sender of the packet

   274

 */

   275

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

   276

{

   277

	PacketUDPType type;

   278

   279

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

   280

	this->has_quit = false;

   281

   282

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

   283

   284

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

   285

		UDP_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   286

		UDP_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   287

		UDP_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   288

		UDP_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   289

		UDP_COMMAND(PACKET_UDP_SERVER_REGISTER);

   290

		UDP_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   291

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   292

		UDP_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   293

		UDP_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   294

		UDP_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   295

		UDP_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   296

   297

		default:

   298

			if (this->HasClientQuit()) {

   299

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

   300

			} else {

   301

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

   302

			}

   303

			break;

   304

	}

   305

}

   306

   307

/**

   308

 * Create stub implementations for all receive commands that only

   309

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

   310

 * socket where the packet came from.

   311

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

   312

 */

   313

#define DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(type) \

   314

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

   315

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

   316

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

   317

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

   318

}

   319

   320

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   321

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   322

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   323

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   324

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   325

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   326

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   327

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   328

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   329

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   330

DEFINE_UNAVAILABLE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   331

   332

#endif /* ENABLE_NETWORK */