src/client.cpp

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