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