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