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))
345 delete m_inventory_from_server;
347 // Delete detached inventories
348 for (auto &m_detached_inventorie : m_detached_inventories) {
349 delete m_detached_inventorie.second;
352 // cleanup 3d model meshes on client shutdown
353 m_rendering_engine->cleanupMeshCache();
355 guiScalingCacheClear();
360 delete m_media_downloader;
362 // Write the changes and delete
363 if (m_mod_storage_database)
364 m_mod_storage_database->endSave();
365 delete m_mod_storage_database;
368 void Client::connect(Address address, bool is_local_server)
370 initLocalMapSaving(address, m_address_name, is_local_server);
372 // Since we use TryReceive() a timeout here would be ineffective anyway
373 m_con->SetTimeoutMs(0);
374 m_con->Connect(address);
377 void Client::step(float dtime)
383 m_animation_time += dtime;
384 if(m_animation_time > 60.0)
385 m_animation_time -= 60.0;
387 m_time_of_day_update_timer += dtime;
395 float &counter = m_packetcounter_timer;
400 u32 sum = m_packetcounter.sum();
401 float avg = sum / counter;
403 infostream << "Client packetcounter (" << counter << "s): "
404 << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
405 m_packetcounter.print(infostream);
406 m_packetcounter.clear();
410 // UGLY hack to fix 2 second startup delay caused by non existent
411 // server client startup synchronization in local server or singleplayer mode
412 static bool initial_step = true;
414 initial_step = false;
416 else if(m_state == LC_Created) {
417 float &counter = m_connection_reinit_timer;
422 LocalPlayer *myplayer = m_env.getLocalPlayer();
423 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
425 sendInit(myplayer->getName());
428 // Not connected, return
433 Do stuff if connected
437 Run Map's timers and unload unused data
439 const float map_timer_and_unload_dtime = 5.25;
440 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
441 std::vector<v3s16> deleted_blocks;
442 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
443 std::max(g_settings->getFloat("client_unload_unused_data_timeout"), 0.0f),
444 g_settings->getS32("client_mapblock_limit"),
449 NOTE: This loop is intentionally iterated the way it is.
452 std::vector<v3s16>::iterator i = deleted_blocks.begin();
453 std::vector<v3s16> sendlist;
455 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
466 sendDeletedBlocks(sendlist);
468 if(i == deleted_blocks.end())
474 sendlist.push_back(*i);
480 Send pending messages on out chat queue
482 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
483 sendChatMessage(m_out_chat_queue.front());
484 m_out_chat_queue.pop();
490 LocalPlayer *player = m_env.getLocalPlayer();
492 // Step environment (also handles player controls)
494 m_sound->step(dtime);
499 while (m_env.hasClientEnvEvents()) {
500 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
502 if (envEvent.type == CEE_PLAYER_DAMAGE) {
503 u16 damage = envEvent.player_damage.amount;
505 if (envEvent.player_damage.send_to_server)
508 // Add to ClientEvent queue
509 ClientEvent *event = new ClientEvent();
510 event->type = CE_PLAYER_DAMAGE;
511 event->player_damage.amount = damage;
512 event->player_damage.effect = true;
513 m_client_event_queue.push(event);
520 float &counter = m_avg_rtt_timer;
524 // connectedAndInitialized() is true, peer exists.
525 float avg_rtt = getRTT();
526 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
530 Send player position to server
533 float &counter = m_playerpos_send_timer;
535 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
543 Replace updated meshes
546 int num_processed_meshes = 0;
547 std::vector<v3s16> blocks_to_ack;
548 bool force_update_shadows = false;
550 while (m_mesh_update_manager.getNextResult(r))
552 num_processed_meshes++;
554 MinimapMapblock *minimap_mapblock = NULL;
555 bool do_mapper_update = true;
557 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
559 // Delete the old mesh
561 block->mesh = nullptr;
564 block->solid_sides = r.solid_sides;
565 minimap_mapblock = r.mesh->moveMinimapMapblock();
566 if (minimap_mapblock == NULL)
567 do_mapper_update = false;
569 bool is_empty = true;
570 for (int l = 0; l < MAX_TILE_LAYERS; l++)
571 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
577 // Replace with the new mesh
578 block->mesh = r.mesh;
580 force_update_shadows = true;
587 if (m_minimap && do_mapper_update)
588 m_minimap->addBlock(r.p, minimap_mapblock);
590 if (r.ack_block_to_server) {
591 if (blocks_to_ack.size() == 255) {
592 sendGotBlocks(blocks_to_ack);
593 blocks_to_ack.clear();
596 blocks_to_ack.emplace_back(r.p);
599 if (blocks_to_ack.size() > 0) {
600 // Acknowledge block(s)
601 sendGotBlocks(blocks_to_ack);
604 if (num_processed_meshes > 0)
605 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
607 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
608 if (shadow_renderer && force_update_shadows)
609 shadow_renderer->setForceUpdateShadowMap();
615 if (m_media_downloader && m_media_downloader->isStarted()) {
616 m_media_downloader->step(this);
617 if (m_media_downloader->isDone()) {
618 delete m_media_downloader;
619 m_media_downloader = NULL;
623 // Acknowledge dynamic media downloads to server
624 std::vector<u32> done;
625 for (auto it = m_pending_media_downloads.begin();
626 it != m_pending_media_downloads.end();) {
627 assert(it->second->isStarted());
628 it->second->step(this);
629 if (it->second->isDone()) {
630 done.emplace_back(it->first);
632 it = m_pending_media_downloads.erase(it);
637 if (done.size() == 255) { // maximum in one packet
647 If the server didn't update the inventory in a while, revert
648 the local inventory (so the player notices the lag problem
649 and knows something is wrong).
651 if (m_inventory_from_server) {
652 float interval = 10.0f;
653 float count_before = std::floor(m_inventory_from_server_age / interval);
655 m_inventory_from_server_age += dtime;
657 float count_after = std::floor(m_inventory_from_server_age / interval);
659 if (count_after != count_before) {
660 // Do this every <interval> seconds after TOCLIENT_INVENTORY
661 // Reset the locally changed inventory to the authoritative inventory
662 player->inventory = *m_inventory_from_server;
663 m_update_wielded_item = true;
668 Update positions of sounds attached to objects
671 for (auto &m_sounds_to_object : m_sounds_to_objects) {
672 int client_id = m_sounds_to_object.first;
673 u16 object_id = m_sounds_to_object.second;
674 ClientActiveObject *cao = m_env.getActiveObject(object_id);
677 m_sound->updateSoundPosition(client_id, cao->getPosition());
682 Handle removed remotely initiated sounds
684 m_removed_sounds_check_timer += dtime;
685 if(m_removed_sounds_check_timer >= 2.32) {
686 m_removed_sounds_check_timer = 0;
687 // Find removed sounds and clear references to them
688 std::vector<s32> removed_server_ids;
689 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
690 i != m_sounds_server_to_client.end();) {
691 s32 server_id = i->first;
692 int client_id = i->second;
694 if(!m_sound->soundExists(client_id)) {
695 m_sounds_server_to_client.erase(server_id);
696 m_sounds_client_to_server.erase(client_id);
697 m_sounds_to_objects.erase(client_id);
698 removed_server_ids.push_back(server_id);
703 if(!removed_server_ids.empty()) {
704 sendRemovedSounds(removed_server_ids);
708 // Write changes to the mod storage
709 m_mod_storage_save_timer -= dtime;
710 if (m_mod_storage_save_timer <= 0.0f) {
711 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
712 m_mod_storage_database->endSave();
713 m_mod_storage_database->beginSave();
717 if (m_localdb && m_localdb_save_interval.step(dtime,
718 m_cache_save_interval)) {
719 m_localdb->endSave();
720 m_localdb->beginSave();
724 bool Client::loadMedia(const std::string &data, const std::string &filename,
725 bool from_media_push)
729 const char *image_ext[] = {
730 ".png", ".jpg", ".bmp", ".tga",
731 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
734 name = removeStringEnd(filename, image_ext);
736 TRACESTREAM(<< "Client: Attempting to load image "
737 << "file \"" << filename << "\"" << std::endl);
739 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
740 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
742 io::IReadFile *rfile = irrfs->createMemoryReadFile(
743 data.c_str(), data.size(), "_tempreadfile");
745 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
748 video::IImage *img = vdrv->createImageFromFile(rfile);
750 errorstream<<"Client: Cannot create image from data of "
751 <<"file \""<<filename<<"\""<<std::endl;
756 m_tsrc->insertSourceImage(filename, img);
762 const char *sound_ext[] = {
763 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
764 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
767 name = removeStringEnd(filename, sound_ext);
769 TRACESTREAM(<< "Client: Attempting to load sound "
770 << "file \"" << filename << "\"" << std::endl);
771 return m_sound->loadSoundData(name, data);
774 const char *model_ext[] = {
775 ".x", ".b3d", ".md2", ".obj",
778 name = removeStringEnd(filename, model_ext);
780 verbosestream<<"Client: Storing model into memory: "
781 <<"\""<<filename<<"\""<<std::endl;
782 if(m_mesh_data.count(filename))
783 errorstream<<"Multiple models with name \""<<filename.c_str()
784 <<"\" found; replacing previous model"<<std::endl;
785 m_mesh_data[filename] = data;
789 const char *translate_ext[] = {
792 name = removeStringEnd(filename, translate_ext);
796 TRACESTREAM(<< "Client: Loading translation: "
797 << "\"" << filename << "\"" << std::endl);
798 g_client_translations->loadTranslation(data);
802 errorstream << "Client: Don't know how to load file \""
803 << filename << "\"" << std::endl;
807 // Virtual methods from con::PeerHandler
808 void Client::peerAdded(con::Peer *peer)
810 infostream << "Client::peerAdded(): peer->id="
811 << peer->id << std::endl;
814 void Client::deletingPeer(con::Peer *peer, bool timeout)
816 infostream << "Client::deletingPeer(): "
817 "Server Peer is getting deleted "
818 << "(timeout=" << timeout << ")" << std::endl;
820 m_access_denied = true;
822 m_access_denied_reason = gettext("Connection timed out.");
823 else if (m_access_denied_reason.empty())
824 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
829 u16 number of files requested
835 void Client::request_media(const std::vector<std::string> &file_requests)
837 std::ostringstream os(std::ios_base::binary);
838 writeU16(os, TOSERVER_REQUEST_MEDIA);
839 size_t file_requests_size = file_requests.size();
841 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
843 // Packet dynamicly resized
844 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
846 pkt << (u16) (file_requests_size & 0xFFFF);
848 for (const std::string &file_request : file_requests) {
854 infostream << "Client: Sending media request list to server ("
855 << file_requests.size() << " files, packet size "
856 << pkt.getSize() << ")" << std::endl;
859 void Client::initLocalMapSaving(const Address &address,
860 const std::string &hostname,
861 bool is_local_server)
863 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
867 std::string world_path;
868 #define set_world_path(hostname) \
869 world_path = porting::path_user \
870 + DIR_DELIM + "worlds" \
871 + DIR_DELIM + "server_" \
872 + hostname + "_" + std::to_string(address.getPort());
874 set_world_path(hostname);
875 if (!fs::IsDir(world_path)) {
876 std::string hostname_escaped = hostname;
877 str_replace(hostname_escaped, ':', '_');
878 set_world_path(hostname_escaped);
880 #undef set_world_path
881 fs::CreateAllDirs(world_path);
883 m_localdb = new MapDatabaseSQLite3(world_path);
884 m_localdb->beginSave();
885 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
888 void Client::ReceiveAll()
891 u64 start_ms = porting::getTimeMs();
892 const u64 budget = 100;
894 // Limit time even if there would be huge amounts of data to
896 if (porting::getTimeMs() > start_ms + budget) {
897 infostream << "Client::ReceiveAll(): "
898 "Packet processing budget exceeded." << std::endl;
904 if (!m_con->TryReceive(&pkt))
907 } catch (const con::InvalidIncomingDataException &e) {
908 infostream << "Client::ReceiveAll(): "
909 "InvalidIncomingDataException: what()="
910 << e.what() << std::endl;
915 inline void Client::handleCommand(NetworkPacket* pkt)
917 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
918 (this->*opHandle.handler)(pkt);
922 sender_peer_id given to this shall be quaranteed to be a valid peer
924 void Client::ProcessData(NetworkPacket *pkt)
926 ToClientCommand command = (ToClientCommand) pkt->getCommand();
927 u32 sender_peer_id = pkt->getPeerId();
929 //infostream<<"Client: received command="<<command<<std::endl;
930 m_packetcounter.add((u16)command);
931 g_profiler->graphAdd("client_received_packets", 1);
934 If this check is removed, be sure to change the queue
935 system to know the ids
937 if(sender_peer_id != PEER_ID_SERVER) {
938 infostream << "Client::ProcessData(): Discarding data not "
939 "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
944 // Command must be handled into ToClientCommandHandler
945 if (command >= TOCLIENT_NUM_MSG_TYPES) {
946 infostream << "Client: Ignoring unknown command "
947 << command << std::endl;
952 * Those packets are handled before m_server_ser_ver is set, it's normal
953 * But we must use the new ToClientConnectionState in the future,
956 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
961 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
962 infostream << "Client: Server serialization"
963 " format invalid or not initialized."
964 " Skipping incoming command=" << command << std::endl;
969 Handle runtime commands
975 void Client::Send(NetworkPacket* pkt)
977 m_con->Send(PEER_ID_SERVER,
978 serverCommandFactoryTable[pkt->getCommand()].channel,
980 serverCommandFactoryTable[pkt->getCommand()].reliable);
983 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
984 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
986 v3f pf = myplayer->getPosition() * 100;
987 v3f sf = myplayer->getSpeed() * 100;
988 s32 pitch = myplayer->getPitch() * 100;
989 s32 yaw = myplayer->getYaw() * 100;
990 u32 keyPressed = myplayer->control.getKeysPressed();
991 // scaled by 80, so that pi can fit into a u8
992 u8 fov = clientMap->getCameraFov() * 80;
993 u8 wanted_range = MYMIN(255,
994 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
996 v3s32 position(pf.X, pf.Y, pf.Z);
997 v3s32 speed(sf.X, sf.Y, sf.Z);
1001 [0] v3s32 position*100
1002 [12] v3s32 speed*100
1003 [12+12] s32 pitch*100
1004 [12+12+4] s32 yaw*100
1005 [12+12+4+4] u32 keyPressed
1006 [12+12+4+4+4] u8 fov*80
1007 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
1009 *pkt << position << speed << pitch << yaw << keyPressed;
1010 *pkt << fov << wanted_range;
1013 void Client::interact(InteractAction action, const PointedThing& pointed)
1015 if(m_state != LC_Ready) {
1016 errorstream << "Client::interact() "
1017 "Canceled (not connected)"
1022 LocalPlayer *myplayer = m_env.getLocalPlayer();
1023 if (myplayer == NULL)
1030 [5] u32 length of the next item (plen)
1031 [9] serialized PointedThing
1032 [9 + plen] player position information
1035 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1038 pkt << myplayer->getWieldIndex();
1040 std::ostringstream tmp_os(std::ios::binary);
1041 pointed.serialize(tmp_os);
1043 pkt.putLongString(tmp_os.str());
1045 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1050 void Client::deleteAuthData()
1055 switch (m_chosen_auth_mech) {
1056 case AUTH_MECHANISM_FIRST_SRP:
1058 case AUTH_MECHANISM_SRP:
1059 case AUTH_MECHANISM_LEGACY_PASSWORD:
1060 srp_user_delete((SRPUser *) m_auth_data);
1063 case AUTH_MECHANISM_NONE:
1066 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1070 AuthMechanism Client::choseAuthMech(const u32 mechs)
1072 if (mechs & AUTH_MECHANISM_SRP)
1073 return AUTH_MECHANISM_SRP;
1075 if (mechs & AUTH_MECHANISM_FIRST_SRP)
1076 return AUTH_MECHANISM_FIRST_SRP;
1078 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1079 return AUTH_MECHANISM_LEGACY_PASSWORD;
1081 return AUTH_MECHANISM_NONE;
1084 void Client::sendInit(const std::string &playerName)
1086 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1088 // we don't support network compression yet
1089 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1091 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1092 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1098 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1100 m_chosen_auth_mech = chosen_auth_mechanism;
1102 switch (chosen_auth_mechanism) {
1103 case AUTH_MECHANISM_FIRST_SRP: {
1104 // send srp verifier to server
1105 std::string verifier;
1107 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1110 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1111 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1116 case AUTH_MECHANISM_SRP:
1117 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1120 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1121 m_password = translate_password(getPlayerName(), m_password);
1125 std::string playername_u = lowercase(getPlayerName());
1126 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1127 getPlayerName().c_str(), playername_u.c_str(),
1128 (const unsigned char *) m_password.c_str(),
1129 m_password.length(), NULL, NULL);
1132 SRP_Result res = srp_user_start_authentication(
1133 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1134 (unsigned char **) &bytes_A, &len_A);
1135 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1137 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1138 resp_pkt << std::string(bytes_A, len_A) << based_on;
1142 case AUTH_MECHANISM_NONE:
1143 break; // not handled in this method
1147 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1149 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1151 pkt << (u8) blocks.size();
1153 for (const v3s16 &block : blocks) {
1160 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1162 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1163 pkt << (u8) blocks.size();
1164 for (const v3s16 &block : blocks)
1170 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1172 size_t server_ids = soundList.size();
1173 assert(server_ids <= 0xFFFF);
1175 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1177 pkt << (u16) (server_ids & 0xFFFF);
1179 for (s32 sound_id : soundList)
1185 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1186 const StringMap &fields)
1188 size_t fields_size = fields.size();
1190 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1192 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1194 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1196 StringMap::const_iterator it;
1197 for (it = fields.begin(); it != fields.end(); ++it) {
1198 const std::string &name = it->first;
1199 const std::string &value = it->second;
1201 pkt.putLongString(value);
1207 void Client::sendInventoryFields(const std::string &formname,
1208 const StringMap &fields)
1210 size_t fields_size = fields.size();
1211 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1213 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1214 pkt << formname << (u16) (fields_size & 0xFFFF);
1216 StringMap::const_iterator it;
1217 for (it = fields.begin(); it != fields.end(); ++it) {
1218 const std::string &name = it->first;
1219 const std::string &value = it->second;
1221 pkt.putLongString(value);
1227 void Client::sendInventoryAction(InventoryAction *a)
1229 std::ostringstream os(std::ios_base::binary);
1234 std::string s = os.str();
1236 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1237 pkt.putRawString(s.c_str(),s.size());
1242 bool Client::canSendChatMessage() const
1244 u32 now = time(NULL);
1245 float time_passed = now - m_last_chat_message_sent;
1247 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1248 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1250 if (virt_chat_message_allowance < 1.0f)
1256 void Client::sendChatMessage(const std::wstring &message)
1258 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1259 if (canSendChatMessage()) {
1260 u32 now = time(NULL);
1261 float time_passed = now - m_last_chat_message_sent;
1262 m_last_chat_message_sent = now;
1264 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1265 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1266 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1268 m_chat_message_allowance -= 1.0f;
1270 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1275 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size < 0) {
1276 m_out_chat_queue.push(message);
1278 infostream << "Could not queue chat message because maximum out chat queue size ("
1279 << max_queue_size << ") is reached." << std::endl;
1283 void Client::clearOutChatQueue()
1285 m_out_chat_queue = std::queue<std::wstring>();
1288 void Client::sendChangePassword(const std::string &oldpassword,
1289 const std::string &newpassword)
1291 LocalPlayer *player = m_env.getLocalPlayer();
1295 // get into sudo mode and then send new password to server
1296 m_password = oldpassword;
1297 m_new_password = newpassword;
1298 startAuth(choseAuthMech(m_sudo_auth_methods));
1302 void Client::sendDamage(u16 damage)
1304 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1309 void Client::sendRespawn()
1311 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1315 void Client::sendReady()
1317 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1318 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1320 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1321 << (u8) 0 << (u16) strlen(g_version_hash);
1323 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1324 pkt << (u16)FORMSPEC_API_VERSION;
1328 void Client::sendPlayerPos()
1330 LocalPlayer *player = m_env.getLocalPlayer();
1334 // Save bandwidth by only updating position when
1335 // player is not dead and something changed
1337 if (m_activeobjects_received && player->isDead())
1340 ClientMap &map = m_env.getClientMap();
1341 u8 camera_fov = map.getCameraFov();
1342 u8 wanted_range = map.getControl().wanted_range;
1344 u32 keyPressed = player->control.getKeysPressed();
1347 player->last_position == player->getPosition() &&
1348 player->last_speed == player->getSpeed() &&
1349 player->last_pitch == player->getPitch() &&
1350 player->last_yaw == player->getYaw() &&
1351 player->last_keyPressed == keyPressed &&
1352 player->last_camera_fov == camera_fov &&
1353 player->last_wanted_range == wanted_range)
1356 player->last_position = player->getPosition();
1357 player->last_speed = player->getSpeed();
1358 player->last_pitch = player->getPitch();
1359 player->last_yaw = player->getYaw();
1360 player->last_keyPressed = keyPressed;
1361 player->last_camera_fov = camera_fov;
1362 player->last_wanted_range = wanted_range;
1364 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1366 writePlayerPos(player, &map, &pkt);
1371 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1373 NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1375 sanity_check(tokens.size() < 256);
1377 pkt << static_cast<u8>(tokens.size());
1378 for (u32 token : tokens)
1384 void Client::removeNode(v3s16 p)
1386 std::map<v3s16, MapBlock*> modified_blocks;
1389 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1391 catch(InvalidPositionException &e) {
1394 for (const auto &modified_block : modified_blocks) {
1395 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1400 * Helper function for Client Side Modding
1401 * CSM restrictions are applied there, this should not be used for core engine
1403 * @param is_valid_position
1406 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1408 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1409 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1410 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1411 *is_valid_position = false;
1415 return m_env.getMap().getNode(p, is_valid_position);
1418 int Client::CSMClampRadius(v3s16 pos, int radius)
1420 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1422 // This is approximate and will cause some allowed nodes to be excluded
1423 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1424 u32 distance = ppos.getDistanceFrom(pos);
1425 if (distance >= m_csm_restriction_noderange)
1427 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1430 v3s16 Client::CSMClampPos(v3s16 pos)
1432 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1434 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1435 const int range = m_csm_restriction_noderange;
1437 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1438 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1439 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1443 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1445 //TimeTaker timer1("Client::addNode()");
1447 std::map<v3s16, MapBlock*> modified_blocks;
1450 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1451 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1453 catch(InvalidPositionException &e) {
1456 for (const auto &modified_block : modified_blocks) {
1457 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1461 void Client::setPlayerControl(PlayerControl &control)
1463 LocalPlayer *player = m_env.getLocalPlayer();
1465 player->control = control;
1468 void Client::setPlayerItem(u16 item)
1470 m_env.getLocalPlayer()->setWieldIndex(item);
1471 m_update_wielded_item = true;
1473 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1478 // Returns true once after the inventory of the local player
1479 // has been updated from the server.
1480 bool Client::updateWieldedItem()
1482 if (!m_update_wielded_item)
1485 m_update_wielded_item = false;
1487 LocalPlayer *player = m_env.getLocalPlayer();
1489 if (auto *list = player->inventory.getList("main"))
1490 list->setModified(false);
1491 if (auto *list = player->inventory.getList("hand"))
1492 list->setModified(false);
1497 scene::ISceneManager* Client::getSceneManager()
1499 return m_rendering_engine->get_scene_manager();
1502 Inventory* Client::getInventory(const InventoryLocation &loc)
1505 case InventoryLocation::UNDEFINED:
1508 case InventoryLocation::CURRENT_PLAYER:
1510 LocalPlayer *player = m_env.getLocalPlayer();
1512 return &player->inventory;
1515 case InventoryLocation::PLAYER:
1517 // Check if we are working with local player inventory
1518 LocalPlayer *player = m_env.getLocalPlayer();
1519 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1521 return &player->inventory;
1524 case InventoryLocation::NODEMETA:
1526 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1529 return meta->getInventory();
1532 case InventoryLocation::DETACHED:
1534 if (m_detached_inventories.count(loc.name) == 0)
1536 return m_detached_inventories[loc.name];
1540 FATAL_ERROR("Invalid inventory location type.");
1546 void Client::inventoryAction(InventoryAction *a)
1549 Send it to the server
1551 sendInventoryAction(a);
1554 Predict some local inventory changes
1556 a->clientApply(this, this);
1562 float Client::getAnimationTime()
1564 return m_animation_time;
1567 int Client::getCrackLevel()
1569 return m_crack_level;
1572 v3s16 Client::getCrackPos()
1577 void Client::setCrack(int level, v3s16 pos)
1579 int old_crack_level = m_crack_level;
1580 v3s16 old_crack_pos = m_crack_pos;
1582 m_crack_level = level;
1585 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1588 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1590 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1593 addUpdateMeshTaskForNode(pos, false, true);
1599 LocalPlayer *player = m_env.getLocalPlayer();
1604 bool Client::getChatMessage(std::wstring &res)
1606 if (m_chat_queue.empty())
1609 ChatMessage *chatMessage = m_chat_queue.front();
1614 switch (chatMessage->type) {
1615 case CHATMESSAGE_TYPE_RAW:
1616 case CHATMESSAGE_TYPE_ANNOUNCE:
1617 case CHATMESSAGE_TYPE_SYSTEM:
1618 res = chatMessage->message;
1620 case CHATMESSAGE_TYPE_NORMAL: {
1621 if (!chatMessage->sender.empty())
1622 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1624 res = chatMessage->message;
1635 void Client::typeChatMessage(const std::wstring &message)
1637 // Discard empty line
1638 if (message.empty())
1641 // If message was consumed by script API, don't send it to server
1642 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1646 sendChatMessage(message);
1649 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1651 // Check if the block exists to begin with. In the case when a non-existing
1652 // neighbor is automatically added, it may not. In that case we don't want
1653 // to tell the mesh update thread about it.
1654 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1658 m_mesh_update_manager.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1661 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1663 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1666 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1670 infostream<<"Client::addUpdateMeshTaskForNode(): "
1671 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1675 v3s16 blockpos = getNodeBlockPos(nodepos);
1676 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1677 m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1679 if (nodepos.X == blockpos_relative.X)
1680 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1681 if (nodepos.Y == blockpos_relative.Y)
1682 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1683 if (nodepos.Z == blockpos_relative.Z)
1684 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1687 ClientEvent *Client::getClientEvent()
1689 FATAL_ERROR_IF(m_client_event_queue.empty(),
1690 "Cannot getClientEvent, queue is empty.");
1692 ClientEvent *event = m_client_event_queue.front();
1693 m_client_event_queue.pop();
1697 const Address Client::getServerAddress()
1699 return m_con->GetPeerAddress(PEER_ID_SERVER);
1702 float Client::mediaReceiveProgress()
1704 if (m_media_downloader)
1705 return m_media_downloader->getProgress();
1707 return 1.0; // downloader only exists when not yet done
1710 struct TextureUpdateArgs {
1711 gui::IGUIEnvironment *guienv;
1714 const wchar_t* text_base;
1715 ITextureSource *tsrc;
1718 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1720 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1721 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1723 // update the loading menu -- if necessary
1724 bool do_draw = false;
1725 u64 time_ms = targs->last_time_ms;
1726 if (cur_percent != targs->last_percent) {
1727 targs->last_percent = cur_percent;
1728 time_ms = porting::getTimeMs();
1729 // only draw when the user will notice something:
1730 do_draw = (time_ms - targs->last_time_ms > 100);
1734 targs->last_time_ms = time_ms;
1735 std::wostringstream strm;
1736 strm << targs->text_base << L" " << targs->last_percent << L"%...";
1737 m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1738 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1742 void Client::afterContentReceived()
1744 infostream<<"Client::afterContentReceived() started"<<std::endl;
1745 assert(m_itemdef_received); // pre-condition
1746 assert(m_nodedef_received); // pre-condition
1747 assert(mediaReceived()); // pre-condition
1749 const wchar_t* text = wgettext("Loading textures...");
1751 // Clear cached pre-scaled 2D GUI images, as this cache
1752 // might have images with the same name but different
1753 // content from previous sessions.
1754 guiScalingCacheClear();
1756 // Rebuild inherited images and recreate textures
1757 infostream<<"- Rebuilding images and textures"<<std::endl;
1758 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1759 m_tsrc->rebuildImagesAndTextures();
1763 infostream<<"- Rebuilding shaders"<<std::endl;
1764 text = wgettext("Rebuilding shaders...");
1765 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1766 m_shsrc->rebuildShaders();
1769 // Update node aliases
1770 infostream<<"- Updating node aliases"<<std::endl;
1771 text = wgettext("Initializing nodes...");
1772 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1773 m_nodedef->updateAliases(m_itemdef);
1774 for (const auto &path : getTextureDirs()) {
1775 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1776 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1777 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1779 m_nodedef->setNodeRegistrationStatus(true);
1780 m_nodedef->runNodeResolveCallbacks();
1783 // Update node textures and assign shaders to each tile
1784 infostream<<"- Updating node textures"<<std::endl;
1785 TextureUpdateArgs tu_args;
1786 tu_args.guienv = guienv;
1787 tu_args.last_time_ms = porting::getTimeMs();
1788 tu_args.last_percent = 0;
1789 tu_args.text_base = wgettext("Initializing nodes");
1790 tu_args.tsrc = m_tsrc;
1791 m_nodedef->updateTextures(this, &tu_args);
1792 delete[] tu_args.text_base;
1794 // Start mesh update thread after setting up content definitions
1795 infostream<<"- Starting mesh update thread"<<std::endl;
1796 m_mesh_update_manager.start();
1802 m_script->on_client_ready(m_env.getLocalPlayer());
1804 text = wgettext("Done!");
1805 m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1806 infostream<<"Client::afterContentReceived() done"<<std::endl;
1810 float Client::getRTT()
1812 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1815 float Client::getCurRate()
1817 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1818 m_con->getLocalStat(con::CUR_DL_RATE));
1821 void Client::makeScreenshot()
1823 irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1824 irr::video::IImage* const raw_image = driver->createScreenShot();
1829 const struct tm tm = mt_localtime();
1831 char timetstamp_c[64];
1832 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1834 std::string screenshot_dir;
1836 if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1837 screenshot_dir = g_settings->get("screenshot_path");
1839 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1841 std::string filename_base = screenshot_dir
1843 + std::string("screenshot_")
1844 + std::string(timetstamp_c);
1845 std::string filename_ext = "." + g_settings->get("screenshot_format");
1846 std::string filename;
1848 // Create the directory if it doesn't already exist.
1849 // Otherwise, saving the screenshot would fail.
1850 fs::CreateDir(screenshot_dir);
1852 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1853 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1855 // Try to find a unique filename
1856 unsigned serial = 0;
1858 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1859 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1860 std::ifstream tmp(filename.c_str());
1862 break; // File did not apparently exist, we'll go with it
1866 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1867 infostream << "Could not find suitable filename for screenshot" << std::endl;
1869 irr::video::IImage* const image =
1870 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1873 raw_image->copyTo(image);
1875 std::ostringstream sstr;
1876 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1877 sstr << "Saved screenshot to '" << filename << "'";
1879 sstr << "Failed to save screenshot '" << filename << "'";
1881 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1882 utf8_to_wide(sstr.str())));
1883 infostream << sstr.str() << std::endl;
1891 bool Client::shouldShowMinimap() const
1893 return !m_minimap_disabled_by_server;
1896 void Client::pushToEventQueue(ClientEvent *event)
1898 m_client_event_queue.push(event);
1901 void Client::showMinimap(const bool show)
1903 m_game_ui->showMinimap(show);
1906 // IGameDef interface
1908 IItemDefManager* Client::getItemDefManager()
1912 const NodeDefManager* Client::getNodeDefManager()
1916 ICraftDefManager* Client::getCraftDefManager()
1919 //return m_craftdef;
1921 ITextureSource* Client::getTextureSource()
1925 IWritableShaderSource* Client::getShaderSource()
1930 u16 Client::allocateUnknownNodeId(const std::string &name)
1932 errorstream << "Client::allocateUnknownNodeId(): "
1933 << "Client cannot allocate node IDs" << std::endl;
1934 FATAL_ERROR("Client allocated unknown node");
1936 return CONTENT_IGNORE;
1938 ISoundManager* Client::getSoundManager()
1942 MtEventManager* Client::getEventManager()
1947 ParticleManager* Client::getParticleManager()
1949 return &m_particle_manager;
1952 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1954 StringMap::const_iterator it = m_mesh_data.find(filename);
1955 if (it == m_mesh_data.end()) {
1956 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1957 << "\"" << std::endl;
1960 const std::string &data = it->second;
1962 // Create the mesh, remove it from cache and return it
1963 // This allows unique vertex colors and other properties for each instance
1964 io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1965 data.c_str(), data.size(), filename.c_str());
1966 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1968 scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
1974 m_rendering_engine->removeMesh(mesh);
1978 const std::string* Client::getModFile(std::string filename)
1980 // strip dir delimiter from beginning of path
1981 auto pos = filename.find_first_of(':');
1982 if (pos == std::string::npos)
1985 auto pos2 = filename.find_first_not_of('/', pos);
1987 filename.erase(pos, pos2 - pos);
1989 StringMap::const_iterator it = m_mod_vfs.find(filename);
1990 if (it == m_mod_vfs.end())
1999 bool Client::joinModChannel(const std::string &channel)
2001 if (m_modchannel_mgr->channelRegistered(channel))
2004 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2008 m_modchannel_mgr->joinChannel(channel, 0);
2012 bool Client::leaveModChannel(const std::string &channel)
2014 if (!m_modchannel_mgr->channelRegistered(channel))
2017 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2021 m_modchannel_mgr->leaveChannel(channel, 0);
2025 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2027 if (!m_modchannel_mgr->canWriteOnChannel(channel))
2030 if (message.size() > STRING_MAX_LEN) {
2031 warningstream << "ModChannel message too long, dropping before sending "
2032 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2033 << channel << ")" << std::endl;
2037 // @TODO: do some client rate limiting
2038 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2039 pkt << channel << message;
2044 ModChannel* Client::getModChannel(const std::string &channel)
2046 return m_modchannel_mgr->getModChannel(channel);