src/client/client.cpp

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