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.h"

    11

#include "../../helpers.hpp"

    12

    13

#include "packet.h"

    14

    15

    16

/* Do not want to include functions.h and all required headers */

    17

extern void NORETURN CDECL error(const char *str, ...);

    18

    19

/**

    20

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

    21

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

    22

 */

    23

Packet::Packet(NetworkSocketHandler *cs)

    24

{

    25

	assert(cs != NULL);

    26

    27

	this->cs   = cs;

    28

	this->next = NULL;

    29

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

    30

	this->size = 0;

    31

}

    32

    33

/**

    34

 * Creates a packet to send

    35

 * @param type of the packet to send

    36

 */

    37

Packet::Packet(PacketType type)

    38

{

    39

	this->cs                   = NULL;

    40

	this->next                 = NULL;

    41

    42

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

    43

	this->pos                  = 0;

    44

	this->size                 = sizeof(PacketSize);

    45

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

    46

}

    47

    48

/**

    49

 * Create a packet for sending

    50

 * @param type the of packet

    51

 * @return the newly created packet

    52

 */

    53

Packet *NetworkSend_Init(PacketType type)

    54

{

    55

	Packet *packet = new Packet(type);

    56

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

    57

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

    58

    59

	return packet;

    60

}

    61

    62

/**

    63

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

    64

 */

    65

void Packet::PrepareToSend()

    66

{

    67

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

    68

    69

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

    70

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

    71

    72

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

    73

}

    74

    75

/**

    76

 * The next couple of functions make sure we can send

    77

 *  uint8, uint16, uint32 and uint64 endian-safe

    78

 *  over the network. The least significant bytes are

    79

 *  sent first.

    80

 *

    81

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

    82

 *

    83

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

    84

 *  and non-zero means true.

    85

 */

    86

    87

void Packet::Send_bool(bool data)

    88

{

    89

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

    90

}

    91

    92

void Packet::Send_uint8(uint8 data)

    93

{

    94

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

    95

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

    96

}

    97

    98

void Packet::Send_uint16(uint16 data)

    99

{

   100

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

   101

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

   102

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

   103

}

   104

   105

void Packet::Send_uint32(uint32 data)

   106

{

   107

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

   108

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

   109

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

   110

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

   111

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

   112

}

   113

   114

void Packet::Send_uint64(uint64 data)

   115

{

   116

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

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

}

   126

   127

/**

   128

 *  Sends a string over the network. It sends out

   129

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

   130

 * @param data   the string to send

   131

 */

   132

void Packet::Send_string(const char* data)

   133

{

   134

	assert(data != NULL);

   135

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

   136

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

   137

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

   138

}

   139

   140

   141

/**

   142

 * Receiving commands

   143

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

   144

 *  see the comment before Send_bool for more info.

   145

 */

   146

   147

   148

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

   149

bool Packet::CanReadFromPacket(uint bytes_to_read)

   150

{

   151

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

   152

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

   153

   154

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

   155

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

   156

		this->cs->CloseConnection();

   157

		return false;

   158

	}

   159

   160

	return true;

   161

}

   162

   163

/**

   164

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

   165

 */

   166

void Packet::ReadRawPacketSize()

   167

{

   168

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

   169

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

   170

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

   171

}

   172

   173

/**

   174

 * Prepares the packet so it can be read

   175

 */

   176

void Packet::PrepareToRead()

   177

{

   178

	this->ReadRawPacketSize();

   179

   180

	/* Put the position on the right place */

   181

	this->pos = sizeof(PacketSize);

   182

}

   183

   184

bool Packet::Recv_bool()

   185

{

   186

	return this->Recv_uint8() != 0;

   187

}

   188

   189

uint8 Packet::Recv_uint8()

   190

{

   191

	uint8 n;

   192

   193

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

   194

   195

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

   196

	return n;

   197

}

   198

   199

uint16 Packet::Recv_uint16()

   200

{

   201

	uint16 n;

   202

   203

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

   204

   205

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

   206

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

   207

	return n;

   208

}

   209

   210

uint32 Packet::Recv_uint32()

   211

{

   212

	uint32 n;

   213

   214

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

   215

   216

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

   217

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

   218

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

   219

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

   220

	return n;

   221

}

   222

   223

uint64 Packet::Recv_uint64()

   224

{

   225

	uint64 n;

   226

   227

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

   228

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

	return n;

   238

}

   239

   240

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

   241

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

   242

{

   243

	PacketSize pos;

   244

	char *bufp = buffer;

   245

   246

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

   247

	if (cs->HasClientQuit()) return;

   248

   249

	pos = this->pos;

   250

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

   251

   252

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

   253

		*buffer = '\0';

   254

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

   255

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

   256

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

   257

		pos++;

   258

	}

   259

	this->pos = pos;

   260

   261

	str_validate(bufp);

   262

}

   263

   264

#endif /* ENABLE_NETWORK */