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