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