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