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