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