src/client/client.cpp

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