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 char NetworkPacket::getChar(u32 offset)
 227 {
 228         checkReadOffset(offset, 1);
 229
 230         return readU8(&m_data[offset]);
 231 }
 232
 233 NetworkPacket& NetworkPacket::operator<<(char src)
 234 {
 235         checkDataSize(1);
 236
 237         writeU8(&m_data[m_read_offset], src);
 238
 239         m_read_offset += 1;
 240         return *this;
 241 }
 242
 243 NetworkPacket& NetworkPacket::operator<<(u8 src)
 244 {
 245         checkDataSize(1);
 246
 247         writeU8(&m_data[m_read_offset], src);
 248
 249         m_read_offset += 1;
 250         return *this;
 251 }
 252
 253 NetworkPacket& NetworkPacket::operator<<(bool src)
 254 {
 255         checkDataSize(1);
 256
 257         writeU8(&m_data[m_read_offset], src);
 258
 259         m_read_offset += 1;
 260         return *this;
 261 }
 262
 263 NetworkPacket& NetworkPacket::operator<<(u16 src)
 264 {
 265         checkDataSize(2);
 266
 267         writeU16(&m_data[m_read_offset], src);
 268
 269         m_read_offset += 2;
 270         return *this;
 271 }
 272
 273 NetworkPacket& NetworkPacket::operator<<(u32 src)
 274 {
 275         checkDataSize(4);
 276
 277         writeU32(&m_data[m_read_offset], src);
 278
 279         m_read_offset += 4;
 280         return *this;
 281 }
 282
 283 NetworkPacket& NetworkPacket::operator<<(u64 src)
 284 {
 285         checkDataSize(8);
 286
 287         writeU64(&m_data[m_read_offset], src);
 288
 289         m_read_offset += 8;
 290         return *this;
 291 }
 292
 293 NetworkPacket& NetworkPacket::operator<<(float src)
 294 {
 295         checkDataSize(4);
 296
 297         writeF32(&m_data[m_read_offset], src);
 298
 299         m_read_offset += 4;
 300         return *this;
 301 }
 302
 303 NetworkPacket& NetworkPacket::operator>>(bool& dst)
 304 {
 305         checkReadOffset(m_read_offset, 1);
 306
 307         dst = readU8(&m_data[m_read_offset]);
 308
 309         m_read_offset += 1;
 310         return *this;
 311 }
 312
 313 NetworkPacket& NetworkPacket::operator>>(u8& dst)
 314 {
 315         checkReadOffset(m_read_offset, 1);
 316
 317         dst = readU8(&m_data[m_read_offset]);
 318
 319         m_read_offset += 1;
 320         return *this;
 321 }
 322
 323 u8 NetworkPacket::getU8(u32 offset)
 324 {
 325         checkReadOffset(offset, 1);
 326
 327         return readU8(&m_data[offset]);
 328 }
 329
 330 u8* NetworkPacket::getU8Ptr(u32 from_offset)
 331 {
 332         if (m_datasize == 0) {
 333                 return NULL;
 334         }
 335
 336         checkReadOffset(from_offset, 1);
 337
 338         return (u8*)&m_data[from_offset];
 339 }
 340
 341 NetworkPacket& NetworkPacket::operator>>(u16& dst)
 342 {
 343         checkReadOffset(m_read_offset, 2);
 344
 345         dst = readU16(&m_data[m_read_offset]);
 346
 347         m_read_offset += 2;
 348         return *this;
 349 }
 350
 351 u16 NetworkPacket::getU16(u32 from_offset)
 352 {
 353         checkReadOffset(from_offset, 2);
 354
 355         return readU16(&m_data[from_offset]);
 356 }
 357
 358 NetworkPacket& NetworkPacket::operator>>(u32& dst)
 359 {
 360         checkReadOffset(m_read_offset, 4);
 361
 362         dst = readU32(&m_data[m_read_offset]);
 363
 364         m_read_offset += 4;
 365         return *this;
 366 }
 367
 368 NetworkPacket& NetworkPacket::operator>>(u64& dst)
 369 {
 370         checkReadOffset(m_read_offset, 8);
 371
 372         dst = readU64(&m_data[m_read_offset]);
 373
 374         m_read_offset += 8;
 375         return *this;
 376 }
 377
 378 NetworkPacket& NetworkPacket::operator>>(float& dst)
 379 {
 380         checkReadOffset(m_read_offset, 4);
 381
 382         dst = readF32(&m_data[m_read_offset]);
 383
 384         m_read_offset += 4;
 385         return *this;
 386 }
 387
 388 NetworkPacket& NetworkPacket::operator>>(v2f& dst)
 389 {
 390         checkReadOffset(m_read_offset, 8);
 391
 392         dst = readV2F32(&m_data[m_read_offset]);
 393
 394         m_read_offset += 8;
 395         return *this;
 396 }
 397
 398 NetworkPacket& NetworkPacket::operator>>(v3f& dst)
 399 {
 400         checkReadOffset(m_read_offset, 12);
 401
 402         dst = readV3F32(&m_data[m_read_offset]);
 403
 404         m_read_offset += 12;
 405         return *this;
 406 }
 407
 408 NetworkPacket& NetworkPacket::operator>>(s16& dst)
 409 {
 410         checkReadOffset(m_read_offset, 2);
 411
 412         dst = readS16(&m_data[m_read_offset]);
 413
 414         m_read_offset += 2;
 415         return *this;
 416 }
 417
 418 NetworkPacket& NetworkPacket::operator<<(s16 src)
 419 {
 420         *this << (u16) src;
 421         return *this;
 422 }
 423
 424 NetworkPacket& NetworkPacket::operator>>(s32& dst)
 425 {
 426         checkReadOffset(m_read_offset, 4);
 427
 428         dst = readS32(&m_data[m_read_offset]);
 429
 430         m_read_offset += 4;
 431         return *this;
 432 }
 433
 434 NetworkPacket& NetworkPacket::operator<<(s32 src)
 435 {
 436         *this << (u32) src;
 437         return *this;
 438 }
 439
 440 NetworkPacket& NetworkPacket::operator>>(v3s16& dst)
 441 {
 442         checkReadOffset(m_read_offset, 6);
 443
 444         dst = readV3S16(&m_data[m_read_offset]);
 445
 446         m_read_offset += 6;
 447         return *this;
 448 }
 449
 450 NetworkPacket& NetworkPacket::operator>>(v2s32& dst)
 451 {
 452         checkReadOffset(m_read_offset, 8);
 453
 454         dst = readV2S32(&m_data[m_read_offset]);
 455
 456         m_read_offset += 8;
 457         return *this;
 458 }
 459
 460 NetworkPacket& NetworkPacket::operator>>(v3s32& dst)
 461 {
 462         checkReadOffset(m_read_offset, 12);
 463
 464         dst = readV3S32(&m_data[m_read_offset]);
 465
 466         m_read_offset += 12;
 467         return *this;
 468 }
 469
 470 NetworkPacket& NetworkPacket::operator<<(v2f src)
 471 {
 472         *this << (float) src.X;
 473         *this << (float) src.Y;
 474         return *this;
 475 }
 476
 477 NetworkPacket& NetworkPacket::operator<<(v3f src)
 478 {
 479         *this << (float) src.X;
 480         *this << (float) src.Y;
 481         *this << (float) src.Z;
 482         return *this;
 483 }
 484
 485 NetworkPacket& NetworkPacket::operator<<(v3s16 src)
 486 {
 487         *this << (s16) src.X;
 488         *this << (s16) src.Y;
 489         *this << (s16) src.Z;
 490         return *this;
 491 }
 492
 493 NetworkPacket& NetworkPacket::operator<<(v2s32 src)
 494 {
 495         *this << (s32) src.X;
 496         *this << (s32) src.Y;
 497         return *this;
 498 }
 499
 500 NetworkPacket& NetworkPacket::operator<<(v3s32 src)
 501 {
 502         *this << (s32) src.X;
 503         *this << (s32) src.Y;
 504         *this << (s32) src.Z;
 505         return *this;
 506 }
 507
 508 NetworkPacket& NetworkPacket::operator>>(video::SColor& dst)
 509 {
 510         checkReadOffset(m_read_offset, 4);
 511
 512         dst = readARGB8(&m_data[m_read_offset]);
 513
 514         m_read_offset += 4;
 515         return *this;
 516 }
 517
 518 NetworkPacket& NetworkPacket::operator<<(video::SColor src)
 519 {
 520         checkDataSize(4);
 521
 522         writeU32(&m_data[m_read_offset], src.color);
 523
 524         m_read_offset += 4;
 525         return *this;
 526 }
 527
 528 SharedBuffer<u8> NetworkPacket::oldForgePacket()
 529 {
 530         SharedBuffer<u8> sb(m_datasize + 2);
 531         writeU16(&sb[0], m_command);
 532
 533         u8* datas = getU8Ptr(0);
 534
 535         if (datas != NULL)
 536                 memcpy(&sb[2], datas, m_datasize);
 537         return sb;
 538 }