3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
24 #include <IFileSystem.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"
42 #include "mapblock_mesh.h"
44 #include "mapsector.h"
46 #include "modchannels.h"
47 #include "content/mods.h"
51 #include "clientmap.h"
52 #include "clientmedia.h"
54 #include "database/database-files.h"
55 #include "database/database-sqlite3.h"
56 #include "serialization.h"
57 #include "guiscalingfilter.h"
58 #include "script/scripting_client.h"
60 #include "chatmessage.h"
61 #include "translation.h"
62 #include "content/mod_configuration.h"
64 extern gui::IGUIEnvironment* guienv;
70 u32 PacketCounter::sum() const
73 for (const auto &it : m_packets)
78 void PacketCounter::print(std::ostream &o) const
80 for (const auto &it : m_packets) {
81 auto name = it.first >= TOCLIENT_NUM_MSG_TYPES ? "?"
82 : toClientCommandTable[it.first].name;
83 o << "cmd " << it.first << " (" << name << ") count "
84 << it.second << std::endl;
93 const char *playername,
94 const std::string &password,
95 const std::string &address_name,
96 MapDrawControl &control,
97 IWritableTextureSource *tsrc,
98 IWritableShaderSource *shsrc,
99 IWritableItemDefManager *itemdef,
100 NodeDefManager *nodedef,
101 ISoundManager *sound,
102 MtEventManager *event,
103 RenderingEngine *rendering_engine,
106 ELoginRegister allow_login_or_register
114 m_rendering_engine(rendering_engine),
115 m_mesh_update_manager(this),
117 new ClientMap(this, rendering_engine, control, 666),
120 m_particle_manager(&m_env),
121 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
122 m_address_name(address_name),
123 m_allow_login_or_register(allow_login_or_register),
124 m_server_ser_ver(SER_FMT_VER_INVALID),
125 m_last_chat_message_sent(time(NULL)),
126 m_password(password),
127 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
128 m_media_downloader(new ClientMediaDownloader()),
131 m_modchannel_mgr(new ModChannelMgr())
134 m_env.setLocalPlayer(new LocalPlayer(this, playername));
136 // Make the mod storage database and begin the save for later
137 m_mod_storage_database =
138 new ModStorageDatabaseSQLite3(porting::path_user + DIR_DELIM + "client");
139 m_mod_storage_database->beginSave();
141 if (g_settings->getBool("enable_minimap")) {
142 m_minimap = new Minimap(this);
145 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
146 m_mesh_grid = { g_settings->getU16("client_mesh_chunk") };
149 void Client::migrateModStorage()
151 std::string mod_storage_dir = porting::path_user + DIR_DELIM + "client";
152 std::string old_mod_storage = mod_storage_dir + DIR_DELIM + "mod_storage";
153 if (fs::IsDir(old_mod_storage)) {
154 infostream << "Migrating client mod storage to SQLite3 database" << std::endl;
156 ModStorageDatabaseFiles files_db(mod_storage_dir);
157 std::vector<std::string> mod_list;
158 files_db.listMods(&mod_list);
159 for (const std::string &modname : mod_list) {
160 infostream << "Migrating client mod storage for mod " << modname << std::endl;
162 files_db.getModEntries(modname, &meta);
163 for (const auto &pair : meta) {
164 m_mod_storage_database->setModEntry(modname, pair.first, pair.second);
168 if (!fs::Rename(old_mod_storage, old_mod_storage + ".bak")) {
169 // Execution cannot move forward if the migration does not complete.
170 throw BaseException("Could not finish migrating client mod storage");
172 infostream << "Finished migration of client mod storage" << std::endl;
176 void Client::loadMods()
178 // Don't load mods twice.
179 // If client scripting is disabled by the client, don't load builtin or
180 // client-provided mods.
181 if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
184 // If client scripting is disabled by the server, don't load builtin or
185 // client-provided mods.
186 // TODO Delete this code block when server-sent CSM and verifying of builtin are
188 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
189 warningstream << "Client-provided mod loading is disabled by server." <<
194 m_script = new ClientScripting(this);
195 m_env.setScript(m_script);
196 m_script->setEnv(&m_env);
199 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
200 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
201 m_script->checkSetByBuiltin();
203 ModConfiguration modconf;
205 std::unordered_map<std::string, std::string> paths;
206 std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
207 const auto modsPath = getClientModsLuaPath();
208 if (modsPath != path_user) {
209 paths["share"] = modsPath;
211 paths["mods"] = path_user;
213 std::string settings_path = path_user + DIR_DELIM + "mods.conf";
214 modconf.addModsFromConfig(settings_path, paths);
215 modconf.checkConflictsAndDeps();
218 m_mods = modconf.getMods();
220 // complain about mods with unsatisfied dependencies
221 if (!modconf.isConsistent()) {
222 errorstream << modconf.getUnsatisfiedModsError() << std::endl;
227 infostream << "Client loading mods: ";
228 for (const ModSpec &mod : m_mods)
229 infostream << mod.name << " ";
230 infostream << std::endl;
232 // Load "mod" scripts
233 for (const ModSpec &mod : m_mods) {
235 scanModIntoMemory(mod.name, mod.path);
239 for (const ModSpec &mod : m_mods)
240 m_script->loadModFromMemory(mod.name);
242 // Mods are done loading. Unlock callbacks
243 m_mods_loaded = true;
245 // Run a callback when mods are loaded
246 m_script->on_mods_loaded();
248 // Create objects if they're ready
249 if (m_state == LC_Ready)
250 m_script->on_client_ready(m_env.getLocalPlayer());
252 m_script->on_camera_ready(m_camera);
254 m_script->on_minimap_ready(m_minimap);
257 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
258 std::string mod_subpath)
260 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
261 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
262 for (const fs::DirListNode &j : mod) {
263 if (j.name[0] == '.')
267 scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
270 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
272 std::string real_path = full_path + j.name;
273 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
274 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
275 << "\" as \"" << vfs_path << "\"." << std::endl;
277 std::string contents;
278 if (!fs::ReadFile(real_path, contents)) {
279 errorstream << "Client::scanModSubfolder(): Can't read file \""
280 << real_path << "\"." << std::endl;
284 m_mod_vfs.emplace(vfs_path, contents);
288 const std::string &Client::getBuiltinLuaPath()
290 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
294 const std::string &Client::getClientModsLuaPath()
296 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
297 return clientmods_dir;
300 const std::vector<ModSpec>& Client::getMods() const
302 static std::vector<ModSpec> client_modspec_temp;
303 return client_modspec_temp;
306 const ModSpec* Client::getModSpec(const std::string &modname) const
315 m_script->on_shutdown();
316 //request all client managed threads to stop
317 m_mesh_update_manager.stop();
318 // Save local server map
320 infostream << "Local map saving ended." << std::endl;
321 m_localdb->endSave();
328 bool Client::isShutdown()
330 return m_shutdown || !m_mesh_update_manager.isRunning();
340 m_mesh_update_manager.stop();
341 m_mesh_update_manager.wait();
344 while (m_mesh_update_manager.getNextResult(r)) {
345 for (auto block : r.map_blocks)
351 delete m_inventory_from_server;
353 // Delete detached inventories
354 for (auto &m_detached_inventorie : m_detached_inventories) {
355 delete m_detached_inventorie.second;
358 // cleanup 3d model meshes on client shutdown
359 m_rendering_engine->cleanupMeshCache();
361 guiScalingCacheClear();
366 delete m_media_downloader;
368 // Write the changes and delete
369 if (m_mod_storage_database)
370 m_mod_storage_database->endSave();
371 delete m_mod_storage_database;
374 void Client::connect(Address address, bool is_local_server)
376 initLocalMapSaving(address, m_address_name, is_local_server);
378 // Since we use TryReceive() a timeout here would be ineffective anyway
379 m_con->SetTimeoutMs(0);
380 m_con->Connect(address);
383 void Client::step(float dtime)
389 m_animation_time += dtime;
390 if(m_animation_time > 60.0)
391 m_animation_time -= 60.0;
393 m_time_of_day_update_timer += dtime;
401 float &counter = m_packetcounter_timer;
406 u32 sum = m_packetcounter.sum();
407 float avg = sum / counter;
409 infostream << "Client packetcounter (" << counter << "s): "
410 << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
411 m_packetcounter.print(infostream);
412 m_packetcounter.clear();
416 // UGLY hack to fix 2 second startup delay caused by non existent
417 // server client startup synchronization in local server or singleplayer mode
418 static bool initial_step = true;
420 initial_step = false;
422 else if(m_state == LC_Created) {
423 float &counter = m_connection_reinit_timer;
428 LocalPlayer *myplayer = m_env.getLocalPlayer();
429 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
431 sendInit(myplayer->getName());
434 // Not connected, return
439 Do stuff if connected
443 Run Map's timers and unload unused data
445 const float map_timer_and_unload_dtime = 5.25;
446 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
447 std::vector<v3s16> deleted_blocks;
448 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
449 std::max(g_settings->getFloat("client_unload_unused_data_timeout"), 0.0f),
450 g_settings->getS32("client_mapblock_limit"),
455 NOTE: This loop is intentionally iterated the way it is.
458 std::vector<v3s16>::iterator i = deleted_blocks.begin();
459 std::vector<v3s16> sendlist;
461 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
472 sendDeletedBlocks(sendlist);
474 if(i == deleted_blocks.end())
480 sendlist.push_back(*i);
486 Send pending messages on out chat queue
488 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
489 sendChatMessage(m_out_chat_queue.front());
490 m_out_chat_queue.pop();
496 LocalPlayer *player = m_env.getLocalPlayer();
498 // Step environment (also handles player controls)
500 m_sound->step(dtime);
505 while (m_env.hasClientEnvEvents()) {
506 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
508 if (envEvent.type == CEE_PLAYER_DAMAGE) {
509 u16 damage = envEvent.player_damage.amount;
511 if (envEvent.player_damage.send_to_server)
514 // Add to ClientEvent queue
515 ClientEvent *event = new ClientEvent();
516 event->type = CE_PLAYER_DAMAGE;
517 event->player_damage.amount = damage;
518 event->player_damage.effect = true;
519 m_client_event_queue.push(event);
526 float &counter = m_avg_rtt_timer;
530 // connectedAndInitialized() is true, peer exists.
531 float avg_rtt = getRTT();
532 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
536 Send player position to server
539 float &counter = m_playerpos_send_timer;
541 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
549 Replace updated meshes
552 int num_processed_meshes = 0;
553 std::vector<v3s16> blocks_to_ack;
554 bool force_update_shadows = false;
556 while (m_mesh_update_manager.getNextResult(r))
558 num_processed_meshes++;
560 std::vector<MinimapMapblock*> minimap_mapblocks;
561 bool do_mapper_update = true;
563 MapSector *sector = m_env.getMap().emergeSector(v2s16(r.p.X, r.p.Z));
565 MapBlock *block = sector->getBlockNoCreateNoEx(r.p.Y);
567 // The block in question is not visible (perhaps it is culled at the server),
568 // create a blank block just to hold the chunk's mesh.
569 // If the block becomes visible later it will replace the blank block.
570 if (!block && r.mesh)
571 block = sector->createBlankBlock(r.p.Y);
574 // Delete the old mesh
576 block->mesh = nullptr;
579 minimap_mapblocks = r.mesh->moveMinimapMapblocks();
580 if (minimap_mapblocks.empty())
581 do_mapper_update = false;
583 bool is_empty = true;
584 for (int l = 0; l < MAX_TILE_LAYERS; l++)
585 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
591 // Replace with the new mesh
592 block->mesh = r.mesh;
594 force_update_shadows = true;
601 for (auto p : r.solid_sides) {
602 auto block = m_env.getMap().getBlockNoCreateNoEx(p.first);
604 block->solid_sides = p.second;
607 if (m_minimap && do_mapper_update) {
610 // See also mapblock_mesh.cpp for the code that creates the array of minimap blocks.
611 for (ofs.Z = 0; ofs.Z < m_mesh_grid.cell_size; ofs.Z++)
612 for (ofs.Y = 0; ofs.Y < m_mesh_grid.cell_size; ofs.Y++)
613 for (ofs.X = 0; ofs.X < m_mesh_grid.cell_size; ofs.X++) {
614 size_t i = m_mesh_grid.getOffsetIndex(ofs);
615 if (i < minimap_mapblocks.size() && minimap_mapblocks[i])
616 m_minimap->addBlock(r.p + ofs, minimap_mapblocks[i]);
620 for (auto p : r.ack_list) {
621 if (blocks_to_ack.size() == 255) {
622 sendGotBlocks(blocks_to_ack);
623 blocks_to_ack.clear();
626 blocks_to_ack.emplace_back(p);
629 for (auto block : r.map_blocks)
633 if (blocks_to_ack.size() > 0) {
634 // Acknowledge block(s)
635 sendGotBlocks(blocks_to_ack);
638 if (num_processed_meshes > 0)
639 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
641 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
642 if (shadow_renderer && force_update_shadows)
643 shadow_renderer->setForceUpdateShadowMap();
649 if (m_media_downloader && m_media_downloader->isStarted()) {
650 m_media_downloader->step(this);
651 if (m_media_downloader->isDone()) {
652 delete m_media_downloader;
653 m_media_downloader = NULL;
657 // Acknowledge dynamic media downloads to server
658 std::vector<u32> done;
659 for (auto it = m_pending_media_downloads.begin();
660 it != m_pending_media_downloads.end();) {
661 assert(it->second->isStarted());
662 it->second->step(this);
663 if (it->second->isDone()) {
664 done.emplace_back(it->first);
666 it = m_pending_media_downloads.erase(it);
671 if (done.size() == 255) { // maximum in one packet
681 If the server didn't update the inventory in a while, revert
682 the local inventory (so the player notices the lag problem
683 and knows something is wrong).
685 if (m_inventory_from_server) {
686 float interval = 10.0f;
687 float count_before = std::floor(m_inventory_from_server_age / interval);
689 m_inventory_from_server_age += dtime;
691 float count_after = std::floor(m_inventory_from_server_age / interval);
693 if (count_after != count_before) {
694 // Do this every <interval> seconds after TOCLIENT_INVENTORY
695 // Reset the locally changed inventory to the authoritative inventory
696 player->inventory = *m_inventory_from_server;
697 m_update_wielded_item = true;
702 Update positions of sounds attached to objects
705 for (auto &m_sounds_to_object : m_sounds_to_objects) {
706 int client_id = m_sounds_to_object.first;
707 u16 object_id = m_sounds_to_object.second;
708 ClientActiveObject *cao = m_env.getActiveObject(object_id);
711 m_sound->updateSoundPosition(client_id, cao->getPosition());
716 Handle removed remotely initiated sounds
718 m_removed_sounds_check_timer += dtime;
719 if(m_removed_sounds_check_timer >= 2.32) {
720 m_removed_sounds_check_timer = 0;
721 // Find removed sounds and clear references to them
722 std::vector<s32> removed_server_ids;
723 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
724 i != m_sounds_server_to_client.end();) {
725 s32 server_id = i->first;
726 int client_id = i->second;
728 if(!m_sound->soundExists(client_id)) {
729 m_sounds_server_to_client.erase(server_id);
730 m_sounds_client_to_server.erase(client_id);
731 m_sounds_to_objects.erase(client_id);
732 removed_server_ids.push_back(server_id);
737 if(!removed_server_ids.empty()) {
738 sendRemovedSounds(removed_server_ids);
742 // Write changes to the mod storage
743 m_mod_storage_save_timer -= dtime;
744 if (m_mod_storage_save_timer <= 0.0f) {
745 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
746 m_mod_storage_database->endSave();
747 m_mod_storage_database->beginSave();
751 if (m_localdb && m_localdb_save_interval.step(dtime,
752 m_cache_save_interval)) {
753 m_localdb->endSave();
754 m_localdb->beginSave();
758 bool Client::loadMedia(const std::string &data, const std::string &filename,
759 bool from_media_push)
763 const char *image_ext[] = {
764 ".png", ".jpg", ".bmp", ".tga",
765 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
768 name = removeStringEnd(filename, image_ext);
770 TRACESTREAM(<< "Client: Attempting to load image "
771 << "file \"" << filename << "\"" << std::endl);
773 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
774 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
776 io::IReadFile *rfile = irrfs->createMemoryReadFile(
777 data.c_str(), data.size(), "_tempreadfile");
779 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
782 video::IImage *img = vdrv->createImageFromFile(rfile);
784 errorstream<<"Client: Cannot create image from data of "
785 <<"file \""<<filename<<"\""<<std::endl;
790 m_tsrc->insertSourceImage(filename, img);
796 const char *sound_ext[] = {
797 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
798 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
801 name = removeStringEnd(filename, sound_ext);
803 TRACESTREAM(<< "Client: Attempting to load sound "
804 << "file \"" << filename << "\"" << std::endl);
805 return m_sound->loadSoundData(name, data);
808 const char *model_ext[] = {
809 ".x", ".b3d", ".md2", ".obj",
812 name = removeStringEnd(filename, model_ext);
814 verbosestream<<"Client: Storing model into memory: "
815 <<"\""<<filename<<"\""<<std::endl;
816 if(m_mesh_data.count(filename))
817 errorstream<<"Multiple models with name \""<<filename.c_str()
818 <<"\" found; replacing previous model"<<std::endl;
819 m_mesh_data[filename] = data;
823 const char *translate_ext[] = {
826 name = removeStringEnd(filename, translate_ext);
830 TRACESTREAM(<< "Client: Loading translation: "
831 << "\"" << filename << "\"" << std::endl);
832 g_client_translations->loadTranslation(data);
836 errorstream << "Client: Don't know how to load file \""
837 << filename << "\"" << std::endl;
841 // Virtual methods from con::PeerHandler
842 void Client::peerAdded(con::Peer *peer)
844 infostream << "Client::peerAdded(): peer->id="
845 << peer->id << std::endl;
848 void Client::deletingPeer(con::Peer *peer, bool timeout)
850 infostream << "Client::deletingPeer(): "
851 "Server Peer is getting deleted "
852 << "(timeout=" << timeout << ")" << std::endl;
854 m_access_denied = true;
856 m_access_denied_reason = gettext("Connection timed out.");
857 else if (m_access_denied_reason.empty())
858 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
863 u16 number of files requested
869 void Client::request_media(const std::vector<std::string> &file_requests)
871 std::ostringstream os(std::ios_base::binary);
872 writeU16(os, TOSERVER_REQUEST_MEDIA);
873 size_t file_requests_size = file_requests.size();
875 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
877 // Packet dynamicly resized
878 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
880 pkt << (u16) (file_requests_size & 0xFFFF);
882 for (const std::string &file_request : file_requests) {
888 infostream << "Client: Sending media request list to server ("
889 << file_requests.size() << " files, packet size "
890 << pkt.getSize() << ")" << std::endl;
893 void Client::initLocalMapSaving(const Address &address,
894 const std::string &hostname,
895 bool is_local_server)
897 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
901 std::string world_path;
902 #define set_world_path(hostname) \
903 world_path = porting::path_user \
904 + DIR_DELIM + "worlds" \
905 + DIR_DELIM + "server_" \
906 + hostname + "_" + std::to_string(address.getPort());
908 set_world_path(hostname);
909 if (!fs::IsDir(world_path)) {
910 std::string hostname_escaped = hostname;
911 str_replace(hostname_escaped, ':', '_');
912 set_world_path(hostname_escaped);
914 #undef set_world_path
915 fs::CreateAllDirs(world_path);
917 m_localdb = new MapDatabaseSQLite3(world_path);
918 m_localdb->beginSave();
919 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
922 void Client::ReceiveAll()
925 u64 start_ms = porting::getTimeMs();
926 const u64 budget = 100;
928 // Limit time even if there would be huge amounts of data to
930 if (porting::getTimeMs() > start_ms + budget) {
931 infostream << "Client::ReceiveAll(): "
932 "Packet processing budget exceeded." << std::endl;
938 if (!m_con->TryReceive(&pkt))
941 } catch (const con::InvalidIncomingDataException &e) {
942 infostream << "Client::ReceiveAll(): "
943 "InvalidIncomingDataException: what()="
944 << e.what() << std::endl;
949 inline void Client::handleCommand(NetworkPacket* pkt)
951 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
952 (this->*opHandle.handler)(pkt);
956 sender_peer_id given to this shall be quaranteed to be a valid peer
958 void Client::ProcessData(NetworkPacket *pkt)
960 ToClientCommand command = (ToClientCommand) pkt->getCommand();
961 u32 sender_peer_id = pkt->getPeerId();
963 //infostream<<"Client: received command="<<command<<std::endl;
964 m_packetcounter.add((u16)command);
965 g_profiler->graphAdd("client_received_packets", 1);
968 If this check is removed, be sure to change the queue
969 system to know the ids
971 if(sender_peer_id != PEER_ID_SERVER) {
972 infostream << "Client::ProcessData(): Discarding data not "
973 "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
978 // Command must be handled into ToClientCommandHandler
979 if (command >= TOCLIENT_NUM_MSG_TYPES) {
980 infostream << "Client: Ignoring unknown command "
981 << command << std::endl;
986 * Those packets are handled before m_server_ser_ver is set, it's normal
987 * But we must use the new ToClientConnectionState in the future,
990 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
995 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
996 infostream << "Client: Server serialization"
997 " format invalid or not initialized."
998 " Skipping incoming command=" << command << std::endl;
1003 Handle runtime commands
1009 void Client::Send(NetworkPacket* pkt)
1011 m_con->Send(PEER_ID_SERVER,
1012 serverCommandFactoryTable[pkt->getCommand()].channel,
1014 serverCommandFactoryTable[pkt->getCommand()].reliable);
1017 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
1018 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
1020 v3f pf = myplayer->getPosition() * 100;
1021 v3f sf = myplayer->getSpeed() * 100;
1022 s32 pitch = myplayer->getPitch() * 100;
1023 s32 yaw = myplayer->getYaw() * 100;
1024 u32 keyPressed = myplayer->control.getKeysPressed();
1025 // scaled by 80, so that pi can fit into a u8
1026 u8 fov = clientMap->getCameraFov() * 80;
1027 u8 wanted_range = MYMIN(255,
1028 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
1030 v3s32 position(pf.X, pf.Y, pf.Z);
1031 v3s32 speed(sf.X, sf.Y, sf.Z);
1035 [0] v3s32 position*100
1036 [12] v3s32 speed*100
1037 [12+12] s32 pitch*100
1038 [12+12+4] s32 yaw*100
1039 [12+12+4+4] u32 keyPressed
1040 [12+12+4+4+4] u8 fov*80
1041 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
1043 *pkt << position << speed << pitch << yaw << keyPressed;
1044 *pkt << fov << wanted_range;
1047 void Client::interact(InteractAction action, const PointedThing& pointed)
1049 if(m_state != LC_Ready) {
1050 errorstream << "Client::interact() "
1051 "Canceled (not connected)"
1056 LocalPlayer *myplayer = m_env.getLocalPlayer();
1057 if (myplayer == NULL)
1064 [5] u32 length of the next item (plen)
1065 [9] serialized PointedThing
1066 [9 + plen] player position information
1069 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1072 pkt << myplayer->getWieldIndex();
1074 std::ostringstream tmp_os(std::ios::binary);
1075 pointed.serialize(tmp_os);
1077 pkt.putLongString(tmp_os.str());
1079 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1084 void Client::deleteAuthData()
1089 switch (m_chosen_auth_mech) {
1090 case AUTH_MECHANISM_FIRST_SRP:
1092 case AUTH_MECHANISM_SRP:
1093 case AUTH_MECHANISM_LEGACY_PASSWORD:
1094 srp_user_delete((SRPUser *) m_auth_data);
1097 case AUTH_MECHANISM_NONE:
1100 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1104 AuthMechanism Client::choseAuthMech(const u32 mechs)
1106 if (mechs & AUTH_MECHANISM_SRP)
1107 return AUTH_MECHANISM_SRP;
1109 if (mechs & AUTH_MECHANISM_FIRST_SRP)
1110 return AUTH_MECHANISM_FIRST_SRP;
1112 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1113 return AUTH_MECHANISM_LEGACY_PASSWORD;
1115 return AUTH_MECHANISM_NONE;
1118 void Client::sendInit(const std::string &playerName)
1120 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1122 // we don't support network compression yet
1123 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1125 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1126 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1132 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1134 m_chosen_auth_mech = chosen_auth_mechanism;
1136 switch (chosen_auth_mechanism) {
1137 case AUTH_MECHANISM_FIRST_SRP: {
1138 // send srp verifier to server
1139 std::string verifier;
1141 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1144 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1145 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1150 case AUTH_MECHANISM_SRP:
1151 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1154 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1155 m_password = translate_password(getPlayerName(), m_password);
1159 std::string playername_u = lowercase(getPlayerName());
1160 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1161 getPlayerName().c_str(), playername_u.c_str(),
1162 (const unsigned char *) m_password.c_str(),
1163 m_password.length(), NULL, NULL);
1166 SRP_Result res = srp_user_start_authentication(
1167 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1168 (unsigned char **) &bytes_A, &len_A);
1169 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1171 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1172 resp_pkt << std::string(bytes_A, len_A) << based_on;
1176 case AUTH_MECHANISM_NONE:
1177 break; // not handled in this method
1181 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1183 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1185 pkt << (u8) blocks.size();
1187 for (const v3s16 &block : blocks) {
1194 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1196 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1197 pkt << (u8) blocks.size();
1198 for (const v3s16 &block : blocks)
1204 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1206 size_t server_ids = soundList.size();
1207 assert(server_ids <= 0xFFFF);
1209 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1211 pkt << (u16) (server_ids & 0xFFFF);
1213 for (s32 sound_id : soundList)
1219 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1220 const StringMap &fields)
1222 size_t fields_size = fields.size();
1224 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1226 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1228 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1230 StringMap::const_iterator it;
1231 for (it = fields.begin(); it != fields.end(); ++it) {
1232 const std::string &name = it->first;
1233 const std::string &value = it->second;
1235 pkt.putLongString(value);
1241 void Client::sendInventoryFields(const std::string &formname,
1242 const StringMap &fields)
1244 size_t fields_size = fields.size();
1245 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1247 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1248 pkt << formname << (u16) (fields_size & 0xFFFF);
1250 StringMap::const_iterator it;
1251 for (it = fields.begin(); it != fields.end(); ++it) {
1252 const std::string &name = it->first;
1253 const std::string &value = it->second;
1255 pkt.putLongString(value);
1261 void Client::sendInventoryAction(InventoryAction *a)
1263 std::ostringstream os(std::ios_base::binary);
1268 std::string s = os.str();
1270 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1271 pkt.putRawString(s.c_str(),s.size());
1276 bool Client::canSendChatMessage() const
1278 u32 now = time(NULL);
1279 float time_passed = now - m_last_chat_message_sent;
1281 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1282 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1284 if (virt_chat_message_allowance < 1.0f)
1290 void Client::sendChatMessage(const std::wstring &message)
1292 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1293 if (canSendChatMessage()) {
1294 u32 now = time(NULL);
1295 float time_passed = now - m_last_chat_message_sent;
1296 m_last_chat_message_sent = now;
1298 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1299 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1300 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1302 m_chat_message_allowance -= 1.0f;
1304 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1309 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size < 0) {
1310 m_out_chat_queue.push(message);
1312 infostream << "Could not queue chat message because maximum out chat queue size ("
1313 << max_queue_size << ") is reached." << std::endl;
1317 void Client::clearOutChatQueue()
1319 m_out_chat_queue = std::queue<std::wstring>();
1322 void Client::sendChangePassword(const std::string &oldpassword,
1323 const std::string &newpassword)
1325 LocalPlayer *player = m_env.getLocalPlayer();
1329 // get into sudo mode and then send new password to server
1330 m_password = oldpassword;
1331 m_new_password = newpassword;
1332 startAuth(choseAuthMech(m_sudo_auth_methods));
1336 void Client::sendDamage(u16 damage)
1338 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1343 void Client::sendRespawn()
1345 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1349 void Client::sendReady()
1351 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1352 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1354 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1355 << (u8) 0 << (u16) strlen(g_version_hash);
1357 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1358 pkt << (u16)FORMSPEC_API_VERSION;
1362 void Client::sendPlayerPos()
1364 LocalPlayer *player = m_env.getLocalPlayer();
1368 // Save bandwidth by only updating position when
1369 // player is not dead and something changed
1371 if (m_activeobjects_received && player->isDead())
1374 ClientMap &map = m_env.getClientMap();
1375 u8 camera_fov = map.getCameraFov();
1376 u8 wanted_range = map.getControl().wanted_range;
1378 u32 keyPressed = player->control.getKeysPressed();
1381 player->last_position == player->getPosition() &&
1382 player->last_speed == player->getSpeed() &&
1383 player->last_pitch == player->getPitch() &&
1384 player->last_yaw == player->getYaw() &&
1385 player->last_keyPressed == keyPressed &&
1386 player->last_camera_fov == camera_fov &&
1387 player->last_wanted_range == wanted_range)
1390 player->last_position = player->getPosition();
1391 player->last_speed = player->getSpeed();
1392 player->last_pitch = player->getPitch();
1393 player->last_yaw = player->getYaw();
1394 player->last_keyPressed = keyPressed;
1395 player->last_camera_fov = camera_fov;
1396 player->last_wanted_range = wanted_range;
1398 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1400 writePlayerPos(player, &map, &pkt);
1405 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1407 NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1409 sanity_check(tokens.size() < 256);
1411 pkt << static_cast<u8>(tokens.size());
1412 for (u32 token : tokens)
1418 void Client::removeNode(v3s16 p)
1420 std::map<v3s16, MapBlock*> modified_blocks;
1423 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1425 catch(InvalidPositionException &e) {
1428 for (const auto &modified_block : modified_blocks) {
1429 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1434 * Helper function for Client Side Modding
1435 * CSM restrictions are applied there, this should not be used for core engine
1437 * @param is_valid_position
1440 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1442 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1443 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1444 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1445 *is_valid_position = false;
1449 return m_env.getMap().getNode(p, is_valid_position);
1452 int Client::CSMClampRadius(v3s16 pos, int radius)
1454 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1456 // This is approximate and will cause some allowed nodes to be excluded
1457 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1458 u32 distance = ppos.getDistanceFrom(pos);
1459 if (distance >= m_csm_restriction_noderange)
1461 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1464 v3s16 Client::CSMClampPos(v3s16 pos)
1466 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1468 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1469 const int range = m_csm_restriction_noderange;
1471 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1472 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1473 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1477 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1479 //TimeTaker timer1("Client::addNode()");
1481 std::map<v3s16, MapBlock*> modified_blocks;
1484 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1485 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1487 catch(InvalidPositionException &e) {
1490 for (const auto &modified_block : modified_blocks) {
1491 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1495 void Client::setPlayerControl(PlayerControl &control)
1497 LocalPlayer *player = m_env.getLocalPlayer();
1499 player->control = control;
1502 void Client::setPlayerItem(u16 item)
1504 m_env.getLocalPlayer()->setWieldIndex(item);
1505 m_update_wielded_item = true;
1507 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1512 // Returns true once after the inventory of the local player
1513 // has been updated from the server.
1514 bool Client::updateWieldedItem()
1516 if (!m_update_wielded_item)
1519 m_update_wielded_item = false;
1521 LocalPlayer *player = m_env.getLocalPlayer();
1523 if (auto *list = player->inventory.getList("main"))
1524 list->setModified(false);
1525 if (auto *list = player->inventory.getList("hand"))
1526 list->setModified(false);
1531 scene::ISceneManager* Client::getSceneManager()
1533 return m_rendering_engine->get_scene_manager();
1536 Inventory* Client::getInventory(const InventoryLocation &loc)
1539 case InventoryLocation::UNDEFINED:
1542 case InventoryLocation::CURRENT_PLAYER:
1544 LocalPlayer *player = m_env.getLocalPlayer();
1546 return &player->inventory;
1549 case InventoryLocation::PLAYER:
1551 // Check if we are working with local player inventory
1552 LocalPlayer *player = m_env.getLocalPlayer();
1553 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1555 return &player->inventory;
1558 case InventoryLocation::NODEMETA:
1560 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1563 return meta->getInventory();
1566 case InventoryLocation::DETACHED:
1568 if (m_detached_inventories.count(loc.name) == 0)
1570 return m_detached_inventories[loc.name];
1574 FATAL_ERROR("Invalid inventory location type.");
1580 void Client::inventoryAction(InventoryAction *a)
1583 Send it to the server
1585 sendInventoryAction(a);
1588 Predict some local inventory changes
1590 a->clientApply(this, this);
1596 float Client::getAnimationTime()
1598 return m_animation_time;
1601 int Client::getCrackLevel()
1603 return m_crack_level;
1606 v3s16 Client::getCrackPos()
1611 void Client::setCrack(int level, v3s16 pos)
1613 int old_crack_level = m_crack_level;
1614 v3s16 old_crack_pos = m_crack_pos;
1616 m_crack_level = level;
1619 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1622 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1624 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1627 addUpdateMeshTaskForNode(pos, false, true);
1633 LocalPlayer *player = m_env.getLocalPlayer();
1638 bool Client::getChatMessage(std::wstring &res)
1640 if (m_chat_queue.empty())
1643 ChatMessage *chatMessage = m_chat_queue.front();
1648 switch (chatMessage->type) {
1649 case CHATMESSAGE_TYPE_RAW:
1650 case CHATMESSAGE_TYPE_ANNOUNCE:
1651 case CHATMESSAGE_TYPE_SYSTEM:
1652 res = chatMessage->message;
1654 case CHATMESSAGE_TYPE_NORMAL: {
1655 if (!chatMessage->sender.empty())
1656 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1658 res = chatMessage->message;
1669 void Client::typeChatMessage(const std::wstring &message)
1671 // Discard empty line
1672 if (message.empty())
1675 // If message was consumed by script API, don't send it to server
1676 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1680 sendChatMessage(message);
1683 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1685 // Check if the block exists to begin with. In the case when a non-existing
1686 // neighbor is automatically added, it may not. In that case we don't want
1687 // to tell the mesh update thread about it.
1688 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1692 m_mesh_update_manager.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1695 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1697 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1700 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1704 infostream<<"Client::addUpdateMeshTaskForNode(): "
1705 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1709 v3s16 blockpos = getNodeBlockPos(nodepos);
1710 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1711 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1713 if (nodepos.X == blockpos_relative.X)
1714 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1715 if (nodepos.Y == blockpos_relative.Y)
1716 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1717 if (nodepos.Z == blockpos_relative.Z)
1718 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1721 ClientEvent *Client::getClientEvent()
1723 FATAL_ERROR_IF(m_client_event_queue.empty(),
1724 "Cannot getClientEvent, queue is empty.");
1726 ClientEvent *event = m_client_event_queue.front();
1727 m_client_event_queue.pop();
1731 const Address Client::getServerAddress()
1733 return m_con->GetPeerAddress(PEER_ID_SERVER);
1736 float Client::mediaReceiveProgress()
1738 if (m_media_downloader)
1739 return m_media_downloader->getProgress();
1741 return 1.0; // downloader only exists when not yet done
1744 struct TextureUpdateArgs {
1745 gui::IGUIEnvironment *guienv;
1748 const wchar_t* text_base;
1749 ITextureSource *tsrc;
1752 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1754 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1755 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1757 // update the loading menu -- if necessary
1758 bool do_draw = false;
1759 u64 time_ms = targs->last_time_ms;
1760 if (cur_percent != targs->last_percent) {
1761 targs->last_percent = cur_percent;
1762 time_ms = porting::getTimeMs();
1763 // only draw when the user will notice something:
1764 do_draw = (time_ms - targs->last_time_ms > 100);
1768 targs->last_time_ms = time_ms;
1769 std::wostringstream strm;
1770 strm << targs->text_base << L" " << targs->last_percent << L"%...";
1771 m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1772 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1776 void Client::afterContentReceived()
1778 infostream<<"Client::afterContentReceived() started"<<std::endl;
1779 assert(m_itemdef_received); // pre-condition
1780 assert(m_nodedef_received); // pre-condition
1781 assert(mediaReceived()); // pre-condition
1783 const wchar_t* text = wgettext("Loading textures...");
1785 // Clear cached pre-scaled 2D GUI images, as this cache
1786 // might have images with the same name but different
1787 // content from previous sessions.
1788 guiScalingCacheClear();
1790 // Rebuild inherited images and recreate textures
1791 infostream<<"- Rebuilding images and textures"<<std::endl;
1792 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1793 m_tsrc->rebuildImagesAndTextures();
1797 infostream<<"- Rebuilding shaders"<<std::endl;
1798 text = wgettext("Rebuilding shaders...");
1799 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1800 m_shsrc->rebuildShaders();
1803 // Update node aliases
1804 infostream<<"- Updating node aliases"<<std::endl;
1805 text = wgettext("Initializing nodes...");
1806 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1807 m_nodedef->updateAliases(m_itemdef);
1808 for (const auto &path : getTextureDirs()) {
1809 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1810 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1811 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1813 m_nodedef->setNodeRegistrationStatus(true);
1814 m_nodedef->runNodeResolveCallbacks();
1817 // Update node textures and assign shaders to each tile
1818 infostream<<"- Updating node textures"<<std::endl;
1819 TextureUpdateArgs tu_args;
1820 tu_args.guienv = guienv;
1821 tu_args.last_time_ms = porting::getTimeMs();
1822 tu_args.last_percent = 0;
1823 tu_args.text_base = wgettext("Initializing nodes");
1824 tu_args.tsrc = m_tsrc;
1825 m_nodedef->updateTextures(this, &tu_args);
1826 delete[] tu_args.text_base;
1828 // Start mesh update thread after setting up content definitions
1829 infostream<<"- Starting mesh update thread"<<std::endl;
1830 m_mesh_update_manager.start();
1836 m_script->on_client_ready(m_env.getLocalPlayer());
1838 text = wgettext("Done!");
1839 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1840 infostream<<"Client::afterContentReceived() done"<<std::endl;
1844 float Client::getRTT()
1846 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1849 float Client::getCurRate()
1851 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1852 m_con->getLocalStat(con::CUR_DL_RATE));
1855 void Client::makeScreenshot()
1857 irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1858 irr::video::IImage* const raw_image = driver->createScreenShot();
1863 const struct tm tm = mt_localtime();
1865 char timetstamp_c[64];
1866 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1868 std::string screenshot_dir;
1870 if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1871 screenshot_dir = g_settings->get("screenshot_path");
1873 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1875 std::string filename_base = screenshot_dir
1877 + std::string("screenshot_")
1878 + std::string(timetstamp_c);
1879 std::string filename_ext = "." + g_settings->get("screenshot_format");
1880 std::string filename;
1882 // Create the directory if it doesn't already exist.
1883 // Otherwise, saving the screenshot would fail.
1884 fs::CreateDir(screenshot_dir);
1886 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1887 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1889 // Try to find a unique filename
1890 unsigned serial = 0;
1892 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1893 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1894 std::ifstream tmp(filename.c_str());
1896 break; // File did not apparently exist, we'll go with it
1900 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1901 infostream << "Could not find suitable filename for screenshot" << std::endl;
1903 irr::video::IImage* const image =
1904 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1907 raw_image->copyTo(image);
1909 std::ostringstream sstr;
1910 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1911 sstr << "Saved screenshot to '" << filename << "'";
1913 sstr << "Failed to save screenshot '" << filename << "'";
1915 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1916 utf8_to_wide(sstr.str())));
1917 infostream << sstr.str() << std::endl;
1925 bool Client::shouldShowMinimap() const
1927 return !m_minimap_disabled_by_server;
1930 void Client::pushToEventQueue(ClientEvent *event)
1932 m_client_event_queue.push(event);
1935 void Client::showMinimap(const bool show)
1937 m_game_ui->showMinimap(show);
1940 // IGameDef interface
1942 IItemDefManager* Client::getItemDefManager()
1946 const NodeDefManager* Client::getNodeDefManager()
1950 ICraftDefManager* Client::getCraftDefManager()
1953 //return m_craftdef;
1955 ITextureSource* Client::getTextureSource()
1959 IWritableShaderSource* Client::getShaderSource()
1964 u16 Client::allocateUnknownNodeId(const std::string &name)
1966 errorstream << "Client::allocateUnknownNodeId(): "
1967 << "Client cannot allocate node IDs" << std::endl;
1968 FATAL_ERROR("Client allocated unknown node");
1970 return CONTENT_IGNORE;
1972 ISoundManager* Client::getSoundManager()
1976 MtEventManager* Client::getEventManager()
1981 ParticleManager* Client::getParticleManager()
1983 return &m_particle_manager;
1986 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1988 StringMap::const_iterator it = m_mesh_data.find(filename);
1989 if (it == m_mesh_data.end()) {
1990 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1991 << "\"" << std::endl;
1994 const std::string &data = it->second;
1996 // Create the mesh, remove it from cache and return it
1997 // This allows unique vertex colors and other properties for each instance
1998 io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1999 data.c_str(), data.size(), filename.c_str());
2000 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
2002 scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
2008 m_rendering_engine->removeMesh(mesh);
2012 const std::string* Client::getModFile(std::string filename)
2014 // strip dir delimiter from beginning of path
2015 auto pos = filename.find_first_of(':');
2016 if (pos == std::string::npos)
2019 auto pos2 = filename.find_first_not_of('/', pos);
2021 filename.erase(pos, pos2 - pos);
2023 StringMap::const_iterator it = m_mod_vfs.find(filename);
2024 if (it == m_mod_vfs.end())
2033 bool Client::joinModChannel(const std::string &channel)
2035 if (m_modchannel_mgr->channelRegistered(channel))
2038 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2042 m_modchannel_mgr->joinChannel(channel, 0);
2046 bool Client::leaveModChannel(const std::string &channel)
2048 if (!m_modchannel_mgr->channelRegistered(channel))
2051 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2055 m_modchannel_mgr->leaveChannel(channel, 0);
2059 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2061 if (!m_modchannel_mgr->canWriteOnChannel(channel))
2064 if (message.size() > STRING_MAX_LEN) {
2065 warningstream << "ModChannel message too long, dropping before sending "
2066 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2067 << channel << ")" << std::endl;
2071 // @TODO: do some client rate limiting
2072 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2073 pkt << channel << message;
2078 ModChannel* Client::getModChannel(const std::string &channel)
2080 return m_modchannel_mgr->getModChannel(channel);