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