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