src/client.cpp

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