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