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