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