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