src/client.cpp

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