src/client/client.cpp

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