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