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-sqlite3.h"
54 #include "serialization.h"
55 #include "guiscalingfilter.h"
56 #include "script/scripting_client.h"
58 #include "chatmessage.h"
59 #include "translation.h"
61 extern gui::IGUIEnvironment* guienv;
67 void PacketCounter::print(std::ostream &o) const
69 for (const auto &it : m_packets) {
70 auto name = it.first >= TOCLIENT_NUM_MSG_TYPES ? "?"
71 : toClientCommandTable[it.first].name;
72 o << "cmd " << it.first << " (" << name << ") count "
73 << it.second << std::endl;
82 const char *playername,
83 const std::string &password,
84 const std::string &address_name,
85 MapDrawControl &control,
86 IWritableTextureSource *tsrc,
87 IWritableShaderSource *shsrc,
88 IWritableItemDefManager *itemdef,
89 NodeDefManager *nodedef,
91 MtEventManager *event,
101 m_mesh_update_thread(this),
103 new ClientMap(this, control, 666),
106 m_particle_manager(&m_env),
107 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
108 m_address_name(address_name),
109 m_server_ser_ver(SER_FMT_VER_INVALID),
110 m_last_chat_message_sent(time(NULL)),
111 m_password(password),
112 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
113 m_media_downloader(new ClientMediaDownloader()),
116 m_modchannel_mgr(new ModChannelMgr())
119 m_env.setLocalPlayer(new LocalPlayer(this, playername));
121 if (g_settings->getBool("enable_minimap")) {
122 m_minimap = new Minimap(this);
124 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
127 void Client::loadMods()
129 // Don't load mods twice.
130 // If client scripting is disabled by the client, don't load builtin or
131 // client-provided mods.
132 if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
135 // If client scripting is disabled by the server, don't load builtin or
136 // client-provided mods.
137 // TODO Delete this code block when server-sent CSM and verifying of builtin are
139 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
140 warningstream << "Client-provided mod loading is disabled by server." <<
145 m_script = new ClientScripting(this);
146 m_env.setScript(m_script);
147 m_script->setEnv(&m_env);
150 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
151 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
153 // TODO Uncomment when server-sent CSM and verifying of builtin are complete
155 // Don't load client-provided mods if disabled by server
156 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
157 warningstream << "Client-provided mod loading is disabled by server." <<
159 // If builtin integrity is wrong, disconnect user
160 if (!checkBuiltinIntegrity()) {
161 // TODO disconnect user
167 ClientModConfiguration modconf(getClientModsLuaPath());
168 m_mods = modconf.getMods();
169 // complain about mods with unsatisfied dependencies
170 if (!modconf.isConsistent()) {
171 modconf.printUnsatisfiedModsError();
176 infostream << "Client loading mods: ";
177 for (const ModSpec &mod : m_mods)
178 infostream << mod.name << " ";
179 infostream << std::endl;
181 // Load "mod" scripts
182 for (const ModSpec &mod : m_mods) {
183 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
184 throw ModError("Error loading mod \"" + mod.name +
185 "\": Mod name does not follow naming conventions: "
186 "Only characters [a-z0-9_] are allowed.");
188 scanModIntoMemory(mod.name, mod.path);
192 for (const ModSpec &mod : m_mods)
193 m_script->loadModFromMemory(mod.name);
195 // Mods are done loading. Unlock callbacks
196 m_mods_loaded = true;
198 // Run a callback when mods are loaded
199 m_script->on_mods_loaded();
201 // Create objects if they're ready
202 if (m_state == LC_Ready)
203 m_script->on_client_ready(m_env.getLocalPlayer());
205 m_script->on_camera_ready(m_camera);
207 m_script->on_minimap_ready(m_minimap);
210 bool Client::checkBuiltinIntegrity()
216 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
217 std::string mod_subpath)
219 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
220 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
221 for (const fs::DirListNode &j : mod) {
223 scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
226 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
228 std::string real_path = full_path + j.name;
229 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
230 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
231 << "\" as \"" << vfs_path << "\"." << std::endl;
233 std::ifstream is(real_path, std::ios::binary | std::ios::ate);
235 errorstream << "Client::scanModSubfolder(): Can't read file \""
236 << real_path << "\"." << std::endl;
239 auto size = is.tellg();
240 std::string contents(size, '\0');
242 is.read(&contents[0], size);
244 infostream << " size: " << size << " bytes" << std::endl;
245 m_mod_vfs.emplace(vfs_path, contents);
249 const std::string &Client::getBuiltinLuaPath()
251 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
255 const std::string &Client::getClientModsLuaPath()
257 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
258 return clientmods_dir;
261 const std::vector<ModSpec>& Client::getMods() const
263 static std::vector<ModSpec> client_modspec_temp;
264 return client_modspec_temp;
267 const ModSpec* Client::getModSpec(const std::string &modname) const
276 m_script->on_shutdown();
277 //request all client managed threads to stop
278 m_mesh_update_thread.stop();
279 // Save local server map
281 infostream << "Local map saving ended." << std::endl;
282 m_localdb->endSave();
289 bool Client::isShutdown()
291 return m_shutdown || !m_mesh_update_thread.isRunning();
301 m_mesh_update_thread.stop();
302 m_mesh_update_thread.wait();
303 while (!m_mesh_update_thread.m_queue_out.empty()) {
304 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
309 delete m_inventory_from_server;
311 // Delete detached inventories
312 for (auto &m_detached_inventorie : m_detached_inventories) {
313 delete m_detached_inventorie.second;
316 // cleanup 3d model meshes on client shutdown
317 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
318 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
321 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
325 delete m_media_downloader;
328 void Client::connect(Address address, bool is_local_server)
330 initLocalMapSaving(address, m_address_name, is_local_server);
332 // Since we use TryReceive() a timeout here would be ineffective anyway
333 m_con->SetTimeoutMs(0);
334 m_con->Connect(address);
337 void Client::step(float dtime)
343 m_animation_time += dtime;
344 if(m_animation_time > 60.0)
345 m_animation_time -= 60.0;
347 m_time_of_day_update_timer += dtime;
355 float &counter = m_packetcounter_timer;
361 infostream << "Client packetcounter (" << m_packetcounter_timer
363 m_packetcounter.print(infostream);
364 m_packetcounter.clear();
368 // UGLY hack to fix 2 second startup delay caused by non existent
369 // server client startup synchronization in local server or singleplayer mode
370 static bool initial_step = true;
372 initial_step = false;
374 else if(m_state == LC_Created) {
375 if (m_is_registration_confirmation_state) {
376 // Waiting confirmation
379 float &counter = m_connection_reinit_timer;
384 LocalPlayer *myplayer = m_env.getLocalPlayer();
385 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
387 sendInit(myplayer->getName());
390 // Not connected, return
395 Do stuff if connected
399 Run Map's timers and unload unused data
401 const float map_timer_and_unload_dtime = 5.25;
402 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
403 std::vector<v3s16> deleted_blocks;
404 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
405 g_settings->getFloat("client_unload_unused_data_timeout"),
406 g_settings->getS32("client_mapblock_limit"),
411 NOTE: This loop is intentionally iterated the way it is.
414 std::vector<v3s16>::iterator i = deleted_blocks.begin();
415 std::vector<v3s16> sendlist;
417 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
428 sendDeletedBlocks(sendlist);
430 if(i == deleted_blocks.end())
436 sendlist.push_back(*i);
442 Send pending messages on out chat queue
444 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
445 sendChatMessage(m_out_chat_queue.front());
446 m_out_chat_queue.pop();
452 // Control local player (0ms)
453 LocalPlayer *player = m_env.getLocalPlayer();
455 player->applyControl(dtime, &m_env);
459 m_sound->step(dtime);
464 while (m_env.hasClientEnvEvents()) {
465 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
467 if (envEvent.type == CEE_PLAYER_DAMAGE) {
468 u16 damage = envEvent.player_damage.amount;
470 if (envEvent.player_damage.send_to_server)
473 // Add to ClientEvent queue
474 ClientEvent *event = new ClientEvent();
475 event->type = CE_PLAYER_DAMAGE;
476 event->player_damage.amount = damage;
477 m_client_event_queue.push(event);
484 float &counter = m_avg_rtt_timer;
488 // connectedAndInitialized() is true, peer exists.
489 float avg_rtt = getRTT();
490 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
494 Send player position to server
497 float &counter = m_playerpos_send_timer;
499 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
507 Replace updated meshes
510 int num_processed_meshes = 0;
511 std::vector<v3s16> blocks_to_ack;
512 while (!m_mesh_update_thread.m_queue_out.empty())
514 num_processed_meshes++;
516 MinimapMapblock *minimap_mapblock = NULL;
517 bool do_mapper_update = true;
519 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
520 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
522 // Delete the old mesh
524 block->mesh = nullptr;
527 minimap_mapblock = r.mesh->moveMinimapMapblock();
528 if (minimap_mapblock == NULL)
529 do_mapper_update = false;
531 bool is_empty = true;
532 for (int l = 0; l < MAX_TILE_LAYERS; l++)
533 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
539 // Replace with the new mesh
540 block->mesh = r.mesh;
546 if (m_minimap && do_mapper_update)
547 m_minimap->addBlock(r.p, minimap_mapblock);
549 if (r.ack_block_to_server) {
550 if (blocks_to_ack.size() == 255) {
551 sendGotBlocks(blocks_to_ack);
552 blocks_to_ack.clear();
555 blocks_to_ack.emplace_back(r.p);
558 if (blocks_to_ack.size() > 0) {
559 // Acknowledge block(s)
560 sendGotBlocks(blocks_to_ack);
563 if (num_processed_meshes > 0)
564 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
570 if (m_media_downloader && m_media_downloader->isStarted()) {
571 m_media_downloader->step(this);
572 if (m_media_downloader->isDone()) {
573 delete m_media_downloader;
574 m_media_downloader = NULL;
579 If the server didn't update the inventory in a while, revert
580 the local inventory (so the player notices the lag problem
581 and knows something is wrong).
583 if (m_inventory_from_server) {
584 float interval = 10.0f;
585 float count_before = std::floor(m_inventory_from_server_age / interval);
587 m_inventory_from_server_age += dtime;
589 float count_after = std::floor(m_inventory_from_server_age / interval);
591 if (count_after != count_before) {
592 // Do this every <interval> seconds after TOCLIENT_INVENTORY
593 // Reset the locally changed inventory to the authoritative inventory
594 player->inventory = *m_inventory_from_server;
595 m_update_wielded_item = true;
600 Update positions of sounds attached to objects
603 for (auto &m_sounds_to_object : m_sounds_to_objects) {
604 int client_id = m_sounds_to_object.first;
605 u16 object_id = m_sounds_to_object.second;
606 ClientActiveObject *cao = m_env.getActiveObject(object_id);
609 m_sound->updateSoundPosition(client_id, cao->getPosition());
614 Handle removed remotely initiated sounds
616 m_removed_sounds_check_timer += dtime;
617 if(m_removed_sounds_check_timer >= 2.32) {
618 m_removed_sounds_check_timer = 0;
619 // Find removed sounds and clear references to them
620 std::vector<s32> removed_server_ids;
621 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
622 i != m_sounds_server_to_client.end();) {
623 s32 server_id = i->first;
624 int client_id = i->second;
626 if(!m_sound->soundExists(client_id)) {
627 m_sounds_server_to_client.erase(server_id);
628 m_sounds_client_to_server.erase(client_id);
629 m_sounds_to_objects.erase(client_id);
630 removed_server_ids.push_back(server_id);
635 if(!removed_server_ids.empty()) {
636 sendRemovedSounds(removed_server_ids);
640 m_mod_storage_save_timer -= dtime;
641 if (m_mod_storage_save_timer <= 0.0f) {
642 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
644 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
645 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
646 if (it->second->isModified()) {
647 it->second->save(getModStoragePath());
652 infostream << "Saved " << n << " modified mod storages." << std::endl;
656 if (m_localdb && m_localdb_save_interval.step(dtime,
657 m_cache_save_interval)) {
658 m_localdb->endSave();
659 m_localdb->beginSave();
663 bool Client::loadMedia(const std::string &data, const std::string &filename)
665 // Silly irrlicht's const-incorrectness
666 Buffer<char> data_rw(data.c_str(), data.size());
670 const char *image_ext[] = {
671 ".png", ".jpg", ".bmp", ".tga",
672 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
675 name = removeStringEnd(filename, image_ext);
677 TRACESTREAM(<< "Client: Attempting to load image "
678 << "file \"" << filename << "\"" << std::endl);
680 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
681 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
683 // Create an irrlicht memory file
684 io::IReadFile *rfile = irrfs->createMemoryReadFile(
685 *data_rw, data_rw.getSize(), "_tempreadfile");
687 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
690 video::IImage *img = vdrv->createImageFromFile(rfile);
692 errorstream<<"Client: Cannot create image from data of "
693 <<"file \""<<filename<<"\""<<std::endl;
698 m_tsrc->insertSourceImage(filename, img);
704 const char *sound_ext[] = {
705 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
706 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
709 name = removeStringEnd(filename, sound_ext);
711 TRACESTREAM(<< "Client: Attempting to load sound "
712 << "file \"" << filename << "\"" << std::endl);
713 return m_sound->loadSoundData(name, data);
716 const char *model_ext[] = {
717 ".x", ".b3d", ".md2", ".obj",
721 name = removeStringEnd(filename, model_ext);
723 verbosestream<<"Client: Storing model into memory: "
724 <<"\""<<filename<<"\""<<std::endl;
725 if(m_mesh_data.count(filename))
726 errorstream<<"Multiple models with name \""<<filename.c_str()
727 <<"\" found; replacing previous model"<<std::endl;
728 m_mesh_data[filename] = data;
732 const char *translate_ext[] = {
735 name = removeStringEnd(filename, translate_ext);
737 TRACESTREAM(<< "Client: Loading translation: "
738 << "\"" << filename << "\"" << std::endl);
739 g_translations->loadTranslation(data);
743 errorstream << "Client: Don't know how to load file \""
744 << filename << "\"" << std::endl;
748 // Virtual methods from con::PeerHandler
749 void Client::peerAdded(con::Peer *peer)
751 infostream << "Client::peerAdded(): peer->id="
752 << peer->id << std::endl;
754 void Client::deletingPeer(con::Peer *peer, bool timeout)
756 infostream << "Client::deletingPeer(): "
757 "Server Peer is getting deleted "
758 << "(timeout=" << timeout << ")" << std::endl;
761 m_access_denied = true;
762 m_access_denied_reason = gettext("Connection timed out.");
768 u16 number of files requested
774 void Client::request_media(const std::vector<std::string> &file_requests)
776 std::ostringstream os(std::ios_base::binary);
777 writeU16(os, TOSERVER_REQUEST_MEDIA);
778 size_t file_requests_size = file_requests.size();
780 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
782 // Packet dynamicly resized
783 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
785 pkt << (u16) (file_requests_size & 0xFFFF);
787 for (const std::string &file_request : file_requests) {
793 infostream << "Client: Sending media request list to server ("
794 << file_requests.size() << " files. packet size)" << std::endl;
797 void Client::initLocalMapSaving(const Address &address,
798 const std::string &hostname,
799 bool is_local_server)
801 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
805 std::string world_path;
806 #define set_world_path(hostname) \
807 world_path = porting::path_user \
808 + DIR_DELIM + "worlds" \
809 + DIR_DELIM + "server_" \
810 + hostname + "_" + std::to_string(address.getPort());
812 set_world_path(hostname);
813 if (!fs::IsDir(world_path)) {
814 std::string hostname_escaped = hostname;
815 str_replace(hostname_escaped, ':', '_');
816 set_world_path(hostname_escaped);
818 #undef set_world_path
819 fs::CreateAllDirs(world_path);
821 m_localdb = new MapDatabaseSQLite3(world_path);
822 m_localdb->beginSave();
823 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
826 void Client::ReceiveAll()
829 u64 start_ms = porting::getTimeMs();
830 const u64 budget = 100;
832 // Limit time even if there would be huge amounts of data to
834 if (porting::getTimeMs() > start_ms + budget) {
835 infostream << "Client::ReceiveAll(): "
836 "Packet processing budget exceeded." << std::endl;
842 if (!m_con->TryReceive(&pkt))
845 } catch (const con::InvalidIncomingDataException &e) {
846 infostream << "Client::ReceiveAll(): "
847 "InvalidIncomingDataException: what()="
848 << e.what() << std::endl;
853 inline void Client::handleCommand(NetworkPacket* pkt)
855 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
856 (this->*opHandle.handler)(pkt);
860 sender_peer_id given to this shall be quaranteed to be a valid peer
862 void Client::ProcessData(NetworkPacket *pkt)
864 ToClientCommand command = (ToClientCommand) pkt->getCommand();
865 u32 sender_peer_id = pkt->getPeerId();
867 //infostream<<"Client: received command="<<command<<std::endl;
868 m_packetcounter.add((u16)command);
869 g_profiler->graphAdd("client_received_packets", 1);
872 If this check is removed, be sure to change the queue
873 system to know the ids
875 if(sender_peer_id != PEER_ID_SERVER) {
876 infostream << "Client::ProcessData(): Discarding data not "
877 "coming from server: peer_id=" << sender_peer_id
882 // Command must be handled into ToClientCommandHandler
883 if (command >= TOCLIENT_NUM_MSG_TYPES) {
884 infostream << "Client: Ignoring unknown command "
885 << command << std::endl;
890 * Those packets are handled before m_server_ser_ver is set, it's normal
891 * But we must use the new ToClientConnectionState in the future,
894 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
899 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
900 infostream << "Client: Server serialization"
901 " format invalid or not initialized."
902 " Skipping incoming command=" << command << std::endl;
907 Handle runtime commands
913 void Client::Send(NetworkPacket* pkt)
915 m_con->Send(PEER_ID_SERVER,
916 serverCommandFactoryTable[pkt->getCommand()].channel,
918 serverCommandFactoryTable[pkt->getCommand()].reliable);
921 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
922 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
924 v3f pf = myplayer->getPosition() * 100;
925 v3f sf = myplayer->getSpeed() * 100;
926 s32 pitch = myplayer->getPitch() * 100;
927 s32 yaw = myplayer->getYaw() * 100;
928 u32 keyPressed = myplayer->keyPressed;
929 // scaled by 80, so that pi can fit into a u8
930 u8 fov = clientMap->getCameraFov() * 80;
931 u8 wanted_range = MYMIN(255,
932 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
934 v3s32 position(pf.X, pf.Y, pf.Z);
935 v3s32 speed(sf.X, sf.Y, sf.Z);
939 [0] v3s32 position*100
941 [12+12] s32 pitch*100
942 [12+12+4] s32 yaw*100
943 [12+12+4+4] u32 keyPressed
944 [12+12+4+4+4] u8 fov*80
945 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
947 *pkt << position << speed << pitch << yaw << keyPressed;
948 *pkt << fov << wanted_range;
951 void Client::interact(InteractAction action, const PointedThing& pointed)
953 if(m_state != LC_Ready) {
954 errorstream << "Client::interact() "
955 "Canceled (not connected)"
960 LocalPlayer *myplayer = m_env.getLocalPlayer();
961 if (myplayer == NULL)
968 [5] u32 length of the next item (plen)
969 [9] serialized PointedThing
970 [9 + plen] player position information
973 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
976 pkt << myplayer->getWieldIndex();
978 std::ostringstream tmp_os(std::ios::binary);
979 pointed.serialize(tmp_os);
981 pkt.putLongString(tmp_os.str());
983 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
988 void Client::deleteAuthData()
993 switch (m_chosen_auth_mech) {
994 case AUTH_MECHANISM_FIRST_SRP:
996 case AUTH_MECHANISM_SRP:
997 case AUTH_MECHANISM_LEGACY_PASSWORD:
998 srp_user_delete((SRPUser *) m_auth_data);
1001 case AUTH_MECHANISM_NONE:
1004 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1008 AuthMechanism Client::choseAuthMech(const u32 mechs)
1010 if (mechs & AUTH_MECHANISM_SRP)
1011 return AUTH_MECHANISM_SRP;
1013 if (mechs & AUTH_MECHANISM_FIRST_SRP)
1014 return AUTH_MECHANISM_FIRST_SRP;
1016 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1017 return AUTH_MECHANISM_LEGACY_PASSWORD;
1019 return AUTH_MECHANISM_NONE;
1022 void Client::sendInit(const std::string &playerName)
1024 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1026 // we don't support network compression yet
1027 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1029 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1030 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1036 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
1038 m_chosen_auth_mech = chosen_auth_mechanism;
1039 m_is_registration_confirmation_state = true;
1042 void Client::confirmRegistration()
1044 m_is_registration_confirmation_state = false;
1045 startAuth(m_chosen_auth_mech);
1048 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1050 m_chosen_auth_mech = chosen_auth_mechanism;
1052 switch (chosen_auth_mechanism) {
1053 case AUTH_MECHANISM_FIRST_SRP: {
1054 // send srp verifier to server
1055 std::string verifier;
1057 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1060 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1061 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1066 case AUTH_MECHANISM_SRP:
1067 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1070 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1071 m_password = translate_password(getPlayerName(), m_password);
1075 std::string playername_u = lowercase(getPlayerName());
1076 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1077 getPlayerName().c_str(), playername_u.c_str(),
1078 (const unsigned char *) m_password.c_str(),
1079 m_password.length(), NULL, NULL);
1082 SRP_Result res = srp_user_start_authentication(
1083 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1084 (unsigned char **) &bytes_A, &len_A);
1085 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1087 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1088 resp_pkt << std::string(bytes_A, len_A) << based_on;
1092 case AUTH_MECHANISM_NONE:
1093 break; // not handled in this method
1097 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1099 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1101 pkt << (u8) blocks.size();
1103 for (const v3s16 &block : blocks) {
1110 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1112 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1113 pkt << (u8) blocks.size();
1114 for (const v3s16 &block : blocks)
1120 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1122 size_t server_ids = soundList.size();
1123 assert(server_ids <= 0xFFFF);
1125 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1127 pkt << (u16) (server_ids & 0xFFFF);
1129 for (s32 sound_id : soundList)
1135 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1136 const StringMap &fields)
1138 size_t fields_size = fields.size();
1140 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1142 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1144 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1146 StringMap::const_iterator it;
1147 for (it = fields.begin(); it != fields.end(); ++it) {
1148 const std::string &name = it->first;
1149 const std::string &value = it->second;
1151 pkt.putLongString(value);
1157 void Client::sendInventoryFields(const std::string &formname,
1158 const StringMap &fields)
1160 size_t fields_size = fields.size();
1161 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1163 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1164 pkt << formname << (u16) (fields_size & 0xFFFF);
1166 StringMap::const_iterator it;
1167 for (it = fields.begin(); it != fields.end(); ++it) {
1168 const std::string &name = it->first;
1169 const std::string &value = it->second;
1171 pkt.putLongString(value);
1177 void Client::sendInventoryAction(InventoryAction *a)
1179 std::ostringstream os(std::ios_base::binary);
1184 std::string s = os.str();
1186 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1187 pkt.putRawString(s.c_str(),s.size());
1192 bool Client::canSendChatMessage() const
1194 u32 now = time(NULL);
1195 float time_passed = now - m_last_chat_message_sent;
1197 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1198 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1200 if (virt_chat_message_allowance < 1.0f)
1206 void Client::sendChatMessage(const std::wstring &message)
1208 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1209 if (canSendChatMessage()) {
1210 u32 now = time(NULL);
1211 float time_passed = now - m_last_chat_message_sent;
1212 m_last_chat_message_sent = time(NULL);
1214 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1215 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1216 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1218 m_chat_message_allowance -= 1.0f;
1220 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1225 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1226 m_out_chat_queue.push(message);
1228 infostream << "Could not queue chat message because maximum out chat queue size ("
1229 << max_queue_size << ") is reached." << std::endl;
1233 void Client::clearOutChatQueue()
1235 m_out_chat_queue = std::queue<std::wstring>();
1238 void Client::sendChangePassword(const std::string &oldpassword,
1239 const std::string &newpassword)
1241 LocalPlayer *player = m_env.getLocalPlayer();
1245 // get into sudo mode and then send new password to server
1246 m_password = oldpassword;
1247 m_new_password = newpassword;
1248 startAuth(choseAuthMech(m_sudo_auth_methods));
1252 void Client::sendDamage(u16 damage)
1254 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1259 void Client::sendRespawn()
1261 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1265 void Client::sendReady()
1267 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1268 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1270 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1271 << (u8) 0 << (u16) strlen(g_version_hash);
1273 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1274 pkt << (u16)FORMSPEC_API_VERSION;
1278 void Client::sendPlayerPos()
1280 LocalPlayer *player = m_env.getLocalPlayer();
1284 ClientMap &map = m_env.getClientMap();
1285 u8 camera_fov = map.getCameraFov();
1286 u8 wanted_range = map.getControl().wanted_range;
1288 // Save bandwidth by only updating position when
1289 // player is not dead and something changed
1291 // FIXME: This part causes breakages in mods like 3d_armor, and has been commented for now
1292 // if (m_activeobjects_received && player->isDead())
1296 player->last_position == player->getPosition() &&
1297 player->last_speed == player->getSpeed() &&
1298 player->last_pitch == player->getPitch() &&
1299 player->last_yaw == player->getYaw() &&
1300 player->last_keyPressed == player->keyPressed &&
1301 player->last_camera_fov == camera_fov &&
1302 player->last_wanted_range == wanted_range)
1305 player->last_position = player->getPosition();
1306 player->last_speed = player->getSpeed();
1307 player->last_pitch = player->getPitch();
1308 player->last_yaw = player->getYaw();
1309 player->last_keyPressed = player->keyPressed;
1310 player->last_camera_fov = camera_fov;
1311 player->last_wanted_range = wanted_range;
1313 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1315 writePlayerPos(player, &map, &pkt);
1320 void Client::removeNode(v3s16 p)
1322 std::map<v3s16, MapBlock*> modified_blocks;
1325 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1327 catch(InvalidPositionException &e) {
1330 for (const auto &modified_block : modified_blocks) {
1331 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1336 * Helper function for Client Side Modding
1337 * CSM restrictions are applied there, this should not be used for core engine
1339 * @param is_valid_position
1342 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1344 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1345 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1346 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1347 *is_valid_position = false;
1351 return m_env.getMap().getNode(p, is_valid_position);
1354 int Client::CSMClampRadius(v3s16 pos, int radius)
1356 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1358 // This is approximate and will cause some allowed nodes to be excluded
1359 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1360 u32 distance = ppos.getDistanceFrom(pos);
1361 if (distance >= m_csm_restriction_noderange)
1363 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1366 v3s16 Client::CSMClampPos(v3s16 pos)
1368 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1370 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1371 const int range = m_csm_restriction_noderange;
1373 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1374 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1375 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1379 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1381 //TimeTaker timer1("Client::addNode()");
1383 std::map<v3s16, MapBlock*> modified_blocks;
1386 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1387 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1389 catch(InvalidPositionException &e) {
1392 for (const auto &modified_block : modified_blocks) {
1393 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1397 void Client::setPlayerControl(PlayerControl &control)
1399 LocalPlayer *player = m_env.getLocalPlayer();
1401 player->control = control;
1404 void Client::setPlayerItem(u16 item)
1406 m_env.getLocalPlayer()->setWieldIndex(item);
1407 m_update_wielded_item = true;
1409 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1414 // Returns true once after the inventory of the local player
1415 // has been updated from the server.
1416 bool Client::updateWieldedItem()
1418 if (!m_update_wielded_item)
1421 m_update_wielded_item = false;
1423 LocalPlayer *player = m_env.getLocalPlayer();
1425 if (auto *list = player->inventory.getList("main"))
1426 list->setModified(false);
1427 if (auto *list = player->inventory.getList("hand"))
1428 list->setModified(false);
1433 Inventory* Client::getInventory(const InventoryLocation &loc)
1436 case InventoryLocation::UNDEFINED:
1439 case InventoryLocation::CURRENT_PLAYER:
1441 LocalPlayer *player = m_env.getLocalPlayer();
1443 return &player->inventory;
1446 case InventoryLocation::PLAYER:
1448 // Check if we are working with local player inventory
1449 LocalPlayer *player = m_env.getLocalPlayer();
1450 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1452 return &player->inventory;
1455 case InventoryLocation::NODEMETA:
1457 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1460 return meta->getInventory();
1463 case InventoryLocation::DETACHED:
1465 if (m_detached_inventories.count(loc.name) == 0)
1467 return m_detached_inventories[loc.name];
1471 FATAL_ERROR("Invalid inventory location type.");
1477 void Client::inventoryAction(InventoryAction *a)
1480 Send it to the server
1482 sendInventoryAction(a);
1485 Predict some local inventory changes
1487 a->clientApply(this, this);
1493 float Client::getAnimationTime()
1495 return m_animation_time;
1498 int Client::getCrackLevel()
1500 return m_crack_level;
1503 v3s16 Client::getCrackPos()
1508 void Client::setCrack(int level, v3s16 pos)
1510 int old_crack_level = m_crack_level;
1511 v3s16 old_crack_pos = m_crack_pos;
1513 m_crack_level = level;
1516 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1519 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1521 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1524 addUpdateMeshTaskForNode(pos, false, true);
1530 LocalPlayer *player = m_env.getLocalPlayer();
1535 bool Client::getChatMessage(std::wstring &res)
1537 if (m_chat_queue.empty())
1540 ChatMessage *chatMessage = m_chat_queue.front();
1545 switch (chatMessage->type) {
1546 case CHATMESSAGE_TYPE_RAW:
1547 case CHATMESSAGE_TYPE_ANNOUNCE:
1548 case CHATMESSAGE_TYPE_SYSTEM:
1549 res = chatMessage->message;
1551 case CHATMESSAGE_TYPE_NORMAL: {
1552 if (!chatMessage->sender.empty())
1553 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1555 res = chatMessage->message;
1566 void Client::typeChatMessage(const std::wstring &message)
1568 // Discard empty line
1569 if (message.empty())
1572 // If message was consumed by script API, don't send it to server
1573 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1577 sendChatMessage(message);
1580 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1582 // Check if the block exists to begin with. In the case when a non-existing
1583 // neighbor is automatically added, it may not. In that case we don't want
1584 // to tell the mesh update thread about it.
1585 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1589 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1592 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1595 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1597 catch(InvalidPositionException &e){}
1600 for (int i=0;i<6;i++)
1603 v3s16 p = blockpos + g_6dirs[i];
1604 addUpdateMeshTask(p, false, urgent);
1606 catch(InvalidPositionException &e){}
1610 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1614 infostream<<"Client::addUpdateMeshTaskForNode(): "
1615 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1619 v3s16 blockpos = getNodeBlockPos(nodepos);
1620 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1623 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1625 catch(InvalidPositionException &e) {}
1628 if(nodepos.X == blockpos_relative.X){
1630 v3s16 p = blockpos + v3s16(-1,0,0);
1631 addUpdateMeshTask(p, false, urgent);
1633 catch(InvalidPositionException &e){}
1636 if(nodepos.Y == blockpos_relative.Y){
1638 v3s16 p = blockpos + v3s16(0,-1,0);
1639 addUpdateMeshTask(p, false, urgent);
1641 catch(InvalidPositionException &e){}
1644 if(nodepos.Z == blockpos_relative.Z){
1646 v3s16 p = blockpos + v3s16(0,0,-1);
1647 addUpdateMeshTask(p, false, urgent);
1649 catch(InvalidPositionException &e){}
1653 ClientEvent *Client::getClientEvent()
1655 FATAL_ERROR_IF(m_client_event_queue.empty(),
1656 "Cannot getClientEvent, queue is empty.");
1658 ClientEvent *event = m_client_event_queue.front();
1659 m_client_event_queue.pop();
1663 bool Client::connectedToServer()
1665 return m_con->Connected();
1668 const Address Client::getServerAddress()
1670 return m_con->GetPeerAddress(PEER_ID_SERVER);
1673 float Client::mediaReceiveProgress()
1675 if (m_media_downloader)
1676 return m_media_downloader->getProgress();
1678 return 1.0; // downloader only exists when not yet done
1681 typedef struct TextureUpdateArgs {
1682 gui::IGUIEnvironment *guienv;
1685 const wchar_t* text_base;
1686 ITextureSource *tsrc;
1687 } TextureUpdateArgs;
1689 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1691 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1692 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1694 // update the loading menu -- if neccessary
1695 bool do_draw = false;
1696 u64 time_ms = targs->last_time_ms;
1697 if (cur_percent != targs->last_percent) {
1698 targs->last_percent = cur_percent;
1699 time_ms = porting::getTimeMs();
1700 // only draw when the user will notice something:
1701 do_draw = (time_ms - targs->last_time_ms > 100);
1705 targs->last_time_ms = time_ms;
1706 std::basic_stringstream<wchar_t> strm;
1707 strm << targs->text_base << " " << targs->last_percent << "%...";
1708 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1709 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1713 void Client::afterContentReceived()
1715 infostream<<"Client::afterContentReceived() started"<<std::endl;
1716 assert(m_itemdef_received); // pre-condition
1717 assert(m_nodedef_received); // pre-condition
1718 assert(mediaReceived()); // pre-condition
1720 const wchar_t* text = wgettext("Loading textures...");
1722 // Clear cached pre-scaled 2D GUI images, as this cache
1723 // might have images with the same name but different
1724 // content from previous sessions.
1725 guiScalingCacheClear();
1727 // Rebuild inherited images and recreate textures
1728 infostream<<"- Rebuilding images and textures"<<std::endl;
1729 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1730 m_tsrc->rebuildImagesAndTextures();
1734 infostream<<"- Rebuilding shaders"<<std::endl;
1735 text = wgettext("Rebuilding shaders...");
1736 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1737 m_shsrc->rebuildShaders();
1740 // Update node aliases
1741 infostream<<"- Updating node aliases"<<std::endl;
1742 text = wgettext("Initializing nodes...");
1743 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1744 m_nodedef->updateAliases(m_itemdef);
1745 for (const auto &path : getTextureDirs()) {
1746 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1747 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1748 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1750 m_nodedef->setNodeRegistrationStatus(true);
1751 m_nodedef->runNodeResolveCallbacks();
1754 // Update node textures and assign shaders to each tile
1755 infostream<<"- Updating node textures"<<std::endl;
1756 TextureUpdateArgs tu_args;
1757 tu_args.guienv = guienv;
1758 tu_args.last_time_ms = porting::getTimeMs();
1759 tu_args.last_percent = 0;
1760 tu_args.text_base = wgettext("Initializing nodes");
1761 tu_args.tsrc = m_tsrc;
1762 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1763 delete[] tu_args.text_base;
1765 // Start mesh update thread after setting up content definitions
1766 infostream<<"- Starting mesh update thread"<<std::endl;
1767 m_mesh_update_thread.start();
1773 m_script->on_client_ready(m_env.getLocalPlayer());
1775 text = wgettext("Done!");
1776 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1777 infostream<<"Client::afterContentReceived() done"<<std::endl;
1781 float Client::getRTT()
1783 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1786 float Client::getCurRate()
1788 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1789 m_con->getLocalStat(con::CUR_DL_RATE));
1792 void Client::makeScreenshot()
1794 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1795 irr::video::IImage* const raw_image = driver->createScreenShot();
1800 time_t t = time(NULL);
1801 struct tm *tm = localtime(&t);
1803 char timetstamp_c[64];
1804 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1806 std::string screenshot_dir;
1808 if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1809 screenshot_dir = g_settings->get("screenshot_path");
1811 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1813 std::string filename_base = screenshot_dir
1815 + std::string("screenshot_")
1816 + std::string(timetstamp_c);
1817 std::string filename_ext = "." + g_settings->get("screenshot_format");
1818 std::string filename;
1820 // Create the directory if it doesn't already exist.
1821 // Otherwise, saving the screenshot would fail.
1822 fs::CreateDir(screenshot_dir);
1824 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1825 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1827 // Try to find a unique filename
1828 unsigned serial = 0;
1830 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1831 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1832 std::ifstream tmp(filename.c_str());
1834 break; // File did not apparently exist, we'll go with it
1838 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1839 infostream << "Could not find suitable filename for screenshot" << std::endl;
1841 irr::video::IImage* const image =
1842 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1845 raw_image->copyTo(image);
1847 std::ostringstream sstr;
1848 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1849 sstr << "Saved screenshot to '" << filename << "'";
1851 sstr << "Failed to save screenshot '" << filename << "'";
1853 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1854 narrow_to_wide(sstr.str())));
1855 infostream << sstr.str() << std::endl;
1863 bool Client::shouldShowMinimap() const
1865 return !m_minimap_disabled_by_server;
1868 void Client::pushToEventQueue(ClientEvent *event)
1870 m_client_event_queue.push(event);
1873 void Client::showMinimap(const bool show)
1875 m_game_ui->showMinimap(show);
1878 // IGameDef interface
1880 IItemDefManager* Client::getItemDefManager()
1884 const NodeDefManager* Client::getNodeDefManager()
1888 ICraftDefManager* Client::getCraftDefManager()
1891 //return m_craftdef;
1893 ITextureSource* Client::getTextureSource()
1897 IWritableShaderSource* Client::getShaderSource()
1902 u16 Client::allocateUnknownNodeId(const std::string &name)
1904 errorstream << "Client::allocateUnknownNodeId(): "
1905 << "Client cannot allocate node IDs" << std::endl;
1906 FATAL_ERROR("Client allocated unknown node");
1908 return CONTENT_IGNORE;
1910 ISoundManager* Client::getSoundManager()
1914 MtEventManager* Client::getEventManager()
1919 ParticleManager* Client::getParticleManager()
1921 return &m_particle_manager;
1924 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1926 StringMap::const_iterator it = m_mesh_data.find(filename);
1927 if (it == m_mesh_data.end()) {
1928 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1929 << "\"" << std::endl;
1932 const std::string &data = it->second;
1934 // Create the mesh, remove it from cache and return it
1935 // This allows unique vertex colors and other properties for each instance
1936 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1937 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1938 *data_rw, data_rw.getSize(), filename.c_str());
1939 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1941 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1945 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1949 const std::string* Client::getModFile(std::string filename)
1951 // strip dir delimiter from beginning of path
1952 auto pos = filename.find_first_of(':');
1953 if (pos == std::string::npos)
1956 auto pos2 = filename.find_first_not_of('/', pos);
1958 filename.erase(pos, pos2 - pos);
1960 StringMap::const_iterator it = m_mod_vfs.find(filename);
1961 if (it == m_mod_vfs.end())
1966 bool Client::registerModStorage(ModMetadata *storage)
1968 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1969 errorstream << "Unable to register same mod storage twice. Storage name: "
1970 << storage->getModName() << std::endl;
1974 m_mod_storages[storage->getModName()] = storage;
1978 void Client::unregisterModStorage(const std::string &name)
1980 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1981 m_mod_storages.find(name);
1982 if (it != m_mod_storages.end()) {
1983 // Save unconditionaly on unregistration
1984 it->second->save(getModStoragePath());
1985 m_mod_storages.erase(name);
1989 std::string Client::getModStoragePath() const
1991 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1998 bool Client::joinModChannel(const std::string &channel)
2000 if (m_modchannel_mgr->channelRegistered(channel))
2003 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2007 m_modchannel_mgr->joinChannel(channel, 0);
2011 bool Client::leaveModChannel(const std::string &channel)
2013 if (!m_modchannel_mgr->channelRegistered(channel))
2016 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2020 m_modchannel_mgr->leaveChannel(channel, 0);
2024 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2026 if (!m_modchannel_mgr->canWriteOnChannel(channel))
2029 if (message.size() > STRING_MAX_LEN) {
2030 warningstream << "ModChannel message too long, dropping before sending "
2031 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2032 << channel << ")" << std::endl;
2036 // @TODO: do some client rate limiting
2037 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2038 pkt << channel << message;
2043 ModChannel* Client::getModChannel(const std::string &channel)
2045 return m_modchannel_mgr->getModChannel(channel);