src/client/client.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   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 <iostream>
  21 #include <algorithm>
  22 #include <sstream>
  23 #include <cmath>
  24 #include <IFileSystem.h>
  25 #include "client.h"
  26 #include "network/clientopcodes.h"
  27 #include "network/connection.h"
  28 #include "network/networkpacket.h"
  29 #include "threading/mutex_auto_lock.h"
  30 #include "client/clientevent.h"
  31 #include "client/gameui.h"
  32 #include "client/renderingengine.h"
  33 #include "client/sound.h"
  34 #include "client/tile.h"
  35 #include "util/auth.h"
  36 #include "util/directiontables.h"
  37 #include "util/pointedthing.h"
  38 #include "util/serialize.h"
  39 #include "util/string.h"
  40 #include "util/srp.h"
  41 #include "filesys.h"
  42 #include "mapblock_mesh.h"
  43 #include "mapblock.h"
  44 #include "mapsector.h"
  45 #include "minimap.h"
  46 #include "modchannels.h"
  47 #include "content/mods.h"
  48 #include "profiler.h"
  49 #include "shader.h"
  50 #include "gettext.h"
  51 #include "clientmap.h"
  52 #include "clientmedia.h"
  53 #include "version.h"
  54 #include "database/database-files.h"
  55 #include "database/database-sqlite3.h"
  56 #include "serialization.h"
  57 #include "guiscalingfilter.h"
  58 #include "script/scripting_client.h"
  59 #include "game.h"
  60 #include "chatmessage.h"
  61 #include "translation.h"
  62
  63 extern gui::IGUIEnvironment* guienv;
  64
  65 /*
  66         Utility classes
  67 */
  68
  69 u32 PacketCounter::sum() const
  70 {
  71         u32 n = 0;
  72         for (const auto &it : m_packets)
  73                 n += it.second;
  74         return n;
  75 }
  76
  77 void PacketCounter::print(std::ostream &o) const
  78 {
  79         for (const auto &it : m_packets) {
  80                 auto name = it.first >= TOCLIENT_NUM_MSG_TYPES ? "?"
  81                         : toClientCommandTable[it.first].name;
  82                 o << "cmd " << it.first << " (" << name << ") count "
  83                         << it.second << std::endl;
  84         }
  85 }
  86
  87 /*
  88         Client
  89 */
  90
  91 Client::Client(
  92                 const char *playername,
  93                 const std::string &password,
  94                 const std::string &address_name,
  95                 MapDrawControl &control,
  96                 IWritableTextureSource *tsrc,
  97                 IWritableShaderSource *shsrc,
  98                 IWritableItemDefManager *itemdef,
  99                 NodeDefManager *nodedef,
 100                 ISoundManager *sound,
 101                 MtEventManager *event,
 102                 RenderingEngine *rendering_engine,
 103                 bool ipv6,
 104                 GameUI *game_ui
 105 ):
 106         m_mesh_update_thread(this),
 107         m_tsrc(tsrc),
 108         m_shsrc(shsrc),
 109         m_itemdef(itemdef),
 110         m_nodedef(nodedef),
 111         m_sound(sound),
 112         m_event(event),
 113         m_rendering_engine(rendering_engine),
 114         m_env(
 115                 new ClientMap(this, rendering_engine, control, 666),
 116                 tsrc, this
 117         ),
 118         m_particle_manager(&m_env),
 119         m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
 120         m_address_name(address_name),
 121         m_server_ser_ver(SER_FMT_VER_INVALID),
 122         m_last_chat_message_sent(time(NULL)),
 123         m_password(password),
 124         m_chosen_auth_mech(AUTH_MECHANISM_NONE),
 125         m_media_downloader(new ClientMediaDownloader()),
 126         m_state(LC_Created),
 127         m_game_ui(game_ui),
 128         m_modchannel_mgr(new ModChannelMgr())
 129 {
 130         // Add local player
 131         m_env.setLocalPlayer(new LocalPlayer(this, playername));
 132
 133         // Make the mod storage database and begin the save for later
 134         m_mod_storage_database =
 135                 new ModMetadataDatabaseSQLite3(porting::path_user + DIR_DELIM + "client");
 136         m_mod_storage_database->beginSave();
 137
 138         if (g_settings->getBool("enable_minimap")) {
 139                 m_minimap = new Minimap(this);
 140         }
 141
 142         m_cache_save_interval = g_settings->getU16("server_map_save_interval");
 143 }
 144
 145 void Client::migrateModStorage()
 146 {
 147         std::string mod_storage_dir = porting::path_user + DIR_DELIM + "client";
 148         std::string old_mod_storage = mod_storage_dir + DIR_DELIM + "mod_storage";
 149         if (fs::IsDir(old_mod_storage)) {
 150                 infostream << "Migrating client mod storage to SQLite3 database" << std::endl;
 151                 {
 152                         ModMetadataDatabaseFiles files_db(mod_storage_dir);
 153                         std::vector<std::string> mod_list;
 154                         files_db.listMods(&mod_list);
 155                         for (const std::string &modname : mod_list) {
 156                                 infostream << "Migrating client mod storage for mod " << modname << std::endl;
 157                                 StringMap meta;
 158                                 files_db.getModEntries(modname, &meta);
 159                                 for (const auto &pair : meta) {
 160                                         m_mod_storage_database->setModEntry(modname, pair.first, pair.second);
 161                                 }
 162                         }
 163                 }
 164                 if (!fs::Rename(old_mod_storage, old_mod_storage + ".bak")) {
 165                         // Execution cannot move forward if the migration does not complete.
 166                         throw BaseException("Could not finish migrating client mod storage");
 167                 }
 168                 infostream << "Finished migration of client mod storage" << std::endl;
 169         }
 170 }
 171
 172 void Client::loadMods()
 173 {
 174         // Don't load mods twice.
 175         // If client scripting is disabled by the client, don't load builtin or
 176         // client-provided mods.
 177         if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
 178                 return;
 179
 180         // If client scripting is disabled by the server, don't load builtin or
 181         // client-provided mods.
 182         // TODO Delete this code block when server-sent CSM and verifying of builtin are
 183         // complete.
 184         if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
 185                 warningstream << "Client-provided mod loading is disabled by server." <<
 186                         std::endl;
 187                 return;
 188         }
 189
 190         m_script = new ClientScripting(this);
 191         m_env.setScript(m_script);
 192         m_script->setEnv(&m_env);
 193
 194         // Load builtin
 195         scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
 196         m_script->loadModFromMemory(BUILTIN_MOD_NAME);
 197
 198         ClientModConfiguration modconf(getClientModsLuaPath());
 199         m_mods = modconf.getMods();
 200         // complain about mods with unsatisfied dependencies
 201         if (!modconf.isConsistent()) {
 202                 modconf.printUnsatisfiedModsError();
 203                 return;
 204         }
 205
 206         // Print mods
 207         infostream << "Client loading mods: ";
 208         for (const ModSpec &mod : m_mods)
 209                 infostream << mod.name << " ";
 210         infostream << std::endl;
 211
 212         // Load "mod" scripts
 213         for (const ModSpec &mod : m_mods) {
 214                 mod.checkAndLog();
 215                 scanModIntoMemory(mod.name, mod.path);
 216         }
 217
 218         // Run them
 219         for (const ModSpec &mod : m_mods)
 220                 m_script->loadModFromMemory(mod.name);
 221
 222         // Mods are done loading. Unlock callbacks
 223         m_mods_loaded = true;
 224
 225         // Run a callback when mods are loaded
 226         m_script->on_mods_loaded();
 227
 228         m_script->init_cheats();
 229
 230         // Create objects if they're ready
 231         if (m_state == LC_Ready)
 232                 m_script->on_client_ready(m_env.getLocalPlayer());
 233         if (m_camera)
 234                 m_script->on_camera_ready(m_camera);
 235         if (m_minimap)
 236                 m_script->on_minimap_ready(m_minimap);
 237 }
 238
 239 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
 240                         std::string mod_subpath)
 241 {
 242         std::string full_path = mod_path + DIR_DELIM + mod_subpath;
 243         std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
 244         for (const fs::DirListNode &j : mod) {
 245                 if (j.name[0] == '.')
 246                         continue;
 247
 248                 if (j.dir) {
 249                         scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
 250                         continue;
 251                 }
 252                 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
 253
 254                 std::string real_path = full_path + j.name;
 255                 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
 256                 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
 257                                 << "\" as \"" << vfs_path << "\"." << std::endl;
 258
 259                 std::string contents;
 260                 if (!fs::ReadFile(real_path, contents)) {
 261                         errorstream << "Client::scanModSubfolder(): Can't read file \""
 262                                         << real_path << "\"." << std::endl;
 263                         continue;
 264                 }
 265
 266                 m_mod_vfs.emplace(vfs_path, contents);
 267         }
 268 }
 269
 270 const std::string &Client::getBuiltinLuaPath()
 271 {
 272         static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
 273         return builtin_dir;
 274 }
 275
 276 const std::string &Client::getClientModsLuaPath()
 277 {
 278         static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
 279         return clientmods_dir;
 280 }
 281
 282 const std::vector<ModSpec>& Client::getMods() const
 283 {
 284         static std::vector<ModSpec> client_modspec_temp;
 285         return client_modspec_temp;
 286 }
 287
 288 const ModSpec* Client::getModSpec(const std::string &modname) const
 289 {
 290         return NULL;
 291 }
 292
 293 void Client::Stop()
 294 {
 295         m_shutdown = true;
 296         if (m_mods_loaded)
 297                 m_script->on_shutdown();
 298         //request all client managed threads to stop
 299         m_mesh_update_thread.stop();
 300         // Save local server map
 301         if (m_localdb) {
 302                 infostream << "Local map saving ended." << std::endl;
 303                 m_localdb->endSave();
 304         }
 305
 306         if (m_mods_loaded)
 307                 delete m_script;
 308 }
 309
 310 bool Client::isShutdown()
 311 {
 312         return m_shutdown || !m_mesh_update_thread.isRunning();
 313 }
 314
 315 Client::~Client()
 316 {
 317         m_shutdown = true;
 318         m_con->Disconnect();
 319
 320         deleteAuthData();
 321
 322         m_mesh_update_thread.stop();
 323         m_mesh_update_thread.wait();
 324         while (!m_mesh_update_thread.m_queue_out.empty()) {
 325                 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
 326                 delete r.mesh;
 327         }
 328
 329
 330         delete m_inventory_from_server;
 331
 332         // Delete detached inventories
 333         for (auto &m_detached_inventorie : m_detached_inventories) {
 334                 delete m_detached_inventorie.second;
 335         }
 336
 337         // cleanup 3d model meshes on client shutdown
 338         m_rendering_engine->cleanupMeshCache();
 339
 340         guiScalingCacheClear();
 341
 342         delete m_minimap;
 343         m_minimap = nullptr;
 344
 345         delete m_media_downloader;
 346
 347         // Write the changes and delete
 348         if (m_mod_storage_database)
 349                 m_mod_storage_database->endSave();
 350         delete m_mod_storage_database;
 351 }
 352
 353 void Client::connect(Address address, bool is_local_server)
 354 {
 355         initLocalMapSaving(address, m_address_name, is_local_server);
 356
 357         // Since we use TryReceive() a timeout here would be ineffective anyway
 358         m_con->SetTimeoutMs(0);
 359         m_con->Connect(address);
 360 }
 361
 362 void Client::step(float dtime)
 363 {
 364         // Limit a bit
 365         if (dtime > 2.0)
 366                 dtime = 2.0;
 367
 368         m_animation_time += dtime;
 369         if(m_animation_time > 60.0)
 370                 m_animation_time -= 60.0;
 371
 372         m_time_of_day_update_timer += dtime;
 373
 374         ReceiveAll();
 375
 376         /*
 377                 Packet counter
 378         */
 379         {
 380                 float &counter = m_packetcounter_timer;
 381                 counter -= dtime;
 382                 if(counter <= 0.0f)
 383                 {
 384                         counter = 30.0f;
 385                         u32 sum = m_packetcounter.sum();
 386                         float avg = sum / counter;
 387
 388                         infostream << "Client packetcounter (" << counter << "s): "
 389                                         << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
 390                         m_packetcounter.print(infostream);
 391                         m_packetcounter.clear();
 392                 }
 393         }
 394
 395         // UGLY hack to fix 2 second startup delay caused by non existent
 396         // server client startup synchronization in local server or singleplayer mode
 397         static bool initial_step = true;
 398         if (initial_step) {
 399                 initial_step = false;
 400         }
 401         else if(m_state == LC_Created) {
 402                 if (m_is_registration_confirmation_state) {
 403                         // Waiting confirmation
 404                         return;
 405                 }
 406                 float &counter = m_connection_reinit_timer;
 407                 counter -= dtime;
 408                 if(counter <= 0.0) {
 409                         counter = 2.0;
 410
 411                         LocalPlayer *myplayer = m_env.getLocalPlayer();
 412                         FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
 413
 414                         sendInit(myplayer->getName());
 415                 }
 416
 417                 // Not connected, return
 418                 return;
 419         }
 420
 421         /*
 422                 Do stuff if connected
 423         */
 424
 425         /*
 426                 Run Map's timers and unload unused data
 427         */
 428         const float map_timer_and_unload_dtime = 5.25;
 429         if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
 430                 std::vector<v3s16> deleted_blocks;
 431                 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
 432                         g_settings->getFloat("client_unload_unused_data_timeout"),
 433                         g_settings->getS32("client_mapblock_limit"),
 434                         &deleted_blocks);
 435
 436                 /*
 437                         Send info to server
 438                         NOTE: This loop is intentionally iterated the way it is.
 439                 */
 440
 441                 std::vector<v3s16>::iterator i = deleted_blocks.begin();
 442                 std::vector<v3s16> sendlist;
 443                 for(;;) {
 444                         if(sendlist.size() == 255 || i == deleted_blocks.end()) {
 445                                 if(sendlist.empty())
 446                                         break;
 447                                 /*
 448                                         [0] u16 command
 449                                         [2] u8 count
 450                                         [3] v3s16 pos_0
 451                                         [3+6] v3s16 pos_1
 452                                         ...
 453                                 */
 454
 455                                 sendDeletedBlocks(sendlist);
 456
 457                                 if(i == deleted_blocks.end())
 458                                         break;
 459
 460                                 sendlist.clear();
 461                         }
 462
 463                         sendlist.push_back(*i);
 464                         ++i;
 465                 }
 466         }
 467
 468         /*
 469                 Send pending messages on out chat queue
 470         */
 471         if (!m_out_chat_queue.empty() && canSendChatMessage()) {
 472                 sendChatMessage(m_out_chat_queue.front());
 473                 m_out_chat_queue.pop();
 474         }
 475
 476         /*
 477                 Handle environment
 478         */
 479         LocalPlayer *player = m_env.getLocalPlayer();
 480
 481         // Step environment (also handles player controls)
 482         m_env.step(dtime);
 483         m_sound->step(dtime);
 484
 485         /*
 486                 Get events
 487         */
 488         while (m_env.hasClientEnvEvents()) {
 489                 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
 490
 491                 if (envEvent.type == CEE_PLAYER_DAMAGE) {
 492                         u16 damage = envEvent.player_damage.amount;
 493
 494                         if (envEvent.player_damage.send_to_server && ! g_settings->getBool("prevent_natural_damage"))
 495                                 sendDamage(damage);
 496
 497                         // Add to ClientEvent queue
 498                         ClientEvent *event = new ClientEvent();
 499                         event->type = CE_PLAYER_DAMAGE;
 500                         event->player_damage.amount = damage;
 501                         m_client_event_queue.push(event);
 502                 }
 503         }
 504
 505         /*
 506                 Print some info
 507         */
 508         float &counter = m_avg_rtt_timer;
 509         counter += dtime;
 510         if(counter >= 10) {
 511                 counter = 0.0;
 512                 // connectedAndInitialized() is true, peer exists.
 513                 float avg_rtt = getRTT();
 514                 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
 515         }
 516
 517         /*
 518                 Send player position to server
 519         */
 520         {
 521                 float &counter = m_playerpos_send_timer;
 522                 counter += dtime;
 523                 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
 524                 {
 525                         counter = 0.0;
 526                         sendPlayerPos();
 527                 }
 528         }
 529
 530         /*
 531                 Replace updated meshes
 532         */
 533         {
 534                 int num_processed_meshes = 0;
 535                 std::vector<v3s16> blocks_to_ack;
 536                 while (!m_mesh_update_thread.m_queue_out.empty())
 537                 {
 538                         num_processed_meshes++;
 539
 540                         MinimapMapblock *minimap_mapblock = NULL;
 541                         bool do_mapper_update = true;
 542
 543                         MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
 544                         MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
 545                         if (block) {
 546                                 // Delete the old mesh
 547                                 delete block->mesh;
 548                                 block->mesh = nullptr;
 549
 550                                 if (r.mesh) {
 551                                         minimap_mapblock = r.mesh->moveMinimapMapblock();
 552                                         if (minimap_mapblock == NULL)
 553                                                 do_mapper_update = false;
 554
 555                                         bool is_empty = true;
 556                                         for (int l = 0; l < MAX_TILE_LAYERS; l++)
 557                                                 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
 558                                                         is_empty = false;
 559
 560                                         if (is_empty)
 561                                                 delete r.mesh;
 562                                         else
 563                                                 // Replace with the new mesh
 564                                                 block->mesh = r.mesh;
 565                                 }
 566                         } else {
 567                                 delete r.mesh;
 568                         }
 569
 570                         if (m_minimap && do_mapper_update)
 571                                 m_minimap->addBlock(r.p, minimap_mapblock);
 572
 573                         if (r.ack_block_to_server) {
 574                                 if (blocks_to_ack.size() == 255) {
 575                                         sendGotBlocks(blocks_to_ack);
 576                                         blocks_to_ack.clear();
 577                                 }
 578
 579                                 blocks_to_ack.emplace_back(r.p);
 580                         }
 581                 }
 582                 if (blocks_to_ack.size() > 0) {
 583                                 // Acknowledge block(s)
 584                                 sendGotBlocks(blocks_to_ack);
 585                 }
 586
 587                 if (num_processed_meshes > 0)
 588                         g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
 589         }
 590
 591         /*
 592                 Load fetched media
 593         */
 594         if (m_media_downloader && m_media_downloader->isStarted()) {
 595                 m_media_downloader->step(this);
 596                 if (m_media_downloader->isDone()) {
 597                         delete m_media_downloader;
 598                         m_media_downloader = NULL;
 599                 }
 600         }
 601         {
 602                 // Acknowledge dynamic media downloads to server
 603                 std::vector<u32> done;
 604                 for (auto it = m_pending_media_downloads.begin();
 605                                 it != m_pending_media_downloads.end();) {
 606                         assert(it->second->isStarted());
 607                         it->second->step(this);
 608                         if (it->second->isDone()) {
 609                                 done.emplace_back(it->first);
 610
 611                                 it = m_pending_media_downloads.erase(it);
 612                         } else {
 613                                 it++;
 614                         }
 615
 616                         if (done.size() == 255) { // maximum in one packet
 617                                 sendHaveMedia(done);
 618                                 done.clear();
 619                         }
 620                 }
 621                 if (!done.empty())
 622                         sendHaveMedia(done);
 623         }
 624
 625         /*
 626                 If the server didn't update the inventory in a while, revert
 627                 the local inventory (so the player notices the lag problem
 628                 and knows something is wrong).
 629         */
 630         if (m_inventory_from_server) {
 631                 float interval = 10.0f;
 632                 float count_before = std::floor(m_inventory_from_server_age / interval);
 633
 634                 m_inventory_from_server_age += dtime;
 635
 636                 float count_after = std::floor(m_inventory_from_server_age / interval);
 637
 638                 if (count_after != count_before) {
 639                         // Do this every <interval> seconds after TOCLIENT_INVENTORY
 640                         // Reset the locally changed inventory to the authoritative inventory
 641                         player->inventory = *m_inventory_from_server;
 642                         m_update_wielded_item = true;
 643                 }
 644         }
 645
 646         /*
 647                 Update positions of sounds attached to objects
 648         */
 649         {
 650                 for (auto &m_sounds_to_object : m_sounds_to_objects) {
 651                         int client_id = m_sounds_to_object.first;
 652                         u16 object_id = m_sounds_to_object.second;
 653                         ClientActiveObject *cao = m_env.getActiveObject(object_id);
 654                         if (!cao)
 655                                 continue;
 656                         m_sound->updateSoundPosition(client_id, cao->getPosition());
 657                 }
 658         }
 659
 660         /*
 661                 Handle removed remotely initiated sounds
 662         */
 663         m_removed_sounds_check_timer += dtime;
 664         if(m_removed_sounds_check_timer >= 2.32) {
 665                 m_removed_sounds_check_timer = 0;
 666                 // Find removed sounds and clear references to them
 667                 std::vector<s32> removed_server_ids;
 668                 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
 669                                 i != m_sounds_server_to_client.end();) {
 670                         s32 server_id = i->first;
 671                         int client_id = i->second;
 672                         ++i;
 673                         if(!m_sound->soundExists(client_id)) {
 674                                 m_sounds_server_to_client.erase(server_id);
 675                                 m_sounds_client_to_server.erase(client_id);
 676                                 m_sounds_to_objects.erase(client_id);
 677                                 removed_server_ids.push_back(server_id);
 678                         }
 679                 }
 680
 681                 // Sync to server
 682                 if(!removed_server_ids.empty()) {
 683                         sendRemovedSounds(removed_server_ids);
 684                 }
 685         }
 686
 687         // Write changes to the mod storage
 688         m_mod_storage_save_timer -= dtime;
 689         if (m_mod_storage_save_timer <= 0.0f) {
 690                 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
 691                 m_mod_storage_database->endSave();
 692                 m_mod_storage_database->beginSave();
 693         }
 694
 695         // Write server map
 696         if (m_localdb && m_localdb_save_interval.step(dtime,
 697                         m_cache_save_interval)) {
 698                 m_localdb->endSave();
 699                 m_localdb->beginSave();
 700         }
 701 }
 702
 703 bool Client::loadMedia(const std::string &data, const std::string &filename,
 704         bool from_media_push)
 705 {
 706         std::string name;
 707
 708         const char *image_ext[] = {
 709                 ".png", ".jpg", ".bmp", ".tga",
 710                 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
 711                 NULL
 712         };
 713         name = removeStringEnd(filename, image_ext);
 714         if (!name.empty()) {
 715                 TRACESTREAM(<< "Client: Attempting to load image "
 716                         << "file \"" << filename << "\"" << std::endl);
 717
 718                 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
 719                 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
 720
 721                 io::IReadFile *rfile = irrfs->createMemoryReadFile(
 722                                 data.c_str(), data.size(), "_tempreadfile");
 723
 724                 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
 725
 726                 // Read image
 727                 video::IImage *img = vdrv->createImageFromFile(rfile);
 728                 if (!img) {
 729                         errorstream<<"Client: Cannot create image from data of "
 730                                         <<"file \""<<filename<<"\""<<std::endl;
 731                         rfile->drop();
 732                         return false;
 733                 }
 734
 735                 m_tsrc->insertSourceImage(filename, img);
 736                 img->drop();
 737                 rfile->drop();
 738                 return true;
 739         }
 740
 741         const char *sound_ext[] = {
 742                 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
 743                 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
 744                 ".ogg", NULL
 745         };
 746         name = removeStringEnd(filename, sound_ext);
 747         if (!name.empty()) {
 748                 TRACESTREAM(<< "Client: Attempting to load sound "
 749                         << "file \"" << filename << "\"" << std::endl);
 750                 return m_sound->loadSoundData(name, data);
 751         }
 752
 753         const char *model_ext[] = {
 754                 ".x", ".b3d", ".md2", ".obj",
 755                 NULL
 756         };
 757         name = removeStringEnd(filename, model_ext);
 758         if (!name.empty()) {
 759                 verbosestream<<"Client: Storing model into memory: "
 760                                 <<"\""<<filename<<"\""<<std::endl;
 761                 if(m_mesh_data.count(filename))
 762                         errorstream<<"Multiple models with name \""<<filename.c_str()
 763                                         <<"\" found; replacing previous model"<<std::endl;
 764                 m_mesh_data[filename] = data;
 765                 return true;
 766         }
 767
 768         const char *translate_ext[] = {
 769                 ".tr", NULL
 770         };
 771         name = removeStringEnd(filename, translate_ext);
 772         if (!name.empty()) {
 773                 if (from_media_push)
 774                         return false;
 775                 TRACESTREAM(<< "Client: Loading translation: "
 776                                 << "\"" << filename << "\"" << std::endl);
 777                 g_client_translations->loadTranslation(data);
 778                 return true;
 779         }
 780
 781         errorstream << "Client: Don't know how to load file \""
 782                 << filename << "\"" << std::endl;
 783         return false;
 784 }
 785
 786 // Virtual methods from con::PeerHandler
 787 void Client::peerAdded(con::Peer *peer)
 788 {
 789         infostream << "Client::peerAdded(): peer->id="
 790                         << peer->id << std::endl;
 791 }
 792 void Client::deletingPeer(con::Peer *peer, bool timeout)
 793 {
 794         infostream << "Client::deletingPeer(): "
 795                         "Server Peer is getting deleted "
 796                         << "(timeout=" << timeout << ")" << std::endl;
 797
 798         if (timeout) {
 799                 m_access_denied = true;
 800                 m_access_denied_reason = gettext("Connection timed out.");
 801         }
 802 }
 803
 804 /*
 805         u16 command
 806         u16 number of files requested
 807         for each file {
 808                 u16 length of name
 809                 string name
 810         }
 811 */
 812 void Client::request_media(const std::vector<std::string> &file_requests)
 813 {
 814         std::ostringstream os(std::ios_base::binary);
 815         writeU16(os, TOSERVER_REQUEST_MEDIA);
 816         size_t file_requests_size = file_requests.size();
 817
 818         FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
 819
 820         // Packet dynamicly resized
 821         NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
 822
 823         pkt << (u16) (file_requests_size & 0xFFFF);
 824
 825         for (const std::string &file_request : file_requests) {
 826                 pkt << file_request;
 827         }
 828
 829         Send(&pkt);
 830
 831         infostream << "Client: Sending media request list to server ("
 832                         << file_requests.size() << " files, packet size "
 833                         << pkt.getSize() << ")" << std::endl;
 834 }
 835
 836 void Client::initLocalMapSaving(const Address &address,
 837                 const std::string &hostname,
 838                 bool is_local_server)
 839 {
 840         if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
 841                 return;
 842         }
 843
 844         std::string world_path;
 845 #define set_world_path(hostname) \
 846         world_path = porting::path_user \
 847                 + DIR_DELIM + "worlds" \
 848                 + DIR_DELIM + "server_" \
 849                 + hostname + "_" + std::to_string(address.getPort());
 850
 851         set_world_path(hostname);
 852         if (!fs::IsDir(world_path)) {
 853                 std::string hostname_escaped = hostname;
 854                 str_replace(hostname_escaped, ':', '_');
 855                 set_world_path(hostname_escaped);
 856         }
 857 #undef set_world_path
 858         fs::CreateAllDirs(world_path);
 859
 860         m_localdb = new MapDatabaseSQLite3(world_path);
 861         m_localdb->beginSave();
 862         actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
 863 }
 864
 865 void Client::ReceiveAll()
 866 {
 867         NetworkPacket pkt;
 868         u64 start_ms = porting::getTimeMs();
 869         const u64 budget = 100;
 870         for(;;) {
 871                 // Limit time even if there would be huge amounts of data to
 872                 // process
 873                 if (porting::getTimeMs() > start_ms + budget) {
 874                         infostream << "Client::ReceiveAll(): "
 875                                         "Packet processing budget exceeded." << std::endl;
 876                         break;
 877                 }
 878
 879                 pkt.clear();
 880                 try {
 881                         if (!m_con->TryReceive(&pkt))
 882                                 break;
 883                         ProcessData(&pkt);
 884                 } catch (const con::InvalidIncomingDataException &e) {
 885                         infostream << "Client::ReceiveAll(): "
 886                                         "InvalidIncomingDataException: what()="
 887                                          << e.what() << std::endl;
 888                 }
 889         }
 890 }
 891
 892 inline void Client::handleCommand(NetworkPacket* pkt)
 893 {
 894         const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
 895         (this->*opHandle.handler)(pkt);
 896 }
 897
 898 /*
 899         sender_peer_id given to this shall be quaranteed to be a valid peer
 900 */
 901 void Client::ProcessData(NetworkPacket *pkt)
 902 {
 903         ToClientCommand command = (ToClientCommand) pkt->getCommand();
 904         u32 sender_peer_id = pkt->getPeerId();
 905
 906         //infostream<<"Client: received command="<<command<<std::endl;
 907         m_packetcounter.add((u16)command);
 908         g_profiler->graphAdd("client_received_packets", 1);
 909
 910         /*
 911                 If this check is removed, be sure to change the queue
 912                 system to know the ids
 913         */
 914         if(sender_peer_id != PEER_ID_SERVER) {
 915                 infostream << "Client::ProcessData(): Discarding data not "
 916                         "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
 917                         << std::endl;
 918                 return;
 919         }
 920
 921         // Command must be handled into ToClientCommandHandler
 922         if (command >= TOCLIENT_NUM_MSG_TYPES) {
 923                 infostream << "Client: Ignoring unknown command "
 924                         << command << std::endl;
 925                 return;
 926         }
 927
 928         /*
 929          * Those packets are handled before m_server_ser_ver is set, it's normal
 930          * But we must use the new ToClientConnectionState in the future,
 931          * as a byte mask
 932          */
 933         if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
 934                 handleCommand(pkt);
 935                 return;
 936         }
 937
 938         if(m_server_ser_ver == SER_FMT_VER_INVALID) {
 939                 infostream << "Client: Server serialization"
 940                                 " format invalid or not initialized."
 941                                 " Skipping incoming command=" << command << std::endl;
 942                 return;
 943         }
 944
 945         /*
 946           Handle runtime commands
 947         */
 948
 949         handleCommand(pkt);
 950 }
 951
 952 void Client::Send(NetworkPacket* pkt)
 953 {
 954         m_con->Send(PEER_ID_SERVER,
 955                 serverCommandFactoryTable[pkt->getCommand()].channel,
 956                 pkt,
 957                 serverCommandFactoryTable[pkt->getCommand()].reliable);
 958 }
 959
 960 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
 961 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
 962 {
 963         v3f pf           = myplayer->getLegitPosition() * 100;
 964         v3f sf           = myplayer->getSendSpeed() * 100;
 965         s32 pitch        = myplayer->getPitch() * 100;
 966         s32 yaw          = myplayer->getYaw() * 100;
 967         u32 keyPressed   = myplayer->control.getKeysPressed();
 968         // scaled by 80, so that pi can fit into a u8
 969         u8 fov           = clientMap->getCameraFov() * 80;
 970         u8 wanted_range  = MYMIN(255,
 971                         std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
 972
 973         v3s32 position(pf.X, pf.Y, pf.Z);
 974         v3s32 speed(sf.X, sf.Y, sf.Z);
 975
 976         /*
 977                 Format:
 978                 [0] v3s32 position*100
 979                 [12] v3s32 speed*100
 980                 [12+12] s32 pitch*100
 981                 [12+12+4] s32 yaw*100
 982                 [12+12+4+4] u32 keyPressed
 983                 [12+12+4+4+4] u8 fov*80
 984                 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 985         */
 986         *pkt << position << speed << pitch << yaw << keyPressed;
 987         *pkt << fov << wanted_range;
 988 }
 989
 990 void Client::interact(InteractAction action, const PointedThing& pointed)
 991 {
 992         if(m_state != LC_Ready) {
 993                 errorstream << "Client::interact() "
 994                                 "Canceled (not connected)"
 995                                 << std::endl;
 996                 return;
 997         }
 998
 999         LocalPlayer *myplayer = m_env.getLocalPlayer();
1000         if (myplayer == NULL)
1001                 return;
1002
1003         /*
1004                 [0] u16 command
1005                 [2] u8 action
1006                 [3] u16 item
1007                 [5] u32 length of the next item (plen)
1008                 [9] serialized PointedThing
1009                 [9 + plen] player position information
1010         */
1011
1012         NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1013
1014         pkt << (u8)action;
1015         pkt << myplayer->getWieldIndex();
1016
1017         std::ostringstream tmp_os(std::ios::binary);
1018         pointed.serialize(tmp_os);
1019
1020         pkt.putLongString(tmp_os.str());
1021
1022         writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1023
1024         Send(&pkt);
1025 }
1026
1027 void Client::deleteAuthData()
1028 {
1029         if (!m_auth_data)
1030                 return;
1031
1032         switch (m_chosen_auth_mech) {
1033                 case AUTH_MECHANISM_FIRST_SRP:
1034                         break;
1035                 case AUTH_MECHANISM_SRP:
1036                 case AUTH_MECHANISM_LEGACY_PASSWORD:
1037                         srp_user_delete((SRPUser *) m_auth_data);
1038                         m_auth_data = NULL;
1039                         break;
1040                 case AUTH_MECHANISM_NONE:
1041                         break;
1042         }
1043         m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1044 }
1045
1046
1047 AuthMechanism Client::choseAuthMech(const u32 mechs)
1048 {
1049         if (mechs & AUTH_MECHANISM_SRP)
1050                 return AUTH_MECHANISM_SRP;
1051
1052         if (mechs & AUTH_MECHANISM_FIRST_SRP)
1053                 return AUTH_MECHANISM_FIRST_SRP;
1054
1055         if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1056                 return AUTH_MECHANISM_LEGACY_PASSWORD;
1057
1058         return AUTH_MECHANISM_NONE;
1059 }
1060
1061 void Client::sendInit(const std::string &playerName)
1062 {
1063         NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1064
1065         // we don't support network compression yet
1066         u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1067
1068         pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1069         pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1070         pkt << playerName;
1071
1072         Send(&pkt);
1073 }
1074
1075 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
1076 {
1077         m_chosen_auth_mech = chosen_auth_mechanism;
1078         m_is_registration_confirmation_state = true;
1079 }
1080
1081 void Client::confirmRegistration()
1082 {
1083         m_is_registration_confirmation_state = false;
1084         startAuth(m_chosen_auth_mech);
1085 }
1086
1087 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1088 {
1089         m_chosen_auth_mech = chosen_auth_mechanism;
1090
1091         switch (chosen_auth_mechanism) {
1092                 case AUTH_MECHANISM_FIRST_SRP: {
1093                         // send srp verifier to server
1094                         std::string verifier;
1095                         std::string salt;
1096                         generate_srp_verifier_and_salt(getPlayerName(), m_password,
1097                                 &verifier, &salt);
1098
1099                         NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1100                         resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1101
1102                         Send(&resp_pkt);
1103                         break;
1104                 }
1105                 case AUTH_MECHANISM_SRP:
1106                 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1107                         u8 based_on = 1;
1108
1109                         if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1110                                 m_password = translate_password(getPlayerName(), m_password);
1111                                 based_on = 0;
1112                         }
1113
1114                         std::string playername_u = lowercase(getPlayerName());
1115                         m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1116                                 getPlayerName().c_str(), playername_u.c_str(),
1117                                 (const unsigned char *) m_password.c_str(),
1118                                 m_password.length(), NULL, NULL);
1119                         char *bytes_A = 0;
1120                         size_t len_A = 0;
1121                         SRP_Result res = srp_user_start_authentication(
1122                                 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1123                                 (unsigned char **) &bytes_A, &len_A);
1124                         FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1125
1126                         NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1127                         resp_pkt << std::string(bytes_A, len_A) << based_on;
1128                         Send(&resp_pkt);
1129                         break;
1130                 }
1131                 case AUTH_MECHANISM_NONE:
1132                         break; // not handled in this method
1133         }
1134 }
1135
1136 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1137 {
1138         NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1139
1140         pkt << (u8) blocks.size();
1141
1142         for (const v3s16 &block : blocks) {
1143                 pkt << block;
1144         }
1145
1146         Send(&pkt);
1147 }
1148
1149 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1150 {
1151         NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1152         pkt << (u8) blocks.size();
1153         for (const v3s16 &block : blocks)
1154                 pkt << block;
1155
1156         Send(&pkt);
1157 }
1158
1159 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1160 {
1161         size_t server_ids = soundList.size();
1162         assert(server_ids <= 0xFFFF);
1163
1164         NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1165
1166         pkt << (u16) (server_ids & 0xFFFF);
1167
1168         for (s32 sound_id : soundList)
1169                 pkt << sound_id;
1170
1171         Send(&pkt);
1172 }
1173
1174 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1175                 const StringMap &fields)
1176 {
1177         size_t fields_size = fields.size();
1178
1179         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1180
1181         NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1182
1183         pkt << p << formname << (u16) (fields_size & 0xFFFF);
1184
1185         StringMap::const_iterator it;
1186         for (it = fields.begin(); it != fields.end(); ++it) {
1187                 const std::string &name = it->first;
1188                 const std::string &value = it->second;
1189                 pkt << name;
1190                 pkt.putLongString(value);
1191         }
1192
1193         Send(&pkt);
1194 }
1195
1196 void Client::sendInventoryFields(const std::string &formname,
1197                 const StringMap &fields)
1198 {
1199         size_t fields_size = fields.size();
1200         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1201
1202         NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1203         pkt << formname << (u16) (fields_size & 0xFFFF);
1204
1205         StringMap::const_iterator it;
1206         for (it = fields.begin(); it != fields.end(); ++it) {
1207                 const std::string &name  = it->first;
1208                 const std::string &value = it->second;
1209                 pkt << name;
1210                 pkt.putLongString(value);
1211         }
1212
1213         Send(&pkt);
1214 }
1215
1216 void Client::sendInventoryAction(InventoryAction *a)
1217 {
1218         std::ostringstream os(std::ios_base::binary);
1219
1220         a->serialize(os);
1221
1222         // Make data buffer
1223         std::string s = os.str();
1224
1225         NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1226         pkt.putRawString(s.c_str(),s.size());
1227
1228         Send(&pkt);
1229 }
1230
1231 bool Client::canSendChatMessage() const
1232 {
1233         u32 now = time(NULL);
1234         float time_passed = now - m_last_chat_message_sent;
1235
1236         float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1237                         (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1238
1239         if (virt_chat_message_allowance < 1.0f)
1240                 return false;
1241
1242         return true;
1243 }
1244
1245 void Client::sendChatMessage(const std::wstring &message)
1246 {
1247         const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1248         if (canSendChatMessage()) {
1249                 u32 now = time(NULL);
1250                 float time_passed = now - m_last_chat_message_sent;
1251                 m_last_chat_message_sent = now;
1252
1253                 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1254                 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1255                         m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1256
1257                 m_chat_message_allowance -= 1.0f;
1258
1259                 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1260
1261                 pkt << message;
1262
1263                 Send(&pkt);
1264         } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1265                 m_out_chat_queue.push(message);
1266         } else {
1267                 infostream << "Could not queue chat message because maximum out chat queue size ("
1268                                 << max_queue_size << ") is reached." << std::endl;
1269         }
1270 }
1271
1272 void Client::clearOutChatQueue()
1273 {
1274         m_out_chat_queue = std::queue<std::wstring>();
1275 }
1276
1277 void Client::sendChangePassword(const std::string &oldpassword,
1278         const std::string &newpassword)
1279 {
1280         LocalPlayer *player = m_env.getLocalPlayer();
1281         if (player == NULL)
1282                 return;
1283
1284         // get into sudo mode and then send new password to server
1285         m_password = oldpassword;
1286         m_new_password = newpassword;
1287         startAuth(choseAuthMech(m_sudo_auth_methods));
1288 }
1289
1290
1291 void Client::sendDamage(u16 damage)
1292 {
1293         NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1294         pkt << damage;
1295         Send(&pkt);
1296 }
1297
1298 void Client::sendRespawn()
1299 {
1300         NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1301         Send(&pkt);
1302 }
1303
1304 void Client::sendReady()
1305 {
1306         NetworkPacket pkt(TOSERVER_CLIENT_READY,
1307                         1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1308
1309         pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1310                 << (u8) 0 << (u16) strlen(g_version_hash);
1311
1312         pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1313         pkt << (u16)FORMSPEC_API_VERSION;
1314         Send(&pkt);
1315 }
1316
1317 void Client::sendPlayerPos(v3f pos)
1318 {
1319         LocalPlayer *player = m_env.getLocalPlayer();
1320         if (!player)
1321                 return;
1322
1323         // Save bandwidth by only updating position when
1324         // player is not dead and something changed
1325
1326         if (m_activeobjects_received && player->isDead())
1327                 return;
1328
1329         ClientMap &map = m_env.getClientMap();
1330         u8 camera_fov   = map.getCameraFov();
1331         u8 wanted_range = map.getControl().wanted_range;
1332
1333         u32 keyPressed = player->control.getKeysPressed();
1334
1335         if (
1336                         player->last_position     == pos &&
1337                         player->last_speed        == player->getSendSpeed()    &&
1338                         player->last_pitch        == player->getPitch()    &&
1339                         player->last_yaw          == player->getYaw()      &&
1340                         player->last_keyPressed   == keyPressed            &&
1341                         player->last_camera_fov   == camera_fov            &&
1342                         player->last_wanted_range == wanted_range)
1343                 return;
1344
1345         player->last_position     = pos;
1346         player->last_speed        = player->getSendSpeed();
1347         player->last_pitch        = player->getPitch();
1348         player->last_yaw          = player->getYaw();
1349         player->last_keyPressed   = keyPressed;
1350         player->last_camera_fov   = camera_fov;
1351         player->last_wanted_range = wanted_range;
1352
1353         NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1354
1355         writePlayerPos(player, &map, &pkt);
1356
1357         Send(&pkt);
1358 }
1359
1360 void Client::sendPlayerPos()
1361 {
1362         LocalPlayer *player = m_env.getLocalPlayer();
1363         if (!player)
1364                 return;
1365         sendPlayerPos(player->getLegitPosition());
1366 }
1367
1368 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1369 {
1370         NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1371
1372         sanity_check(tokens.size() < 256);
1373
1374         pkt << static_cast<u8>(tokens.size());
1375         for (u32 token : tokens)
1376                 pkt << token;
1377
1378         Send(&pkt);
1379 }
1380
1381 void Client::removeNode(v3s16 p)
1382 {
1383         std::map<v3s16, MapBlock*> modified_blocks;
1384
1385         try {
1386                 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1387         }
1388         catch(InvalidPositionException &e) {
1389         }
1390
1391         for (const auto &modified_block : modified_blocks) {
1392                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1393         }
1394 }
1395
1396 /**
1397  * Helper function for Client Side Modding
1398  * CSM restrictions are applied there, this should not be used for core engine
1399  * @param p
1400  * @param is_valid_position
1401  * @return
1402  */
1403 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1404 {
1405         if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1406                 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1407                 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1408                         *is_valid_position = false;
1409                         return {};
1410                 }
1411         }
1412         return m_env.getMap().getNode(p, is_valid_position);
1413 }
1414
1415 int Client::CSMClampRadius(v3s16 pos, int radius)
1416 {
1417         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1418                 return radius;
1419         // This is approximate and will cause some allowed nodes to be excluded
1420         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1421         u32 distance = ppos.getDistanceFrom(pos);
1422         if (distance >= m_csm_restriction_noderange)
1423                 return 0;
1424         return std::min<int>(radius, m_csm_restriction_noderange - distance);
1425 }
1426
1427 v3s16 Client::CSMClampPos(v3s16 pos)
1428 {
1429         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1430                 return pos;
1431         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1432         const int range = m_csm_restriction_noderange;
1433         return v3s16(
1434                 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1435                 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1436                 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1437         );
1438 }
1439
1440 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1441 {
1442         //TimeTaker timer1("Client::addNode()");
1443
1444         std::map<v3s16, MapBlock*> modified_blocks;
1445
1446         try {
1447                 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1448                 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1449         }
1450         catch(InvalidPositionException &e) {
1451         }
1452
1453         for (const auto &modified_block : modified_blocks) {
1454                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1455         }
1456 }
1457
1458 void Client::setPlayerControl(PlayerControl &control)
1459 {
1460         LocalPlayer *player = m_env.getLocalPlayer();
1461         assert(player);
1462         player->control = control;
1463 }
1464
1465 void Client::setPlayerItem(u16 item)
1466 {
1467         m_env.getLocalPlayer()->setWieldIndex(item);
1468         m_update_wielded_item = true;
1469
1470         NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1471         pkt << item;
1472         Send(&pkt);
1473 }
1474
1475 // Returns true once after the inventory of the local player
1476 // has been updated from the server.
1477 bool Client::updateWieldedItem()
1478 {
1479         if (!m_update_wielded_item)
1480                 return false;
1481
1482         m_update_wielded_item = false;
1483
1484         LocalPlayer *player = m_env.getLocalPlayer();
1485         assert(player);
1486         if (auto *list = player->inventory.getList("main"))
1487                 list->setModified(false);
1488         if (auto *list = player->inventory.getList("hand"))
1489                 list->setModified(false);
1490
1491         return true;
1492 }
1493
1494 scene::ISceneManager* Client::getSceneManager()
1495 {
1496         return m_rendering_engine->get_scene_manager();
1497 }
1498
1499 Inventory* Client::getInventory(const InventoryLocation &loc)
1500 {
1501         switch(loc.type){
1502         case InventoryLocation::UNDEFINED:
1503         {}
1504         break;
1505         case InventoryLocation::PLAYER:
1506         case InventoryLocation::CURRENT_PLAYER:
1507         {
1508                 LocalPlayer *player = m_env.getLocalPlayer();
1509                 assert(player);
1510                 return &player->inventory;
1511         }
1512         break;
1513         case InventoryLocation::NODEMETA:
1514         {
1515                 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1516                 if(!meta)
1517                         return NULL;
1518                 return meta->getInventory();
1519         }
1520         break;
1521         case InventoryLocation::DETACHED:
1522         {
1523                 if (m_detached_inventories.count(loc.name) == 0)
1524                         return NULL;
1525                 return m_detached_inventories[loc.name];
1526         }
1527         break;
1528         default:
1529                 FATAL_ERROR("Invalid inventory location type.");
1530                 break;
1531         }
1532         return NULL;
1533 }
1534
1535 void Client::inventoryAction(InventoryAction *a)
1536 {
1537         /*
1538                 Send it to the server
1539         */
1540         sendInventoryAction(a);
1541
1542         /*
1543                 Predict some local inventory changes
1544         */
1545         a->clientApply(this, this);
1546
1547         // Remove it
1548         delete a;
1549 }
1550
1551 float Client::getAnimationTime()
1552 {
1553         return m_animation_time;
1554 }
1555
1556 int Client::getCrackLevel()
1557 {
1558         return m_crack_level;
1559 }
1560
1561 v3s16 Client::getCrackPos()
1562 {
1563         return m_crack_pos;
1564 }
1565
1566 void Client::setCrack(int level, v3s16 pos)
1567 {
1568         int old_crack_level = m_crack_level;
1569         v3s16 old_crack_pos = m_crack_pos;
1570
1571         m_crack_level = level;
1572         m_crack_pos = pos;
1573
1574         if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1575         {
1576                 // remove old crack
1577                 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1578         }
1579         if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1580         {
1581                 // add new crack
1582                 addUpdateMeshTaskForNode(pos, false, true);
1583         }
1584 }
1585
1586 u16 Client::getHP()
1587 {
1588         LocalPlayer *player = m_env.getLocalPlayer();
1589         assert(player);
1590         return player->hp;
1591 }
1592
1593 bool Client::getChatMessage(std::wstring &res)
1594 {
1595         if (m_chat_queue.empty())
1596                 return false;
1597
1598         ChatMessage *chatMessage = m_chat_queue.front();
1599         m_chat_queue.pop();
1600
1601         res = L"";
1602
1603         switch (chatMessage->type) {
1604                 case CHATMESSAGE_TYPE_RAW:
1605                 case CHATMESSAGE_TYPE_ANNOUNCE:
1606                 case CHATMESSAGE_TYPE_SYSTEM:
1607                         res = chatMessage->message;
1608                         break;
1609                 case CHATMESSAGE_TYPE_NORMAL: {
1610                         if (!chatMessage->sender.empty())
1611                                 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1612                         else
1613                                 res = chatMessage->message;
1614                         break;
1615                 }
1616                 default:
1617                         break;
1618         }
1619
1620         delete chatMessage;
1621         return true;
1622 }
1623
1624 void Client::typeChatMessage(const std::wstring &message)
1625 {
1626         // Discard empty line
1627         if (message.empty())
1628                 return;
1629
1630         // If message was consumed by script API, don't send it to server
1631         if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1632                 return;
1633
1634         // Send to others
1635         sendChatMessage(message);
1636 }
1637
1638 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1639 {
1640         // Check if the block exists to begin with. In the case when a non-existing
1641         // neighbor is automatically added, it may not. In that case we don't want
1642         // to tell the mesh update thread about it.
1643         MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1644         if (b == NULL)
1645                 return;
1646
1647         m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1648 }
1649
1650 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1651 {
1652         m_mesh_update_thread.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1653 }
1654
1655 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1656 {
1657         {
1658                 v3s16 p = nodepos;
1659                 infostream<<"Client::addUpdateMeshTaskForNode(): "
1660                                 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1661                                 <<std::endl;
1662         }
1663
1664         v3s16 blockpos = getNodeBlockPos(nodepos);
1665         v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1666         m_mesh_update_thread.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1667         // Leading edge
1668         if (nodepos.X == blockpos_relative.X)
1669                 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1670         if (nodepos.Y == blockpos_relative.Y)
1671                 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1672         if (nodepos.Z == blockpos_relative.Z)
1673                 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1674 }
1675
1676 void Client::updateAllMapBlocks()
1677 {
1678         v3s16 currentBlock = getNodeBlockPos(floatToInt(m_env.getLocalPlayer()->getPosition(), BS));
1679
1680         for (s16 X = currentBlock.X - 2; X <= currentBlock.X + 2; X++)
1681         for (s16 Y = currentBlock.Y - 2; Y <= currentBlock.Y + 2; Y++)
1682         for (s16 Z = currentBlock.Z - 2; Z <= currentBlock.Z + 2; Z++)
1683                 addUpdateMeshTask(v3s16(X, Y, Z), false, true);
1684
1685         Map &map = m_env.getMap();
1686
1687         std::vector<v3s16> positions;
1688         map.listAllLoadedBlocks(positions);
1689
1690         for (v3s16 p : positions) {
1691                 addUpdateMeshTask(p, false, false);
1692         }
1693 }
1694
1695 ClientEvent *Client::getClientEvent()
1696 {
1697         FATAL_ERROR_IF(m_client_event_queue.empty(),
1698                         "Cannot getClientEvent, queue is empty.");
1699
1700         ClientEvent *event = m_client_event_queue.front();
1701         m_client_event_queue.pop();
1702         return event;
1703 }
1704
1705 const Address Client::getServerAddress()
1706 {
1707         return m_con->GetPeerAddress(PEER_ID_SERVER);
1708 }
1709
1710 float Client::mediaReceiveProgress()
1711 {
1712         if (m_media_downloader)
1713                 return m_media_downloader->getProgress();
1714
1715         return 1.0; // downloader only exists when not yet done
1716 }
1717
1718 struct TextureUpdateArgs {
1719         gui::IGUIEnvironment *guienv;
1720         u64 last_time_ms;
1721         u16 last_percent;
1722         const wchar_t* text_base;
1723         ITextureSource *tsrc;
1724 };
1725
1726 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1727 {
1728                 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1729                 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1730
1731                 // update the loading menu -- if neccessary
1732                 bool do_draw = false;
1733                 u64 time_ms = targs->last_time_ms;
1734                 if (cur_percent != targs->last_percent) {
1735                         targs->last_percent = cur_percent;
1736                         time_ms = porting::getTimeMs();
1737                         // only draw when the user will notice something:
1738                         do_draw = (time_ms - targs->last_time_ms > 100);
1739                 }
1740
1741                 if (do_draw) {
1742                         targs->last_time_ms = time_ms;
1743                         std::wostringstream strm;
1744                         strm << targs->text_base << L" " << targs->last_percent << L"%...";
1745                         m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1746                                 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1747                 }
1748 }
1749
1750 void Client::afterContentReceived()
1751 {
1752         infostream<<"Client::afterContentReceived() started"<<std::endl;
1753         assert(m_itemdef_received); // pre-condition
1754         assert(m_nodedef_received); // pre-condition
1755         assert(mediaReceived()); // pre-condition
1756
1757         const wchar_t* text = wgettext("Loading textures...");
1758
1759         // Clear cached pre-scaled 2D GUI images, as this cache
1760         // might have images with the same name but different
1761         // content from previous sessions.
1762         guiScalingCacheClear();
1763
1764         // Rebuild inherited images and recreate textures
1765         infostream<<"- Rebuilding images and textures"<<std::endl;
1766         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1767         m_tsrc->rebuildImagesAndTextures();
1768         delete[] text;
1769
1770         // Rebuild shaders
1771         infostream<<"- Rebuilding shaders"<<std::endl;
1772         text = wgettext("Rebuilding shaders...");
1773         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1774         m_shsrc->rebuildShaders();
1775         delete[] text;
1776
1777         // Update node aliases
1778         infostream<<"- Updating node aliases"<<std::endl;
1779         text = wgettext("Initializing nodes...");
1780         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1781         m_nodedef->updateAliases(m_itemdef);
1782         for (const auto &path : getTextureDirs()) {
1783                 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1784                 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1785                 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1786         }
1787         m_nodedef->setNodeRegistrationStatus(true);
1788         m_nodedef->runNodeResolveCallbacks();
1789         delete[] text;
1790
1791         // Update node textures and assign shaders to each tile
1792         infostream<<"- Updating node textures"<<std::endl;
1793         TextureUpdateArgs tu_args;
1794         tu_args.guienv = guienv;
1795         tu_args.last_time_ms = porting::getTimeMs();
1796         tu_args.last_percent = 0;
1797         tu_args.text_base = wgettext("Initializing nodes");
1798         tu_args.tsrc = m_tsrc;
1799         m_nodedef->updateTextures(this, &tu_args);
1800         delete[] tu_args.text_base;
1801
1802         // Start mesh update thread after setting up content definitions
1803         infostream<<"- Starting mesh update thread"<<std::endl;
1804         m_mesh_update_thread.start();
1805
1806         m_state = LC_Ready;
1807         sendReady();
1808
1809         if (m_mods_loaded)
1810                 m_script->on_client_ready(m_env.getLocalPlayer());
1811
1812         text = wgettext("Done!");
1813         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1814         infostream<<"Client::afterContentReceived() done"<<std::endl;
1815         delete[] text;
1816 }
1817
1818 float Client::getRTT()
1819 {
1820         return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1821 }
1822
1823 float Client::getCurRate()
1824 {
1825         return (m_con->getLocalStat(con::CUR_INC_RATE) +
1826                         m_con->getLocalStat(con::CUR_DL_RATE));
1827 }
1828
1829 void Client::makeScreenshot()
1830 {
1831         irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1832         irr::video::IImage* const raw_image = driver->createScreenShot();
1833
1834         if (!raw_image)
1835                 return;
1836
1837         const struct tm tm = mt_localtime();
1838
1839         char timetstamp_c[64];
1840         strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1841
1842         std::string screenshot_dir;
1843
1844         if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1845                 screenshot_dir = g_settings->get("screenshot_path");
1846         else
1847                 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1848
1849         std::string filename_base = screenshot_dir
1850                         + DIR_DELIM
1851                         + std::string("screenshot_")
1852                         + std::string(timetstamp_c);
1853         std::string filename_ext = "." + g_settings->get("screenshot_format");
1854         std::string filename;
1855
1856         // Create the directory if it doesn't already exist.
1857         // Otherwise, saving the screenshot would fail.
1858         fs::CreateDir(screenshot_dir);
1859
1860         u32 quality = (u32)g_settings->getS32("screenshot_quality");
1861         quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1862
1863         // Try to find a unique filename
1864         unsigned serial = 0;
1865
1866         while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1867                 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1868                 std::ifstream tmp(filename.c_str());
1869                 if (!tmp.good())
1870                         break;  // File did not apparently exist, we'll go with it
1871                 serial++;
1872         }
1873
1874         if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1875                 infostream << "Could not find suitable filename for screenshot" << std::endl;
1876         } else {
1877                 irr::video::IImage* const image =
1878                                 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1879
1880                 if (image) {
1881                         raw_image->copyTo(image);
1882
1883                         std::ostringstream sstr;
1884                         if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1885                                 sstr << "Saved screenshot to '" << filename << "'";
1886                         } else {
1887                                 sstr << "Failed to save screenshot '" << filename << "'";
1888                         }
1889                         pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1890                                         utf8_to_wide(sstr.str())));
1891                         infostream << sstr.str() << std::endl;
1892                         image->drop();
1893                 }
1894         }
1895
1896         raw_image->drop();
1897 }
1898
1899 bool Client::shouldShowMinimap() const
1900 {
1901         return !m_minimap_disabled_by_server;
1902 }
1903
1904 void Client::pushToEventQueue(ClientEvent *event)
1905 {
1906         m_client_event_queue.push(event);
1907 }
1908
1909 void Client::showMinimap(const bool show)
1910 {
1911         m_game_ui->showMinimap(show);
1912 }
1913
1914 // IGameDef interface
1915 // Under envlock
1916 IItemDefManager* Client::getItemDefManager()
1917 {
1918         return m_itemdef;
1919 }
1920 IWritableItemDefManager* Client::getWritableItemDefManager()
1921 {
1922         return m_itemdef;
1923 }
1924 const NodeDefManager* Client::getNodeDefManager()
1925 {
1926         return m_nodedef;
1927 }
1928 NodeDefManager* Client::getWritableNodeDefManager()
1929 {
1930         return m_nodedef;
1931 }
1932 ICraftDefManager* Client::getCraftDefManager()
1933 {
1934         return NULL;
1935         //return m_craftdef;
1936 }
1937 ITextureSource* Client::getTextureSource()
1938 {
1939         return m_tsrc;
1940 }
1941 IWritableShaderSource* Client::getShaderSource()
1942 {
1943         return m_shsrc;
1944 }
1945
1946 u16 Client::allocateUnknownNodeId(const std::string &name)
1947 {
1948         errorstream << "Client::allocateUnknownNodeId(): "
1949                         << "Client cannot allocate node IDs" << std::endl;
1950         FATAL_ERROR("Client allocated unknown node");
1951
1952         return CONTENT_IGNORE;
1953 }
1954 ISoundManager* Client::getSoundManager()
1955 {
1956         return m_sound;
1957 }
1958 MtEventManager* Client::getEventManager()
1959 {
1960         return m_event;
1961 }
1962
1963 ParticleManager* Client::getParticleManager()
1964 {
1965         return &m_particle_manager;
1966 }
1967
1968 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1969 {
1970         StringMap::const_iterator it = m_mesh_data.find(filename);
1971         if (it == m_mesh_data.end()) {
1972                 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1973                         << "\"" << std::endl;
1974                 return NULL;
1975         }
1976         const std::string &data    = it->second;
1977
1978         // Create the mesh, remove it from cache and return it
1979         // This allows unique vertex colors and other properties for each instance
1980         io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1981                         data.c_str(), data.size(), filename.c_str());
1982         FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1983
1984         scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
1985         rfile->drop();
1986         if (!mesh)
1987                 return nullptr;
1988         mesh->grab();
1989         if (!cache)
1990                 m_rendering_engine->removeMesh(mesh);
1991         return mesh;
1992 }
1993
1994 const std::string* Client::getModFile(std::string filename)
1995 {
1996         // strip dir delimiter from beginning of path
1997         auto pos = filename.find_first_of(':');
1998         if (pos == std::string::npos)
1999                 return nullptr;
2000         pos++;
2001         auto pos2 = filename.find_first_not_of('/', pos);
2002         if (pos2 > pos)
2003                 filename.erase(pos, pos2 - pos);
2004
2005         StringMap::const_iterator it = m_mod_vfs.find(filename);
2006         if (it == m_mod_vfs.end())
2007                 return nullptr;
2008         return &it->second;
2009 }
2010
2011 bool Client::registerModStorage(ModMetadata *storage)
2012 {
2013         if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
2014                 errorstream << "Unable to register same mod storage twice. Storage name: "
2015                                 << storage->getModName() << std::endl;
2016                 return false;
2017         }
2018
2019         m_mod_storages[storage->getModName()] = storage;
2020         return true;
2021 }
2022
2023 void Client::unregisterModStorage(const std::string &name)
2024 {
2025         std::unordered_map<std::string, ModMetadata *>::const_iterator it =
2026                 m_mod_storages.find(name);
2027         if (it != m_mod_storages.end())
2028                 m_mod_storages.erase(name);
2029 }
2030
2031 /*
2032  * Mod channels
2033  */
2034
2035 bool Client::joinModChannel(const std::string &channel)
2036 {
2037         if (m_modchannel_mgr->channelRegistered(channel))
2038                 return false;
2039
2040         NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2041         pkt << channel;
2042         Send(&pkt);
2043
2044         m_modchannel_mgr->joinChannel(channel, 0);
2045         return true;
2046 }
2047
2048 bool Client::leaveModChannel(const std::string &channel)
2049 {
2050         if (!m_modchannel_mgr->channelRegistered(channel))
2051                 return false;
2052
2053         NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2054         pkt << channel;
2055         Send(&pkt);
2056
2057         m_modchannel_mgr->leaveChannel(channel, 0);
2058         return true;
2059 }
2060
2061 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2062 {
2063         if (!m_modchannel_mgr->canWriteOnChannel(channel))
2064                 return false;
2065
2066         if (message.size() > STRING_MAX_LEN) {
2067                 warningstream << "ModChannel message too long, dropping before sending "
2068                                 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2069                                 << channel << ")" << std::endl;
2070                 return false;
2071         }
2072
2073         // @TODO: do some client rate limiting
2074         NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2075         pkt << channel << message;
2076         Send(&pkt);
2077         return true;
2078 }
2079
2080 ModChannel* Client::getModChannel(const std::string &channel)
2081 {
2082         return m_modchannel_mgr->getModChannel(channel);
2083 }