src/client.cpp

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