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