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");
148 void Client::migrateModStorage()
150 std::string mod_storage_dir = porting::path_user + DIR_DELIM + "client";
151 std::string old_mod_storage = mod_storage_dir + DIR_DELIM + "mod_storage";
152 if (fs::IsDir(old_mod_storage)) {
153 infostream << "Migrating client mod storage to SQLite3 database" << std::endl;
155 ModStorageDatabaseFiles files_db(mod_storage_dir);
156 std::vector<std::string> mod_list;
157 files_db.listMods(&mod_list);
158 for (const std::string &modname : mod_list) {
159 infostream << "Migrating client mod storage for mod " << modname << std::endl;
161 files_db.getModEntries(modname, &meta);
162 for (const auto &pair : meta) {
163 m_mod_storage_database->setModEntry(modname, pair.first, pair.second);
167 if (!fs::Rename(old_mod_storage, old_mod_storage + ".bak")) {
168 // Execution cannot move forward if the migration does not complete.
169 throw BaseException("Could not finish migrating client mod storage");
171 infostream << "Finished migration of client mod storage" << std::endl;
175 void Client::loadMods()
177 // Don't load mods twice.
178 // If client scripting is disabled by the client, don't load builtin or
179 // client-provided mods.
180 if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
183 // If client scripting is disabled by the server, don't load builtin or
184 // client-provided mods.
185 // TODO Delete this code block when server-sent CSM and verifying of builtin are
187 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
188 warningstream << "Client-provided mod loading is disabled by server." <<
193 m_script = new ClientScripting(this);
194 m_env.setScript(m_script);
195 m_script->setEnv(&m_env);
198 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
199 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
200 m_script->checkSetByBuiltin();
202 ModConfiguration modconf;
204 std::unordered_map<std::string, std::string> paths;
205 std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
206 const auto modsPath = getClientModsLuaPath();
207 if (modsPath != path_user) {
208 paths["share"] = modsPath;
210 paths["mods"] = path_user;
212 std::string settings_path = path_user + DIR_DELIM + "mods.conf";
213 modconf.addModsFromConfig(settings_path, paths);
214 modconf.checkConflictsAndDeps();
217 m_mods = modconf.getMods();
219 // complain about mods with unsatisfied dependencies
220 if (!modconf.isConsistent()) {
221 errorstream << modconf.getUnsatisfiedModsError() << std::endl;
226 infostream << "Client loading mods: ";
227 for (const ModSpec &mod : m_mods)
228 infostream << mod.name << " ";
229 infostream << std::endl;
231 // Load "mod" scripts
232 for (const ModSpec &mod : m_mods) {
234 scanModIntoMemory(mod.name, mod.path);
238 for (const ModSpec &mod : m_mods)
239 m_script->loadModFromMemory(mod.name);
241 // Mods are done loading. Unlock callbacks
242 m_mods_loaded = true;
244 // Run a callback when mods are loaded
245 m_script->on_mods_loaded();
247 // Create objects if they're ready
248 if (m_state == LC_Ready)
249 m_script->on_client_ready(m_env.getLocalPlayer());
251 m_script->on_camera_ready(m_camera);
253 m_script->on_minimap_ready(m_minimap);
256 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
257 std::string mod_subpath)
259 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
260 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
261 for (const fs::DirListNode &j : mod) {
262 if (j.name[0] == '.')
266 scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
269 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
271 std::string real_path = full_path + j.name;
272 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
273 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
274 << "\" as \"" << vfs_path << "\"." << std::endl;
276 std::string contents;
277 if (!fs::ReadFile(real_path, contents)) {
278 errorstream << "Client::scanModSubfolder(): Can't read file \""
279 << real_path << "\"." << std::endl;
283 m_mod_vfs.emplace(vfs_path, contents);
287 const std::string &Client::getBuiltinLuaPath()
289 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
293 const std::string &Client::getClientModsLuaPath()
295 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
296 return clientmods_dir;
299 const std::vector<ModSpec>& Client::getMods() const
301 static std::vector<ModSpec> client_modspec_temp;
302 return client_modspec_temp;
305 const ModSpec* Client::getModSpec(const std::string &modname) const
314 m_script->on_shutdown();
315 //request all client managed threads to stop
316 m_mesh_update_manager.stop();
317 // Save local server map
319 infostream << "Local map saving ended." << std::endl;
320 m_localdb->endSave();
327 bool Client::isShutdown()
329 return m_shutdown || !m_mesh_update_manager.isRunning();
339 m_mesh_update_manager.stop();
340 m_mesh_update_manager.wait();
343 while (m_mesh_update_manager.getNextResult(r)) {
344 for (auto block : r.map_blocks)
350 delete m_inventory_from_server;
352 // Delete detached inventories
353 for (auto &m_detached_inventorie : m_detached_inventories) {
354 delete m_detached_inventorie.second;
357 // cleanup 3d model meshes on client shutdown
358 m_rendering_engine->cleanupMeshCache();
360 guiScalingCacheClear();
365 delete m_media_downloader;
367 // Write the changes and delete
368 if (m_mod_storage_database)
369 m_mod_storage_database->endSave();
370 delete m_mod_storage_database;
373 void Client::connect(Address address, bool is_local_server)
375 initLocalMapSaving(address, m_address_name, is_local_server);
377 // Since we use TryReceive() a timeout here would be ineffective anyway
378 m_con->SetTimeoutMs(0);
379 m_con->Connect(address);
382 void Client::step(float dtime)
388 m_animation_time += dtime;
389 if(m_animation_time > 60.0)
390 m_animation_time -= 60.0;
392 m_time_of_day_update_timer += dtime;
400 float &counter = m_packetcounter_timer;
405 u32 sum = m_packetcounter.sum();
406 float avg = sum / counter;
408 infostream << "Client packetcounter (" << counter << "s): "
409 << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
410 m_packetcounter.print(infostream);
411 m_packetcounter.clear();
415 // UGLY hack to fix 2 second startup delay caused by non existent
416 // server client startup synchronization in local server or singleplayer mode
417 static bool initial_step = true;
419 initial_step = false;
421 else if(m_state == LC_Created) {
422 float &counter = m_connection_reinit_timer;
427 LocalPlayer *myplayer = m_env.getLocalPlayer();
428 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
430 sendInit(myplayer->getName());
433 // Not connected, return
438 Do stuff if connected
442 Run Map's timers and unload unused data
444 const float map_timer_and_unload_dtime = 5.25;
445 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
446 std::vector<v3s16> deleted_blocks;
447 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
448 std::max(g_settings->getFloat("client_unload_unused_data_timeout"), 0.0f),
449 g_settings->getS32("client_mapblock_limit"),
454 NOTE: This loop is intentionally iterated the way it is.
457 std::vector<v3s16>::iterator i = deleted_blocks.begin();
458 std::vector<v3s16> sendlist;
460 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
471 sendDeletedBlocks(sendlist);
473 if(i == deleted_blocks.end())
479 sendlist.push_back(*i);
485 Send pending messages on out chat queue
487 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
488 sendChatMessage(m_out_chat_queue.front());
489 m_out_chat_queue.pop();
495 LocalPlayer *player = m_env.getLocalPlayer();
497 // Step environment (also handles player controls)
499 m_sound->step(dtime);
504 while (m_env.hasClientEnvEvents()) {
505 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
507 if (envEvent.type == CEE_PLAYER_DAMAGE) {
508 u16 damage = envEvent.player_damage.amount;
510 if (envEvent.player_damage.send_to_server)
513 // Add to ClientEvent queue
514 ClientEvent *event = new ClientEvent();
515 event->type = CE_PLAYER_DAMAGE;
516 event->player_damage.amount = damage;
517 event->player_damage.effect = true;
518 m_client_event_queue.push(event);
525 float &counter = m_avg_rtt_timer;
529 // connectedAndInitialized() is true, peer exists.
530 float avg_rtt = getRTT();
531 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
535 Send player position to server
538 float &counter = m_playerpos_send_timer;
540 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
548 Replace updated meshes
551 int num_processed_meshes = 0;
552 std::vector<v3s16> blocks_to_ack;
553 bool force_update_shadows = false;
555 while (m_mesh_update_manager.getNextResult(r))
557 num_processed_meshes++;
559 std::vector<MinimapMapblock*> minimap_mapblocks;
560 bool do_mapper_update = true;
562 MapSector *sector = m_env.getMap().emergeSector(v2s16(r.p.X, r.p.Z));
564 MapBlock *block = sector->getBlockNoCreateNoEx(r.p.Y);
566 // The block in question is not visible (perhaps it is culled at the server),
567 // create a blank block just to hold the 2x2x2 mesh.
568 // If the block becomes visible later it will replace the blank block.
569 if (!block && r.mesh)
570 block = sector->createBlankBlock(r.p.Y);
573 // Delete the old mesh
575 block->mesh = nullptr;
578 minimap_mapblocks = r.mesh->moveMinimapMapblocks();
579 if (minimap_mapblocks.empty())
580 do_mapper_update = false;
582 bool is_empty = true;
583 for (int l = 0; l < MAX_TILE_LAYERS; l++)
584 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
590 // Replace with the new mesh
591 block->mesh = r.mesh;
593 force_update_shadows = true;
600 for (auto p : r.solid_sides) {
601 auto block = m_env.getMap().getBlockNoCreateNoEx(p.first);
603 block->solid_sides = p.second;
606 if (m_minimap && do_mapper_update) {
609 // See also mapblock_mesh.cpp for the code that creates the array of minimap blocks.
610 for (ofs.Z = 0; ofs.Z <= 1; ofs.Z++)
611 for (ofs.Y = 0; ofs.Y <= 1; ofs.Y++)
612 for (ofs.X = 0; ofs.X <= 1; ofs.X++) {
613 size_t i = ofs.Z * 4 + ofs.Y * 2 + ofs.X;
614 if (i < minimap_mapblocks.size() && minimap_mapblocks[i])
615 m_minimap->addBlock(r.p + ofs, minimap_mapblocks[i]);
619 for (auto p : r.ack_list) {
620 if (blocks_to_ack.size() == 255) {
621 sendGotBlocks(blocks_to_ack);
622 blocks_to_ack.clear();
625 blocks_to_ack.emplace_back(p);
628 for (auto block : r.map_blocks)
632 if (blocks_to_ack.size() > 0) {
633 // Acknowledge block(s)
634 sendGotBlocks(blocks_to_ack);
637 if (num_processed_meshes > 0)
638 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
640 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
641 if (shadow_renderer && force_update_shadows)
642 shadow_renderer->setForceUpdateShadowMap();
648 if (m_media_downloader && m_media_downloader->isStarted()) {
649 m_media_downloader->step(this);
650 if (m_media_downloader->isDone()) {
651 delete m_media_downloader;
652 m_media_downloader = NULL;
656 // Acknowledge dynamic media downloads to server
657 std::vector<u32> done;
658 for (auto it = m_pending_media_downloads.begin();
659 it != m_pending_media_downloads.end();) {
660 assert(it->second->isStarted());
661 it->second->step(this);
662 if (it->second->isDone()) {
663 done.emplace_back(it->first);
665 it = m_pending_media_downloads.erase(it);
670 if (done.size() == 255) { // maximum in one packet
680 If the server didn't update the inventory in a while, revert
681 the local inventory (so the player notices the lag problem
682 and knows something is wrong).
684 if (m_inventory_from_server) {
685 float interval = 10.0f;
686 float count_before = std::floor(m_inventory_from_server_age / interval);
688 m_inventory_from_server_age += dtime;
690 float count_after = std::floor(m_inventory_from_server_age / interval);
692 if (count_after != count_before) {
693 // Do this every <interval> seconds after TOCLIENT_INVENTORY
694 // Reset the locally changed inventory to the authoritative inventory
695 player->inventory = *m_inventory_from_server;
696 m_update_wielded_item = true;
701 Update positions of sounds attached to objects
704 for (auto &m_sounds_to_object : m_sounds_to_objects) {
705 int client_id = m_sounds_to_object.first;
706 u16 object_id = m_sounds_to_object.second;
707 ClientActiveObject *cao = m_env.getActiveObject(object_id);
710 m_sound->updateSoundPosition(client_id, cao->getPosition());
715 Handle removed remotely initiated sounds
717 m_removed_sounds_check_timer += dtime;
718 if(m_removed_sounds_check_timer >= 2.32) {
719 m_removed_sounds_check_timer = 0;
720 // Find removed sounds and clear references to them
721 std::vector<s32> removed_server_ids;
722 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
723 i != m_sounds_server_to_client.end();) {
724 s32 server_id = i->first;
725 int client_id = i->second;
727 if(!m_sound->soundExists(client_id)) {
728 m_sounds_server_to_client.erase(server_id);
729 m_sounds_client_to_server.erase(client_id);
730 m_sounds_to_objects.erase(client_id);
731 removed_server_ids.push_back(server_id);
736 if(!removed_server_ids.empty()) {
737 sendRemovedSounds(removed_server_ids);
741 // Write changes to the mod storage
742 m_mod_storage_save_timer -= dtime;
743 if (m_mod_storage_save_timer <= 0.0f) {
744 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
745 m_mod_storage_database->endSave();
746 m_mod_storage_database->beginSave();
750 if (m_localdb && m_localdb_save_interval.step(dtime,
751 m_cache_save_interval)) {
752 m_localdb->endSave();
753 m_localdb->beginSave();
757 bool Client::loadMedia(const std::string &data, const std::string &filename,
758 bool from_media_push)
762 const char *image_ext[] = {
763 ".png", ".jpg", ".bmp", ".tga",
764 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
767 name = removeStringEnd(filename, image_ext);
769 TRACESTREAM(<< "Client: Attempting to load image "
770 << "file \"" << filename << "\"" << std::endl);
772 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
773 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
775 io::IReadFile *rfile = irrfs->createMemoryReadFile(
776 data.c_str(), data.size(), "_tempreadfile");
778 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
781 video::IImage *img = vdrv->createImageFromFile(rfile);
783 errorstream<<"Client: Cannot create image from data of "
784 <<"file \""<<filename<<"\""<<std::endl;
789 m_tsrc->insertSourceImage(filename, img);
795 const char *sound_ext[] = {
796 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
797 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
800 name = removeStringEnd(filename, sound_ext);
802 TRACESTREAM(<< "Client: Attempting to load sound "
803 << "file \"" << filename << "\"" << std::endl);
804 return m_sound->loadSoundData(name, data);
807 const char *model_ext[] = {
808 ".x", ".b3d", ".md2", ".obj",
811 name = removeStringEnd(filename, model_ext);
813 verbosestream<<"Client: Storing model into memory: "
814 <<"\""<<filename<<"\""<<std::endl;
815 if(m_mesh_data.count(filename))
816 errorstream<<"Multiple models with name \""<<filename.c_str()
817 <<"\" found; replacing previous model"<<std::endl;
818 m_mesh_data[filename] = data;
822 const char *translate_ext[] = {
825 name = removeStringEnd(filename, translate_ext);
829 TRACESTREAM(<< "Client: Loading translation: "
830 << "\"" << filename << "\"" << std::endl);
831 g_client_translations->loadTranslation(data);
835 errorstream << "Client: Don't know how to load file \""
836 << filename << "\"" << std::endl;
840 // Virtual methods from con::PeerHandler
841 void Client::peerAdded(con::Peer *peer)
843 infostream << "Client::peerAdded(): peer->id="
844 << peer->id << std::endl;
847 void Client::deletingPeer(con::Peer *peer, bool timeout)
849 infostream << "Client::deletingPeer(): "
850 "Server Peer is getting deleted "
851 << "(timeout=" << timeout << ")" << std::endl;
853 m_access_denied = true;
855 m_access_denied_reason = gettext("Connection timed out.");
856 else if (m_access_denied_reason.empty())
857 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
862 u16 number of files requested
868 void Client::request_media(const std::vector<std::string> &file_requests)
870 std::ostringstream os(std::ios_base::binary);
871 writeU16(os, TOSERVER_REQUEST_MEDIA);
872 size_t file_requests_size = file_requests.size();
874 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
876 // Packet dynamicly resized
877 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
879 pkt << (u16) (file_requests_size & 0xFFFF);
881 for (const std::string &file_request : file_requests) {
887 infostream << "Client: Sending media request list to server ("
888 << file_requests.size() << " files, packet size "
889 << pkt.getSize() << ")" << std::endl;
892 void Client::initLocalMapSaving(const Address &address,
893 const std::string &hostname,
894 bool is_local_server)
896 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
900 std::string world_path;
901 #define set_world_path(hostname) \
902 world_path = porting::path_user \
903 + DIR_DELIM + "worlds" \
904 + DIR_DELIM + "server_" \
905 + hostname + "_" + std::to_string(address.getPort());
907 set_world_path(hostname);
908 if (!fs::IsDir(world_path)) {
909 std::string hostname_escaped = hostname;
910 str_replace(hostname_escaped, ':', '_');
911 set_world_path(hostname_escaped);
913 #undef set_world_path
914 fs::CreateAllDirs(world_path);
916 m_localdb = new MapDatabaseSQLite3(world_path);
917 m_localdb->beginSave();
918 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
921 void Client::ReceiveAll()
924 u64 start_ms = porting::getTimeMs();
925 const u64 budget = 100;
927 // Limit time even if there would be huge amounts of data to
929 if (porting::getTimeMs() > start_ms + budget) {
930 infostream << "Client::ReceiveAll(): "
931 "Packet processing budget exceeded." << std::endl;
937 if (!m_con->TryReceive(&pkt))
940 } catch (const con::InvalidIncomingDataException &e) {
941 infostream << "Client::ReceiveAll(): "
942 "InvalidIncomingDataException: what()="
943 << e.what() << std::endl;
948 inline void Client::handleCommand(NetworkPacket* pkt)
950 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
951 (this->*opHandle.handler)(pkt);
955 sender_peer_id given to this shall be quaranteed to be a valid peer
957 void Client::ProcessData(NetworkPacket *pkt)
959 ToClientCommand command = (ToClientCommand) pkt->getCommand();
960 u32 sender_peer_id = pkt->getPeerId();
962 //infostream<<"Client: received command="<<command<<std::endl;
963 m_packetcounter.add((u16)command);
964 g_profiler->graphAdd("client_received_packets", 1);
967 If this check is removed, be sure to change the queue
968 system to know the ids
970 if(sender_peer_id != PEER_ID_SERVER) {
971 infostream << "Client::ProcessData(): Discarding data not "
972 "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
977 // Command must be handled into ToClientCommandHandler
978 if (command >= TOCLIENT_NUM_MSG_TYPES) {
979 infostream << "Client: Ignoring unknown command "
980 << command << std::endl;
985 * Those packets are handled before m_server_ser_ver is set, it's normal
986 * But we must use the new ToClientConnectionState in the future,
989 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
994 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
995 infostream << "Client: Server serialization"
996 " format invalid or not initialized."
997 " Skipping incoming command=" << command << std::endl;
1002 Handle runtime commands
1008 void Client::Send(NetworkPacket* pkt)
1010 m_con->Send(PEER_ID_SERVER,
1011 serverCommandFactoryTable[pkt->getCommand()].channel,
1013 serverCommandFactoryTable[pkt->getCommand()].reliable);
1016 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
1017 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
1019 v3f pf = myplayer->getPosition() * 100;
1020 v3f sf = myplayer->getSpeed() * 100;
1021 s32 pitch = myplayer->getPitch() * 100;
1022 s32 yaw = myplayer->getYaw() * 100;
1023 u32 keyPressed = myplayer->control.getKeysPressed();
1024 // scaled by 80, so that pi can fit into a u8
1025 u8 fov = clientMap->getCameraFov() * 80;
1026 u8 wanted_range = MYMIN(255,
1027 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
1029 v3s32 position(pf.X, pf.Y, pf.Z);
1030 v3s32 speed(sf.X, sf.Y, sf.Z);
1034 [0] v3s32 position*100
1035 [12] v3s32 speed*100
1036 [12+12] s32 pitch*100
1037 [12+12+4] s32 yaw*100
1038 [12+12+4+4] u32 keyPressed
1039 [12+12+4+4+4] u8 fov*80
1040 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
1042 *pkt << position << speed << pitch << yaw << keyPressed;
1043 *pkt << fov << wanted_range;
1046 void Client::interact(InteractAction action, const PointedThing& pointed)
1048 if(m_state != LC_Ready) {
1049 errorstream << "Client::interact() "
1050 "Canceled (not connected)"
1055 LocalPlayer *myplayer = m_env.getLocalPlayer();
1056 if (myplayer == NULL)
1063 [5] u32 length of the next item (plen)
1064 [9] serialized PointedThing
1065 [9 + plen] player position information
1068 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1071 pkt << myplayer->getWieldIndex();
1073 std::ostringstream tmp_os(std::ios::binary);
1074 pointed.serialize(tmp_os);
1076 pkt.putLongString(tmp_os.str());
1078 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1083 void Client::deleteAuthData()
1088 switch (m_chosen_auth_mech) {
1089 case AUTH_MECHANISM_FIRST_SRP:
1091 case AUTH_MECHANISM_SRP:
1092 case AUTH_MECHANISM_LEGACY_PASSWORD:
1093 srp_user_delete((SRPUser *) m_auth_data);
1096 case AUTH_MECHANISM_NONE:
1099 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1103 AuthMechanism Client::choseAuthMech(const u32 mechs)
1105 if (mechs & AUTH_MECHANISM_SRP)
1106 return AUTH_MECHANISM_SRP;
1108 if (mechs & AUTH_MECHANISM_FIRST_SRP)
1109 return AUTH_MECHANISM_FIRST_SRP;
1111 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1112 return AUTH_MECHANISM_LEGACY_PASSWORD;
1114 return AUTH_MECHANISM_NONE;
1117 void Client::sendInit(const std::string &playerName)
1119 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1121 // we don't support network compression yet
1122 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1124 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1125 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1131 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1133 m_chosen_auth_mech = chosen_auth_mechanism;
1135 switch (chosen_auth_mechanism) {
1136 case AUTH_MECHANISM_FIRST_SRP: {
1137 // send srp verifier to server
1138 std::string verifier;
1140 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1143 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1144 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1149 case AUTH_MECHANISM_SRP:
1150 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1153 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1154 m_password = translate_password(getPlayerName(), m_password);
1158 std::string playername_u = lowercase(getPlayerName());
1159 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1160 getPlayerName().c_str(), playername_u.c_str(),
1161 (const unsigned char *) m_password.c_str(),
1162 m_password.length(), NULL, NULL);
1165 SRP_Result res = srp_user_start_authentication(
1166 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1167 (unsigned char **) &bytes_A, &len_A);
1168 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1170 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1171 resp_pkt << std::string(bytes_A, len_A) << based_on;
1175 case AUTH_MECHANISM_NONE:
1176 break; // not handled in this method
1180 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1182 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1184 pkt << (u8) blocks.size();
1186 for (const v3s16 &block : blocks) {
1193 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1195 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1196 pkt << (u8) blocks.size();
1197 for (const v3s16 &block : blocks)
1203 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1205 size_t server_ids = soundList.size();
1206 assert(server_ids <= 0xFFFF);
1208 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1210 pkt << (u16) (server_ids & 0xFFFF);
1212 for (s32 sound_id : soundList)
1218 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1219 const StringMap &fields)
1221 size_t fields_size = fields.size();
1223 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1225 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1227 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1229 StringMap::const_iterator it;
1230 for (it = fields.begin(); it != fields.end(); ++it) {
1231 const std::string &name = it->first;
1232 const std::string &value = it->second;
1234 pkt.putLongString(value);
1240 void Client::sendInventoryFields(const std::string &formname,
1241 const StringMap &fields)
1243 size_t fields_size = fields.size();
1244 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1246 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1247 pkt << formname << (u16) (fields_size & 0xFFFF);
1249 StringMap::const_iterator it;
1250 for (it = fields.begin(); it != fields.end(); ++it) {
1251 const std::string &name = it->first;
1252 const std::string &value = it->second;
1254 pkt.putLongString(value);
1260 void Client::sendInventoryAction(InventoryAction *a)
1262 std::ostringstream os(std::ios_base::binary);
1267 std::string s = os.str();
1269 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1270 pkt.putRawString(s.c_str(),s.size());
1275 bool Client::canSendChatMessage() const
1277 u32 now = time(NULL);
1278 float time_passed = now - m_last_chat_message_sent;
1280 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1281 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1283 if (virt_chat_message_allowance < 1.0f)
1289 void Client::sendChatMessage(const std::wstring &message)
1291 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1292 if (canSendChatMessage()) {
1293 u32 now = time(NULL);
1294 float time_passed = now - m_last_chat_message_sent;
1295 m_last_chat_message_sent = now;
1297 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1298 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1299 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1301 m_chat_message_allowance -= 1.0f;
1303 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1308 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size < 0) {
1309 m_out_chat_queue.push(message);
1311 infostream << "Could not queue chat message because maximum out chat queue size ("
1312 << max_queue_size << ") is reached." << std::endl;
1316 void Client::clearOutChatQueue()
1318 m_out_chat_queue = std::queue<std::wstring>();
1321 void Client::sendChangePassword(const std::string &oldpassword,
1322 const std::string &newpassword)
1324 LocalPlayer *player = m_env.getLocalPlayer();
1328 // get into sudo mode and then send new password to server
1329 m_password = oldpassword;
1330 m_new_password = newpassword;
1331 startAuth(choseAuthMech(m_sudo_auth_methods));
1335 void Client::sendDamage(u16 damage)
1337 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1342 void Client::sendRespawn()
1344 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1348 void Client::sendReady()
1350 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1351 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1353 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1354 << (u8) 0 << (u16) strlen(g_version_hash);
1356 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1357 pkt << (u16)FORMSPEC_API_VERSION;
1361 void Client::sendPlayerPos()
1363 LocalPlayer *player = m_env.getLocalPlayer();
1367 // Save bandwidth by only updating position when
1368 // player is not dead and something changed
1370 if (m_activeobjects_received && player->isDead())
1373 ClientMap &map = m_env.getClientMap();
1374 u8 camera_fov = map.getCameraFov();
1375 u8 wanted_range = map.getControl().wanted_range;
1377 u32 keyPressed = player->control.getKeysPressed();
1380 player->last_position == player->getPosition() &&
1381 player->last_speed == player->getSpeed() &&
1382 player->last_pitch == player->getPitch() &&
1383 player->last_yaw == player->getYaw() &&
1384 player->last_keyPressed == keyPressed &&
1385 player->last_camera_fov == camera_fov &&
1386 player->last_wanted_range == wanted_range)
1389 player->last_position = player->getPosition();
1390 player->last_speed = player->getSpeed();
1391 player->last_pitch = player->getPitch();
1392 player->last_yaw = player->getYaw();
1393 player->last_keyPressed = keyPressed;
1394 player->last_camera_fov = camera_fov;
1395 player->last_wanted_range = wanted_range;
1397 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1399 writePlayerPos(player, &map, &pkt);
1404 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1406 NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1408 sanity_check(tokens.size() < 256);
1410 pkt << static_cast<u8>(tokens.size());
1411 for (u32 token : tokens)
1417 void Client::removeNode(v3s16 p)
1419 std::map<v3s16, MapBlock*> modified_blocks;
1422 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1424 catch(InvalidPositionException &e) {
1427 for (const auto &modified_block : modified_blocks) {
1428 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1433 * Helper function for Client Side Modding
1434 * CSM restrictions are applied there, this should not be used for core engine
1436 * @param is_valid_position
1439 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1441 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1442 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1443 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1444 *is_valid_position = false;
1448 return m_env.getMap().getNode(p, is_valid_position);
1451 int Client::CSMClampRadius(v3s16 pos, int radius)
1453 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1455 // This is approximate and will cause some allowed nodes to be excluded
1456 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1457 u32 distance = ppos.getDistanceFrom(pos);
1458 if (distance >= m_csm_restriction_noderange)
1460 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1463 v3s16 Client::CSMClampPos(v3s16 pos)
1465 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1467 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1468 const int range = m_csm_restriction_noderange;
1470 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1471 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1472 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1476 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1478 //TimeTaker timer1("Client::addNode()");
1480 std::map<v3s16, MapBlock*> modified_blocks;
1483 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1484 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1486 catch(InvalidPositionException &e) {
1489 for (const auto &modified_block : modified_blocks) {
1490 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1494 void Client::setPlayerControl(PlayerControl &control)
1496 LocalPlayer *player = m_env.getLocalPlayer();
1498 player->control = control;
1501 void Client::setPlayerItem(u16 item)
1503 m_env.getLocalPlayer()->setWieldIndex(item);
1504 m_update_wielded_item = true;
1506 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1511 // Returns true once after the inventory of the local player
1512 // has been updated from the server.
1513 bool Client::updateWieldedItem()
1515 if (!m_update_wielded_item)
1518 m_update_wielded_item = false;
1520 LocalPlayer *player = m_env.getLocalPlayer();
1522 if (auto *list = player->inventory.getList("main"))
1523 list->setModified(false);
1524 if (auto *list = player->inventory.getList("hand"))
1525 list->setModified(false);
1530 scene::ISceneManager* Client::getSceneManager()
1532 return m_rendering_engine->get_scene_manager();
1535 Inventory* Client::getInventory(const InventoryLocation &loc)
1538 case InventoryLocation::UNDEFINED:
1541 case InventoryLocation::CURRENT_PLAYER:
1543 LocalPlayer *player = m_env.getLocalPlayer();
1545 return &player->inventory;
1548 case InventoryLocation::PLAYER:
1550 // Check if we are working with local player inventory
1551 LocalPlayer *player = m_env.getLocalPlayer();
1552 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1554 return &player->inventory;
1557 case InventoryLocation::NODEMETA:
1559 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1562 return meta->getInventory();
1565 case InventoryLocation::DETACHED:
1567 if (m_detached_inventories.count(loc.name) == 0)
1569 return m_detached_inventories[loc.name];
1573 FATAL_ERROR("Invalid inventory location type.");
1579 void Client::inventoryAction(InventoryAction *a)
1582 Send it to the server
1584 sendInventoryAction(a);
1587 Predict some local inventory changes
1589 a->clientApply(this, this);
1595 float Client::getAnimationTime()
1597 return m_animation_time;
1600 int Client::getCrackLevel()
1602 return m_crack_level;
1605 v3s16 Client::getCrackPos()
1610 void Client::setCrack(int level, v3s16 pos)
1612 int old_crack_level = m_crack_level;
1613 v3s16 old_crack_pos = m_crack_pos;
1615 m_crack_level = level;
1618 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1621 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1623 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1626 addUpdateMeshTaskForNode(pos, false, true);
1632 LocalPlayer *player = m_env.getLocalPlayer();
1637 bool Client::getChatMessage(std::wstring &res)
1639 if (m_chat_queue.empty())
1642 ChatMessage *chatMessage = m_chat_queue.front();
1647 switch (chatMessage->type) {
1648 case CHATMESSAGE_TYPE_RAW:
1649 case CHATMESSAGE_TYPE_ANNOUNCE:
1650 case CHATMESSAGE_TYPE_SYSTEM:
1651 res = chatMessage->message;
1653 case CHATMESSAGE_TYPE_NORMAL: {
1654 if (!chatMessage->sender.empty())
1655 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1657 res = chatMessage->message;
1668 void Client::typeChatMessage(const std::wstring &message)
1670 // Discard empty line
1671 if (message.empty())
1674 // If message was consumed by script API, don't send it to server
1675 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1679 sendChatMessage(message);
1682 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1684 // Check if the block exists to begin with. In the case when a non-existing
1685 // neighbor is automatically added, it may not. In that case we don't want
1686 // to tell the mesh update thread about it.
1687 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1691 m_mesh_update_manager.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1694 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1696 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1699 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1703 infostream<<"Client::addUpdateMeshTaskForNode(): "
1704 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1708 v3s16 blockpos = getNodeBlockPos(nodepos);
1709 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1710 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1712 if (nodepos.X == blockpos_relative.X)
1713 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1714 if (nodepos.Y == blockpos_relative.Y)
1715 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1716 if (nodepos.Z == blockpos_relative.Z)
1717 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1720 ClientEvent *Client::getClientEvent()
1722 FATAL_ERROR_IF(m_client_event_queue.empty(),
1723 "Cannot getClientEvent, queue is empty.");
1725 ClientEvent *event = m_client_event_queue.front();
1726 m_client_event_queue.pop();
1730 const Address Client::getServerAddress()
1732 return m_con->GetPeerAddress(PEER_ID_SERVER);
1735 float Client::mediaReceiveProgress()
1737 if (m_media_downloader)
1738 return m_media_downloader->getProgress();
1740 return 1.0; // downloader only exists when not yet done
1743 struct TextureUpdateArgs {
1744 gui::IGUIEnvironment *guienv;
1747 const wchar_t* text_base;
1748 ITextureSource *tsrc;
1751 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1753 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1754 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1756 // update the loading menu -- if necessary
1757 bool do_draw = false;
1758 u64 time_ms = targs->last_time_ms;
1759 if (cur_percent != targs->last_percent) {
1760 targs->last_percent = cur_percent;
1761 time_ms = porting::getTimeMs();
1762 // only draw when the user will notice something:
1763 do_draw = (time_ms - targs->last_time_ms > 100);
1767 targs->last_time_ms = time_ms;
1768 std::wostringstream strm;
1769 strm << targs->text_base << L" " << targs->last_percent << L"%...";
1770 m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1771 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1775 void Client::afterContentReceived()
1777 infostream<<"Client::afterContentReceived() started"<<std::endl;
1778 assert(m_itemdef_received); // pre-condition
1779 assert(m_nodedef_received); // pre-condition
1780 assert(mediaReceived()); // pre-condition
1782 const wchar_t* text = wgettext("Loading textures...");
1784 // Clear cached pre-scaled 2D GUI images, as this cache
1785 // might have images with the same name but different
1786 // content from previous sessions.
1787 guiScalingCacheClear();
1789 // Rebuild inherited images and recreate textures
1790 infostream<<"- Rebuilding images and textures"<<std::endl;
1791 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1792 m_tsrc->rebuildImagesAndTextures();
1796 infostream<<"- Rebuilding shaders"<<std::endl;
1797 text = wgettext("Rebuilding shaders...");
1798 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1799 m_shsrc->rebuildShaders();
1802 // Update node aliases
1803 infostream<<"- Updating node aliases"<<std::endl;
1804 text = wgettext("Initializing nodes...");
1805 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1806 m_nodedef->updateAliases(m_itemdef);
1807 for (const auto &path : getTextureDirs()) {
1808 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1809 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1810 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1812 m_nodedef->setNodeRegistrationStatus(true);
1813 m_nodedef->runNodeResolveCallbacks();
1816 // Update node textures and assign shaders to each tile
1817 infostream<<"- Updating node textures"<<std::endl;
1818 TextureUpdateArgs tu_args;
1819 tu_args.guienv = guienv;
1820 tu_args.last_time_ms = porting::getTimeMs();
1821 tu_args.last_percent = 0;
1822 tu_args.text_base = wgettext("Initializing nodes");
1823 tu_args.tsrc = m_tsrc;
1824 m_nodedef->updateTextures(this, &tu_args);
1825 delete[] tu_args.text_base;
1827 // Start mesh update thread after setting up content definitions
1828 infostream<<"- Starting mesh update thread"<<std::endl;
1829 m_mesh_update_manager.start();
1835 m_script->on_client_ready(m_env.getLocalPlayer());
1837 text = wgettext("Done!");
1838 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1839 infostream<<"Client::afterContentReceived() done"<<std::endl;
1843 float Client::getRTT()
1845 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1848 float Client::getCurRate()
1850 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1851 m_con->getLocalStat(con::CUR_DL_RATE));
1854 void Client::makeScreenshot()
1856 irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1857 irr::video::IImage* const raw_image = driver->createScreenShot();
1862 const struct tm tm = mt_localtime();
1864 char timetstamp_c[64];
1865 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1867 std::string screenshot_dir;
1869 if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1870 screenshot_dir = g_settings->get("screenshot_path");
1872 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1874 std::string filename_base = screenshot_dir
1876 + std::string("screenshot_")
1877 + std::string(timetstamp_c);
1878 std::string filename_ext = "." + g_settings->get("screenshot_format");
1879 std::string filename;
1881 // Create the directory if it doesn't already exist.
1882 // Otherwise, saving the screenshot would fail.
1883 fs::CreateDir(screenshot_dir);
1885 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1886 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1888 // Try to find a unique filename
1889 unsigned serial = 0;
1891 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1892 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1893 std::ifstream tmp(filename.c_str());
1895 break; // File did not apparently exist, we'll go with it
1899 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1900 infostream << "Could not find suitable filename for screenshot" << std::endl;
1902 irr::video::IImage* const image =
1903 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1906 raw_image->copyTo(image);
1908 std::ostringstream sstr;
1909 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1910 sstr << "Saved screenshot to '" << filename << "'";
1912 sstr << "Failed to save screenshot '" << filename << "'";
1914 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1915 utf8_to_wide(sstr.str())));
1916 infostream << sstr.str() << std::endl;
1924 bool Client::shouldShowMinimap() const
1926 return !m_minimap_disabled_by_server;
1929 void Client::pushToEventQueue(ClientEvent *event)
1931 m_client_event_queue.push(event);
1934 void Client::showMinimap(const bool show)
1936 m_game_ui->showMinimap(show);
1939 // IGameDef interface
1941 IItemDefManager* Client::getItemDefManager()
1945 const NodeDefManager* Client::getNodeDefManager()
1949 ICraftDefManager* Client::getCraftDefManager()
1952 //return m_craftdef;
1954 ITextureSource* Client::getTextureSource()
1958 IWritableShaderSource* Client::getShaderSource()
1963 u16 Client::allocateUnknownNodeId(const std::string &name)
1965 errorstream << "Client::allocateUnknownNodeId(): "
1966 << "Client cannot allocate node IDs" << std::endl;
1967 FATAL_ERROR("Client allocated unknown node");
1969 return CONTENT_IGNORE;
1971 ISoundManager* Client::getSoundManager()
1975 MtEventManager* Client::getEventManager()
1980 ParticleManager* Client::getParticleManager()
1982 return &m_particle_manager;
1985 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1987 StringMap::const_iterator it = m_mesh_data.find(filename);
1988 if (it == m_mesh_data.end()) {
1989 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1990 << "\"" << std::endl;
1993 const std::string &data = it->second;
1995 // Create the mesh, remove it from cache and return it
1996 // This allows unique vertex colors and other properties for each instance
1997 io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1998 data.c_str(), data.size(), filename.c_str());
1999 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
2001 scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
2007 m_rendering_engine->removeMesh(mesh);
2011 const std::string* Client::getModFile(std::string filename)
2013 // strip dir delimiter from beginning of path
2014 auto pos = filename.find_first_of(':');
2015 if (pos == std::string::npos)
2018 auto pos2 = filename.find_first_not_of('/', pos);
2020 filename.erase(pos, pos2 - pos);
2022 StringMap::const_iterator it = m_mod_vfs.find(filename);
2023 if (it == m_mod_vfs.end())
2032 bool Client::joinModChannel(const std::string &channel)
2034 if (m_modchannel_mgr->channelRegistered(channel))
2037 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2041 m_modchannel_mgr->joinChannel(channel, 0);
2045 bool Client::leaveModChannel(const std::string &channel)
2047 if (!m_modchannel_mgr->channelRegistered(channel))
2050 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2054 m_modchannel_mgr->leaveChannel(channel, 0);
2058 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2060 if (!m_modchannel_mgr->canWriteOnChannel(channel))
2063 if (message.size() > STRING_MAX_LEN) {
2064 warningstream << "ModChannel message too long, dropping before sending "
2065 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2066 << channel << ")" << std::endl;
2070 // @TODO: do some client rate limiting
2071 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2072 pkt << channel << message;
2077 ModChannel* Client::getModChannel(const std::string &channel)
2079 return m_modchannel_mgr->getModChannel(channel);