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