src/client.cpp

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