src/client/client.cpp

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