1

/* $Id$ */

     2

     3

/**

     4

 * @file packet.cpp Basic functions to create, fill and read packets.

     5

 */

     6

     7

#ifdef ENABLE_NETWORK

     8

     9

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

    10

#include "../../string_func.h"

    11

    12

#include "packet.h"

    13

    14

/**

    15

 * Create a packet that is used to read from a network socket

    16

 * @param cs the socket handler associated with the socket we are reading from

    17

 */

    18

Packet::Packet(NetworkSocketHandler *cs)

    19

{

    20

	assert(cs != NULL);

    21

    22

	this->cs   = cs;

    23

	this->next = NULL;

    24

	this->pos  = 0; // We start reading from here

    25

	this->size = 0;

    26

}

    27

    28

/**

    29

 * Creates a packet to send

    30

 * @param type of the packet to send

    31

 */

    32

Packet::Packet(PacketType type)

    33

{

    34

	this->cs                   = NULL;

    35

	this->next                 = NULL;

    36

    37

	/* Skip the size so we can write that in before sending the packet */

    38

	this->pos                  = 0;

    39

	this->size                 = sizeof(PacketSize);

    40

	this->buffer[this->size++] = type;

    41

}

    42

    43

/**

    44

 * Create a packet for sending

    45

 * @param type the of packet

    46

 * @return the newly created packet

    47

 */

    48

Packet *NetworkSend_Init(PacketType type)

    49

{

    50

	Packet *packet = new Packet(type);

    51

	/* An error is inplace here, because it simply means we ran out of memory. */

    52

	if (packet == NULL) error("Failed to allocate Packet");

    53

    54

	return packet;

    55

}

    56

    57

/**

    58

 * Writes the packet size from the raw packet from packet->size

    59

 */

    60

void Packet::PrepareToSend()

    61

{

    62

	assert(this->cs == NULL && this->next == NULL);

    63

    64

	this->buffer[0] = GB(this->size, 0, 8);

    65

	this->buffer[1] = GB(this->size, 8, 8);

    66

    67

	this->pos  = 0; // We start reading from here

    68

}

    69

    70

/**

    71

 * The next couple of functions make sure we can send

    72

 *  uint8, uint16, uint32 and uint64 endian-safe

    73

 *  over the network. The least significant bytes are

    74

 *  sent first.

    75

 *

    76

 *  So 0x01234567 would be sent as 67 45 23 01.

    77

 *

    78

 * A bool is sent as a uint8 where zero means false

    79

 *  and non-zero means true.

    80

 */

    81

    82

void Packet::Send_bool(bool data)

    83

{

    84

	this->Send_uint8(data ? 1 : 0);

    85

}

    86

    87

void Packet::Send_uint8(uint8 data)

    88

{

    89

	assert(this->size < sizeof(this->buffer) - sizeof(data));

    90

	this->buffer[this->size++] = data;

    91

}

    92

    93

void Packet::Send_uint16(uint16 data)

    94

{

    95

	assert(this->size < sizeof(this->buffer) - sizeof(data));

    96

	this->buffer[this->size++] = GB(data, 0, 8);

    97

	this->buffer[this->size++] = GB(data, 8, 8);

    98

}

    99

   100

void Packet::Send_uint32(uint32 data)

   101

{

   102

	assert(this->size < sizeof(this->buffer) - sizeof(data));

   103

	this->buffer[this->size++] = GB(data,  0, 8);

   104

	this->buffer[this->size++] = GB(data,  8, 8);

   105

	this->buffer[this->size++] = GB(data, 16, 8);

   106

	this->buffer[this->size++] = GB(data, 24, 8);

   107

}

   108

   109

void Packet::Send_uint64(uint64 data)

   110

{

   111

	assert(this->size < sizeof(this->buffer) - sizeof(data));

   112

	this->buffer[this->size++] = GB(data,  0, 8);

   113

	this->buffer[this->size++] = GB(data,  8, 8);

   114

	this->buffer[this->size++] = GB(data, 16, 8);

   115

	this->buffer[this->size++] = GB(data, 24, 8);

   116

	this->buffer[this->size++] = GB(data, 32, 8);

   117

	this->buffer[this->size++] = GB(data, 40, 8);

   118

	this->buffer[this->size++] = GB(data, 48, 8);

   119

	this->buffer[this->size++] = GB(data, 56, 8);

   120

}

   121

   122

/**

   123

 *  Sends a string over the network. It sends out

   124

 *  the string + '\0'. No size-byte or something.

   125

 * @param data   the string to send

   126

 */

   127

void Packet::Send_string(const char* data)

   128

{

   129

	assert(data != NULL);

   130

	/* The <= *is* valid due to the fact that we are comparing sizes and not the index. */

   131

	assert(this->size + strlen(data) + 1 <= sizeof(this->buffer));

   132

	while ((this->buffer[this->size++] = *data++) != '\0') {}

   133

}

   134

   135

   136

/**

   137

 * Receiving commands

   138

 * Again, the next couple of functions are endian-safe

   139

 *  see the comment before Send_bool for more info.

   140

 */

   141

   142

   143

/** Is it safe to read from the packet, i.e. didn't we run over the buffer ? */

   144

bool Packet::CanReadFromPacket(uint bytes_to_read)

   145

{

   146

	/* Don't allow reading from a quit client/client who send bad data */

   147

	if (this->cs->HasClientQuit()) return false;

   148

   149

	/* Check if variable is within packet-size */

   150

	if (this->pos + bytes_to_read > this->size) {

   151

		this->cs->CloseConnection();

   152

		return false;

   153

	}

   154

   155

	return true;

   156

}

   157

   158

/**

   159

 * Reads the packet size from the raw packet and stores it in the packet->size

   160

 */

   161

void Packet::ReadRawPacketSize()

   162

{

   163

	assert(this->cs != NULL && this->next == NULL);

   164

	this->size  = (PacketSize)this->buffer[0];

   165

	this->size += (PacketSize)this->buffer[1] << 8;

   166

}

   167

   168

/**

   169

 * Prepares the packet so it can be read

   170

 */

   171

void Packet::PrepareToRead()

   172

{

   173

	this->ReadRawPacketSize();

   174

   175

	/* Put the position on the right place */

   176

	this->pos = sizeof(PacketSize);

   177

}

   178

   179

bool Packet::Recv_bool()

   180

{

   181

	return this->Recv_uint8() != 0;

   182

}

   183

   184

uint8 Packet::Recv_uint8()

   185

{

   186

	uint8 n;

   187

   188

	if (!this->CanReadFromPacket(sizeof(n))) return 0;

   189

   190

	n = this->buffer[this->pos++];

   191

	return n;

   192

}

   193

   194

uint16 Packet::Recv_uint16()

   195

{

   196

	uint16 n;

   197

   198

	if (!this->CanReadFromPacket(sizeof(n))) return 0;

   199

   200

	n  = (uint16)this->buffer[this->pos++];

   201

	n += (uint16)this->buffer[this->pos++] << 8;

   202

	return n;

   203

}

   204

   205

uint32 Packet::Recv_uint32()

   206

{

   207

	uint32 n;

   208

   209

	if (!this->CanReadFromPacket(sizeof(n))) return 0;

   210

   211

	n  = (uint32)this->buffer[this->pos++];

   212

	n += (uint32)this->buffer[this->pos++] << 8;

   213

	n += (uint32)this->buffer[this->pos++] << 16;

   214

	n += (uint32)this->buffer[this->pos++] << 24;

   215

	return n;

   216

}

   217

   218

uint64 Packet::Recv_uint64()

   219

{

   220

	uint64 n;

   221

   222

	if (!this->CanReadFromPacket(sizeof(n))) return 0;

   223

   224

	n  = (uint64)this->buffer[this->pos++];

   225

	n += (uint64)this->buffer[this->pos++] << 8;

   226

	n += (uint64)this->buffer[this->pos++] << 16;

   227

	n += (uint64)this->buffer[this->pos++] << 24;

   228

	n += (uint64)this->buffer[this->pos++] << 32;

   229

	n += (uint64)this->buffer[this->pos++] << 40;

   230

	n += (uint64)this->buffer[this->pos++] << 48;

   231

	n += (uint64)this->buffer[this->pos++] << 56;

   232

	return n;

   233

}

   234

   235

/** Reads a string till it finds a '\0' in the stream */

   236

void Packet::Recv_string(char *buffer, size_t size)

   237

{

   238

	PacketSize pos;

   239

	char *bufp = buffer;

   240

   241

	/* Don't allow reading from a closed socket */

   242

	if (cs->HasClientQuit()) return;

   243

   244

	pos = this->pos;

   245

	while (--size > 0 && pos < this->size && (*buffer++ = this->buffer[pos++]) != '\0') {}

   246

   247

	if (size == 0 || pos == this->size) {

   248

		*buffer = '\0';

   249

		/* If size was sooner to zero then the string in the stream

   250

		 *  skip till the \0, so than packet can be read out correctly for the rest */

   251

		while (pos < this->size && this->buffer[pos] != '\0') pos++;

   252

		pos++;

   253

	}

   254

	this->pos = pos;

   255

   256

	str_validate(bufp);

   257

}

   258

   259

#endif /* ENABLE_NETWORK */