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