src/network/networkpacket.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2015 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "networkpacket.h"
  21 #include <sstream>
  22 #include "networkexceptions.h"
  23 #include "util/serialize.h"
  24
  25 NetworkPacket::NetworkPacket(u16 command, u32 datasize, u16 peer_id):
  26 m_datasize(datasize), m_command(command), m_peer_id(peer_id)
  27 {
  28         m_data.resize(m_datasize);
  29 }
  30
  31 NetworkPacket::NetworkPacket(u16 command, u32 datasize):
  32 m_datasize(datasize), m_command(command)
  33 {
  34         m_data.resize(m_datasize);
  35 }
  36
  37 NetworkPacket::~NetworkPacket()
  38 {
  39         m_data.clear();
  40 }
  41
  42 void NetworkPacket::checkReadOffset(u32 from_offset, u32 field_size)
  43 {
  44         if (from_offset + field_size > m_datasize) {
  45                 std::stringstream ss;
  46                 ss << "Reading outside packet (offset: " <<
  47                                 from_offset << ", packet size: " << getSize() << ")";
  48                 throw PacketError(ss.str());
  49         }
  50 }
  51
  52 void NetworkPacket::putRawPacket(u8 *data, u32 datasize, u16 peer_id)
  53 {
  54         // If a m_command is already set, we are rewriting on same packet
  55         // This is not permitted
  56         assert(m_command == 0);
  57
  58         m_datasize = datasize - 2;
  59         m_peer_id = peer_id;
  60
  61         // split command and datas
  62         m_command = readU16(&data[0]);
  63         m_data = std::vector<u8>(&data[2], &data[2 + m_datasize]);
  64 }
  65
  66 const char* NetworkPacket::getString(u32 from_offset)
  67 {
  68         checkReadOffset(from_offset, 0);
  69
  70         return (char*)&m_data[from_offset];
  71 }
  72
  73 void NetworkPacket::putRawString(const char* src, u32 len)
  74 {
  75         if (m_read_offset + len > m_datasize) {
  76                 m_datasize = m_read_offset + len;
  77                 m_data.resize(m_datasize);
  78         }
  79
  80         if (len == 0)
  81                 return;
  82
  83         memcpy(&m_data[m_read_offset], src, len);
  84         m_read_offset += len;
  85 }
  86
  87 NetworkPacket& NetworkPacket::operator>>(std::string& dst)
  88 {
  89         checkReadOffset(m_read_offset, 2);
  90         u16 strLen = readU16(&m_data[m_read_offset]);
  91         m_read_offset += 2;
  92
  93         dst.clear();
  94
  95         if (strLen == 0) {
  96                 return *this;
  97         }
  98
  99         checkReadOffset(m_read_offset, strLen);
 100
 101         dst.reserve(strLen);
 102         dst.append((char*)&m_data[m_read_offset], strLen);
 103
 104         m_read_offset += strLen;
 105         return *this;
 106 }
 107
 108 NetworkPacket& NetworkPacket::operator<<(const std::string &src)
 109 {
 110         u16 msgsize = src.size();
 111         if (msgsize > STRING_MAX_LEN) {
 112                 throw PacketError("String too long");
 113         }
 114
 115         *this << msgsize;
 116
 117         putRawString(src.c_str(), (u32)msgsize);
 118
 119         return *this;
 120 }
 121
 122 void NetworkPacket::putLongString(const std::string &src)
 123 {
 124         u32 msgsize = src.size();
 125         if (msgsize > LONG_STRING_MAX_LEN) {
 126                 throw PacketError("String too long");
 127         }
 128
 129         *this << msgsize;
 130
 131         putRawString(src.c_str(), msgsize);
 132 }
 133
 134 NetworkPacket& NetworkPacket::operator>>(std::wstring& dst)
 135 {
 136         checkReadOffset(m_read_offset, 2);
 137         u16 strLen = readU16(&m_data[m_read_offset]);
 138         m_read_offset += 2;
 139
 140         dst.clear();
 141
 142         if (strLen == 0) {
 143                 return *this;
 144         }
 145
 146         checkReadOffset(m_read_offset, strLen * 2);
 147
 148         dst.reserve(strLen);
 149         for(u16 i=0; i<strLen; i++) {
 150                 wchar_t c16 = readU16(&m_data[m_read_offset]);
 151                 dst.append(&c16, 1);
 152                 m_read_offset += sizeof(u16);
 153         }
 154
 155         return *this;
 156 }
 157
 158 NetworkPacket& NetworkPacket::operator<<(const std::wstring &src)
 159 {
 160         u16 msgsize = src.size();
 161         if (msgsize > WIDE_STRING_MAX_LEN) {
 162                 throw PacketError("String too long");
 163         }
 164
 165         *this << msgsize;
 166
 167         // Write string
 168         for (u16 i=0; i<msgsize; i++) {
 169                 *this << (u16) src[i];
 170         }
 171
 172         return *this;
 173 }
 174
 175 std::string NetworkPacket::readLongString()
 176 {
 177         checkReadOffset(m_read_offset, 4);
 178         u32 strLen = readU32(&m_data[m_read_offset]);
 179         m_read_offset += 4;
 180
 181         if (strLen == 0) {
 182                 return "";
 183         }
 184
 185         if (strLen > LONG_STRING_MAX_LEN) {
 186                 throw PacketError("String too long");
 187         }
 188
 189         checkReadOffset(m_read_offset, strLen);
 190
 191         std::string dst;
 192
 193         dst.reserve(strLen);
 194         dst.append((char*)&m_data[m_read_offset], strLen);
 195
 196         m_read_offset += strLen;
 197
 198         return dst;
 199 }
 200
 201 NetworkPacket& NetworkPacket::operator>>(char& dst)
 202 {
 203         checkReadOffset(m_read_offset, 1);
 204
 205         dst = readU8(&m_data[m_read_offset]);
 206
 207         m_read_offset += 1;
 208         return *this;
 209 }
 210
 211 char NetworkPacket::getChar(u32 offset)
 212 {
 213         checkReadOffset(offset, 1);
 214
 215         return readU8(&m_data[offset]);
 216 }
 217
 218 NetworkPacket& NetworkPacket::operator<<(char src)
 219 {
 220         checkDataSize(1);
 221
 222         writeU8(&m_data[m_read_offset], src);
 223
 224         m_read_offset += 1;
 225         return *this;
 226 }
 227
 228 NetworkPacket& NetworkPacket::operator<<(u8 src)
 229 {
 230         checkDataSize(1);
 231
 232         writeU8(&m_data[m_read_offset], src);
 233
 234         m_read_offset += 1;
 235         return *this;
 236 }
 237
 238 NetworkPacket& NetworkPacket::operator<<(bool src)
 239 {
 240         checkDataSize(1);
 241
 242         writeU8(&m_data[m_read_offset], src);
 243
 244         m_read_offset += 1;
 245         return *this;
 246 }
 247
 248 NetworkPacket& NetworkPacket::operator<<(u16 src)
 249 {
 250         checkDataSize(2);
 251
 252         writeU16(&m_data[m_read_offset], src);
 253
 254         m_read_offset += 2;
 255         return *this;
 256 }
 257
 258 NetworkPacket& NetworkPacket::operator<<(u32 src)
 259 {
 260         checkDataSize(4);
 261
 262         writeU32(&m_data[m_read_offset], src);
 263
 264         m_read_offset += 4;
 265         return *this;
 266 }
 267
 268 NetworkPacket& NetworkPacket::operator<<(u64 src)
 269 {
 270         checkDataSize(8);
 271
 272         writeU64(&m_data[m_read_offset], src);
 273
 274         m_read_offset += 8;
 275         return *this;
 276 }
 277
 278 NetworkPacket& NetworkPacket::operator<<(std::time_t src)
 279 {
 280         *this << (u64) src;
 281         return *this;
 282 }
 283
 284 NetworkPacket& NetworkPacket::operator<<(float src)
 285 {
 286         checkDataSize(4);
 287
 288         writeF1000(&m_data[m_read_offset], src);
 289
 290         m_read_offset += 4;
 291         return *this;
 292 }
 293
 294 NetworkPacket& NetworkPacket::operator>>(bool& dst)
 295 {
 296         checkReadOffset(m_read_offset, 1);
 297
 298         dst = readU8(&m_data[m_read_offset]);
 299
 300         m_read_offset += 1;
 301         return *this;
 302 }
 303
 304 NetworkPacket& NetworkPacket::operator>>(u8& dst)
 305 {
 306         checkReadOffset(m_read_offset, 1);
 307
 308         dst = readU8(&m_data[m_read_offset]);
 309
 310         m_read_offset += 1;
 311         return *this;
 312 }
 313
 314 u8 NetworkPacket::getU8(u32 offset)
 315 {
 316         checkReadOffset(offset, 1);
 317
 318         return readU8(&m_data[offset]);
 319 }
 320
 321 u8* NetworkPacket::getU8Ptr(u32 from_offset)
 322 {
 323         if (m_datasize == 0) {
 324                 return NULL;
 325         }
 326
 327         checkReadOffset(from_offset, 1);
 328
 329         return (u8*)&m_data[from_offset];
 330 }
 331
 332 NetworkPacket& NetworkPacket::operator>>(u16& dst)
 333 {
 334         checkReadOffset(m_read_offset, 2);
 335
 336         dst = readU16(&m_data[m_read_offset]);
 337
 338         m_read_offset += 2;
 339         return *this;
 340 }
 341
 342 u16 NetworkPacket::getU16(u32 from_offset)
 343 {
 344         checkReadOffset(from_offset, 2);
 345
 346         return readU16(&m_data[from_offset]);
 347 }
 348
 349 NetworkPacket& NetworkPacket::operator>>(u32& dst)
 350 {
 351         checkReadOffset(m_read_offset, 4);
 352
 353         dst = readU32(&m_data[m_read_offset]);
 354
 355         m_read_offset += 4;
 356         return *this;
 357 }
 358
 359 NetworkPacket& NetworkPacket::operator>>(u64& dst)
 360 {
 361         checkReadOffset(m_read_offset, 8);
 362
 363         dst = readU64(&m_data[m_read_offset]);
 364
 365         m_read_offset += 8;
 366         return *this;
 367 }
 368
 369 NetworkPacket& NetworkPacket::operator>>(std::time_t& dst)
 370 {
 371         checkReadOffset(m_read_offset, 8);
 372
 373         dst = readU64(&m_data[m_read_offset]);
 374
 375         m_read_offset += 8;
 376         return *this;
 377 }
 378
 379 NetworkPacket& NetworkPacket::operator>>(float& dst)
 380 {
 381         checkReadOffset(m_read_offset, 4);
 382
 383         dst = readF1000(&m_data[m_read_offset]);
 384
 385         m_read_offset += 4;
 386         return *this;
 387 }
 388
 389 NetworkPacket& NetworkPacket::operator>>(v2f& dst)
 390 {
 391         checkReadOffset(m_read_offset, 8);
 392
 393         dst = readV2F1000(&m_data[m_read_offset]);
 394
 395         m_read_offset += 8;
 396         return *this;
 397 }
 398
 399 NetworkPacket& NetworkPacket::operator>>(v3f& dst)
 400 {
 401         checkReadOffset(m_read_offset, 12);
 402
 403         dst = readV3F1000(&m_data[m_read_offset]);
 404
 405         m_read_offset += 12;
 406         return *this;
 407 }
 408
 409 NetworkPacket& NetworkPacket::operator>>(s16& dst)
 410 {
 411         checkReadOffset(m_read_offset, 2);
 412
 413         dst = readS16(&m_data[m_read_offset]);
 414
 415         m_read_offset += 2;
 416         return *this;
 417 }
 418
 419 NetworkPacket& NetworkPacket::operator<<(s16 src)
 420 {
 421         *this << (u16) src;
 422         return *this;
 423 }
 424
 425 NetworkPacket& NetworkPacket::operator>>(s32& dst)
 426 {
 427         checkReadOffset(m_read_offset, 4);
 428
 429         dst = readS32(&m_data[m_read_offset]);
 430
 431         m_read_offset += 4;
 432         return *this;
 433 }
 434
 435 NetworkPacket& NetworkPacket::operator<<(s32 src)
 436 {
 437         *this << (u32) src;
 438         return *this;
 439 }
 440
 441 NetworkPacket& NetworkPacket::operator>>(v3s16& dst)
 442 {
 443         checkReadOffset(m_read_offset, 6);
 444
 445         dst = readV3S16(&m_data[m_read_offset]);
 446
 447         m_read_offset += 6;
 448         return *this;
 449 }
 450
 451 NetworkPacket& NetworkPacket::operator>>(v2s32& dst)
 452 {
 453         checkReadOffset(m_read_offset, 8);
 454
 455         dst = readV2S32(&m_data[m_read_offset]);
 456
 457         m_read_offset += 8;
 458         return *this;
 459 }
 460
 461 NetworkPacket& NetworkPacket::operator>>(v3s32& dst)
 462 {
 463         checkReadOffset(m_read_offset, 12);
 464
 465         dst = readV3S32(&m_data[m_read_offset]);
 466
 467         m_read_offset += 12;
 468         return *this;
 469 }
 470
 471 NetworkPacket& NetworkPacket::operator<<(v2f src)
 472 {
 473         *this << (float) src.X;
 474         *this << (float) src.Y;
 475         return *this;
 476 }
 477
 478 NetworkPacket& NetworkPacket::operator<<(v3f src)
 479 {
 480         *this << (float) src.X;
 481         *this << (float) src.Y;
 482         *this << (float) src.Z;
 483         return *this;
 484 }
 485
 486 NetworkPacket& NetworkPacket::operator<<(v3s16 src)
 487 {
 488         *this << (s16) src.X;
 489         *this << (s16) src.Y;
 490         *this << (s16) src.Z;
 491         return *this;
 492 }
 493
 494 NetworkPacket& NetworkPacket::operator<<(v2s32 src)
 495 {
 496         *this << (s32) src.X;
 497         *this << (s32) src.Y;
 498         return *this;
 499 }
 500
 501 NetworkPacket& NetworkPacket::operator<<(v3s32 src)
 502 {
 503         *this << (s32) src.X;
 504         *this << (s32) src.Y;
 505         *this << (s32) src.Z;
 506         return *this;
 507 }
 508
 509 NetworkPacket& NetworkPacket::operator>>(video::SColor& dst)
 510 {
 511         checkReadOffset(m_read_offset, 4);
 512
 513         dst = readARGB8(&m_data[m_read_offset]);
 514
 515         m_read_offset += 4;
 516         return *this;
 517 }
 518
 519 NetworkPacket& NetworkPacket::operator<<(video::SColor src)
 520 {
 521         checkDataSize(4);
 522
 523         writeU32(&m_data[m_read_offset], src.color);
 524
 525         m_read_offset += 4;
 526         return *this;
 527 }
 528
 529 SharedBuffer<u8> NetworkPacket::oldForgePacket()
 530 {
 531         SharedBuffer<u8> sb(m_datasize + 2);
 532         writeU16(&sb[0], m_command);
 533
 534         u8* datas = getU8Ptr(0);
 535
 536         if (datas != NULL)
 537                 memcpy(&sb[2], datas, m_datasize);
 538         return sb;
 539 }