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