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