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