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

    11

#include "../../string.h"

    12

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

    13

    14

#include "packet.h"

    15

    16

    17

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

    18

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

    19

    20

/**

    21

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

    22

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

    23

 */

    24

Packet::Packet(NetworkSocketHandler *cs)

    25

{

    26

	assert(cs != NULL);

    27

    28

	this->cs   = cs;

    29

	this->next = NULL;

    30

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

    31

	this->size = 0;

    32

}

    33

    34

/**

    35

 * Creates a packet to send

    36

 * @param type of the packet to send

    37

 */

    38

Packet::Packet(PacketType type)

    39

{

    40

	this->cs                   = NULL;

    41

	this->next                 = NULL;

    42

    43

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

    44

	this->pos                  = 0;

    45

	this->size                 = sizeof(PacketSize);

    46

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

    47

}

    48

    49

/**

    50

 * Create a packet for sending

    51

 * @param type the of packet

    52

 * @return the newly created packet

    53

 */

    54

Packet *NetworkSend_Init(PacketType type)

    55

{

    56

	Packet *packet = new Packet(type);

    57

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

    58

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

    59

    60

	return packet;

    61

}

    62

    63

/**

    64

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

    65

 */

    66

void Packet::PrepareToSend()

    67

{

    68

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

    69

    70

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

    71

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

    72

    73

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

    74

}

    75

    76

/**

    77

 * The next couple of functions make sure we can send

    78

 *  uint8, uint16, uint32 and uint64 endian-safe

    79

 *  over the network. The least significant bytes are

    80

 *  sent first.

    81

 *

    82

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

    83

 *

    84

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

    85

 *  and non-zero means true.

    86

 */

    87

    88

void Packet::Send_bool(bool data)

    89

{

    90

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

    91

}

    92

    93

void Packet::Send_uint8(uint8 data)

    94

{

    95

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

    96

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

    97

}

    98

    99

void Packet::Send_uint16(uint16 data)

   100

{

   101

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

   102

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

   103

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

   104

}

   105

   106

void Packet::Send_uint32(uint32 data)

   107

{

   108

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

   109

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

   110

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

   111

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

   112

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

   113

}

   114

   115

void Packet::Send_uint64(uint64 data)

   116

{

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

}

   127

   128

/**

   129

 *  Sends a string over the network. It sends out

   130

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

   131

 * @param data   the string to send

   132

 */

   133

void Packet::Send_string(const char* data)

   134

{

   135

	assert(data != NULL);

   138

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

   139

}

   140

   141

   142

/**

   143

 * Receiving commands

   144

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

   145

 *  see the comment before Send_bool for more info.

   146

 */

   147

   148

   149

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

   150

bool Packet::CanReadFromPacket(uint bytes_to_read)

   151

{

   152

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

   153

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

   154

   155

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

   156

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

   157

		this->cs->CloseConnection();

   158

		return false;

   159

	}

   160

   161

	return true;

   162

}

   163

   164

/**

   165

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

   166

 */

   167

void Packet::ReadRawPacketSize()

   168

{

   169

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

   170

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

   171

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

   172

}

   173

   174

/**

   175

 * Prepares the packet so it can be read

   176

 */

   177

void Packet::PrepareToRead()

   178

{

   179

	this->ReadRawPacketSize();

   180

   181

	/* Put the position on the right place */

   182

	this->pos = sizeof(PacketSize);

   183

}

   184

   185

bool Packet::Recv_bool()

   186

{

   187

	return this->Recv_uint8() != 0;

   188

}

   189

   190

uint8 Packet::Recv_uint8()

   191

{

   192

	uint8 n;

   193

   194

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

   195

   196

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

   197

	return n;

   198

}

   199

   200

uint16 Packet::Recv_uint16()

   201

{

   202

	uint16 n;

   203

   204

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

   205

   206

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

   207

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

   208

	return n;

   209

}

   210

   211

uint32 Packet::Recv_uint32()

   212

{

   213

	uint32 n;

   214

   215

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

   216

   217

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

   218

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

   219

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

   220

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

   221

	return n;

   222

}

   223

   224

uint64 Packet::Recv_uint64()

   225

{

   226

	uint64 n;

   227

   228

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

   229

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

	return n;

   239

}

   240

   241

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

   242

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

   243

{

   244

	PacketSize pos;

   245

	char *bufp = buffer;

   246

   247

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

   248

	if (cs->HasClientQuit()) return;

   249

   250

	pos = this->pos;

   251

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

   252

   253

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

   254

		*buffer = '\0';

   255

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

   256

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

   257

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

   258

		pos++;

   259

	}

   260

	this->pos = pos;

   261

   262

	str_validate(bufp);

   263

}

   264

   265

#endif /* ENABLE_NETWORK */