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 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
 933 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
 934 {
 935         v3f pf           = myplayer->getPosition() * 100;
 936         v3f sf           = myplayer->getSpeed() * 100;
 937         s32 pitch        = myplayer->getPitch() * 100;
 938         s32 yaw          = myplayer->getYaw() * 100;
 939         u32 keyPressed   = myplayer->keyPressed;
 940         // scaled by 80, so that pi can fit into a u8
 941         u8 fov           = clientMap->getCameraFov() * 80;
 942         u8 wanted_range  = clientMap->getControl().wanted_range / MAP_BLOCKSIZE;
 943
 944         v3s32 position(pf.X, pf.Y, pf.Z);
 945         v3s32 speed(sf.X, sf.Y, sf.Z);
 946
 947         /*
 948                 Format:
 949                 [0] v3s32 position*100
 950                 [12] v3s32 speed*100
 951                 [12+12] s32 pitch*100
 952                 [12+12+4] s32 yaw*100
 953                 [12+12+4+4] u32 keyPressed
 954                 [12+12+4+4+4] u8 fov*80
 955                 [12+12+4+4+4+1] u8 wanted_range / MAP_BLOCKSIZE
 956         */
 957         *pkt << position << speed << pitch << yaw << keyPressed;
 958         *pkt << fov << wanted_range;
 959 }
 960
 961 void Client::interact(u8 action, const PointedThing& pointed)
 962 {
 963         if(m_state != LC_Ready) {
 964                 errorstream << "Client::interact() "
 965                                 "Canceled (not connected)"
 966                                 << std::endl;
 967                 return;
 968         }
 969
 970         LocalPlayer *myplayer = m_env.getLocalPlayer();
 971         if (myplayer == NULL)
 972                 return;
 973
 974         /*
 975                 [0] u16 command
 976                 [2] u8 action
 977                 [3] u16 item
 978                 [5] u32 length of the next item (plen)
 979                 [9] serialized PointedThing
 980                 [9 + plen] player position information
 981                 actions:
 982                 0: start digging (from undersurface) or use
 983                 1: stop digging (all parameters ignored)
 984                 2: digging completed
 985                 3: place block or item (to abovesurface)
 986                 4: use item
 987                 5: perform secondary action of item
 988         */
 989
 990         NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
 991
 992         pkt << action;
 993         pkt << (u16)getPlayerItem();
 994
 995         std::ostringstream tmp_os(std::ios::binary);
 996         pointed.serialize(tmp_os);
 997
 998         pkt.putLongString(tmp_os.str());
 999
1000         writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1001
1002         Send(&pkt);
1003 }
1004
1005 void Client::deleteAuthData()
1006 {
1007         if (!m_auth_data)
1008                 return;
1009
1010         switch (m_chosen_auth_mech) {
1011                 case AUTH_MECHANISM_FIRST_SRP:
1012                         break;
1013                 case AUTH_MECHANISM_SRP:
1014                 case AUTH_MECHANISM_LEGACY_PASSWORD:
1015                         srp_user_delete((SRPUser *) m_auth_data);
1016                         m_auth_data = NULL;
1017                         break;
1018                 case AUTH_MECHANISM_NONE:
1019                         break;
1020         }
1021         m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1022 }
1023
1024
1025 AuthMechanism Client::choseAuthMech(const u32 mechs)
1026 {
1027         if (mechs & AUTH_MECHANISM_SRP)
1028                 return AUTH_MECHANISM_SRP;
1029
1030         if (mechs & AUTH_MECHANISM_FIRST_SRP)
1031                 return AUTH_MECHANISM_FIRST_SRP;
1032
1033         if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1034                 return AUTH_MECHANISM_LEGACY_PASSWORD;
1035
1036         return AUTH_MECHANISM_NONE;
1037 }
1038
1039 void Client::sendLegacyInit(const char* playerName, const char* playerPassword)
1040 {
1041         NetworkPacket pkt(TOSERVER_INIT_LEGACY,
1042                         1 + PLAYERNAME_SIZE + PASSWORD_SIZE + 2 + 2);
1043
1044         u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
1045                 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
1046
1047         pkt << (u8) SER_FMT_VER_HIGHEST_READ;
1048         pkt.putRawString(playerName,PLAYERNAME_SIZE);
1049         pkt.putRawString(playerPassword, PASSWORD_SIZE);
1050         pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1051
1052         Send(&pkt);
1053 }
1054
1055 void Client::sendInit(const std::string &playerName)
1056 {
1057         NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1058
1059         // we don't support network compression yet
1060         u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1061
1062         u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
1063                 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
1064
1065         pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1066         pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1067         pkt << playerName;
1068
1069         Send(&pkt);
1070 }
1071
1072 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1073 {
1074         m_chosen_auth_mech = chosen_auth_mechanism;
1075
1076         switch (chosen_auth_mechanism) {
1077                 case AUTH_MECHANISM_FIRST_SRP: {
1078                         // send srp verifier to server
1079                         std::string verifier;
1080                         std::string salt;
1081                         generate_srp_verifier_and_salt(getPlayerName(), m_password,
1082                                 &verifier, &salt);
1083
1084                         NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1085                         resp_pkt << salt << verifier << (u8)((m_password == "") ? 1 : 0);
1086
1087                         Send(&resp_pkt);
1088                         break;
1089                 }
1090                 case AUTH_MECHANISM_SRP:
1091                 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1092                         u8 based_on = 1;
1093
1094                         if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1095                                 m_password = translate_password(getPlayerName(), m_password);
1096                                 based_on = 0;
1097                         }
1098
1099                         std::string playername_u = lowercase(getPlayerName());
1100                         m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1101                                 getPlayerName().c_str(), playername_u.c_str(),
1102                                 (const unsigned char *) m_password.c_str(),
1103                                 m_password.length(), NULL, NULL);
1104                         char *bytes_A = 0;
1105                         size_t len_A = 0;
1106                         SRP_Result res = srp_user_start_authentication(
1107                                 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1108                                 (unsigned char **) &bytes_A, &len_A);
1109                         FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1110
1111                         NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1112                         resp_pkt << std::string(bytes_A, len_A) << based_on;
1113                         Send(&resp_pkt);
1114                         break;
1115                 }
1116                 case AUTH_MECHANISM_NONE:
1117                         break; // not handled in this method
1118         }
1119 }
1120
1121 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1122 {
1123         NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1124
1125         pkt << (u8) blocks.size();
1126
1127         u32 k = 0;
1128         for(std::vector<v3s16>::iterator
1129                         j = blocks.begin();
1130                         j != blocks.end(); ++j) {
1131                 pkt << *j;
1132                 k++;
1133         }
1134
1135         Send(&pkt);
1136 }
1137
1138 void Client::sendGotBlocks(v3s16 block)
1139 {
1140         NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1141         pkt << (u8) 1 << block;
1142         Send(&pkt);
1143 }
1144
1145 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1146 {
1147         size_t server_ids = soundList.size();
1148         assert(server_ids <= 0xFFFF);
1149
1150         NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1151
1152         pkt << (u16) (server_ids & 0xFFFF);
1153
1154         for(std::vector<s32>::iterator i = soundList.begin();
1155                         i != soundList.end(); ++i)
1156                 pkt << *i;
1157
1158         Send(&pkt);
1159 }
1160
1161 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1162                 const StringMap &fields)
1163 {
1164         size_t fields_size = fields.size();
1165
1166         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1167
1168         NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1169
1170         pkt << p << formname << (u16) (fields_size & 0xFFFF);
1171
1172         StringMap::const_iterator it;
1173         for (it = fields.begin(); it != fields.end(); ++it) {
1174                 const std::string &name = it->first;
1175                 const std::string &value = it->second;
1176                 pkt << name;
1177                 pkt.putLongString(value);
1178         }
1179
1180         Send(&pkt);
1181 }
1182
1183 void Client::sendInventoryFields(const std::string &formname,
1184                 const StringMap &fields)
1185 {
1186         size_t fields_size = fields.size();
1187         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1188
1189         NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1190         pkt << formname << (u16) (fields_size & 0xFFFF);
1191
1192         StringMap::const_iterator it;
1193         for (it = fields.begin(); it != fields.end(); ++it) {
1194                 const std::string &name  = it->first;
1195                 const std::string &value = it->second;
1196                 pkt << name;
1197                 pkt.putLongString(value);
1198         }
1199
1200         Send(&pkt);
1201 }
1202
1203 void Client::sendInventoryAction(InventoryAction *a)
1204 {
1205         std::ostringstream os(std::ios_base::binary);
1206
1207         a->serialize(os);
1208
1209         // Make data buffer
1210         std::string s = os.str();
1211
1212         NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1213         pkt.putRawString(s.c_str(),s.size());
1214
1215         Send(&pkt);
1216 }
1217
1218 void Client::sendChatMessage(const std::wstring &message)
1219 {
1220         NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1221
1222         pkt << message;
1223
1224         Send(&pkt);
1225 }
1226
1227 void Client::sendChangePassword(const std::string &oldpassword,
1228         const std::string &newpassword)
1229 {
1230         LocalPlayer *player = m_env.getLocalPlayer();
1231         if (player == NULL)
1232                 return;
1233
1234         std::string playername = player->getName();
1235         if (m_proto_ver >= 25) {
1236                 // get into sudo mode and then send new password to server
1237                 m_password = oldpassword;
1238                 m_new_password = newpassword;
1239                 startAuth(choseAuthMech(m_sudo_auth_methods));
1240         } else {
1241                 std::string oldpwd = translate_password(playername, oldpassword);
1242                 std::string newpwd = translate_password(playername, newpassword);
1243
1244                 NetworkPacket pkt(TOSERVER_PASSWORD_LEGACY, 2 * PASSWORD_SIZE);
1245
1246                 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1247                         pkt << (u8) (i < oldpwd.length() ? oldpwd[i] : 0);
1248                 }
1249
1250                 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1251                         pkt << (u8) (i < newpwd.length() ? newpwd[i] : 0);
1252                 }
1253                 Send(&pkt);
1254         }
1255 }
1256
1257
1258 void Client::sendDamage(u8 damage)
1259 {
1260         DSTACK(FUNCTION_NAME);
1261
1262         NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u8));
1263         pkt << damage;
1264         Send(&pkt);
1265 }
1266
1267 void Client::sendBreath(u16 breath)
1268 {
1269         DSTACK(FUNCTION_NAME);
1270
1271         NetworkPacket pkt(TOSERVER_BREATH, sizeof(u16));
1272         pkt << breath;
1273         Send(&pkt);
1274 }
1275
1276 void Client::sendRespawn()
1277 {
1278         DSTACK(FUNCTION_NAME);
1279
1280         NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1281         Send(&pkt);
1282 }
1283
1284 void Client::sendReady()
1285 {
1286         DSTACK(FUNCTION_NAME);
1287
1288         NetworkPacket pkt(TOSERVER_CLIENT_READY,
1289                         1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash));
1290
1291         pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1292                 << (u8) 0 << (u16) strlen(g_version_hash);
1293
1294         pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1295         Send(&pkt);
1296 }
1297
1298 void Client::sendPlayerPos()
1299 {
1300         LocalPlayer *myplayer = m_env.getLocalPlayer();
1301         if(myplayer == NULL)
1302                 return;
1303
1304         ClientMap &map = m_env.getClientMap();
1305
1306         u8 camera_fov    = map.getCameraFov();
1307         u8 wanted_range  = map.getControl().wanted_range;
1308
1309         // Save bandwidth by only updating position when something changed
1310         if(myplayer->last_position        == myplayer->getPosition() &&
1311                         myplayer->last_speed        == myplayer->getSpeed()    &&
1312                         myplayer->last_pitch        == myplayer->getPitch()    &&
1313                         myplayer->last_yaw          == myplayer->getYaw()      &&
1314                         myplayer->last_keyPressed   == myplayer->keyPressed    &&
1315                         myplayer->last_camera_fov   == camera_fov              &&
1316                         myplayer->last_wanted_range == wanted_range)
1317                 return;
1318
1319         myplayer->last_position     = myplayer->getPosition();
1320         myplayer->last_speed        = myplayer->getSpeed();
1321         myplayer->last_pitch        = myplayer->getPitch();
1322         myplayer->last_yaw          = myplayer->getYaw();
1323         myplayer->last_keyPressed   = myplayer->keyPressed;
1324         myplayer->last_camera_fov   = camera_fov;
1325         myplayer->last_wanted_range = wanted_range;
1326
1327         //infostream << "Sending Player Position information" << std::endl;
1328
1329         u16 our_peer_id;
1330         {
1331                 //MutexAutoLock lock(m_con_mutex); //bulk comment-out
1332                 our_peer_id = m_con.GetPeerID();
1333         }
1334
1335         // Set peer id if not set already
1336         if(myplayer->peer_id == PEER_ID_INEXISTENT)
1337                 myplayer->peer_id = our_peer_id;
1338
1339         assert(myplayer->peer_id == our_peer_id);
1340
1341         NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1342
1343         writePlayerPos(myplayer, &map, &pkt);
1344
1345         Send(&pkt);
1346 }
1347
1348 void Client::sendPlayerItem(u16 item)
1349 {
1350         LocalPlayer *myplayer = m_env.getLocalPlayer();
1351         if(myplayer == NULL)
1352                 return;
1353
1354         u16 our_peer_id = m_con.GetPeerID();
1355
1356         // Set peer id if not set already
1357         if(myplayer->peer_id == PEER_ID_INEXISTENT)
1358                 myplayer->peer_id = our_peer_id;
1359         assert(myplayer->peer_id == our_peer_id);
1360
1361         NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1362
1363         pkt << item;
1364
1365         Send(&pkt);
1366 }
1367
1368 void Client::removeNode(v3s16 p)
1369 {
1370         std::map<v3s16, MapBlock*> modified_blocks;
1371
1372         try {
1373                 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1374         }
1375         catch(InvalidPositionException &e) {
1376         }
1377
1378         for(std::map<v3s16, MapBlock *>::iterator
1379                         i = modified_blocks.begin();
1380                         i != modified_blocks.end(); ++i) {
1381                 addUpdateMeshTaskWithEdge(i->first, false, true);
1382         }
1383 }
1384
1385 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1386 {
1387         //TimeTaker timer1("Client::addNode()");
1388
1389         std::map<v3s16, MapBlock*> modified_blocks;
1390
1391         try {
1392                 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1393                 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1394         }
1395         catch(InvalidPositionException &e) {
1396         }
1397
1398         for(std::map<v3s16, MapBlock *>::iterator
1399                         i = modified_blocks.begin();
1400                         i != modified_blocks.end(); ++i) {
1401                 addUpdateMeshTaskWithEdge(i->first, false, true);
1402         }
1403 }
1404
1405 void Client::setPlayerControl(PlayerControl &control)
1406 {
1407         LocalPlayer *player = m_env.getLocalPlayer();
1408         assert(player != NULL);
1409         player->control = control;
1410 }
1411
1412 void Client::selectPlayerItem(u16 item)
1413 {
1414         m_playeritem = item;
1415         m_inventory_updated = true;
1416         sendPlayerItem(item);
1417 }
1418
1419 // Returns true if the inventory of the local player has been
1420 // updated from the server. If it is true, it is set to false.
1421 bool Client::getLocalInventoryUpdated()
1422 {
1423         bool updated = m_inventory_updated;
1424         m_inventory_updated = false;
1425         return updated;
1426 }
1427
1428 // Copies the inventory of the local player to parameter
1429 void Client::getLocalInventory(Inventory &dst)
1430 {
1431         LocalPlayer *player = m_env.getLocalPlayer();
1432         assert(player != NULL);
1433         dst = player->inventory;
1434 }
1435
1436 Inventory* Client::getInventory(const InventoryLocation &loc)
1437 {
1438         switch(loc.type){
1439         case InventoryLocation::UNDEFINED:
1440         {}
1441         break;
1442         case InventoryLocation::CURRENT_PLAYER:
1443         {
1444                 LocalPlayer *player = m_env.getLocalPlayer();
1445                 assert(player != NULL);
1446                 return &player->inventory;
1447         }
1448         break;
1449         case InventoryLocation::PLAYER:
1450         {
1451                 // Check if we are working with local player inventory
1452                 LocalPlayer *player = m_env.getLocalPlayer();
1453                 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1454                         return NULL;
1455                 return &player->inventory;
1456         }
1457         break;
1458         case InventoryLocation::NODEMETA:
1459         {
1460                 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1461                 if(!meta)
1462                         return NULL;
1463                 return meta->getInventory();
1464         }
1465         break;
1466         case InventoryLocation::DETACHED:
1467         {
1468                 if (m_detached_inventories.count(loc.name) == 0)
1469                         return NULL;
1470                 return m_detached_inventories[loc.name];
1471         }
1472         break;
1473         default:
1474                 FATAL_ERROR("Invalid inventory location type.");
1475                 break;
1476         }
1477         return NULL;
1478 }
1479
1480 void Client::inventoryAction(InventoryAction *a)
1481 {
1482         /*
1483                 Send it to the server
1484         */
1485         sendInventoryAction(a);
1486
1487         /*
1488                 Predict some local inventory changes
1489         */
1490         a->clientApply(this, this);
1491
1492         // Remove it
1493         delete a;
1494 }
1495
1496 ClientActiveObject * Client::getSelectedActiveObject(
1497                 f32 max_d,
1498                 v3f from_pos_f_on_map,
1499                 core::line3d<f32> shootline_on_map
1500         )
1501 {
1502         std::vector<DistanceSortedActiveObject> objects;
1503
1504         m_env.getActiveObjects(from_pos_f_on_map, max_d, objects);
1505
1506         // Sort them.
1507         // After this, the closest object is the first in the array.
1508         std::sort(objects.begin(), objects.end());
1509
1510         for(unsigned int i=0; i<objects.size(); i++)
1511         {
1512                 ClientActiveObject *obj = objects[i].obj;
1513
1514                 aabb3f *selection_box = obj->getSelectionBox();
1515                 if(selection_box == NULL)
1516                         continue;
1517
1518                 v3f pos = obj->getPosition();
1519
1520                 aabb3f offsetted_box(
1521                                 selection_box->MinEdge + pos,
1522                                 selection_box->MaxEdge + pos
1523                 );
1524
1525                 if(offsetted_box.intersectsWithLine(shootline_on_map))
1526                 {
1527                         return obj;
1528                 }
1529         }
1530
1531         return NULL;
1532 }
1533
1534 float Client::getAnimationTime()
1535 {
1536         return m_animation_time;
1537 }
1538
1539 int Client::getCrackLevel()
1540 {
1541         return m_crack_level;
1542 }
1543
1544 void Client::setCrack(int level, v3s16 pos)
1545 {
1546         int old_crack_level = m_crack_level;
1547         v3s16 old_crack_pos = m_crack_pos;
1548
1549         m_crack_level = level;
1550         m_crack_pos = pos;
1551
1552         if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1553         {
1554                 // remove old crack
1555                 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1556         }
1557         if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1558         {
1559                 // add new crack
1560                 addUpdateMeshTaskForNode(pos, false, true);
1561         }
1562 }
1563
1564 u16 Client::getHP()
1565 {
1566         LocalPlayer *player = m_env.getLocalPlayer();
1567         assert(player != NULL);
1568         return player->hp;
1569 }
1570
1571 bool Client::getChatMessage(std::wstring &message)
1572 {
1573         if(m_chat_queue.size() == 0)
1574                 return false;
1575         message = m_chat_queue.front();
1576         m_chat_queue.pop();
1577         return true;
1578 }
1579
1580 void Client::typeChatMessage(const std::wstring &message)
1581 {
1582         // Discard empty line
1583         if(message == L"")
1584                 return;
1585
1586         // Send to others
1587         sendChatMessage(message);
1588
1589         // Show locally
1590         if (message[0] == L'/')
1591         {
1592                 m_chat_queue.push((std::wstring)L"issued command: " + message);
1593         }
1594         else
1595         {
1596                 LocalPlayer *player = m_env.getLocalPlayer();
1597                 assert(player != NULL);
1598                 std::wstring name = narrow_to_wide(player->getName());
1599                 m_chat_queue.push((std::wstring)L"<" + name + L"> " + message);
1600         }
1601 }
1602
1603 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1604 {
1605         MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1606         if(b == NULL)
1607                 return;
1608
1609         /*
1610                 Create a task to update the mesh of the block
1611         */
1612
1613         MeshMakeData *data = new MeshMakeData(this, m_cache_enable_shaders,
1614                 m_cache_use_tangent_vertices);
1615
1616         {
1617                 //TimeTaker timer("data fill");
1618                 // Release: ~0ms
1619                 // Debug: 1-6ms, avg=2ms
1620                 data->fill(b);
1621                 data->setCrack(m_crack_level, m_crack_pos);
1622                 data->setSmoothLighting(m_cache_smooth_lighting);
1623         }
1624
1625         // Add task to queue
1626         m_mesh_update_thread.enqueueUpdate(p, data, ack_to_server, urgent);
1627 }
1628
1629 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1630 {
1631         try{
1632                 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1633         }
1634         catch(InvalidPositionException &e){}
1635
1636         // Leading edge
1637         for (int i=0;i<6;i++)
1638         {
1639                 try{
1640                         v3s16 p = blockpos + g_6dirs[i];
1641                         addUpdateMeshTask(p, false, urgent);
1642                 }
1643                 catch(InvalidPositionException &e){}
1644         }
1645 }
1646
1647 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1648 {
1649         {
1650                 v3s16 p = nodepos;
1651                 infostream<<"Client::addUpdateMeshTaskForNode(): "
1652                                 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1653                                 <<std::endl;
1654         }
1655
1656         v3s16 blockpos          = getNodeBlockPos(nodepos);
1657         v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1658
1659         try{
1660                 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1661         }
1662         catch(InvalidPositionException &e) {}
1663
1664         // Leading edge
1665         if(nodepos.X == blockpos_relative.X){
1666                 try{
1667                         v3s16 p = blockpos + v3s16(-1,0,0);
1668                         addUpdateMeshTask(p, false, urgent);
1669                 }
1670                 catch(InvalidPositionException &e){}
1671         }
1672
1673         if(nodepos.Y == blockpos_relative.Y){
1674                 try{
1675                         v3s16 p = blockpos + v3s16(0,-1,0);
1676                         addUpdateMeshTask(p, false, urgent);
1677                 }
1678                 catch(InvalidPositionException &e){}
1679         }
1680
1681         if(nodepos.Z == blockpos_relative.Z){
1682                 try{
1683                         v3s16 p = blockpos + v3s16(0,0,-1);
1684                         addUpdateMeshTask(p, false, urgent);
1685                 }
1686                 catch(InvalidPositionException &e){}
1687         }
1688 }
1689
1690 ClientEvent Client::getClientEvent()
1691 {
1692         ClientEvent event;
1693         if (m_client_event_queue.empty()) {
1694                 event.type = CE_NONE;
1695         }
1696         else {
1697                 event = m_client_event_queue.front();
1698                 m_client_event_queue.pop();
1699         }
1700         return event;
1701 }
1702
1703 float Client::mediaReceiveProgress()
1704 {
1705         if (m_media_downloader)
1706                 return m_media_downloader->getProgress();
1707         else
1708                 return 1.0; // downloader only exists when not yet done
1709 }
1710
1711 typedef struct TextureUpdateArgs {
1712         IrrlichtDevice *device;
1713         gui::IGUIEnvironment *guienv;
1714         u32 last_time_ms;
1715         u16 last_percent;
1716         const wchar_t* text_base;
1717 } TextureUpdateArgs;
1718
1719 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1720 {
1721                 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1722                 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1723
1724                 // update the loading menu -- if neccessary
1725                 bool do_draw = false;
1726                 u32 time_ms = targs->last_time_ms;
1727                 if (cur_percent != targs->last_percent) {
1728                         targs->last_percent = cur_percent;
1729                         time_ms = getTimeMs();
1730                         // only draw when the user will notice something:
1731                         do_draw = (time_ms - targs->last_time_ms > 100);
1732                 }
1733
1734                 if (do_draw) {
1735                         targs->last_time_ms = time_ms;
1736                         std::basic_stringstream<wchar_t> strm;
1737                         strm << targs->text_base << " " << targs->last_percent << "%...";
1738                         draw_load_screen(strm.str(), targs->device, targs->guienv, 0,
1739                                 72 + (u16) ((18. / 100.) * (double) targs->last_percent));
1740                 }
1741 }
1742
1743 void Client::afterContentReceived(IrrlichtDevice *device)
1744 {
1745         infostream<<"Client::afterContentReceived() started"<<std::endl;
1746         assert(m_itemdef_received); // pre-condition
1747         assert(m_nodedef_received); // pre-condition
1748         assert(mediaReceived()); // pre-condition
1749
1750         const wchar_t* text = wgettext("Loading textures...");
1751
1752         // Clear cached pre-scaled 2D GUI images, as this cache
1753         // might have images with the same name but different
1754         // content from previous sessions.
1755         guiScalingCacheClear(device->getVideoDriver());
1756
1757         // Rebuild inherited images and recreate textures
1758         infostream<<"- Rebuilding images and textures"<<std::endl;
1759         draw_load_screen(text,device, guienv, 0, 70);
1760         m_tsrc->rebuildImagesAndTextures();
1761         delete[] text;
1762
1763         // Rebuild shaders
1764         infostream<<"- Rebuilding shaders"<<std::endl;
1765         text = wgettext("Rebuilding shaders...");
1766         draw_load_screen(text, device, guienv, 0, 71);
1767         m_shsrc->rebuildShaders();
1768         delete[] text;
1769
1770         // Update node aliases
1771         infostream<<"- Updating node aliases"<<std::endl;
1772         text = wgettext("Initializing nodes...");
1773         draw_load_screen(text, device, guienv, 0, 72);
1774         m_nodedef->updateAliases(m_itemdef);
1775         std::string texture_path = g_settings->get("texture_path");
1776         if (texture_path != "" && fs::IsDir(texture_path))
1777                 m_nodedef->applyTextureOverrides(texture_path + DIR_DELIM + "override.txt");
1778         m_nodedef->setNodeRegistrationStatus(true);
1779         m_nodedef->runNodeResolveCallbacks();
1780         delete[] text;
1781
1782         // Update node textures and assign shaders to each tile
1783         infostream<<"- Updating node textures"<<std::endl;
1784         TextureUpdateArgs tu_args;
1785         tu_args.device = device;
1786         tu_args.guienv = guienv;
1787         tu_args.last_time_ms = getTimeMs();
1788         tu_args.last_percent = 0;
1789         tu_args.text_base =  wgettext("Initializing nodes");
1790         m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1791         delete[] tu_args.text_base;
1792
1793         // Start mesh update thread after setting up content definitions
1794         infostream<<"- Starting mesh update thread"<<std::endl;
1795         m_mesh_update_thread.start();
1796
1797         m_state = LC_Ready;
1798         sendReady();
1799         text = wgettext("Done!");
1800         draw_load_screen(text, device, guienv, 0, 100);
1801         infostream<<"Client::afterContentReceived() done"<<std::endl;
1802         delete[] text;
1803 }
1804
1805 float Client::getRTT(void)
1806 {
1807         return m_con.getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1808 }
1809
1810 float Client::getCurRate(void)
1811 {
1812         return ( m_con.getLocalStat(con::CUR_INC_RATE) +
1813                         m_con.getLocalStat(con::CUR_DL_RATE));
1814 }
1815
1816 float Client::getAvgRate(void)
1817 {
1818         return ( m_con.getLocalStat(con::AVG_INC_RATE) +
1819                         m_con.getLocalStat(con::AVG_DL_RATE));
1820 }
1821
1822 void Client::makeScreenshot(IrrlichtDevice *device)
1823 {
1824         irr::video::IVideoDriver *driver = device->getVideoDriver();
1825         irr::video::IImage* const raw_image = driver->createScreenShot();
1826
1827         if (!raw_image)
1828                 return;
1829
1830         time_t t = time(NULL);
1831         struct tm *tm = localtime(&t);
1832
1833         char timetstamp_c[64];
1834         strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1835
1836         std::string filename_base = g_settings->get("screenshot_path")
1837                         + DIR_DELIM
1838                         + std::string("screenshot_")
1839                         + std::string(timetstamp_c);
1840         std::string filename_ext = "." + g_settings->get("screenshot_format");
1841         std::string filename;
1842
1843         u32 quality = (u32)g_settings->getS32("screenshot_quality");
1844         quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
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(), quality)) {
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 }