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