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"
45 #include "modchannels.h"
46 #include "content/mods.h"
50 #include "clientmap.h"
51 #include "clientmedia.h"
53 #include "database/database-files.h"
54 #include "database/database-sqlite3.h"
55 #include "serialization.h"
56 #include "guiscalingfilter.h"
57 #include "script/scripting_client.h"
59 #include "chatmessage.h"
60 #include "translation.h"
61 #include "content/mod_configuration.h"
63 extern gui::IGUIEnvironment* guienv;
69 u32 PacketCounter::sum() const
72 for (const auto &it : m_packets)
77 void PacketCounter::print(std::ostream &o) const
79 for (const auto &it : m_packets) {
80 auto name = it.first >= TOCLIENT_NUM_MSG_TYPES ? "?"
81 : toClientCommandTable[it.first].name;
82 o << "cmd " << it.first << " (" << name << ") count "
83 << it.second << std::endl;
92 const char *playername,
93 const std::string &password,
94 const std::string &address_name,
95 MapDrawControl &control,
96 IWritableTextureSource *tsrc,
97 IWritableShaderSource *shsrc,
98 IWritableItemDefManager *itemdef,
99 NodeDefManager *nodedef,
100 ISoundManager *sound,
101 MtEventManager *event,
102 RenderingEngine *rendering_engine,
105 ELoginRegister allow_login_or_register
113 m_rendering_engine(rendering_engine),
114 m_mesh_update_manager(this),
116 new ClientMap(this, rendering_engine, control, 666),
119 m_particle_manager(&m_env),
120 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
121 m_address_name(address_name),
122 m_allow_login_or_register(allow_login_or_register),
123 m_server_ser_ver(SER_FMT_VER_INVALID),
124 m_last_chat_message_sent(time(NULL)),
125 m_password(password),
126 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
127 m_media_downloader(new ClientMediaDownloader()),
130 m_modchannel_mgr(new ModChannelMgr())
133 m_env.setLocalPlayer(new LocalPlayer(this, playername));
135 // Make the mod storage database and begin the save for later
136 m_mod_storage_database =
137 new ModStorageDatabaseSQLite3(porting::path_user + DIR_DELIM + "client");
138 m_mod_storage_database->beginSave();
140 if (g_settings->getBool("enable_minimap")) {
141 m_minimap = new Minimap(this);
144 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
147 void Client::migrateModStorage()
149 std::string mod_storage_dir = porting::path_user + DIR_DELIM + "client";
150 std::string old_mod_storage = mod_storage_dir + DIR_DELIM + "mod_storage";
151 if (fs::IsDir(old_mod_storage)) {
152 infostream << "Migrating client mod storage to SQLite3 database" << std::endl;
154 ModStorageDatabaseFiles files_db(mod_storage_dir);
155 std::vector<std::string> mod_list;
156 files_db.listMods(&mod_list);
157 for (const std::string &modname : mod_list) {
158 infostream << "Migrating client mod storage for mod " << modname << std::endl;
160 files_db.getModEntries(modname, &meta);
161 for (const auto &pair : meta) {
162 m_mod_storage_database->setModEntry(modname, pair.first, pair.second);
166 if (!fs::Rename(old_mod_storage, old_mod_storage + ".bak")) {
167 // Execution cannot move forward if the migration does not complete.
168 throw BaseException("Could not finish migrating client mod storage");
170 infostream << "Finished migration of client mod storage" << std::endl;
174 void Client::loadMods()
176 // Don't load mods twice.
177 // If client scripting is disabled by the client, don't load builtin or
178 // client-provided mods.
179 if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
182 // If client scripting is disabled by the server, don't load builtin or
183 // client-provided mods.
184 // TODO Delete this code block when server-sent CSM and verifying of builtin are
186 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
187 warningstream << "Client-provided mod loading is disabled by server." <<
192 m_script = new ClientScripting(this);
193 m_env.setScript(m_script);
194 m_script->setEnv(&m_env);
197 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
198 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
199 m_script->checkSetByBuiltin();
201 ModConfiguration modconf;
203 std::unordered_map<std::string, std::string> paths;
204 std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
205 const auto modsPath = getClientModsLuaPath();
206 if (modsPath != path_user) {
207 paths["share"] = modsPath;
209 paths["mods"] = path_user;
211 std::string settings_path = path_user + DIR_DELIM + "mods.conf";
212 modconf.addModsFromConfig(settings_path, paths);
213 modconf.checkConflictsAndDeps();
216 m_mods = modconf.getMods();
218 // complain about mods with unsatisfied dependencies
219 if (!modconf.isConsistent()) {
220 errorstream << modconf.getUnsatisfiedModsError() << std::endl;
225 infostream << "Client loading mods: ";
226 for (const ModSpec &mod : m_mods)
227 infostream << mod.name << " ";
228 infostream << std::endl;
230 // Load "mod" scripts
231 for (const ModSpec &mod : m_mods) {
233 scanModIntoMemory(mod.name, mod.path);
237 for (const ModSpec &mod : m_mods)
238 m_script->loadModFromMemory(mod.name);
240 // Mods are done loading. Unlock callbacks
241 m_mods_loaded = true;
243 // Run a callback when mods are loaded
244 m_script->on_mods_loaded();
246 // Create objects if they're ready
247 if (m_state == LC_Ready)
248 m_script->on_client_ready(m_env.getLocalPlayer());
250 m_script->on_camera_ready(m_camera);
252 m_script->on_minimap_ready(m_minimap);
255 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
256 std::string mod_subpath)
258 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
259 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
260 for (const fs::DirListNode &j : mod) {
261 if (j.name[0] == '.')
265 scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
268 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
270 std::string real_path = full_path + j.name;
271 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
272 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
273 << "\" as \"" << vfs_path << "\"." << std::endl;
275 std::string contents;
276 if (!fs::ReadFile(real_path, contents)) {
277 errorstream << "Client::scanModSubfolder(): Can't read file \""
278 << real_path << "\"." << std::endl;
282 m_mod_vfs.emplace(vfs_path, contents);
286 const std::string &Client::getBuiltinLuaPath()
288 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
292 const std::string &Client::getClientModsLuaPath()
294 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
295 return clientmods_dir;
298 const std::vector<ModSpec>& Client::getMods() const
300 static std::vector<ModSpec> client_modspec_temp;
301 return client_modspec_temp;
304 const ModSpec* Client::getModSpec(const std::string &modname) const
313 m_script->on_shutdown();
314 //request all client managed threads to stop
315 m_mesh_update_manager.stop();
316 // Save local server map
318 infostream << "Local map saving ended." << std::endl;
319 m_localdb->endSave();
326 bool Client::isShutdown()
328 return m_shutdown || !m_mesh_update_manager.isRunning();
338 m_mesh_update_manager.stop();
339 m_mesh_update_manager.wait();
342 while (m_mesh_update_manager.getNextResult(r)) {
343 for (auto block : r.map_blocks)
349 delete m_inventory_from_server;
351 // Delete detached inventories
352 for (auto &m_detached_inventorie : m_detached_inventories) {
353 delete m_detached_inventorie.second;
356 // cleanup 3d model meshes on client shutdown
357 m_rendering_engine->cleanupMeshCache();
359 guiScalingCacheClear();
364 delete m_media_downloader;
366 // Write the changes and delete
367 if (m_mod_storage_database)
368 m_mod_storage_database->endSave();
369 delete m_mod_storage_database;
372 void Client::connect(Address address, bool is_local_server)
374 initLocalMapSaving(address, m_address_name, is_local_server);
376 // Since we use TryReceive() a timeout here would be ineffective anyway
377 m_con->SetTimeoutMs(0);
378 m_con->Connect(address);
381 void Client::step(float dtime)
387 m_animation_time += dtime;
388 if(m_animation_time > 60.0)
389 m_animation_time -= 60.0;
391 m_time_of_day_update_timer += dtime;
399 float &counter = m_packetcounter_timer;
404 u32 sum = m_packetcounter.sum();
405 float avg = sum / counter;
407 infostream << "Client packetcounter (" << counter << "s): "
408 << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
409 m_packetcounter.print(infostream);
410 m_packetcounter.clear();
414 // UGLY hack to fix 2 second startup delay caused by non existent
415 // server client startup synchronization in local server or singleplayer mode
416 static bool initial_step = true;
418 initial_step = false;
420 else if(m_state == LC_Created) {
421 float &counter = m_connection_reinit_timer;
426 LocalPlayer *myplayer = m_env.getLocalPlayer();
427 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
429 sendInit(myplayer->getName());
432 // Not connected, return
437 Do stuff if connected
441 Run Map's timers and unload unused data
443 const float map_timer_and_unload_dtime = 5.25;
444 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
445 std::vector<v3s16> deleted_blocks;
446 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
447 std::max(g_settings->getFloat("client_unload_unused_data_timeout"), 0.0f),
448 g_settings->getS32("client_mapblock_limit"),
453 NOTE: This loop is intentionally iterated the way it is.
456 std::vector<v3s16>::iterator i = deleted_blocks.begin();
457 std::vector<v3s16> sendlist;
459 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
470 sendDeletedBlocks(sendlist);
472 if(i == deleted_blocks.end())
478 sendlist.push_back(*i);
484 Send pending messages on out chat queue
486 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
487 sendChatMessage(m_out_chat_queue.front());
488 m_out_chat_queue.pop();
494 LocalPlayer *player = m_env.getLocalPlayer();
496 // Step environment (also handles player controls)
498 m_sound->step(dtime);
503 while (m_env.hasClientEnvEvents()) {
504 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
506 if (envEvent.type == CEE_PLAYER_DAMAGE) {
507 u16 damage = envEvent.player_damage.amount;
509 if (envEvent.player_damage.send_to_server)
512 // Add to ClientEvent queue
513 ClientEvent *event = new ClientEvent();
514 event->type = CE_PLAYER_DAMAGE;
515 event->player_damage.amount = damage;
516 event->player_damage.effect = true;
517 m_client_event_queue.push(event);
524 float &counter = m_avg_rtt_timer;
528 // connectedAndInitialized() is true, peer exists.
529 float avg_rtt = getRTT();
530 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
534 Send player position to server
537 float &counter = m_playerpos_send_timer;
539 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
547 Replace updated meshes
550 int num_processed_meshes = 0;
551 std::vector<v3s16> blocks_to_ack;
552 bool force_update_shadows = false;
554 while (m_mesh_update_manager.getNextResult(r))
556 num_processed_meshes++;
558 MinimapMapblock *minimap_mapblock = NULL;
559 bool do_mapper_update = true;
561 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
563 // Delete the old mesh
565 block->mesh = nullptr;
568 block->solid_sides = r.solid_sides;
569 minimap_mapblock = r.mesh->moveMinimapMapblock();
570 if (minimap_mapblock == NULL)
571 do_mapper_update = false;
573 bool is_empty = true;
574 for (int l = 0; l < MAX_TILE_LAYERS; l++)
575 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
581 // Replace with the new mesh
582 block->mesh = r.mesh;
584 force_update_shadows = true;
591 if (m_minimap && do_mapper_update)
592 m_minimap->addBlock(r.p, minimap_mapblock);
594 if (r.ack_block_to_server) {
595 if (blocks_to_ack.size() == 255) {
596 sendGotBlocks(blocks_to_ack);
597 blocks_to_ack.clear();
600 blocks_to_ack.emplace_back(r.p);
603 for (auto block : r.map_blocks)
607 if (blocks_to_ack.size() > 0) {
608 // Acknowledge block(s)
609 sendGotBlocks(blocks_to_ack);
612 if (num_processed_meshes > 0)
613 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
615 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
616 if (shadow_renderer && force_update_shadows)
617 shadow_renderer->setForceUpdateShadowMap();
623 if (m_media_downloader && m_media_downloader->isStarted()) {
624 m_media_downloader->step(this);
625 if (m_media_downloader->isDone()) {
626 delete m_media_downloader;
627 m_media_downloader = NULL;
631 // Acknowledge dynamic media downloads to server
632 std::vector<u32> done;
633 for (auto it = m_pending_media_downloads.begin();
634 it != m_pending_media_downloads.end();) {
635 assert(it->second->isStarted());
636 it->second->step(this);
637 if (it->second->isDone()) {
638 done.emplace_back(it->first);
640 it = m_pending_media_downloads.erase(it);
645 if (done.size() == 255) { // maximum in one packet
655 If the server didn't update the inventory in a while, revert
656 the local inventory (so the player notices the lag problem
657 and knows something is wrong).
659 if (m_inventory_from_server) {
660 float interval = 10.0f;
661 float count_before = std::floor(m_inventory_from_server_age / interval);
663 m_inventory_from_server_age += dtime;
665 float count_after = std::floor(m_inventory_from_server_age / interval);
667 if (count_after != count_before) {
668 // Do this every <interval> seconds after TOCLIENT_INVENTORY
669 // Reset the locally changed inventory to the authoritative inventory
670 player->inventory = *m_inventory_from_server;
671 m_update_wielded_item = true;
676 Update positions of sounds attached to objects
679 for (auto &m_sounds_to_object : m_sounds_to_objects) {
680 int client_id = m_sounds_to_object.first;
681 u16 object_id = m_sounds_to_object.second;
682 ClientActiveObject *cao = m_env.getActiveObject(object_id);
685 m_sound->updateSoundPosition(client_id, cao->getPosition());
690 Handle removed remotely initiated sounds
692 m_removed_sounds_check_timer += dtime;
693 if(m_removed_sounds_check_timer >= 2.32) {
694 m_removed_sounds_check_timer = 0;
695 // Find removed sounds and clear references to them
696 std::vector<s32> removed_server_ids;
697 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
698 i != m_sounds_server_to_client.end();) {
699 s32 server_id = i->first;
700 int client_id = i->second;
702 if(!m_sound->soundExists(client_id)) {
703 m_sounds_server_to_client.erase(server_id);
704 m_sounds_client_to_server.erase(client_id);
705 m_sounds_to_objects.erase(client_id);
706 removed_server_ids.push_back(server_id);
711 if(!removed_server_ids.empty()) {
712 sendRemovedSounds(removed_server_ids);
716 // Write changes to the mod storage
717 m_mod_storage_save_timer -= dtime;
718 if (m_mod_storage_save_timer <= 0.0f) {
719 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
720 m_mod_storage_database->endSave();
721 m_mod_storage_database->beginSave();
725 if (m_localdb && m_localdb_save_interval.step(dtime,
726 m_cache_save_interval)) {
727 m_localdb->endSave();
728 m_localdb->beginSave();
732 bool Client::loadMedia(const std::string &data, const std::string &filename,
733 bool from_media_push)
737 const char *image_ext[] = {
738 ".png", ".jpg", ".bmp", ".tga",
739 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
742 name = removeStringEnd(filename, image_ext);
744 TRACESTREAM(<< "Client: Attempting to load image "
745 << "file \"" << filename << "\"" << std::endl);
747 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
748 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
750 io::IReadFile *rfile = irrfs->createMemoryReadFile(
751 data.c_str(), data.size(), "_tempreadfile");
753 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
756 video::IImage *img = vdrv->createImageFromFile(rfile);
758 errorstream<<"Client: Cannot create image from data of "
759 <<"file \""<<filename<<"\""<<std::endl;
764 m_tsrc->insertSourceImage(filename, img);
770 const char *sound_ext[] = {
771 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
772 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
775 name = removeStringEnd(filename, sound_ext);
777 TRACESTREAM(<< "Client: Attempting to load sound "
778 << "file \"" << filename << "\"" << std::endl);
779 return m_sound->loadSoundData(name, data);
782 const char *model_ext[] = {
783 ".x", ".b3d", ".md2", ".obj",
786 name = removeStringEnd(filename, model_ext);
788 verbosestream<<"Client: Storing model into memory: "
789 <<"\""<<filename<<"\""<<std::endl;
790 if(m_mesh_data.count(filename))
791 errorstream<<"Multiple models with name \""<<filename.c_str()
792 <<"\" found; replacing previous model"<<std::endl;
793 m_mesh_data[filename] = data;
797 const char *translate_ext[] = {
800 name = removeStringEnd(filename, translate_ext);
804 TRACESTREAM(<< "Client: Loading translation: "
805 << "\"" << filename << "\"" << std::endl);
806 g_client_translations->loadTranslation(data);
810 errorstream << "Client: Don't know how to load file \""
811 << filename << "\"" << std::endl;
815 // Virtual methods from con::PeerHandler
816 void Client::peerAdded(con::Peer *peer)
818 infostream << "Client::peerAdded(): peer->id="
819 << peer->id << std::endl;
822 void Client::deletingPeer(con::Peer *peer, bool timeout)
824 infostream << "Client::deletingPeer(): "
825 "Server Peer is getting deleted "
826 << "(timeout=" << timeout << ")" << std::endl;
828 m_access_denied = true;
830 m_access_denied_reason = gettext("Connection timed out.");
831 else if (m_access_denied_reason.empty())
832 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
837 u16 number of files requested
843 void Client::request_media(const std::vector<std::string> &file_requests)
845 std::ostringstream os(std::ios_base::binary);
846 writeU16(os, TOSERVER_REQUEST_MEDIA);
847 size_t file_requests_size = file_requests.size();
849 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
851 // Packet dynamicly resized
852 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
854 pkt << (u16) (file_requests_size & 0xFFFF);
856 for (const std::string &file_request : file_requests) {
862 infostream << "Client: Sending media request list to server ("
863 << file_requests.size() << " files, packet size "
864 << pkt.getSize() << ")" << std::endl;
867 void Client::initLocalMapSaving(const Address &address,
868 const std::string &hostname,
869 bool is_local_server)
871 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
875 std::string world_path;
876 #define set_world_path(hostname) \
877 world_path = porting::path_user \
878 + DIR_DELIM + "worlds" \
879 + DIR_DELIM + "server_" \
880 + hostname + "_" + std::to_string(address.getPort());
882 set_world_path(hostname);
883 if (!fs::IsDir(world_path)) {
884 std::string hostname_escaped = hostname;
885 str_replace(hostname_escaped, ':', '_');
886 set_world_path(hostname_escaped);
888 #undef set_world_path
889 fs::CreateAllDirs(world_path);
891 m_localdb = new MapDatabaseSQLite3(world_path);
892 m_localdb->beginSave();
893 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
896 void Client::ReceiveAll()
899 u64 start_ms = porting::getTimeMs();
900 const u64 budget = 100;
902 // Limit time even if there would be huge amounts of data to
904 if (porting::getTimeMs() > start_ms + budget) {
905 infostream << "Client::ReceiveAll(): "
906 "Packet processing budget exceeded." << std::endl;
912 if (!m_con->TryReceive(&pkt))
915 } catch (const con::InvalidIncomingDataException &e) {
916 infostream << "Client::ReceiveAll(): "
917 "InvalidIncomingDataException: what()="
918 << e.what() << std::endl;
923 inline void Client::handleCommand(NetworkPacket* pkt)
925 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
926 (this->*opHandle.handler)(pkt);
930 sender_peer_id given to this shall be quaranteed to be a valid peer
932 void Client::ProcessData(NetworkPacket *pkt)
934 ToClientCommand command = (ToClientCommand) pkt->getCommand();
935 u32 sender_peer_id = pkt->getPeerId();
937 //infostream<<"Client: received command="<<command<<std::endl;
938 m_packetcounter.add((u16)command);
939 g_profiler->graphAdd("client_received_packets", 1);
942 If this check is removed, be sure to change the queue
943 system to know the ids
945 if(sender_peer_id != PEER_ID_SERVER) {
946 infostream << "Client::ProcessData(): Discarding data not "
947 "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
952 // Command must be handled into ToClientCommandHandler
953 if (command >= TOCLIENT_NUM_MSG_TYPES) {
954 infostream << "Client: Ignoring unknown command "
955 << command << std::endl;
960 * Those packets are handled before m_server_ser_ver is set, it's normal
961 * But we must use the new ToClientConnectionState in the future,
964 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
969 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
970 infostream << "Client: Server serialization"
971 " format invalid or not initialized."
972 " Skipping incoming command=" << command << std::endl;
977 Handle runtime commands
983 void Client::Send(NetworkPacket* pkt)
985 m_con->Send(PEER_ID_SERVER,
986 serverCommandFactoryTable[pkt->getCommand()].channel,
988 serverCommandFactoryTable[pkt->getCommand()].reliable);
991 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
992 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
994 v3f pf = myplayer->getPosition() * 100;
995 v3f sf = myplayer->getSpeed() * 100;
996 s32 pitch = myplayer->getPitch() * 100;
997 s32 yaw = myplayer->getYaw() * 100;
998 u32 keyPressed = myplayer->control.getKeysPressed();
999 // scaled by 80, so that pi can fit into a u8
1000 u8 fov = clientMap->getCameraFov() * 80;
1001 u8 wanted_range = MYMIN(255,
1002 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
1004 v3s32 position(pf.X, pf.Y, pf.Z);
1005 v3s32 speed(sf.X, sf.Y, sf.Z);
1009 [0] v3s32 position*100
1010 [12] v3s32 speed*100
1011 [12+12] s32 pitch*100
1012 [12+12+4] s32 yaw*100
1013 [12+12+4+4] u32 keyPressed
1014 [12+12+4+4+4] u8 fov*80
1015 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
1017 *pkt << position << speed << pitch << yaw << keyPressed;
1018 *pkt << fov << wanted_range;
1021 void Client::interact(InteractAction action, const PointedThing& pointed)
1023 if(m_state != LC_Ready) {
1024 errorstream << "Client::interact() "
1025 "Canceled (not connected)"
1030 LocalPlayer *myplayer = m_env.getLocalPlayer();
1031 if (myplayer == NULL)
1038 [5] u32 length of the next item (plen)
1039 [9] serialized PointedThing
1040 [9 + plen] player position information
1043 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1046 pkt << myplayer->getWieldIndex();
1048 std::ostringstream tmp_os(std::ios::binary);
1049 pointed.serialize(tmp_os);
1051 pkt.putLongString(tmp_os.str());
1053 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1058 void Client::deleteAuthData()
1063 switch (m_chosen_auth_mech) {
1064 case AUTH_MECHANISM_FIRST_SRP:
1066 case AUTH_MECHANISM_SRP:
1067 case AUTH_MECHANISM_LEGACY_PASSWORD:
1068 srp_user_delete((SRPUser *) m_auth_data);
1071 case AUTH_MECHANISM_NONE:
1074 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1078 AuthMechanism Client::choseAuthMech(const u32 mechs)
1080 if (mechs & AUTH_MECHANISM_SRP)
1081 return AUTH_MECHANISM_SRP;
1083 if (mechs & AUTH_MECHANISM_FIRST_SRP)
1084 return AUTH_MECHANISM_FIRST_SRP;
1086 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1087 return AUTH_MECHANISM_LEGACY_PASSWORD;
1089 return AUTH_MECHANISM_NONE;
1092 void Client::sendInit(const std::string &playerName)
1094 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1096 // we don't support network compression yet
1097 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1099 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1100 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1106 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1108 m_chosen_auth_mech = chosen_auth_mechanism;
1110 switch (chosen_auth_mechanism) {
1111 case AUTH_MECHANISM_FIRST_SRP: {
1112 // send srp verifier to server
1113 std::string verifier;
1115 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1118 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1119 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1124 case AUTH_MECHANISM_SRP:
1125 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1128 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1129 m_password = translate_password(getPlayerName(), m_password);
1133 std::string playername_u = lowercase(getPlayerName());
1134 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1135 getPlayerName().c_str(), playername_u.c_str(),
1136 (const unsigned char *) m_password.c_str(),
1137 m_password.length(), NULL, NULL);
1140 SRP_Result res = srp_user_start_authentication(
1141 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1142 (unsigned char **) &bytes_A, &len_A);
1143 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1145 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1146 resp_pkt << std::string(bytes_A, len_A) << based_on;
1150 case AUTH_MECHANISM_NONE:
1151 break; // not handled in this method
1155 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1157 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1159 pkt << (u8) blocks.size();
1161 for (const v3s16 &block : blocks) {
1168 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1170 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1171 pkt << (u8) blocks.size();
1172 for (const v3s16 &block : blocks)
1178 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1180 size_t server_ids = soundList.size();
1181 assert(server_ids <= 0xFFFF);
1183 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1185 pkt << (u16) (server_ids & 0xFFFF);
1187 for (s32 sound_id : soundList)
1193 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1194 const StringMap &fields)
1196 size_t fields_size = fields.size();
1198 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1200 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1202 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1204 StringMap::const_iterator it;
1205 for (it = fields.begin(); it != fields.end(); ++it) {
1206 const std::string &name = it->first;
1207 const std::string &value = it->second;
1209 pkt.putLongString(value);
1215 void Client::sendInventoryFields(const std::string &formname,
1216 const StringMap &fields)
1218 size_t fields_size = fields.size();
1219 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1221 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1222 pkt << formname << (u16) (fields_size & 0xFFFF);
1224 StringMap::const_iterator it;
1225 for (it = fields.begin(); it != fields.end(); ++it) {
1226 const std::string &name = it->first;
1227 const std::string &value = it->second;
1229 pkt.putLongString(value);
1235 void Client::sendInventoryAction(InventoryAction *a)
1237 std::ostringstream os(std::ios_base::binary);
1242 std::string s = os.str();
1244 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1245 pkt.putRawString(s.c_str(),s.size());
1250 bool Client::canSendChatMessage() const
1252 u32 now = time(NULL);
1253 float time_passed = now - m_last_chat_message_sent;
1255 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1256 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1258 if (virt_chat_message_allowance < 1.0f)
1264 void Client::sendChatMessage(const std::wstring &message)
1266 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1267 if (canSendChatMessage()) {
1268 u32 now = time(NULL);
1269 float time_passed = now - m_last_chat_message_sent;
1270 m_last_chat_message_sent = now;
1272 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1273 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1274 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1276 m_chat_message_allowance -= 1.0f;
1278 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1283 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size < 0) {
1284 m_out_chat_queue.push(message);
1286 infostream << "Could not queue chat message because maximum out chat queue size ("
1287 << max_queue_size << ") is reached." << std::endl;
1291 void Client::clearOutChatQueue()
1293 m_out_chat_queue = std::queue<std::wstring>();
1296 void Client::sendChangePassword(const std::string &oldpassword,
1297 const std::string &newpassword)
1299 LocalPlayer *player = m_env.getLocalPlayer();
1303 // get into sudo mode and then send new password to server
1304 m_password = oldpassword;
1305 m_new_password = newpassword;
1306 startAuth(choseAuthMech(m_sudo_auth_methods));
1310 void Client::sendDamage(u16 damage)
1312 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1317 void Client::sendRespawn()
1319 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1323 void Client::sendReady()
1325 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1326 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1328 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1329 << (u8) 0 << (u16) strlen(g_version_hash);
1331 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1332 pkt << (u16)FORMSPEC_API_VERSION;
1336 void Client::sendPlayerPos()
1338 LocalPlayer *player = m_env.getLocalPlayer();
1342 // Save bandwidth by only updating position when
1343 // player is not dead and something changed
1345 if (m_activeobjects_received && player->isDead())
1348 ClientMap &map = m_env.getClientMap();
1349 u8 camera_fov = map.getCameraFov();
1350 u8 wanted_range = map.getControl().wanted_range;
1352 u32 keyPressed = player->control.getKeysPressed();
1355 player->last_position == player->getPosition() &&
1356 player->last_speed == player->getSpeed() &&
1357 player->last_pitch == player->getPitch() &&
1358 player->last_yaw == player->getYaw() &&
1359 player->last_keyPressed == keyPressed &&
1360 player->last_camera_fov == camera_fov &&
1361 player->last_wanted_range == wanted_range)
1364 player->last_position = player->getPosition();
1365 player->last_speed = player->getSpeed();
1366 player->last_pitch = player->getPitch();
1367 player->last_yaw = player->getYaw();
1368 player->last_keyPressed = keyPressed;
1369 player->last_camera_fov = camera_fov;
1370 player->last_wanted_range = wanted_range;
1372 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1374 writePlayerPos(player, &map, &pkt);
1379 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1381 NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1383 sanity_check(tokens.size() < 256);
1385 pkt << static_cast<u8>(tokens.size());
1386 for (u32 token : tokens)
1392 void Client::removeNode(v3s16 p)
1394 std::map<v3s16, MapBlock*> modified_blocks;
1397 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1399 catch(InvalidPositionException &e) {
1402 for (const auto &modified_block : modified_blocks) {
1403 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1408 * Helper function for Client Side Modding
1409 * CSM restrictions are applied there, this should not be used for core engine
1411 * @param is_valid_position
1414 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1416 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1417 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1418 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1419 *is_valid_position = false;
1423 return m_env.getMap().getNode(p, is_valid_position);
1426 int Client::CSMClampRadius(v3s16 pos, int radius)
1428 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1430 // This is approximate and will cause some allowed nodes to be excluded
1431 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1432 u32 distance = ppos.getDistanceFrom(pos);
1433 if (distance >= m_csm_restriction_noderange)
1435 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1438 v3s16 Client::CSMClampPos(v3s16 pos)
1440 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1442 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1443 const int range = m_csm_restriction_noderange;
1445 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1446 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1447 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1451 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1453 //TimeTaker timer1("Client::addNode()");
1455 std::map<v3s16, MapBlock*> modified_blocks;
1458 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1459 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1461 catch(InvalidPositionException &e) {
1464 for (const auto &modified_block : modified_blocks) {
1465 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1469 void Client::setPlayerControl(PlayerControl &control)
1471 LocalPlayer *player = m_env.getLocalPlayer();
1473 player->control = control;
1476 void Client::setPlayerItem(u16 item)
1478 m_env.getLocalPlayer()->setWieldIndex(item);
1479 m_update_wielded_item = true;
1481 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1486 // Returns true once after the inventory of the local player
1487 // has been updated from the server.
1488 bool Client::updateWieldedItem()
1490 if (!m_update_wielded_item)
1493 m_update_wielded_item = false;
1495 LocalPlayer *player = m_env.getLocalPlayer();
1497 if (auto *list = player->inventory.getList("main"))
1498 list->setModified(false);
1499 if (auto *list = player->inventory.getList("hand"))
1500 list->setModified(false);
1505 scene::ISceneManager* Client::getSceneManager()
1507 return m_rendering_engine->get_scene_manager();
1510 Inventory* Client::getInventory(const InventoryLocation &loc)
1513 case InventoryLocation::UNDEFINED:
1516 case InventoryLocation::CURRENT_PLAYER:
1518 LocalPlayer *player = m_env.getLocalPlayer();
1520 return &player->inventory;
1523 case InventoryLocation::PLAYER:
1525 // Check if we are working with local player inventory
1526 LocalPlayer *player = m_env.getLocalPlayer();
1527 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1529 return &player->inventory;
1532 case InventoryLocation::NODEMETA:
1534 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1537 return meta->getInventory();
1540 case InventoryLocation::DETACHED:
1542 if (m_detached_inventories.count(loc.name) == 0)
1544 return m_detached_inventories[loc.name];
1548 FATAL_ERROR("Invalid inventory location type.");
1554 void Client::inventoryAction(InventoryAction *a)
1557 Send it to the server
1559 sendInventoryAction(a);
1562 Predict some local inventory changes
1564 a->clientApply(this, this);
1570 float Client::getAnimationTime()
1572 return m_animation_time;
1575 int Client::getCrackLevel()
1577 return m_crack_level;
1580 v3s16 Client::getCrackPos()
1585 void Client::setCrack(int level, v3s16 pos)
1587 int old_crack_level = m_crack_level;
1588 v3s16 old_crack_pos = m_crack_pos;
1590 m_crack_level = level;
1593 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1596 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1598 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1601 addUpdateMeshTaskForNode(pos, false, true);
1607 LocalPlayer *player = m_env.getLocalPlayer();
1612 bool Client::getChatMessage(std::wstring &res)
1614 if (m_chat_queue.empty())
1617 ChatMessage *chatMessage = m_chat_queue.front();
1622 switch (chatMessage->type) {
1623 case CHATMESSAGE_TYPE_RAW:
1624 case CHATMESSAGE_TYPE_ANNOUNCE:
1625 case CHATMESSAGE_TYPE_SYSTEM:
1626 res = chatMessage->message;
1628 case CHATMESSAGE_TYPE_NORMAL: {
1629 if (!chatMessage->sender.empty())
1630 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1632 res = chatMessage->message;
1643 void Client::typeChatMessage(const std::wstring &message)
1645 // Discard empty line
1646 if (message.empty())
1649 // If message was consumed by script API, don't send it to server
1650 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1654 sendChatMessage(message);
1657 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1659 // Check if the block exists to begin with. In the case when a non-existing
1660 // neighbor is automatically added, it may not. In that case we don't want
1661 // to tell the mesh update thread about it.
1662 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1666 m_mesh_update_manager.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1669 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1671 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1674 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1678 infostream<<"Client::addUpdateMeshTaskForNode(): "
1679 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1683 v3s16 blockpos = getNodeBlockPos(nodepos);
1684 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1685 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1687 if (nodepos.X == blockpos_relative.X)
1688 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1689 if (nodepos.Y == blockpos_relative.Y)
1690 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1691 if (nodepos.Z == blockpos_relative.Z)
1692 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1695 ClientEvent *Client::getClientEvent()
1697 FATAL_ERROR_IF(m_client_event_queue.empty(),
1698 "Cannot getClientEvent, queue is empty.");
1700 ClientEvent *event = m_client_event_queue.front();
1701 m_client_event_queue.pop();
1705 const Address Client::getServerAddress()
1707 return m_con->GetPeerAddress(PEER_ID_SERVER);
1710 float Client::mediaReceiveProgress()
1712 if (m_media_downloader)
1713 return m_media_downloader->getProgress();
1715 return 1.0; // downloader only exists when not yet done
1718 struct TextureUpdateArgs {
1719 gui::IGUIEnvironment *guienv;
1722 const wchar_t* text_base;
1723 ITextureSource *tsrc;
1726 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1728 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1729 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1731 // update the loading menu -- if necessary
1732 bool do_draw = false;
1733 u64 time_ms = targs->last_time_ms;
1734 if (cur_percent != targs->last_percent) {
1735 targs->last_percent = cur_percent;
1736 time_ms = porting::getTimeMs();
1737 // only draw when the user will notice something:
1738 do_draw = (time_ms - targs->last_time_ms > 100);
1742 targs->last_time_ms = time_ms;
1743 std::wostringstream strm;
1744 strm << targs->text_base << L" " << targs->last_percent << L"%...";
1745 m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1746 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1750 void Client::afterContentReceived()
1752 infostream<<"Client::afterContentReceived() started"<<std::endl;
1753 assert(m_itemdef_received); // pre-condition
1754 assert(m_nodedef_received); // pre-condition
1755 assert(mediaReceived()); // pre-condition
1757 const wchar_t* text = wgettext("Loading textures...");
1759 // Clear cached pre-scaled 2D GUI images, as this cache
1760 // might have images with the same name but different
1761 // content from previous sessions.
1762 guiScalingCacheClear();
1764 // Rebuild inherited images and recreate textures
1765 infostream<<"- Rebuilding images and textures"<<std::endl;
1766 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1767 m_tsrc->rebuildImagesAndTextures();
1771 infostream<<"- Rebuilding shaders"<<std::endl;
1772 text = wgettext("Rebuilding shaders...");
1773 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1774 m_shsrc->rebuildShaders();
1777 // Update node aliases
1778 infostream<<"- Updating node aliases"<<std::endl;
1779 text = wgettext("Initializing nodes...");
1780 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1781 m_nodedef->updateAliases(m_itemdef);
1782 for (const auto &path : getTextureDirs()) {
1783 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1784 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1785 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1787 m_nodedef->setNodeRegistrationStatus(true);
1788 m_nodedef->runNodeResolveCallbacks();
1791 // Update node textures and assign shaders to each tile
1792 infostream<<"- Updating node textures"<<std::endl;
1793 TextureUpdateArgs tu_args;
1794 tu_args.guienv = guienv;
1795 tu_args.last_time_ms = porting::getTimeMs();
1796 tu_args.last_percent = 0;
1797 tu_args.text_base = wgettext("Initializing nodes");
1798 tu_args.tsrc = m_tsrc;
1799 m_nodedef->updateTextures(this, &tu_args);
1800 delete[] tu_args.text_base;
1802 // Start mesh update thread after setting up content definitions
1803 infostream<<"- Starting mesh update thread"<<std::endl;
1804 m_mesh_update_manager.start();
1810 m_script->on_client_ready(m_env.getLocalPlayer());
1812 text = wgettext("Done!");
1813 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1814 infostream<<"Client::afterContentReceived() done"<<std::endl;
1818 float Client::getRTT()
1820 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1823 float Client::getCurRate()
1825 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1826 m_con->getLocalStat(con::CUR_DL_RATE));
1829 void Client::makeScreenshot()
1831 irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1832 irr::video::IImage* const raw_image = driver->createScreenShot();
1837 const struct tm tm = mt_localtime();
1839 char timetstamp_c[64];
1840 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1842 std::string screenshot_dir;
1844 if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1845 screenshot_dir = g_settings->get("screenshot_path");
1847 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1849 std::string filename_base = screenshot_dir
1851 + std::string("screenshot_")
1852 + std::string(timetstamp_c);
1853 std::string filename_ext = "." + g_settings->get("screenshot_format");
1854 std::string filename;
1856 // Create the directory if it doesn't already exist.
1857 // Otherwise, saving the screenshot would fail.
1858 fs::CreateDir(screenshot_dir);
1860 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1861 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1863 // Try to find a unique filename
1864 unsigned serial = 0;
1866 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1867 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1868 std::ifstream tmp(filename.c_str());
1870 break; // File did not apparently exist, we'll go with it
1874 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1875 infostream << "Could not find suitable filename for screenshot" << std::endl;
1877 irr::video::IImage* const image =
1878 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1881 raw_image->copyTo(image);
1883 std::ostringstream sstr;
1884 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1885 sstr << "Saved screenshot to '" << filename << "'";
1887 sstr << "Failed to save screenshot '" << filename << "'";
1889 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1890 utf8_to_wide(sstr.str())));
1891 infostream << sstr.str() << std::endl;
1899 bool Client::shouldShowMinimap() const
1901 return !m_minimap_disabled_by_server;
1904 void Client::pushToEventQueue(ClientEvent *event)
1906 m_client_event_queue.push(event);
1909 void Client::showMinimap(const bool show)
1911 m_game_ui->showMinimap(show);
1914 // IGameDef interface
1916 IItemDefManager* Client::getItemDefManager()
1920 const NodeDefManager* Client::getNodeDefManager()
1924 ICraftDefManager* Client::getCraftDefManager()
1927 //return m_craftdef;
1929 ITextureSource* Client::getTextureSource()
1933 IWritableShaderSource* Client::getShaderSource()
1938 u16 Client::allocateUnknownNodeId(const std::string &name)
1940 errorstream << "Client::allocateUnknownNodeId(): "
1941 << "Client cannot allocate node IDs" << std::endl;
1942 FATAL_ERROR("Client allocated unknown node");
1944 return CONTENT_IGNORE;
1946 ISoundManager* Client::getSoundManager()
1950 MtEventManager* Client::getEventManager()
1955 ParticleManager* Client::getParticleManager()
1957 return &m_particle_manager;
1960 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1962 StringMap::const_iterator it = m_mesh_data.find(filename);
1963 if (it == m_mesh_data.end()) {
1964 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1965 << "\"" << std::endl;
1968 const std::string &data = it->second;
1970 // Create the mesh, remove it from cache and return it
1971 // This allows unique vertex colors and other properties for each instance
1972 io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1973 data.c_str(), data.size(), filename.c_str());
1974 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1976 scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
1982 m_rendering_engine->removeMesh(mesh);
1986 const std::string* Client::getModFile(std::string filename)
1988 // strip dir delimiter from beginning of path
1989 auto pos = filename.find_first_of(':');
1990 if (pos == std::string::npos)
1993 auto pos2 = filename.find_first_not_of('/', pos);
1995 filename.erase(pos, pos2 - pos);
1997 StringMap::const_iterator it = m_mod_vfs.find(filename);
1998 if (it == m_mod_vfs.end())
2007 bool Client::joinModChannel(const std::string &channel)
2009 if (m_modchannel_mgr->channelRegistered(channel))
2012 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2016 m_modchannel_mgr->joinChannel(channel, 0);
2020 bool Client::leaveModChannel(const std::string &channel)
2022 if (!m_modchannel_mgr->channelRegistered(channel))
2025 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2029 m_modchannel_mgr->leaveChannel(channel, 0);
2033 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2035 if (!m_modchannel_mgr->canWriteOnChannel(channel))
2038 if (message.size() > STRING_MAX_LEN) {
2039 warningstream << "ModChannel message too long, dropping before sending "
2040 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2041 << channel << ")" << std::endl;
2045 // @TODO: do some client rate limiting
2046 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2047 pkt << channel << message;
2052 ModChannel* Client::getModChannel(const std::string &channel)
2054 return m_modchannel_mgr->getModChannel(channel);