src/client/client.cpp

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