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