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