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                 bool force_update_shadows = false;
 537                 while (!m_mesh_update_thread.m_queue_out.empty())
 538                 {
 539                         num_processed_meshes++;
 540
 541                         MinimapMapblock *minimap_mapblock = NULL;
 542                         bool do_mapper_update = true;
 543
 544                         MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
 545                         MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
 546                         if (block) {
 547                                 // Delete the old mesh
 548                                 delete block->mesh;
 549                                 block->mesh = nullptr;
 550
 551                                 if (r.mesh) {
 552                                         minimap_mapblock = r.mesh->moveMinimapMapblock();
 553                                         if (minimap_mapblock == NULL)
 554                                                 do_mapper_update = false;
 555
 556                                         bool is_empty = true;
 557                                         for (int l = 0; l < MAX_TILE_LAYERS; l++)
 558                                                 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
 559                                                         is_empty = false;
 560
 561                                         if (is_empty)
 562                                                 delete r.mesh;
 563                                         else {
 564                                                 // Replace with the new mesh
 565                                                 block->mesh = r.mesh;
 566                                                 force_update_shadows = true;
 567                                         }
 568                                 }
 569                         } else {
 570                                 delete r.mesh;
 571                         }
 572
 573                         if (m_minimap && do_mapper_update)
 574                                 m_minimap->addBlock(r.p, minimap_mapblock);
 575
 576                         if (r.ack_block_to_server) {
 577                                 if (blocks_to_ack.size() == 255) {
 578                                         sendGotBlocks(blocks_to_ack);
 579                                         blocks_to_ack.clear();
 580                                 }
 581
 582                                 blocks_to_ack.emplace_back(r.p);
 583                         }
 584                 }
 585                 if (blocks_to_ack.size() > 0) {
 586                                 // Acknowledge block(s)
 587                                 sendGotBlocks(blocks_to_ack);
 588                 }
 589
 590                 if (num_processed_meshes > 0)
 591                         g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
 592
 593                 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
 594                 if (shadow_renderer && force_update_shadows)
 595                         shadow_renderer->setForceUpdateShadowMap();
 596         }
 597
 598         /*
 599                 Load fetched media
 600         */
 601         if (m_media_downloader && m_media_downloader->isStarted()) {
 602                 m_media_downloader->step(this);
 603                 if (m_media_downloader->isDone()) {
 604                         delete m_media_downloader;
 605                         m_media_downloader = NULL;
 606                 }
 607         }
 608         {
 609                 // Acknowledge dynamic media downloads to server
 610                 std::vector<u32> done;
 611                 for (auto it = m_pending_media_downloads.begin();
 612                                 it != m_pending_media_downloads.end();) {
 613                         assert(it->second->isStarted());
 614                         it->second->step(this);
 615                         if (it->second->isDone()) {
 616                                 done.emplace_back(it->first);
 617
 618                                 it = m_pending_media_downloads.erase(it);
 619                         } else {
 620                                 it++;
 621                         }
 622
 623                         if (done.size() == 255) { // maximum in one packet
 624                                 sendHaveMedia(done);
 625                                 done.clear();
 626                         }
 627                 }
 628                 if (!done.empty())
 629                         sendHaveMedia(done);
 630         }
 631
 632         /*
 633                 If the server didn't update the inventory in a while, revert
 634                 the local inventory (so the player notices the lag problem
 635                 and knows something is wrong).
 636         */
 637         if (m_inventory_from_server) {
 638                 float interval = 10.0f;
 639                 float count_before = std::floor(m_inventory_from_server_age / interval);
 640
 641                 m_inventory_from_server_age += dtime;
 642
 643                 float count_after = std::floor(m_inventory_from_server_age / interval);
 644
 645                 if (count_after != count_before) {
 646                         // Do this every <interval> seconds after TOCLIENT_INVENTORY
 647                         // Reset the locally changed inventory to the authoritative inventory
 648                         player->inventory = *m_inventory_from_server;
 649                         m_update_wielded_item = true;
 650                 }
 651         }
 652
 653         /*
 654                 Update positions of sounds attached to objects
 655         */
 656         {
 657                 for (auto &m_sounds_to_object : m_sounds_to_objects) {
 658                         int client_id = m_sounds_to_object.first;
 659                         u16 object_id = m_sounds_to_object.second;
 660                         ClientActiveObject *cao = m_env.getActiveObject(object_id);
 661                         if (!cao)
 662                                 continue;
 663                         m_sound->updateSoundPosition(client_id, cao->getPosition());
 664                 }
 665         }
 666
 667         /*
 668                 Handle removed remotely initiated sounds
 669         */
 670         m_removed_sounds_check_timer += dtime;
 671         if(m_removed_sounds_check_timer >= 2.32) {
 672                 m_removed_sounds_check_timer = 0;
 673                 // Find removed sounds and clear references to them
 674                 std::vector<s32> removed_server_ids;
 675                 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
 676                                 i != m_sounds_server_to_client.end();) {
 677                         s32 server_id = i->first;
 678                         int client_id = i->second;
 679                         ++i;
 680                         if(!m_sound->soundExists(client_id)) {
 681                                 m_sounds_server_to_client.erase(server_id);
 682                                 m_sounds_client_to_server.erase(client_id);
 683                                 m_sounds_to_objects.erase(client_id);
 684                                 removed_server_ids.push_back(server_id);
 685                         }
 686                 }
 687
 688                 // Sync to server
 689                 if(!removed_server_ids.empty()) {
 690                         sendRemovedSounds(removed_server_ids);
 691                 }
 692         }
 693
 694         // Write changes to the mod storage
 695         m_mod_storage_save_timer -= dtime;
 696         if (m_mod_storage_save_timer <= 0.0f) {
 697                 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
 698                 m_mod_storage_database->endSave();
 699                 m_mod_storage_database->beginSave();
 700         }
 701
 702         // Write server map
 703         if (m_localdb && m_localdb_save_interval.step(dtime,
 704                         m_cache_save_interval)) {
 705                 m_localdb->endSave();
 706                 m_localdb->beginSave();
 707         }
 708 }
 709
 710 bool Client::loadMedia(const std::string &data, const std::string &filename,
 711         bool from_media_push)
 712 {
 713         std::string name;
 714
 715         const char *image_ext[] = {
 716                 ".png", ".jpg", ".bmp", ".tga",
 717                 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
 718                 NULL
 719         };
 720         name = removeStringEnd(filename, image_ext);
 721         if (!name.empty()) {
 722                 TRACESTREAM(<< "Client: Attempting to load image "
 723                         << "file \"" << filename << "\"" << std::endl);
 724
 725                 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
 726                 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
 727
 728                 io::IReadFile *rfile = irrfs->createMemoryReadFile(
 729                                 data.c_str(), data.size(), "_tempreadfile");
 730
 731                 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
 732
 733                 // Read image
 734                 video::IImage *img = vdrv->createImageFromFile(rfile);
 735                 if (!img) {
 736                         errorstream<<"Client: Cannot create image from data of "
 737                                         <<"file \""<<filename<<"\""<<std::endl;
 738                         rfile->drop();
 739                         return false;
 740                 }
 741
 742                 m_tsrc->insertSourceImage(filename, img);
 743                 img->drop();
 744                 rfile->drop();
 745                 return true;
 746         }
 747
 748         const char *sound_ext[] = {
 749                 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
 750                 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
 751                 ".ogg", NULL
 752         };
 753         name = removeStringEnd(filename, sound_ext);
 754         if (!name.empty()) {
 755                 TRACESTREAM(<< "Client: Attempting to load sound "
 756                         << "file \"" << filename << "\"" << std::endl);
 757                 return m_sound->loadSoundData(name, data);
 758         }
 759
 760         const char *model_ext[] = {
 761                 ".x", ".b3d", ".md2", ".obj",
 762                 NULL
 763         };
 764         name = removeStringEnd(filename, model_ext);
 765         if (!name.empty()) {
 766                 verbosestream<<"Client: Storing model into memory: "
 767                                 <<"\""<<filename<<"\""<<std::endl;
 768                 if(m_mesh_data.count(filename))
 769                         errorstream<<"Multiple models with name \""<<filename.c_str()
 770                                         <<"\" found; replacing previous model"<<std::endl;
 771                 m_mesh_data[filename] = data;
 772                 return true;
 773         }
 774
 775         const char *translate_ext[] = {
 776                 ".tr", NULL
 777         };
 778         name = removeStringEnd(filename, translate_ext);
 779         if (!name.empty()) {
 780                 if (from_media_push)
 781                         return false;
 782                 TRACESTREAM(<< "Client: Loading translation: "
 783                                 << "\"" << filename << "\"" << std::endl);
 784                 g_client_translations->loadTranslation(data);
 785                 return true;
 786         }
 787
 788         errorstream << "Client: Don't know how to load file \""
 789                 << filename << "\"" << std::endl;
 790         return false;
 791 }
 792
 793 // Virtual methods from con::PeerHandler
 794 void Client::peerAdded(con::Peer *peer)
 795 {
 796         infostream << "Client::peerAdded(): peer->id="
 797                         << peer->id << std::endl;
 798 }
 799
 800 void Client::deletingPeer(con::Peer *peer, bool timeout)
 801 {
 802         infostream << "Client::deletingPeer(): "
 803                         "Server Peer is getting deleted "
 804                         << "(timeout=" << timeout << ")" << std::endl;
 805
 806         m_access_denied = true;
 807         if (timeout)
 808                 m_access_denied_reason = gettext("Connection timed out.");
 809         else if (m_access_denied_reason.empty())
 810                 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
 811 }
 812
 813 /*
 814         u16 command
 815         u16 number of files requested
 816         for each file {
 817                 u16 length of name
 818                 string name
 819         }
 820 */
 821 void Client::request_media(const std::vector<std::string> &file_requests)
 822 {
 823         std::ostringstream os(std::ios_base::binary);
 824         writeU16(os, TOSERVER_REQUEST_MEDIA);
 825         size_t file_requests_size = file_requests.size();
 826
 827         FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
 828
 829         // Packet dynamicly resized
 830         NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
 831
 832         pkt << (u16) (file_requests_size & 0xFFFF);
 833
 834         for (const std::string &file_request : file_requests) {
 835                 pkt << file_request;
 836         }
 837
 838         Send(&pkt);
 839
 840         infostream << "Client: Sending media request list to server ("
 841                         << file_requests.size() << " files, packet size "
 842                         << pkt.getSize() << ")" << std::endl;
 843 }
 844
 845 void Client::initLocalMapSaving(const Address &address,
 846                 const std::string &hostname,
 847                 bool is_local_server)
 848 {
 849         if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
 850                 return;
 851         }
 852
 853         std::string world_path;
 854 #define set_world_path(hostname) \
 855         world_path = porting::path_user \
 856                 + DIR_DELIM + "worlds" \
 857                 + DIR_DELIM + "server_" \
 858                 + hostname + "_" + std::to_string(address.getPort());
 859
 860         set_world_path(hostname);
 861         if (!fs::IsDir(world_path)) {
 862                 std::string hostname_escaped = hostname;
 863                 str_replace(hostname_escaped, ':', '_');
 864                 set_world_path(hostname_escaped);
 865         }
 866 #undef set_world_path
 867         fs::CreateAllDirs(world_path);
 868
 869         m_localdb = new MapDatabaseSQLite3(world_path);
 870         m_localdb->beginSave();
 871         actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
 872 }
 873
 874 void Client::ReceiveAll()
 875 {
 876         NetworkPacket pkt;
 877         u64 start_ms = porting::getTimeMs();
 878         const u64 budget = 100;
 879         for(;;) {
 880                 // Limit time even if there would be huge amounts of data to
 881                 // process
 882                 if (porting::getTimeMs() > start_ms + budget) {
 883                         infostream << "Client::ReceiveAll(): "
 884                                         "Packet processing budget exceeded." << std::endl;
 885                         break;
 886                 }
 887
 888                 pkt.clear();
 889                 try {
 890                         if (!m_con->TryReceive(&pkt))
 891                                 break;
 892                         ProcessData(&pkt);
 893                 } catch (const con::InvalidIncomingDataException &e) {
 894                         infostream << "Client::ReceiveAll(): "
 895                                         "InvalidIncomingDataException: what()="
 896                                          << e.what() << std::endl;
 897                 }
 898         }
 899 }
 900
 901 inline void Client::handleCommand(NetworkPacket* pkt)
 902 {
 903         const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
 904         (this->*opHandle.handler)(pkt);
 905 }
 906
 907 /*
 908         sender_peer_id given to this shall be quaranteed to be a valid peer
 909 */
 910 void Client::ProcessData(NetworkPacket *pkt)
 911 {
 912         ToClientCommand command = (ToClientCommand) pkt->getCommand();
 913         u32 sender_peer_id = pkt->getPeerId();
 914
 915         //infostream<<"Client: received command="<<command<<std::endl;
 916         m_packetcounter.add((u16)command);
 917         g_profiler->graphAdd("client_received_packets", 1);
 918
 919         /*
 920                 If this check is removed, be sure to change the queue
 921                 system to know the ids
 922         */
 923         if(sender_peer_id != PEER_ID_SERVER) {
 924                 infostream << "Client::ProcessData(): Discarding data not "
 925                         "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
 926                         << std::endl;
 927                 return;
 928         }
 929
 930         // Command must be handled into ToClientCommandHandler
 931         if (command >= TOCLIENT_NUM_MSG_TYPES) {
 932                 infostream << "Client: Ignoring unknown command "
 933                         << command << std::endl;
 934                 return;
 935         }
 936
 937         /*
 938          * Those packets are handled before m_server_ser_ver is set, it's normal
 939          * But we must use the new ToClientConnectionState in the future,
 940          * as a byte mask
 941          */
 942         if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
 943                 handleCommand(pkt);
 944                 return;
 945         }
 946
 947         if(m_server_ser_ver == SER_FMT_VER_INVALID) {
 948                 infostream << "Client: Server serialization"
 949                                 " format invalid or not initialized."
 950                                 " Skipping incoming command=" << command << std::endl;
 951                 return;
 952         }
 953
 954         /*
 955           Handle runtime commands
 956         */
 957
 958         handleCommand(pkt);
 959 }
 960
 961 void Client::Send(NetworkPacket* pkt)
 962 {
 963         m_con->Send(PEER_ID_SERVER,
 964                 serverCommandFactoryTable[pkt->getCommand()].channel,
 965                 pkt,
 966                 serverCommandFactoryTable[pkt->getCommand()].reliable);
 967 }
 968
 969 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
 970 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
 971 {
 972         v3f pf           = myplayer->getLegitPosition() * 100;
 973         v3f sf           = myplayer->getSendSpeed() * 100;
 974         s32 pitch        = myplayer->getPitch() * 100;
 975         s32 yaw          = myplayer->getYaw() * 100;
 976         u32 keyPressed   = myplayer->control.getKeysPressed();
 977         // scaled by 80, so that pi can fit into a u8
 978         u8 fov           = clientMap->getCameraFov() * 80;
 979         u8 wanted_range  = MYMIN(255,
 980                         std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
 981
 982         v3s32 position(pf.X, pf.Y, pf.Z);
 983         v3s32 speed(sf.X, sf.Y, sf.Z);
 984
 985         /*
 986                 Format:
 987                 [0] v3s32 position*100
 988                 [12] v3s32 speed*100
 989                 [12+12] s32 pitch*100
 990                 [12+12+4] s32 yaw*100
 991                 [12+12+4+4] u32 keyPressed
 992                 [12+12+4+4+4] u8 fov*80
 993                 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 994         */
 995         *pkt << position << speed << pitch << yaw << keyPressed;
 996         *pkt << fov << wanted_range;
 997 }
 998
 999 void Client::interact(InteractAction action, const PointedThing& pointed)
1000 {
1001         if(m_state != LC_Ready) {
1002                 errorstream << "Client::interact() "
1003                                 "Canceled (not connected)"
1004                                 << std::endl;
1005                 return;
1006         }
1007
1008         LocalPlayer *myplayer = m_env.getLocalPlayer();
1009         if (myplayer == NULL)
1010                 return;
1011
1012         /*
1013                 [0] u16 command
1014                 [2] u8 action
1015                 [3] u16 item
1016                 [5] u32 length of the next item (plen)
1017                 [9] serialized PointedThing
1018                 [9 + plen] player position information
1019         */
1020
1021         NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1022
1023         pkt << (u8)action;
1024         pkt << myplayer->getWieldIndex();
1025
1026         std::ostringstream tmp_os(std::ios::binary);
1027         pointed.serialize(tmp_os);
1028
1029         pkt.putLongString(tmp_os.str());
1030
1031         writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1032
1033         Send(&pkt);
1034 }
1035
1036 void Client::deleteAuthData()
1037 {
1038         if (!m_auth_data)
1039                 return;
1040
1041         switch (m_chosen_auth_mech) {
1042                 case AUTH_MECHANISM_FIRST_SRP:
1043                         break;
1044                 case AUTH_MECHANISM_SRP:
1045                 case AUTH_MECHANISM_LEGACY_PASSWORD:
1046                         srp_user_delete((SRPUser *) m_auth_data);
1047                         m_auth_data = NULL;
1048                         break;
1049                 case AUTH_MECHANISM_NONE:
1050                         break;
1051         }
1052         m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1053 }
1054
1055
1056 AuthMechanism Client::choseAuthMech(const u32 mechs)
1057 {
1058         if (mechs & AUTH_MECHANISM_SRP)
1059                 return AUTH_MECHANISM_SRP;
1060
1061         if (mechs & AUTH_MECHANISM_FIRST_SRP)
1062                 return AUTH_MECHANISM_FIRST_SRP;
1063
1064         if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1065                 return AUTH_MECHANISM_LEGACY_PASSWORD;
1066
1067         return AUTH_MECHANISM_NONE;
1068 }
1069
1070 void Client::sendInit(const std::string &playerName)
1071 {
1072         NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1073
1074         // we don't support network compression yet
1075         u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1076
1077         pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1078         pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1079         pkt << playerName;
1080
1081         Send(&pkt);
1082 }
1083
1084 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
1085 {
1086         m_chosen_auth_mech = chosen_auth_mechanism;
1087         m_is_registration_confirmation_state = true;
1088 }
1089
1090 void Client::confirmRegistration()
1091 {
1092         m_is_registration_confirmation_state = false;
1093         startAuth(m_chosen_auth_mech);
1094 }
1095
1096 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1097 {
1098         m_chosen_auth_mech = chosen_auth_mechanism;
1099
1100         switch (chosen_auth_mechanism) {
1101                 case AUTH_MECHANISM_FIRST_SRP: {
1102                         // send srp verifier to server
1103                         std::string verifier;
1104                         std::string salt;
1105                         generate_srp_verifier_and_salt(getPlayerName(), m_password,
1106                                 &verifier, &salt);
1107
1108                         NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1109                         resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1110
1111                         Send(&resp_pkt);
1112                         break;
1113                 }
1114                 case AUTH_MECHANISM_SRP:
1115                 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1116                         u8 based_on = 1;
1117
1118                         if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1119                                 m_password = translate_password(getPlayerName(), m_password);
1120                                 based_on = 0;
1121                         }
1122
1123                         std::string playername_u = lowercase(getPlayerName());
1124                         m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1125                                 getPlayerName().c_str(), playername_u.c_str(),
1126                                 (const unsigned char *) m_password.c_str(),
1127                                 m_password.length(), NULL, NULL);
1128                         char *bytes_A = 0;
1129                         size_t len_A = 0;
1130                         SRP_Result res = srp_user_start_authentication(
1131                                 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1132                                 (unsigned char **) &bytes_A, &len_A);
1133                         FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1134
1135                         NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1136                         resp_pkt << std::string(bytes_A, len_A) << based_on;
1137                         Send(&resp_pkt);
1138                         break;
1139                 }
1140                 case AUTH_MECHANISM_NONE:
1141                         break; // not handled in this method
1142         }
1143 }
1144
1145 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1146 {
1147         NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1148
1149         pkt << (u8) blocks.size();
1150
1151         for (const v3s16 &block : blocks) {
1152                 pkt << block;
1153         }
1154
1155         Send(&pkt);
1156 }
1157
1158 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1159 {
1160         NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1161         pkt << (u8) blocks.size();
1162         for (const v3s16 &block : blocks)
1163                 pkt << block;
1164
1165         Send(&pkt);
1166 }
1167
1168 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1169 {
1170         size_t server_ids = soundList.size();
1171         assert(server_ids <= 0xFFFF);
1172
1173         NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1174
1175         pkt << (u16) (server_ids & 0xFFFF);
1176
1177         for (s32 sound_id : soundList)
1178                 pkt << sound_id;
1179
1180         Send(&pkt);
1181 }
1182
1183 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1184                 const StringMap &fields)
1185 {
1186         size_t fields_size = fields.size();
1187
1188         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1189
1190         NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1191
1192         pkt << p << formname << (u16) (fields_size & 0xFFFF);
1193
1194         StringMap::const_iterator it;
1195         for (it = fields.begin(); it != fields.end(); ++it) {
1196                 const std::string &name = it->first;
1197                 const std::string &value = it->second;
1198                 pkt << name;
1199                 pkt.putLongString(value);
1200         }
1201
1202         Send(&pkt);
1203 }
1204
1205 void Client::sendInventoryFields(const std::string &formname,
1206                 const StringMap &fields)
1207 {
1208         size_t fields_size = fields.size();
1209         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1210
1211         NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1212         pkt << formname << (u16) (fields_size & 0xFFFF);
1213
1214         StringMap::const_iterator it;
1215         for (it = fields.begin(); it != fields.end(); ++it) {
1216                 const std::string &name  = it->first;
1217                 const std::string &value = it->second;
1218                 pkt << name;
1219                 pkt.putLongString(value);
1220         }
1221
1222         Send(&pkt);
1223 }
1224
1225 void Client::sendInventoryAction(InventoryAction *a)
1226 {
1227         std::ostringstream os(std::ios_base::binary);
1228
1229         a->serialize(os);
1230
1231         // Make data buffer
1232         std::string s = os.str();
1233
1234         NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1235         pkt.putRawString(s.c_str(),s.size());
1236
1237         Send(&pkt);
1238 }
1239
1240 bool Client::canSendChatMessage() const
1241 {
1242         u32 now = time(NULL);
1243         float time_passed = now - m_last_chat_message_sent;
1244
1245         float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1246                         (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1247
1248         if (virt_chat_message_allowance < 1.0f)
1249                 return false;
1250
1251         return true;
1252 }
1253
1254 void Client::sendChatMessage(const std::wstring &message)
1255 {
1256         const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1257         if (canSendChatMessage()) {
1258                 u32 now = time(NULL);
1259                 float time_passed = now - m_last_chat_message_sent;
1260                 m_last_chat_message_sent = now;
1261
1262                 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1263                 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1264                         m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1265
1266                 m_chat_message_allowance -= 1.0f;
1267
1268                 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1269
1270                 pkt << message;
1271
1272                 Send(&pkt);
1273         } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1274                 m_out_chat_queue.push(message);
1275         } else {
1276                 infostream << "Could not queue chat message because maximum out chat queue size ("
1277                                 << max_queue_size << ") is reached." << std::endl;
1278         }
1279 }
1280
1281 void Client::clearOutChatQueue()
1282 {
1283         m_out_chat_queue = std::queue<std::wstring>();
1284 }
1285
1286 void Client::sendChangePassword(const std::string &oldpassword,
1287         const std::string &newpassword)
1288 {
1289         LocalPlayer *player = m_env.getLocalPlayer();
1290         if (player == NULL)
1291                 return;
1292
1293         // get into sudo mode and then send new password to server
1294         m_password = oldpassword;
1295         m_new_password = newpassword;
1296         startAuth(choseAuthMech(m_sudo_auth_methods));
1297 }
1298
1299
1300 void Client::sendDamage(u16 damage)
1301 {
1302         NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1303         pkt << damage;
1304         Send(&pkt);
1305 }
1306
1307 void Client::sendRespawn()
1308 {
1309         NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1310         Send(&pkt);
1311 }
1312
1313 void Client::sendReady()
1314 {
1315         NetworkPacket pkt(TOSERVER_CLIENT_READY,
1316                         1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1317
1318         pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1319                 << (u8) 0 << (u16) strlen(g_version_hash);
1320
1321         pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1322         pkt << (u16)FORMSPEC_API_VERSION;
1323         Send(&pkt);
1324 }
1325
1326 void Client::sendPlayerPos(v3f pos)
1327 {
1328         LocalPlayer *player = m_env.getLocalPlayer();
1329         if (!player)
1330                 return;
1331
1332         // Save bandwidth by only updating position when
1333         // player is not dead and something changed
1334
1335         if (m_activeobjects_received && player->isDead())
1336                 return;
1337
1338         ClientMap &map = m_env.getClientMap();
1339         u8 camera_fov   = map.getCameraFov();
1340         u8 wanted_range = map.getControl().wanted_range;
1341
1342         u32 keyPressed = player->control.getKeysPressed();
1343
1344         if (
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                 return;
1353
1354         player->last_position     = pos;
1355         player->last_speed        = player->getSendSpeed();
1356         player->last_pitch        = player->getPitch();
1357         player->last_yaw          = player->getYaw();
1358         player->last_keyPressed   = keyPressed;
1359         player->last_camera_fov   = camera_fov;
1360         player->last_wanted_range = wanted_range;
1361
1362         NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1363
1364         writePlayerPos(player, &map, &pkt);
1365
1366         Send(&pkt);
1367 }
1368
1369 void Client::sendPlayerPos()
1370 {
1371         LocalPlayer *player = m_env.getLocalPlayer();
1372         if (!player)
1373                 return;
1374         sendPlayerPos(player->getLegitPosition());
1375 }
1376
1377 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1378 {
1379         NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1380
1381         sanity_check(tokens.size() < 256);
1382
1383         pkt << static_cast<u8>(tokens.size());
1384         for (u32 token : tokens)
1385                 pkt << token;
1386
1387         Send(&pkt);
1388 }
1389
1390 void Client::removeNode(v3s16 p)
1391 {
1392         std::map<v3s16, MapBlock*> modified_blocks;
1393
1394         try {
1395                 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1396         }
1397         catch(InvalidPositionException &e) {
1398         }
1399
1400         for (const auto &modified_block : modified_blocks) {
1401                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1402         }
1403 }
1404
1405 /**
1406  * Helper function for Client Side Modding
1407  * CSM restrictions are applied there, this should not be used for core engine
1408  * @param p
1409  * @param is_valid_position
1410  * @return
1411  */
1412 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1413 {
1414         if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1415                 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1416                 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1417                         *is_valid_position = false;
1418                         return {};
1419                 }
1420         }
1421         return m_env.getMap().getNode(p, is_valid_position);
1422 }
1423
1424 int Client::CSMClampRadius(v3s16 pos, int radius)
1425 {
1426         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1427                 return radius;
1428         // This is approximate and will cause some allowed nodes to be excluded
1429         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1430         u32 distance = ppos.getDistanceFrom(pos);
1431         if (distance >= m_csm_restriction_noderange)
1432                 return 0;
1433         return std::min<int>(radius, m_csm_restriction_noderange - distance);
1434 }
1435
1436 v3s16 Client::CSMClampPos(v3s16 pos)
1437 {
1438         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1439                 return pos;
1440         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1441         const int range = m_csm_restriction_noderange;
1442         return v3s16(
1443                 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1444                 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1445                 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1446         );
1447 }
1448
1449 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1450 {
1451         //TimeTaker timer1("Client::addNode()");
1452
1453         std::map<v3s16, MapBlock*> modified_blocks;
1454
1455         try {
1456                 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1457                 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1458         }
1459         catch(InvalidPositionException &e) {
1460         }
1461
1462         for (const auto &modified_block : modified_blocks) {
1463                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1464         }
1465 }
1466
1467 void Client::setPlayerControl(PlayerControl &control)
1468 {
1469         LocalPlayer *player = m_env.getLocalPlayer();
1470         assert(player);
1471         player->control = control;
1472 }
1473
1474 void Client::setPlayerItem(u16 item)
1475 {
1476         m_env.getLocalPlayer()->setWieldIndex(item);
1477         m_update_wielded_item = true;
1478
1479         NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1480         pkt << item;
1481         Send(&pkt);
1482 }
1483
1484 // Returns true once after the inventory of the local player
1485 // has been updated from the server.
1486 bool Client::updateWieldedItem()
1487 {
1488         if (!m_update_wielded_item)
1489                 return false;
1490
1491         m_update_wielded_item = false;
1492
1493         LocalPlayer *player = m_env.getLocalPlayer();
1494         assert(player);
1495         if (auto *list = player->inventory.getList("main"))
1496                 list->setModified(false);
1497         if (auto *list = player->inventory.getList("hand"))
1498                 list->setModified(false);
1499
1500         return true;
1501 }
1502
1503 scene::ISceneManager* Client::getSceneManager()
1504 {
1505         return m_rendering_engine->get_scene_manager();
1506 }
1507
1508 Inventory* Client::getInventory(const InventoryLocation &loc)
1509 {
1510         switch(loc.type){
1511         case InventoryLocation::UNDEFINED:
1512         {}
1513         break;
1514         case InventoryLocation::PLAYER:
1515         case InventoryLocation::CURRENT_PLAYER:
1516         {
1517                 LocalPlayer *player = m_env.getLocalPlayer();
1518                 assert(player);
1519                 return &player->inventory;
1520         }
1521         break;
1522         case InventoryLocation::NODEMETA:
1523         {
1524                 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1525                 if(!meta)
1526                         return NULL;
1527                 return meta->getInventory();
1528         }
1529         break;
1530         case InventoryLocation::DETACHED:
1531         {
1532                 if (m_detached_inventories.count(loc.name) == 0)
1533                         return NULL;
1534                 return m_detached_inventories[loc.name];
1535         }
1536         break;
1537         default:
1538                 FATAL_ERROR("Invalid inventory location type.");
1539                 break;
1540         }
1541         return NULL;
1542 }
1543
1544 void Client::inventoryAction(InventoryAction *a)
1545 {
1546         /*
1547                 Send it to the server
1548         */
1549         sendInventoryAction(a);
1550
1551         /*
1552                 Predict some local inventory changes
1553         */
1554         a->clientApply(this, this);
1555
1556         // Remove it
1557         delete a;
1558 }
1559
1560 float Client::getAnimationTime()
1561 {
1562         return m_animation_time;
1563 }
1564
1565 int Client::getCrackLevel()
1566 {
1567         return m_crack_level;
1568 }
1569
1570 v3s16 Client::getCrackPos()
1571 {
1572         return m_crack_pos;
1573 }
1574
1575 void Client::setCrack(int level, v3s16 pos)
1576 {
1577         int old_crack_level = m_crack_level;
1578         v3s16 old_crack_pos = m_crack_pos;
1579
1580         m_crack_level = level;
1581         m_crack_pos = pos;
1582
1583         if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1584         {
1585                 // remove old crack
1586                 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1587         }
1588         if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1589         {
1590                 // add new crack
1591                 addUpdateMeshTaskForNode(pos, false, true);
1592         }
1593 }
1594
1595 u16 Client::getHP()
1596 {
1597         LocalPlayer *player = m_env.getLocalPlayer();
1598         assert(player);
1599         return player->hp;
1600 }
1601
1602 bool Client::getChatMessage(std::wstring &res)
1603 {
1604         if (m_chat_queue.empty())
1605                 return false;
1606
1607         ChatMessage *chatMessage = m_chat_queue.front();
1608         m_chat_queue.pop();
1609
1610         res = L"";
1611
1612         switch (chatMessage->type) {
1613                 case CHATMESSAGE_TYPE_RAW:
1614                 case CHATMESSAGE_TYPE_ANNOUNCE:
1615                 case CHATMESSAGE_TYPE_SYSTEM:
1616                         res = chatMessage->message;
1617                         break;
1618                 case CHATMESSAGE_TYPE_NORMAL: {
1619                         if (!chatMessage->sender.empty())
1620                                 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1621                         else
1622                                 res = chatMessage->message;
1623                         break;
1624                 }
1625                 default:
1626                         break;
1627         }
1628
1629         delete chatMessage;
1630         return true;
1631 }
1632
1633 void Client::typeChatMessage(const std::wstring &message)
1634 {
1635         // Discard empty line
1636         if (message.empty())
1637                 return;
1638
1639         // If message was consumed by script API, don't send it to server
1640         if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1641                 return;
1642
1643         // Send to others
1644         sendChatMessage(message);
1645 }
1646
1647 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1648 {
1649         // Check if the block exists to begin with. In the case when a non-existing
1650         // neighbor is automatically added, it may not. In that case we don't want
1651         // to tell the mesh update thread about it.
1652         MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1653         if (b == NULL)
1654                 return;
1655
1656         m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1657 }
1658
1659 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1660 {
1661         m_mesh_update_thread.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1662 }
1663
1664 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1665 {
1666         {
1667                 v3s16 p = nodepos;
1668                 infostream<<"Client::addUpdateMeshTaskForNode(): "
1669                                 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1670                                 <<std::endl;
1671         }
1672
1673         v3s16 blockpos = getNodeBlockPos(nodepos);
1674         v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1675         m_mesh_update_thread.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1676         // Leading edge
1677         if (nodepos.X == blockpos_relative.X)
1678                 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1679         if (nodepos.Y == blockpos_relative.Y)
1680                 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1681         if (nodepos.Z == blockpos_relative.Z)
1682                 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1683 }
1684
1685 void Client::updateAllMapBlocks()
1686 {
1687         v3s16 currentBlock = getNodeBlockPos(floatToInt(m_env.getLocalPlayer()->getPosition(), BS));
1688
1689         for (s16 X = currentBlock.X - 2; X <= currentBlock.X + 2; X++)
1690         for (s16 Y = currentBlock.Y - 2; Y <= currentBlock.Y + 2; Y++)
1691         for (s16 Z = currentBlock.Z - 2; Z <= currentBlock.Z + 2; Z++)
1692                 addUpdateMeshTask(v3s16(X, Y, Z), false, true);
1693
1694         Map &map = m_env.getMap();
1695
1696         std::vector<v3s16> positions;
1697         map.listAllLoadedBlocks(positions);
1698
1699         for (v3s16 p : positions) {
1700                 addUpdateMeshTask(p, false, false);
1701         }
1702 }
1703
1704 ClientEvent *Client::getClientEvent()
1705 {
1706         FATAL_ERROR_IF(m_client_event_queue.empty(),
1707                         "Cannot getClientEvent, queue is empty.");
1708
1709         ClientEvent *event = m_client_event_queue.front();
1710         m_client_event_queue.pop();
1711         return event;
1712 }
1713
1714 const Address Client::getServerAddress()
1715 {
1716         return m_con->GetPeerAddress(PEER_ID_SERVER);
1717 }
1718
1719 float Client::mediaReceiveProgress()
1720 {
1721         if (m_media_downloader)
1722                 return m_media_downloader->getProgress();
1723
1724         return 1.0; // downloader only exists when not yet done
1725 }
1726
1727 struct TextureUpdateArgs {
1728         gui::IGUIEnvironment *guienv;
1729         u64 last_time_ms;
1730         u16 last_percent;
1731         const wchar_t* text_base;
1732         ITextureSource *tsrc;
1733 };
1734
1735 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1736 {
1737                 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1738                 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1739
1740                 // update the loading menu -- if neccessary
1741                 bool do_draw = false;
1742                 u64 time_ms = targs->last_time_ms;
1743                 if (cur_percent != targs->last_percent) {
1744                         targs->last_percent = cur_percent;
1745                         time_ms = porting::getTimeMs();
1746                         // only draw when the user will notice something:
1747                         do_draw = (time_ms - targs->last_time_ms > 100);
1748                 }
1749
1750                 if (do_draw) {
1751                         targs->last_time_ms = time_ms;
1752                         std::wostringstream strm;
1753                         strm << targs->text_base << L" " << targs->last_percent << L"%...";
1754                         m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1755                                 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1756                 }
1757 }
1758
1759 void Client::afterContentReceived()
1760 {
1761         infostream<<"Client::afterContentReceived() started"<<std::endl;
1762         assert(m_itemdef_received); // pre-condition
1763         assert(m_nodedef_received); // pre-condition
1764         assert(mediaReceived()); // pre-condition
1765
1766         const wchar_t* text = wgettext("Loading textures...");
1767
1768         // Clear cached pre-scaled 2D GUI images, as this cache
1769         // might have images with the same name but different
1770         // content from previous sessions.
1771         guiScalingCacheClear();
1772
1773         // Rebuild inherited images and recreate textures
1774         infostream<<"- Rebuilding images and textures"<<std::endl;
1775         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1776         m_tsrc->rebuildImagesAndTextures();
1777         delete[] text;
1778
1779         // Rebuild shaders
1780         infostream<<"- Rebuilding shaders"<<std::endl;
1781         text = wgettext("Rebuilding shaders...");
1782         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1783         m_shsrc->rebuildShaders();
1784         delete[] text;
1785
1786         // Update node aliases
1787         infostream<<"- Updating node aliases"<<std::endl;
1788         text = wgettext("Initializing nodes...");
1789         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1790         m_nodedef->updateAliases(m_itemdef);
1791         for (const auto &path : getTextureDirs()) {
1792                 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1793                 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1794                 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1795         }
1796         m_nodedef->setNodeRegistrationStatus(true);
1797         m_nodedef->runNodeResolveCallbacks();
1798         delete[] text;
1799
1800         // Update node textures and assign shaders to each tile
1801         infostream<<"- Updating node textures"<<std::endl;
1802         TextureUpdateArgs tu_args;
1803         tu_args.guienv = guienv;
1804         tu_args.last_time_ms = porting::getTimeMs();
1805         tu_args.last_percent = 0;
1806         tu_args.text_base = wgettext("Initializing nodes");
1807         tu_args.tsrc = m_tsrc;
1808         m_nodedef->updateTextures(this, &tu_args);
1809         delete[] tu_args.text_base;
1810
1811         // Start mesh update thread after setting up content definitions
1812         infostream<<"- Starting mesh update thread"<<std::endl;
1813         m_mesh_update_thread.start();
1814
1815         m_state = LC_Ready;
1816         sendReady();
1817
1818         if (m_mods_loaded)
1819                 m_script->on_client_ready(m_env.getLocalPlayer());
1820
1821         text = wgettext("Done!");
1822         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1823         infostream<<"Client::afterContentReceived() done"<<std::endl;
1824         delete[] text;
1825 }
1826
1827 float Client::getRTT()
1828 {
1829         return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1830 }
1831
1832 float Client::getCurRate()
1833 {
1834         return (m_con->getLocalStat(con::CUR_INC_RATE) +
1835                         m_con->getLocalStat(con::CUR_DL_RATE));
1836 }
1837
1838 void Client::makeScreenshot()
1839 {
1840         irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1841         irr::video::IImage* const raw_image = driver->createScreenShot();
1842
1843         if (!raw_image)
1844                 return;
1845
1846         const struct tm tm = mt_localtime();
1847
1848         char timetstamp_c[64];
1849         strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1850
1851         std::string screenshot_dir;
1852
1853         if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1854                 screenshot_dir = g_settings->get("screenshot_path");
1855         else
1856                 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1857
1858         std::string filename_base = screenshot_dir
1859                         + DIR_DELIM
1860                         + std::string("screenshot_")
1861                         + std::string(timetstamp_c);
1862         std::string filename_ext = "." + g_settings->get("screenshot_format");
1863         std::string filename;
1864
1865         // Create the directory if it doesn't already exist.
1866         // Otherwise, saving the screenshot would fail.
1867         fs::CreateDir(screenshot_dir);
1868
1869         u32 quality = (u32)g_settings->getS32("screenshot_quality");
1870         quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1871
1872         // Try to find a unique filename
1873         unsigned serial = 0;
1874
1875         while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1876                 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1877                 std::ifstream tmp(filename.c_str());
1878                 if (!tmp.good())
1879                         break;  // File did not apparently exist, we'll go with it
1880                 serial++;
1881         }
1882
1883         if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1884                 infostream << "Could not find suitable filename for screenshot" << std::endl;
1885         } else {
1886                 irr::video::IImage* const image =
1887                                 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1888
1889                 if (image) {
1890                         raw_image->copyTo(image);
1891
1892                         std::ostringstream sstr;
1893                         if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1894                                 sstr << "Saved screenshot to '" << filename << "'";
1895                         } else {
1896                                 sstr << "Failed to save screenshot '" << filename << "'";
1897                         }
1898                         pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1899                                         utf8_to_wide(sstr.str())));
1900                         infostream << sstr.str() << std::endl;
1901                         image->drop();
1902                 }
1903         }
1904
1905         raw_image->drop();
1906 }
1907
1908 bool Client::shouldShowMinimap() const
1909 {
1910         return !m_minimap_disabled_by_server;
1911 }
1912
1913 void Client::pushToEventQueue(ClientEvent *event)
1914 {
1915         m_client_event_queue.push(event);
1916 }
1917
1918 void Client::showMinimap(const bool show)
1919 {
1920         m_game_ui->showMinimap(show);
1921 }
1922
1923 // IGameDef interface
1924 // Under envlock
1925 IItemDefManager* Client::getItemDefManager()
1926 {
1927         return m_itemdef;
1928 }
1929 IWritableItemDefManager* Client::getWritableItemDefManager()
1930 {
1931         return m_itemdef;
1932 }
1933 const NodeDefManager* Client::getNodeDefManager()
1934 {
1935         return m_nodedef;
1936 }
1937 NodeDefManager* Client::getWritableNodeDefManager()
1938 {
1939         return m_nodedef;
1940 }
1941 ICraftDefManager* Client::getCraftDefManager()
1942 {
1943         return NULL;
1944         //return m_craftdef;
1945 }
1946 ITextureSource* Client::getTextureSource()
1947 {
1948         return m_tsrc;
1949 }
1950 IWritableShaderSource* Client::getShaderSource()
1951 {
1952         return m_shsrc;
1953 }
1954
1955 u16 Client::allocateUnknownNodeId(const std::string &name)
1956 {
1957         errorstream << "Client::allocateUnknownNodeId(): "
1958                         << "Client cannot allocate node IDs" << std::endl;
1959         FATAL_ERROR("Client allocated unknown node");
1960
1961         return CONTENT_IGNORE;
1962 }
1963 ISoundManager* Client::getSoundManager()
1964 {
1965         return m_sound;
1966 }
1967 MtEventManager* Client::getEventManager()
1968 {
1969         return m_event;
1970 }
1971
1972 ParticleManager* Client::getParticleManager()
1973 {
1974         return &m_particle_manager;
1975 }
1976
1977 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1978 {
1979         StringMap::const_iterator it = m_mesh_data.find(filename);
1980         if (it == m_mesh_data.end()) {
1981                 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1982                         << "\"" << std::endl;
1983                 return NULL;
1984         }
1985         const std::string &data    = it->second;
1986
1987         // Create the mesh, remove it from cache and return it
1988         // This allows unique vertex colors and other properties for each instance
1989         io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1990                         data.c_str(), data.size(), filename.c_str());
1991         FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1992
1993         scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
1994         rfile->drop();
1995         if (!mesh)
1996                 return nullptr;
1997         mesh->grab();
1998         if (!cache)
1999                 m_rendering_engine->removeMesh(mesh);
2000         return mesh;
2001 }
2002
2003 const std::string* Client::getModFile(std::string filename)
2004 {
2005         // strip dir delimiter from beginning of path
2006         auto pos = filename.find_first_of(':');
2007         if (pos == std::string::npos)
2008                 return nullptr;
2009         pos++;
2010         auto pos2 = filename.find_first_not_of('/', pos);
2011         if (pos2 > pos)
2012                 filename.erase(pos, pos2 - pos);
2013
2014         StringMap::const_iterator it = m_mod_vfs.find(filename);
2015         if (it == m_mod_vfs.end())
2016                 return nullptr;
2017         return &it->second;
2018 }
2019
2020 bool Client::registerModStorage(ModMetadata *storage)
2021 {
2022         if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
2023                 errorstream << "Unable to register same mod storage twice. Storage name: "
2024                                 << storage->getModName() << std::endl;
2025                 return false;
2026         }
2027
2028         m_mod_storages[storage->getModName()] = storage;
2029         return true;
2030 }
2031
2032 void Client::unregisterModStorage(const std::string &name)
2033 {
2034         std::unordered_map<std::string, ModMetadata *>::const_iterator it =
2035                 m_mod_storages.find(name);
2036         if (it != m_mod_storages.end())
2037                 m_mod_storages.erase(name);
2038 }
2039
2040 /*
2041  * Mod channels
2042  */
2043
2044 bool Client::joinModChannel(const std::string &channel)
2045 {
2046         if (m_modchannel_mgr->channelRegistered(channel))
2047                 return false;
2048
2049         NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2050         pkt << channel;
2051         Send(&pkt);
2052
2053         m_modchannel_mgr->joinChannel(channel, 0);
2054         return true;
2055 }
2056
2057 bool Client::leaveModChannel(const std::string &channel)
2058 {
2059         if (!m_modchannel_mgr->channelRegistered(channel))
2060                 return false;
2061
2062         NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2063         pkt << channel;
2064         Send(&pkt);
2065
2066         m_modchannel_mgr->leaveChannel(channel, 0);
2067         return true;
2068 }
2069
2070 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2071 {
2072         if (!m_modchannel_mgr->canWriteOnChannel(channel))
2073                 return false;
2074
2075         if (message.size() > STRING_MAX_LEN) {
2076                 warningstream << "ModChannel message too long, dropping before sending "
2077                                 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2078                                 << channel << ")" << std::endl;
2079                 return false;
2080         }
2081
2082         // @TODO: do some client rate limiting
2083         NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2084         pkt << channel << message;
2085         Send(&pkt);
2086         return true;
2087 }
2088
2089 ModChannel* Client::getModChannel(const std::string &channel)
2090 {
2091         return m_modchannel_mgr->getModChannel(channel);
2092 }