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