src/client/client.cpp

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