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 "util/auth.h"
  27 #include "util/directiontables.h"
  28 #include "util/pointedthing.h"
  29 #include "util/serialize.h"
  30 #include "util/string.h"
  31 #include "util/srp.h"
  32 #include "client.h"
  33 #include "network/clientopcodes.h"
  34 #include "filesys.h"
  35 #include "mapblock_mesh.h"
  36 #include "mapblock.h"
  37 #include "minimap.h"
  38 #include "mods.h"
  39 #include "profiler.h"
  40 #include "gettext.h"
  41 #include "clientmap.h"
  42 #include "clientmedia.h"
  43 #include "version.h"
  44 #include "drawscene.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                 IrrlichtDevice *device,
  59                 const char *playername,
  60                 const std::string &password,
  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_packetcounter_timer(0.0),
  72         m_connection_reinit_timer(0.1),
  73         m_avg_rtt_timer(0.0),
  74         m_playerpos_send_timer(0.0),
  75         m_ignore_damage_timer(0.0),
  76         m_tsrc(tsrc),
  77         m_shsrc(shsrc),
  78         m_itemdef(itemdef),
  79         m_nodedef(nodedef),
  80         m_sound(sound),
  81         m_event(event),
  82         m_mesh_update_thread(this),
  83         m_env(
  84                 new ClientMap(this, control,
  85                         device->getSceneManager()->getRootSceneNode(),
  86                         device->getSceneManager(), 666),
  87                 device->getSceneManager(),
  88                 tsrc, this, device
  89         ),
  90         m_particle_manager(&m_env),
  91         m_con(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this),
  92         m_device(device),
  93         m_camera(NULL),
  94         m_minimap_disabled_by_server(false),
  95         m_server_ser_ver(SER_FMT_VER_INVALID),
  96         m_proto_ver(0),
  97         m_playeritem(0),
  98         m_inventory_updated(false),
  99         m_inventory_from_server(NULL),
 100         m_inventory_from_server_age(0.0),
 101         m_animation_time(0),
 102         m_crack_level(-1),
 103         m_crack_pos(0,0,0),
 104         m_map_seed(0),
 105         m_password(password),
 106         m_chosen_auth_mech(AUTH_MECHANISM_NONE),
 107         m_auth_data(NULL),
 108         m_access_denied(false),
 109         m_access_denied_reconnect(false),
 110         m_itemdef_received(false),
 111         m_nodedef_received(false),
 112         m_media_downloader(new ClientMediaDownloader()),
 113         m_time_of_day_set(false),
 114         m_last_time_of_day_f(-1),
 115         m_time_of_day_update_timer(0),
 116         m_recommended_send_interval(0.1),
 117         m_removed_sounds_check_timer(0),
 118         m_state(LC_Created),
 119         m_localdb(NULL),
 120         m_script(NULL),
 121         m_mod_storage_save_timer(10.0f),
 122         m_game_ui_flags(game_ui_flags),
 123         m_shutdown(false)
 124 {
 125         // Add local player
 126         m_env.setLocalPlayer(new LocalPlayer(this, playername));
 127
 128         m_minimap = new Minimap(device, this);
 129         m_cache_save_interval = g_settings->getU16("server_map_save_interval");
 130
 131         m_modding_enabled = g_settings->getBool("enable_client_modding");
 132         m_script = new ClientScripting(this);
 133         m_env.setScript(m_script);
 134         m_script->setEnv(&m_env);
 135 }
 136
 137 void Client::initMods()
 138 {
 139         m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME);
 140
 141         // If modding is not enabled, don't load mods, just builtin
 142         if (!m_modding_enabled) {
 143                 return;
 144         }
 145
 146         ClientModConfiguration modconf(getClientModsLuaPath());
 147         std::vector<ModSpec> mods = modconf.getMods();
 148         std::vector<ModSpec> unsatisfied_mods = modconf.getUnsatisfiedMods();
 149         // complain about mods with unsatisfied dependencies
 150         if (!modconf.isConsistent()) {
 151                 modconf.printUnsatisfiedModsError();
 152         }
 153
 154         // Print mods
 155         infostream << "Client Loading mods: ";
 156         for (std::vector<ModSpec>::const_iterator i = mods.begin();
 157                 i != mods.end(); ++i) {
 158                 infostream << (*i).name << " ";
 159         }
 160
 161         infostream << std::endl;
 162         // Load and run "mod" scripts
 163         for (std::vector<ModSpec>::const_iterator it = mods.begin();
 164                 it != mods.end(); ++it) {
 165                 const ModSpec &mod = *it;
 166                 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
 167                         throw ModError("Error loading mod \"" + mod.name +
 168                                 "\": Mod name does not follow naming conventions: "
 169                                         "Only chararacters [a-z0-9_] are allowed.");
 170                 }
 171                 std::string script_path = mod.path + DIR_DELIM + "init.lua";
 172                 infostream << "  [" << padStringRight(mod.name, 12) << "] [\""
 173                         << script_path << "\"]" << std::endl;
 174                 m_script->loadMod(script_path, mod.name);
 175         }
 176 }
 177
 178 const std::string &Client::getBuiltinLuaPath()
 179 {
 180         static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
 181         return builtin_dir;
 182 }
 183
 184 const std::string &Client::getClientModsLuaPath()
 185 {
 186         static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
 187         return clientmods_dir;
 188 }
 189
 190 const std::vector<ModSpec>& Client::getMods() const
 191 {
 192         static std::vector<ModSpec> client_modspec_temp;
 193         return client_modspec_temp;
 194 }
 195
 196 const ModSpec* Client::getModSpec(const std::string &modname) const
 197 {
 198         return NULL;
 199 }
 200
 201 void Client::Stop()
 202 {
 203         m_shutdown = true;
 204         // Don't disable this part when modding is disabled, it's used in builtin
 205         m_script->on_shutdown();
 206         //request all client managed threads to stop
 207         m_mesh_update_thread.stop();
 208         // Save local server map
 209         if (m_localdb) {
 210                 infostream << "Local map saving ended." << std::endl;
 211                 m_localdb->endSave();
 212         }
 213
 214         delete m_script;
 215 }
 216
 217 bool Client::isShutdown()
 218 {
 219         return m_shutdown || !m_mesh_update_thread.isRunning();
 220 }
 221
 222 Client::~Client()
 223 {
 224         m_shutdown = true;
 225         m_con.Disconnect();
 226
 227         m_mesh_update_thread.stop();
 228         m_mesh_update_thread.wait();
 229         while (!m_mesh_update_thread.m_queue_out.empty()) {
 230                 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
 231                 delete r.mesh;
 232         }
 233
 234
 235         delete m_inventory_from_server;
 236
 237         // Delete detached inventories
 238         for (UNORDERED_MAP<std::string, Inventory*>::iterator
 239                         i = m_detached_inventories.begin();
 240                         i != m_detached_inventories.end(); ++i) {
 241                 delete i->second;
 242         }
 243
 244         // cleanup 3d model meshes on client shutdown
 245         while (m_device->getSceneManager()->getMeshCache()->getMeshCount() != 0) {
 246                 scene::IAnimatedMesh *mesh =
 247                         m_device->getSceneManager()->getMeshCache()->getMeshByIndex(0);
 248
 249                 if (mesh != NULL)
 250                         m_device->getSceneManager()->getMeshCache()->removeMesh(mesh);
 251         }
 252
 253         delete m_minimap;
 254 }
 255
 256 void Client::connect(Address address,
 257                 const std::string &address_name,
 258                 bool is_local_server)
 259 {
 260         DSTACK(FUNCTION_NAME);
 261
 262         initLocalMapSaving(address, address_name, is_local_server);
 263
 264         m_con.SetTimeoutMs(0);
 265         m_con.Connect(address);
 266 }
 267
 268 void Client::step(float dtime)
 269 {
 270         DSTACK(FUNCTION_NAME);
 271
 272         // Limit a bit
 273         if(dtime > 2.0)
 274                 dtime = 2.0;
 275
 276         if(m_ignore_damage_timer > dtime)
 277                 m_ignore_damage_timer -= dtime;
 278         else
 279                 m_ignore_damage_timer = 0.0;
 280
 281         m_animation_time += dtime;
 282         if(m_animation_time > 60.0)
 283                 m_animation_time -= 60.0;
 284
 285         m_time_of_day_update_timer += dtime;
 286
 287         ReceiveAll();
 288
 289         /*
 290                 Packet counter
 291         */
 292         {
 293                 float &counter = m_packetcounter_timer;
 294                 counter -= dtime;
 295                 if(counter <= 0.0)
 296                 {
 297                         counter = 20.0;
 298
 299                         infostream << "Client packetcounter (" << m_packetcounter_timer
 300                                         << "):"<<std::endl;
 301                         m_packetcounter.print(infostream);
 302                         m_packetcounter.clear();
 303                 }
 304         }
 305
 306         // UGLY hack to fix 2 second startup delay caused by non existent
 307         // server client startup synchronization in local server or singleplayer mode
 308         static bool initial_step = true;
 309         if (initial_step) {
 310                 initial_step = false;
 311         }
 312         else if(m_state == LC_Created) {
 313                 float &counter = m_connection_reinit_timer;
 314                 counter -= dtime;
 315                 if(counter <= 0.0) {
 316                         counter = 2.0;
 317
 318                         LocalPlayer *myplayer = m_env.getLocalPlayer();
 319                         FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
 320
 321                         u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
 322                                 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
 323
 324                         if (proto_version_min < 25) {
 325                                 // Send TOSERVER_INIT_LEGACY
 326                                 // [0] u16 TOSERVER_INIT_LEGACY
 327                                 // [2] u8 SER_FMT_VER_HIGHEST_READ
 328                                 // [3] u8[20] player_name
 329                                 // [23] u8[28] password (new in some version)
 330                                 // [51] u16 minimum supported network protocol version (added sometime)
 331                                 // [53] u16 maximum supported network protocol version (added later than the previous one)
 332
 333                                 char pName[PLAYERNAME_SIZE];
 334                                 char pPassword[PASSWORD_SIZE];
 335                                 memset(pName, 0, PLAYERNAME_SIZE * sizeof(char));
 336                                 memset(pPassword, 0, PASSWORD_SIZE * sizeof(char));
 337
 338                                 std::string hashed_password = translate_password(myplayer->getName(), m_password);
 339                                 snprintf(pName, PLAYERNAME_SIZE, "%s", myplayer->getName());
 340                                 snprintf(pPassword, PASSWORD_SIZE, "%s", hashed_password.c_str());
 341
 342                                 sendLegacyInit(pName, pPassword);
 343                         }
 344                         if (CLIENT_PROTOCOL_VERSION_MAX >= 25)
 345                                 sendInit(myplayer->getName());
 346                 }
 347
 348                 // Not connected, return
 349                 return;
 350         }
 351
 352         /*
 353                 Do stuff if connected
 354         */
 355
 356         /*
 357                 Run Map's timers and unload unused data
 358         */
 359         const float map_timer_and_unload_dtime = 5.25;
 360         if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
 361                 ScopeProfiler sp(g_profiler, "Client: map timer and unload");
 362                 std::vector<v3s16> deleted_blocks;
 363                 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
 364                         g_settings->getFloat("client_unload_unused_data_timeout"),
 365                         g_settings->getS32("client_mapblock_limit"),
 366                         &deleted_blocks);
 367
 368                 /*
 369                         Send info to server
 370                         NOTE: This loop is intentionally iterated the way it is.
 371                 */
 372
 373                 std::vector<v3s16>::iterator i = deleted_blocks.begin();
 374                 std::vector<v3s16> sendlist;
 375                 for(;;) {
 376                         if(sendlist.size() == 255 || i == deleted_blocks.end()) {
 377                                 if(sendlist.empty())
 378                                         break;
 379                                 /*
 380                                         [0] u16 command
 381                                         [2] u8 count
 382                                         [3] v3s16 pos_0
 383                                         [3+6] v3s16 pos_1
 384                                         ...
 385                                 */
 386
 387                                 sendDeletedBlocks(sendlist);
 388
 389                                 if(i == deleted_blocks.end())
 390                                         break;
 391
 392                                 sendlist.clear();
 393                         }
 394
 395                         sendlist.push_back(*i);
 396                         ++i;
 397                 }
 398         }
 399
 400         /*
 401                 Handle environment
 402         */
 403         // Control local player (0ms)
 404         LocalPlayer *player = m_env.getLocalPlayer();
 405         assert(player != NULL);
 406         player->applyControl(dtime);
 407
 408         // Step environment
 409         m_env.step(dtime);
 410
 411         /*
 412                 Get events
 413         */
 414         for(;;) {
 415                 ClientEnvEvent event = m_env.getClientEvent();
 416                 if(event.type == CEE_NONE) {
 417                         break;
 418                 }
 419                 else if(event.type == CEE_PLAYER_DAMAGE) {
 420                         if(m_ignore_damage_timer <= 0) {
 421                                 u8 damage = event.player_damage.amount;
 422
 423                                 if(event.player_damage.send_to_server)
 424                                         sendDamage(damage);
 425
 426                                 // Add to ClientEvent queue
 427                                 ClientEvent event;
 428                                 event.type = CE_PLAYER_DAMAGE;
 429                                 event.player_damage.amount = damage;
 430                                 m_client_event_queue.push(event);
 431                         }
 432                 }
 433                 // Protocol v29 or greater obsoleted this event
 434                 else if (event.type == CEE_PLAYER_BREATH && m_proto_ver < 29) {
 435                         u16 breath = event.player_breath.amount;
 436                         sendBreath(breath);
 437                 }
 438         }
 439
 440         /*
 441                 Print some info
 442         */
 443         float &counter = m_avg_rtt_timer;
 444         counter += dtime;
 445         if(counter >= 10) {
 446                 counter = 0.0;
 447                 // connectedAndInitialized() is true, peer exists.
 448                 float avg_rtt = getRTT();
 449                 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
 450         }
 451
 452         /*
 453                 Send player position to server
 454         */
 455         {
 456                 float &counter = m_playerpos_send_timer;
 457                 counter += dtime;
 458                 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
 459                 {
 460                         counter = 0.0;
 461                         sendPlayerPos();
 462                 }
 463         }
 464
 465         /*
 466                 Replace updated meshes
 467         */
 468         {
 469                 int num_processed_meshes = 0;
 470                 while (!m_mesh_update_thread.m_queue_out.empty())
 471                 {
 472                         num_processed_meshes++;
 473
 474                         MinimapMapblock *minimap_mapblock = NULL;
 475                         bool do_mapper_update = true;
 476
 477                         MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
 478                         MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
 479                         if (block) {
 480                                 // Delete the old mesh
 481                                 if (block->mesh != NULL) {
 482                                         delete block->mesh;
 483                                         block->mesh = NULL;
 484                                 }
 485
 486                                 if (r.mesh) {
 487                                         minimap_mapblock = r.mesh->moveMinimapMapblock();
 488                                         if (minimap_mapblock == NULL)
 489                                                 do_mapper_update = false;
 490
 491                                         bool is_empty = true;
 492                                         for (int l = 0; l < MAX_TILE_LAYERS; l++)
 493                                                 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
 494                                                         is_empty = false;
 495
 496                                         if (is_empty)
 497                                                 delete r.mesh;
 498                                         else
 499                                                 // Replace with the new mesh
 500                                                 block->mesh = r.mesh;
 501                                 }
 502                         } else {
 503                                 delete r.mesh;
 504                         }
 505
 506                         if (do_mapper_update)
 507                                 m_minimap->addBlock(r.p, minimap_mapblock);
 508
 509                         if (r.ack_block_to_server) {
 510                                 /*
 511                                         Acknowledge block
 512                                         [0] u8 count
 513                                         [1] v3s16 pos_0
 514                                 */
 515                                 sendGotBlocks(r.p);
 516                         }
 517                 }
 518
 519                 if (num_processed_meshes > 0)
 520                         g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
 521         }
 522
 523         /*
 524                 Load fetched media
 525         */
 526         if (m_media_downloader && m_media_downloader->isStarted()) {
 527                 m_media_downloader->step(this);
 528                 if (m_media_downloader->isDone()) {
 529                         received_media();
 530                         delete m_media_downloader;
 531                         m_media_downloader = NULL;
 532                 }
 533         }
 534
 535         /*
 536                 If the server didn't update the inventory in a while, revert
 537                 the local inventory (so the player notices the lag problem
 538                 and knows something is wrong).
 539         */
 540         if(m_inventory_from_server)
 541         {
 542                 float interval = 10.0;
 543                 float count_before = floor(m_inventory_from_server_age / interval);
 544
 545                 m_inventory_from_server_age += dtime;
 546
 547                 float count_after = floor(m_inventory_from_server_age / interval);
 548
 549                 if(count_after != count_before)
 550                 {
 551                         // Do this every <interval> seconds after TOCLIENT_INVENTORY
 552                         // Reset the locally changed inventory to the authoritative inventory
 553                         LocalPlayer *player = m_env.getLocalPlayer();
 554                         player->inventory = *m_inventory_from_server;
 555                         m_inventory_updated = true;
 556                 }
 557         }
 558
 559         /*
 560                 Update positions of sounds attached to objects
 561         */
 562         {
 563                 for(UNORDERED_MAP<int, u16>::iterator i = m_sounds_to_objects.begin();
 564                                 i != m_sounds_to_objects.end(); ++i) {
 565                         int client_id = i->first;
 566                         u16 object_id = i->second;
 567                         ClientActiveObject *cao = m_env.getActiveObject(object_id);
 568                         if(!cao)
 569                                 continue;
 570                         v3f pos = cao->getPosition();
 571                         m_sound->updateSoundPosition(client_id, pos);
 572                 }
 573         }
 574
 575         /*
 576                 Handle removed remotely initiated sounds
 577         */
 578         m_removed_sounds_check_timer += dtime;
 579         if(m_removed_sounds_check_timer >= 2.32) {
 580                 m_removed_sounds_check_timer = 0;
 581                 // Find removed sounds and clear references to them
 582                 std::vector<s32> removed_server_ids;
 583                 for(UNORDERED_MAP<s32, int>::iterator i = m_sounds_server_to_client.begin();
 584                                 i != m_sounds_server_to_client.end();) {
 585                         s32 server_id = i->first;
 586                         int client_id = i->second;
 587                         ++i;
 588                         if(!m_sound->soundExists(client_id)) {
 589                                 m_sounds_server_to_client.erase(server_id);
 590                                 m_sounds_client_to_server.erase(client_id);
 591                                 m_sounds_to_objects.erase(client_id);
 592                                 removed_server_ids.push_back(server_id);
 593                         }
 594                 }
 595
 596                 // Sync to server
 597                 if(!removed_server_ids.empty()) {
 598                         sendRemovedSounds(removed_server_ids);
 599                 }
 600         }
 601
 602         m_mod_storage_save_timer -= dtime;
 603         if (m_mod_storage_save_timer <= 0.0f) {
 604                 verbosestream << "Saving registered mod storages." << std::endl;
 605                 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
 606                 for (UNORDERED_MAP<std::string, ModMetadata *>::const_iterator
 607                                 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
 608                         if (it->second->isModified()) {
 609                                 it->second->save(getModStoragePath());
 610                         }
 611                 }
 612         }
 613
 614         // Write server map
 615         if (m_localdb && m_localdb_save_interval.step(dtime,
 616                         m_cache_save_interval)) {
 617                 m_localdb->endSave();
 618                 m_localdb->beginSave();
 619         }
 620 }
 621
 622 bool Client::loadMedia(const std::string &data, const std::string &filename)
 623 {
 624         // Silly irrlicht's const-incorrectness
 625         Buffer<char> data_rw(data.c_str(), data.size());
 626
 627         std::string name;
 628
 629         const char *image_ext[] = {
 630                 ".png", ".jpg", ".bmp", ".tga",
 631                 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
 632                 NULL
 633         };
 634         name = removeStringEnd(filename, image_ext);
 635         if(name != "")
 636         {
 637                 verbosestream<<"Client: Attempting to load image "
 638                 <<"file \""<<filename<<"\""<<std::endl;
 639
 640                 io::IFileSystem *irrfs = m_device->getFileSystem();
 641                 video::IVideoDriver *vdrv = m_device->getVideoDriver();
 642
 643                 // Create an irrlicht memory file
 644                 io::IReadFile *rfile = irrfs->createMemoryReadFile(
 645                                 *data_rw, data_rw.getSize(), "_tempreadfile");
 646
 647                 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
 648
 649                 // Read image
 650                 video::IImage *img = vdrv->createImageFromFile(rfile);
 651                 if(!img){
 652                         errorstream<<"Client: Cannot create image from data of "
 653                                         <<"file \""<<filename<<"\""<<std::endl;
 654                         rfile->drop();
 655                         return false;
 656                 }
 657                 else {
 658                         m_tsrc->insertSourceImage(filename, img);
 659                         img->drop();
 660                         rfile->drop();
 661                         return true;
 662                 }
 663         }
 664
 665         const char *sound_ext[] = {
 666                 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
 667                 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
 668                 ".ogg", NULL
 669         };
 670         name = removeStringEnd(filename, sound_ext);
 671         if(name != "")
 672         {
 673                 verbosestream<<"Client: Attempting to load sound "
 674                 <<"file \""<<filename<<"\""<<std::endl;
 675                 m_sound->loadSoundData(name, data);
 676                 return true;
 677         }
 678
 679         const char *model_ext[] = {
 680                 ".x", ".b3d", ".md2", ".obj",
 681                 NULL
 682         };
 683         name = removeStringEnd(filename, model_ext);
 684         if(name != "")
 685         {
 686                 verbosestream<<"Client: Storing model into memory: "
 687                                 <<"\""<<filename<<"\""<<std::endl;
 688                 if(m_mesh_data.count(filename))
 689                         errorstream<<"Multiple models with name \""<<filename.c_str()
 690                                         <<"\" found; replacing previous model"<<std::endl;
 691                 m_mesh_data[filename] = data;
 692                 return true;
 693         }
 694
 695         errorstream<<"Client: Don't know how to load file \""
 696                         <<filename<<"\""<<std::endl;
 697         return false;
 698 }
 699
 700 // Virtual methods from con::PeerHandler
 701 void Client::peerAdded(con::Peer *peer)
 702 {
 703         infostream << "Client::peerAdded(): peer->id="
 704                         << peer->id << std::endl;
 705 }
 706 void Client::deletingPeer(con::Peer *peer, bool timeout)
 707 {
 708         infostream << "Client::deletingPeer(): "
 709                         "Server Peer is getting deleted "
 710                         << "(timeout=" << timeout << ")" << std::endl;
 711
 712         if (timeout) {
 713                 m_access_denied = true;
 714                 m_access_denied_reason = gettext("Connection timed out.");
 715         }
 716 }
 717
 718 /*
 719         u16 command
 720         u16 number of files requested
 721         for each file {
 722                 u16 length of name
 723                 string name
 724         }
 725 */
 726 void Client::request_media(const std::vector<std::string> &file_requests)
 727 {
 728         std::ostringstream os(std::ios_base::binary);
 729         writeU16(os, TOSERVER_REQUEST_MEDIA);
 730         size_t file_requests_size = file_requests.size();
 731
 732         FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
 733
 734         // Packet dynamicly resized
 735         NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
 736
 737         pkt << (u16) (file_requests_size & 0xFFFF);
 738
 739         for(std::vector<std::string>::const_iterator i = file_requests.begin();
 740                         i != file_requests.end(); ++i) {
 741                 pkt << (*i);
 742         }
 743
 744         Send(&pkt);
 745
 746         infostream << "Client: Sending media request list to server ("
 747                         << file_requests.size() << " files. packet size)" << std::endl;
 748 }
 749
 750 void Client::received_media()
 751 {
 752         NetworkPacket pkt(TOSERVER_RECEIVED_MEDIA, 0);
 753         Send(&pkt);
 754         infostream << "Client: Notifying server that we received all media"
 755                         << std::endl;
 756 }
 757
 758 void Client::initLocalMapSaving(const Address &address,
 759                 const std::string &hostname,
 760                 bool is_local_server)
 761 {
 762         if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
 763                 return;
 764         }
 765
 766         const std::string world_path = porting::path_user
 767                 + DIR_DELIM + "worlds"
 768                 + DIR_DELIM + "server_"
 769                 + hostname + "_" + std::to_string(address.getPort());
 770
 771         fs::CreateAllDirs(world_path);
 772
 773         m_localdb = new MapDatabaseSQLite3(world_path);
 774         m_localdb->beginSave();
 775         actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
 776 }
 777
 778 void Client::ReceiveAll()
 779 {
 780         DSTACK(FUNCTION_NAME);
 781         u32 start_ms = porting::getTimeMs();
 782         for(;;)
 783         {
 784                 // Limit time even if there would be huge amounts of data to
 785                 // process
 786                 if(porting::getTimeMs() > start_ms + 100)
 787                         break;
 788
 789                 try {
 790                         Receive();
 791                         g_profiler->graphAdd("client_received_packets", 1);
 792                 }
 793                 catch(con::NoIncomingDataException &e) {
 794                         break;
 795                 }
 796                 catch(con::InvalidIncomingDataException &e) {
 797                         infostream<<"Client::ReceiveAll(): "
 798                                         "InvalidIncomingDataException: what()="
 799                                         <<e.what()<<std::endl;
 800                 }
 801         }
 802 }
 803
 804 void Client::Receive()
 805 {
 806         DSTACK(FUNCTION_NAME);
 807         NetworkPacket pkt;
 808         m_con.Receive(&pkt);
 809         ProcessData(&pkt);
 810 }
 811
 812 inline void Client::handleCommand(NetworkPacket* pkt)
 813 {
 814         const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
 815         (this->*opHandle.handler)(pkt);
 816 }
 817
 818 /*
 819         sender_peer_id given to this shall be quaranteed to be a valid peer
 820 */
 821 void Client::ProcessData(NetworkPacket *pkt)
 822 {
 823         DSTACK(FUNCTION_NAME);
 824
 825         ToClientCommand command = (ToClientCommand) pkt->getCommand();
 826         u32 sender_peer_id = pkt->getPeerId();
 827
 828         //infostream<<"Client: received command="<<command<<std::endl;
 829         m_packetcounter.add((u16)command);
 830
 831         /*
 832                 If this check is removed, be sure to change the queue
 833                 system to know the ids
 834         */
 835         if(sender_peer_id != PEER_ID_SERVER) {
 836                 infostream << "Client::ProcessData(): Discarding data not "
 837                         "coming from server: peer_id=" << sender_peer_id
 838                         << std::endl;
 839                 return;
 840         }
 841
 842         // Command must be handled into ToClientCommandHandler
 843         if (command >= TOCLIENT_NUM_MSG_TYPES) {
 844                 infostream << "Client: Ignoring unknown command "
 845                         << command << std::endl;
 846                 return;
 847         }
 848
 849         /*
 850          * Those packets are handled before m_server_ser_ver is set, it's normal
 851          * But we must use the new ToClientConnectionState in the future,
 852          * as a byte mask
 853          */
 854         if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
 855                 handleCommand(pkt);
 856                 return;
 857         }
 858
 859         if(m_server_ser_ver == SER_FMT_VER_INVALID) {
 860                 infostream << "Client: Server serialization"
 861                                 " format invalid or not initialized."
 862                                 " Skipping incoming command=" << command << std::endl;
 863                 return;
 864         }
 865
 866         /*
 867           Handle runtime commands
 868         */
 869
 870         handleCommand(pkt);
 871 }
 872
 873 void Client::Send(NetworkPacket* pkt)
 874 {
 875         m_con.Send(PEER_ID_SERVER,
 876                 serverCommandFactoryTable[pkt->getCommand()].channel,
 877                 pkt,
 878                 serverCommandFactoryTable[pkt->getCommand()].reliable);
 879 }
 880
 881 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
 882 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
 883 {
 884         v3f pf           = myplayer->getPosition() * 100;
 885         v3f sf           = myplayer->getSpeed() * 100;
 886         s32 pitch        = myplayer->getPitch() * 100;
 887         s32 yaw          = myplayer->getYaw() * 100;
 888         u32 keyPressed   = myplayer->keyPressed;
 889         // scaled by 80, so that pi can fit into a u8
 890         u8 fov           = clientMap->getCameraFov() * 80;
 891         u8 wanted_range  = MYMIN(255,
 892                         std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
 893
 894         v3s32 position(pf.X, pf.Y, pf.Z);
 895         v3s32 speed(sf.X, sf.Y, sf.Z);
 896
 897         /*
 898                 Format:
 899                 [0] v3s32 position*100
 900                 [12] v3s32 speed*100
 901                 [12+12] s32 pitch*100
 902                 [12+12+4] s32 yaw*100
 903                 [12+12+4+4] u32 keyPressed
 904                 [12+12+4+4+4] u8 fov*80
 905                 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 906         */
 907         *pkt << position << speed << pitch << yaw << keyPressed;
 908         *pkt << fov << wanted_range;
 909 }
 910
 911 void Client::interact(u8 action, const PointedThing& pointed)
 912 {
 913         if(m_state != LC_Ready) {
 914                 errorstream << "Client::interact() "
 915                                 "Canceled (not connected)"
 916                                 << std::endl;
 917                 return;
 918         }
 919
 920         LocalPlayer *myplayer = m_env.getLocalPlayer();
 921         if (myplayer == NULL)
 922                 return;
 923
 924         /*
 925                 [0] u16 command
 926                 [2] u8 action
 927                 [3] u16 item
 928                 [5] u32 length of the next item (plen)
 929                 [9] serialized PointedThing
 930                 [9 + plen] player position information
 931                 actions:
 932                 0: start digging (from undersurface) or use
 933                 1: stop digging (all parameters ignored)
 934                 2: digging completed
 935                 3: place block or item (to abovesurface)
 936                 4: use item
 937                 5: perform secondary action of item
 938         */
 939
 940         NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
 941
 942         pkt << action;
 943         pkt << (u16)getPlayerItem();
 944
 945         std::ostringstream tmp_os(std::ios::binary);
 946         pointed.serialize(tmp_os);
 947
 948         pkt.putLongString(tmp_os.str());
 949
 950         writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
 951
 952         Send(&pkt);
 953 }
 954
 955 void Client::deleteAuthData()
 956 {
 957         if (!m_auth_data)
 958                 return;
 959
 960         switch (m_chosen_auth_mech) {
 961                 case AUTH_MECHANISM_FIRST_SRP:
 962                         break;
 963                 case AUTH_MECHANISM_SRP:
 964                 case AUTH_MECHANISM_LEGACY_PASSWORD:
 965                         srp_user_delete((SRPUser *) m_auth_data);
 966                         m_auth_data = NULL;
 967                         break;
 968                 case AUTH_MECHANISM_NONE:
 969                         break;
 970         }
 971         m_chosen_auth_mech = AUTH_MECHANISM_NONE;
 972 }
 973
 974
 975 AuthMechanism Client::choseAuthMech(const u32 mechs)
 976 {
 977         if (mechs & AUTH_MECHANISM_SRP)
 978                 return AUTH_MECHANISM_SRP;
 979
 980         if (mechs & AUTH_MECHANISM_FIRST_SRP)
 981                 return AUTH_MECHANISM_FIRST_SRP;
 982
 983         if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
 984                 return AUTH_MECHANISM_LEGACY_PASSWORD;
 985
 986         return AUTH_MECHANISM_NONE;
 987 }
 988
 989 void Client::sendLegacyInit(const char* playerName, const char* playerPassword)
 990 {
 991         NetworkPacket pkt(TOSERVER_INIT_LEGACY,
 992                         1 + PLAYERNAME_SIZE + PASSWORD_SIZE + 2 + 2);
 993
 994         u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
 995                 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
 996
 997         pkt << (u8) SER_FMT_VER_HIGHEST_READ;
 998         pkt.putRawString(playerName,PLAYERNAME_SIZE);
 999         pkt.putRawString(playerPassword, PASSWORD_SIZE);
1000         pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1001
1002         Send(&pkt);
1003 }
1004
1005 void Client::sendInit(const std::string &playerName)
1006 {
1007         NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1008
1009         // we don't support network compression yet
1010         u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1011
1012         u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
1013                 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
1014
1015         pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1016         pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1017         pkt << playerName;
1018
1019         Send(&pkt);
1020 }
1021
1022 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1023 {
1024         m_chosen_auth_mech = chosen_auth_mechanism;
1025
1026         switch (chosen_auth_mechanism) {
1027                 case AUTH_MECHANISM_FIRST_SRP: {
1028                         // send srp verifier to server
1029                         std::string verifier;
1030                         std::string salt;
1031                         generate_srp_verifier_and_salt(getPlayerName(), m_password,
1032                                 &verifier, &salt);
1033
1034                         NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1035                         resp_pkt << salt << verifier << (u8)((m_password == "") ? 1 : 0);
1036
1037                         Send(&resp_pkt);
1038                         break;
1039                 }
1040                 case AUTH_MECHANISM_SRP:
1041                 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1042                         u8 based_on = 1;
1043
1044                         if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1045                                 m_password = translate_password(getPlayerName(), m_password);
1046                                 based_on = 0;
1047                         }
1048
1049                         std::string playername_u = lowercase(getPlayerName());
1050                         m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1051                                 getPlayerName().c_str(), playername_u.c_str(),
1052                                 (const unsigned char *) m_password.c_str(),
1053                                 m_password.length(), NULL, NULL);
1054                         char *bytes_A = 0;
1055                         size_t len_A = 0;
1056                         SRP_Result res = srp_user_start_authentication(
1057                                 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1058                                 (unsigned char **) &bytes_A, &len_A);
1059                         FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1060
1061                         NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1062                         resp_pkt << std::string(bytes_A, len_A) << based_on;
1063                         Send(&resp_pkt);
1064                         break;
1065                 }
1066                 case AUTH_MECHANISM_NONE:
1067                         break; // not handled in this method
1068         }
1069 }
1070
1071 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1072 {
1073         NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1074
1075         pkt << (u8) blocks.size();
1076
1077         u32 k = 0;
1078         for(std::vector<v3s16>::iterator
1079                         j = blocks.begin();
1080                         j != blocks.end(); ++j) {
1081                 pkt << *j;
1082                 k++;
1083         }
1084
1085         Send(&pkt);
1086 }
1087
1088 void Client::sendGotBlocks(v3s16 block)
1089 {
1090         NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1091         pkt << (u8) 1 << block;
1092         Send(&pkt);
1093 }
1094
1095 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1096 {
1097         size_t server_ids = soundList.size();
1098         assert(server_ids <= 0xFFFF);
1099
1100         NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1101
1102         pkt << (u16) (server_ids & 0xFFFF);
1103
1104         for(std::vector<s32>::iterator i = soundList.begin();
1105                         i != soundList.end(); ++i)
1106                 pkt << *i;
1107
1108         Send(&pkt);
1109 }
1110
1111 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1112                 const StringMap &fields)
1113 {
1114         size_t fields_size = fields.size();
1115
1116         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1117
1118         NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1119
1120         pkt << p << formname << (u16) (fields_size & 0xFFFF);
1121
1122         StringMap::const_iterator it;
1123         for (it = fields.begin(); it != fields.end(); ++it) {
1124                 const std::string &name = it->first;
1125                 const std::string &value = it->second;
1126                 pkt << name;
1127                 pkt.putLongString(value);
1128         }
1129
1130         Send(&pkt);
1131 }
1132
1133 void Client::sendInventoryFields(const std::string &formname,
1134                 const StringMap &fields)
1135 {
1136         size_t fields_size = fields.size();
1137         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1138
1139         NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1140         pkt << formname << (u16) (fields_size & 0xFFFF);
1141
1142         StringMap::const_iterator it;
1143         for (it = fields.begin(); it != fields.end(); ++it) {
1144                 const std::string &name  = it->first;
1145                 const std::string &value = it->second;
1146                 pkt << name;
1147                 pkt.putLongString(value);
1148         }
1149
1150         Send(&pkt);
1151 }
1152
1153 void Client::sendInventoryAction(InventoryAction *a)
1154 {
1155         std::ostringstream os(std::ios_base::binary);
1156
1157         a->serialize(os);
1158
1159         // Make data buffer
1160         std::string s = os.str();
1161
1162         NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1163         pkt.putRawString(s.c_str(),s.size());
1164
1165         Send(&pkt);
1166 }
1167
1168 void Client::sendChatMessage(const std::wstring &message)
1169 {
1170         NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1171
1172         pkt << message;
1173
1174         Send(&pkt);
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 != NULL);
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 != NULL);
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 != NULL);
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 != NULL);
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 != NULL);
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         ClientEvent event;
1609         if (m_client_event_queue.empty()) {
1610                 event.type = CE_NONE;
1611         }
1612         else {
1613                 event = m_client_event_queue.front();
1614                 m_client_event_queue.pop();
1615         }
1616         return event;
1617 }
1618
1619 float Client::mediaReceiveProgress()
1620 {
1621         if (m_media_downloader)
1622                 return m_media_downloader->getProgress();
1623         else
1624                 return 1.0; // downloader only exists when not yet done
1625 }
1626
1627 typedef struct TextureUpdateArgs {
1628         IrrlichtDevice *device;
1629         gui::IGUIEnvironment *guienv;
1630         u32 last_time_ms;
1631         u16 last_percent;
1632         const wchar_t* text_base;
1633         ITextureSource *tsrc;
1634 } TextureUpdateArgs;
1635
1636 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1637 {
1638                 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1639                 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1640
1641                 // update the loading menu -- if neccessary
1642                 bool do_draw = false;
1643                 u32 time_ms = targs->last_time_ms;
1644                 if (cur_percent != targs->last_percent) {
1645                         targs->last_percent = cur_percent;
1646                         time_ms = getTimeMs();
1647                         // only draw when the user will notice something:
1648                         do_draw = (time_ms - targs->last_time_ms > 100);
1649                 }
1650
1651                 if (do_draw) {
1652                         targs->last_time_ms = time_ms;
1653                         std::basic_stringstream<wchar_t> strm;
1654                         strm << targs->text_base << " " << targs->last_percent << "%...";
1655                         draw_load_screen(strm.str(), targs->device, targs->guienv, targs->tsrc, 0,
1656                                 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1657                 }
1658 }
1659
1660 void Client::afterContentReceived(IrrlichtDevice *device)
1661 {
1662         infostream<<"Client::afterContentReceived() started"<<std::endl;
1663         assert(m_itemdef_received); // pre-condition
1664         assert(m_nodedef_received); // pre-condition
1665         assert(mediaReceived()); // pre-condition
1666
1667         const wchar_t* text = wgettext("Loading textures...");
1668
1669         // Clear cached pre-scaled 2D GUI images, as this cache
1670         // might have images with the same name but different
1671         // content from previous sessions.
1672         guiScalingCacheClear(device->getVideoDriver());
1673
1674         // Rebuild inherited images and recreate textures
1675         infostream<<"- Rebuilding images and textures"<<std::endl;
1676         draw_load_screen(text,device, guienv, m_tsrc, 0, 70);
1677         m_tsrc->rebuildImagesAndTextures();
1678         delete[] text;
1679
1680         // Rebuild shaders
1681         infostream<<"- Rebuilding shaders"<<std::endl;
1682         text = wgettext("Rebuilding shaders...");
1683         draw_load_screen(text, device, guienv, m_tsrc, 0, 71);
1684         m_shsrc->rebuildShaders();
1685         delete[] text;
1686
1687         // Update node aliases
1688         infostream<<"- Updating node aliases"<<std::endl;
1689         text = wgettext("Initializing nodes...");
1690         draw_load_screen(text, device, guienv, m_tsrc, 0, 72);
1691         m_nodedef->updateAliases(m_itemdef);
1692         std::string texture_path = g_settings->get("texture_path");
1693         if (texture_path != "" && fs::IsDir(texture_path))
1694                 m_nodedef->applyTextureOverrides(texture_path + DIR_DELIM + "override.txt");
1695         m_nodedef->setNodeRegistrationStatus(true);
1696         m_nodedef->runNodeResolveCallbacks();
1697         delete[] text;
1698
1699         // Update node textures and assign shaders to each tile
1700         infostream<<"- Updating node textures"<<std::endl;
1701         TextureUpdateArgs tu_args;
1702         tu_args.device = device;
1703         tu_args.guienv = guienv;
1704         tu_args.last_time_ms = getTimeMs();
1705         tu_args.last_percent = 0;
1706         tu_args.text_base =  wgettext("Initializing nodes");
1707         tu_args.tsrc = m_tsrc;
1708         m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1709         delete[] tu_args.text_base;
1710
1711         // Start mesh update thread after setting up content definitions
1712         infostream<<"- Starting mesh update thread"<<std::endl;
1713         m_mesh_update_thread.start();
1714
1715         m_state = LC_Ready;
1716         sendReady();
1717
1718         if (g_settings->getBool("enable_client_modding")) {
1719                 m_script->on_client_ready(m_env.getLocalPlayer());
1720                 m_script->on_connect();
1721         }
1722
1723         text = wgettext("Done!");
1724         draw_load_screen(text, device, guienv, m_tsrc, 0, 100);
1725         infostream<<"Client::afterContentReceived() done"<<std::endl;
1726         delete[] text;
1727 }
1728
1729 float Client::getRTT()
1730 {
1731         return m_con.getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1732 }
1733
1734 float Client::getCurRate()
1735 {
1736         return ( m_con.getLocalStat(con::CUR_INC_RATE) +
1737                         m_con.getLocalStat(con::CUR_DL_RATE));
1738 }
1739
1740 void Client::makeScreenshot(IrrlichtDevice *device)
1741 {
1742         irr::video::IVideoDriver *driver = device->getVideoDriver();
1743         irr::video::IImage* const raw_image = driver->createScreenShot();
1744
1745         if (!raw_image)
1746                 return;
1747
1748         time_t t = time(NULL);
1749         struct tm *tm = localtime(&t);
1750
1751         char timetstamp_c[64];
1752         strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1753
1754         std::string filename_base = g_settings->get("screenshot_path")
1755                         + DIR_DELIM
1756                         + std::string("screenshot_")
1757                         + std::string(timetstamp_c);
1758         std::string filename_ext = "." + g_settings->get("screenshot_format");
1759         std::string filename;
1760
1761         u32 quality = (u32)g_settings->getS32("screenshot_quality");
1762         quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1763
1764         // Try to find a unique filename
1765         unsigned serial = 0;
1766
1767         while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1768                 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1769                 std::ifstream tmp(filename.c_str());
1770                 if (!tmp.good())
1771                         break;  // File did not apparently exist, we'll go with it
1772                 serial++;
1773         }
1774
1775         if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1776                 infostream << "Could not find suitable filename for screenshot" << std::endl;
1777         } else {
1778                 irr::video::IImage* const image =
1779                                 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1780
1781                 if (image) {
1782                         raw_image->copyTo(image);
1783
1784                         std::ostringstream sstr;
1785                         if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1786                                 sstr << "Saved screenshot to '" << filename << "'";
1787                         } else {
1788                                 sstr << "Failed to save screenshot '" << filename << "'";
1789                         }
1790                         pushToChatQueue(narrow_to_wide(sstr.str()));
1791                         infostream << sstr.str() << std::endl;
1792                         image->drop();
1793                 }
1794         }
1795
1796         raw_image->drop();
1797 }
1798
1799 bool Client::shouldShowMinimap() const
1800 {
1801         return !m_minimap_disabled_by_server;
1802 }
1803
1804 void Client::showGameChat(const bool show)
1805 {
1806         m_game_ui_flags->show_chat = show;
1807 }
1808
1809 void Client::showGameHud(const bool show)
1810 {
1811         m_game_ui_flags->show_hud = show;
1812 }
1813
1814 void Client::showMinimap(const bool show)
1815 {
1816         m_game_ui_flags->show_minimap = show;
1817 }
1818
1819 void Client::showProfiler(const bool show)
1820 {
1821         m_game_ui_flags->show_profiler_graph = show;
1822 }
1823
1824 void Client::showGameFog(const bool show)
1825 {
1826         m_game_ui_flags->force_fog_off = !show;
1827 }
1828
1829 void Client::showGameDebug(const bool show)
1830 {
1831         m_game_ui_flags->show_debug = show;
1832 }
1833
1834 // IGameDef interface
1835 // Under envlock
1836 IItemDefManager* Client::getItemDefManager()
1837 {
1838         return m_itemdef;
1839 }
1840 INodeDefManager* Client::getNodeDefManager()
1841 {
1842         return m_nodedef;
1843 }
1844 ICraftDefManager* Client::getCraftDefManager()
1845 {
1846         return NULL;
1847         //return m_craftdef;
1848 }
1849 ITextureSource* Client::getTextureSource()
1850 {
1851         return m_tsrc;
1852 }
1853 IShaderSource* Client::getShaderSource()
1854 {
1855         return m_shsrc;
1856 }
1857 scene::ISceneManager* Client::getSceneManager()
1858 {
1859         return m_device->getSceneManager();
1860 }
1861 u16 Client::allocateUnknownNodeId(const std::string &name)
1862 {
1863         errorstream << "Client::allocateUnknownNodeId(): "
1864                         << "Client cannot allocate node IDs" << std::endl;
1865         FATAL_ERROR("Client allocated unknown node");
1866
1867         return CONTENT_IGNORE;
1868 }
1869 ISoundManager* Client::getSoundManager()
1870 {
1871         return m_sound;
1872 }
1873 MtEventManager* Client::getEventManager()
1874 {
1875         return m_event;
1876 }
1877
1878 ParticleManager* Client::getParticleManager()
1879 {
1880         return &m_particle_manager;
1881 }
1882
1883 scene::IAnimatedMesh* Client::getMesh(const std::string &filename)
1884 {
1885         StringMap::const_iterator it = m_mesh_data.find(filename);
1886         if (it == m_mesh_data.end()) {
1887                 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1888                         << "\"" << std::endl;
1889                 return NULL;
1890         }
1891         const std::string &data    = it->second;
1892         scene::ISceneManager *smgr = m_device->getSceneManager();
1893
1894         // Create the mesh, remove it from cache and return it
1895         // This allows unique vertex colors and other properties for each instance
1896         Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1897         io::IFileSystem *irrfs = m_device->getFileSystem();
1898         io::IReadFile *rfile   = irrfs->createMemoryReadFile(
1899                         *data_rw, data_rw.getSize(), filename.c_str());
1900         FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1901
1902         scene::IAnimatedMesh *mesh = smgr->getMesh(rfile);
1903         rfile->drop();
1904         // NOTE: By playing with Irrlicht refcounts, maybe we could cache a bunch
1905         // of uniquely named instances and re-use them
1906         mesh->grab();
1907         smgr->getMeshCache()->removeMesh(mesh);
1908         return mesh;
1909 }
1910
1911 bool Client::registerModStorage(ModMetadata *storage)
1912 {
1913         if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1914                 errorstream << "Unable to register same mod storage twice. Storage name: "
1915                                 << storage->getModName() << std::endl;
1916                 return false;
1917         }
1918
1919         m_mod_storages[storage->getModName()] = storage;
1920         return true;
1921 }
1922
1923 void Client::unregisterModStorage(const std::string &name)
1924 {
1925         UNORDERED_MAP<std::string, ModMetadata *>::const_iterator it = m_mod_storages.find(name);
1926         if (it != m_mod_storages.end()) {
1927                 // Save unconditionaly on unregistration
1928                 it->second->save(getModStoragePath());
1929                 m_mod_storages.erase(name);
1930         }
1931 }
1932
1933 std::string Client::getModStoragePath() const
1934 {
1935         return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1936 }
1937