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;
68 const char *playername,
69 const std::string &password,
70 const std::string &address_name,
71 MapDrawControl &control,
72 IWritableTextureSource *tsrc,
73 IWritableShaderSource *shsrc,
74 IWritableItemDefManager *itemdef,
75 NodeDefManager *nodedef,
77 MtEventManager *event,
87 m_mesh_update_thread(this),
89 new ClientMap(this, control, 666),
92 m_particle_manager(&m_env),
93 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
94 m_address_name(address_name),
95 m_server_ser_ver(SER_FMT_VER_INVALID),
96 m_last_chat_message_sent(time(NULL)),
98 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
99 m_media_downloader(new ClientMediaDownloader()),
102 m_modchannel_mgr(new ModChannelMgr())
105 m_env.setLocalPlayer(new LocalPlayer(this, playername));
107 if (g_settings->getBool("enable_minimap")) {
108 m_minimap = new Minimap(this);
110 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
113 void Client::loadMods()
115 // Don't load mods twice.
116 // If client scripting is disabled by the client, don't load builtin or
117 // client-provided mods.
118 if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
121 // If client scripting is disabled by the server, don't load builtin or
122 // client-provided mods.
123 // TODO Delete this code block when server-sent CSM and verifying of builtin are
125 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
126 warningstream << "Client-provided mod loading is disabled by server." <<
131 m_script = new ClientScripting(this);
132 m_env.setScript(m_script);
133 m_script->setEnv(&m_env);
136 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
137 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
139 // TODO Uncomment when server-sent CSM and verifying of builtin are complete
141 // Don't load client-provided mods if disabled by server
142 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
143 warningstream << "Client-provided mod loading is disabled by server." <<
145 // If builtin integrity is wrong, disconnect user
146 if (!checkBuiltinIntegrity()) {
147 // TODO disconnect user
153 ClientModConfiguration modconf(getClientModsLuaPath());
154 m_mods = modconf.getMods();
155 // complain about mods with unsatisfied dependencies
156 if (!modconf.isConsistent()) {
157 modconf.printUnsatisfiedModsError();
162 infostream << "Client loading mods: ";
163 for (const ModSpec &mod : m_mods)
164 infostream << mod.name << " ";
165 infostream << std::endl;
167 // Load and run "mod" scripts
168 for (const ModSpec &mod : m_mods) {
169 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
170 throw ModError("Error loading mod \"" + mod.name +
171 "\": Mod name does not follow naming conventions: "
172 "Only characters [a-z0-9_] are allowed.");
174 scanModIntoMemory(mod.name, mod.path);
177 // Load and run "mod" scripts
178 for (const ModSpec &mod : m_mods)
179 m_script->loadModFromMemory(mod.name);
181 // Mods are done loading. Unlock callbacks
182 m_mods_loaded = true;
184 // Run a callback when mods are loaded
185 m_script->on_mods_loaded();
186 if (m_state == LC_Ready)
187 m_script->on_client_ready(m_env.getLocalPlayer());
189 m_script->on_camera_ready(m_camera);
192 bool Client::checkBuiltinIntegrity()
198 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
199 std::string mod_subpath)
201 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
202 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
203 for (const fs::DirListNode &j : mod) {
205 scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
208 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
210 std::string real_path = full_path + j.name;
211 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
212 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
213 << "\" as \"" << vfs_path << "\"." << std::endl;
215 std::ifstream is(real_path, std::ios::binary | std::ios::ate);
217 errorstream << "Client::scanModSubfolder(): Can't read file \""
218 << real_path << "\"." << std::endl;
221 auto size = is.tellg();
222 std::string contents(size, '\0');
224 is.read(&contents[0], size);
226 infostream << " size: " << size << " bytes" << std::endl;
227 m_mod_vfs.emplace(vfs_path, contents);
231 const std::string &Client::getBuiltinLuaPath()
233 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
237 const std::string &Client::getClientModsLuaPath()
239 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
240 return clientmods_dir;
243 const std::vector<ModSpec>& Client::getMods() const
245 static std::vector<ModSpec> client_modspec_temp;
246 return client_modspec_temp;
249 const ModSpec* Client::getModSpec(const std::string &modname) const
258 m_script->on_shutdown();
259 //request all client managed threads to stop
260 m_mesh_update_thread.stop();
261 // Save local server map
263 infostream << "Local map saving ended." << std::endl;
264 m_localdb->endSave();
271 bool Client::isShutdown()
273 return m_shutdown || !m_mesh_update_thread.isRunning();
283 m_mesh_update_thread.stop();
284 m_mesh_update_thread.wait();
285 while (!m_mesh_update_thread.m_queue_out.empty()) {
286 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
291 delete m_inventory_from_server;
293 // Delete detached inventories
294 for (auto &m_detached_inventorie : m_detached_inventories) {
295 delete m_detached_inventorie.second;
298 // cleanup 3d model meshes on client shutdown
299 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
300 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
303 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
307 delete m_media_downloader;
310 void Client::connect(Address address, bool is_local_server)
312 initLocalMapSaving(address, m_address_name, is_local_server);
314 // Since we use TryReceive() a timeout here would be ineffective anyway
315 m_con->SetTimeoutMs(0);
316 m_con->Connect(address);
319 void Client::step(float dtime)
325 m_animation_time += dtime;
326 if(m_animation_time > 60.0)
327 m_animation_time -= 60.0;
329 m_time_of_day_update_timer += dtime;
337 float &counter = m_packetcounter_timer;
343 infostream << "Client packetcounter (" << m_packetcounter_timer
345 m_packetcounter.print(infostream);
346 m_packetcounter.clear();
350 // UGLY hack to fix 2 second startup delay caused by non existent
351 // server client startup synchronization in local server or singleplayer mode
352 static bool initial_step = true;
354 initial_step = false;
356 else if(m_state == LC_Created) {
357 if (m_is_registration_confirmation_state) {
358 // Waiting confirmation
361 float &counter = m_connection_reinit_timer;
366 LocalPlayer *myplayer = m_env.getLocalPlayer();
367 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
369 sendInit(myplayer->getName());
372 // Not connected, return
377 Do stuff if connected
381 Run Map's timers and unload unused data
383 const float map_timer_and_unload_dtime = 5.25;
384 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
385 std::vector<v3s16> deleted_blocks;
386 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
387 g_settings->getFloat("client_unload_unused_data_timeout"),
388 g_settings->getS32("client_mapblock_limit"),
393 NOTE: This loop is intentionally iterated the way it is.
396 std::vector<v3s16>::iterator i = deleted_blocks.begin();
397 std::vector<v3s16> sendlist;
399 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
410 sendDeletedBlocks(sendlist);
412 if(i == deleted_blocks.end())
418 sendlist.push_back(*i);
424 Send pending messages on out chat queue
426 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
427 sendChatMessage(m_out_chat_queue.front());
428 m_out_chat_queue.pop();
434 // Control local player (0ms)
435 LocalPlayer *player = m_env.getLocalPlayer();
437 player->applyControl(dtime, &m_env);
441 m_sound->step(dtime);
446 while (m_env.hasClientEnvEvents()) {
447 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
449 if (envEvent.type == CEE_PLAYER_DAMAGE) {
450 u16 damage = envEvent.player_damage.amount;
452 if (envEvent.player_damage.send_to_server)
455 // Add to ClientEvent queue
456 ClientEvent *event = new ClientEvent();
457 event->type = CE_PLAYER_DAMAGE;
458 event->player_damage.amount = damage;
459 m_client_event_queue.push(event);
466 float &counter = m_avg_rtt_timer;
470 // connectedAndInitialized() is true, peer exists.
471 float avg_rtt = getRTT();
472 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
476 Send player position to server
479 float &counter = m_playerpos_send_timer;
481 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
489 Replace updated meshes
492 int num_processed_meshes = 0;
493 std::vector<v3s16> blocks_to_ack;
494 while (!m_mesh_update_thread.m_queue_out.empty())
496 num_processed_meshes++;
498 MinimapMapblock *minimap_mapblock = NULL;
499 bool do_mapper_update = true;
501 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
502 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
504 // Delete the old mesh
506 block->mesh = nullptr;
509 minimap_mapblock = r.mesh->moveMinimapMapblock();
510 if (minimap_mapblock == NULL)
511 do_mapper_update = false;
513 bool is_empty = true;
514 for (int l = 0; l < MAX_TILE_LAYERS; l++)
515 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
521 // Replace with the new mesh
522 block->mesh = r.mesh;
528 if (m_minimap && do_mapper_update)
529 m_minimap->addBlock(r.p, minimap_mapblock);
531 if (r.ack_block_to_server) {
532 if (blocks_to_ack.size() == 255) {
533 sendGotBlocks(blocks_to_ack);
534 blocks_to_ack.clear();
537 blocks_to_ack.emplace_back(r.p);
540 if (blocks_to_ack.size() > 0) {
541 // Acknowledge block(s)
542 sendGotBlocks(blocks_to_ack);
545 if (num_processed_meshes > 0)
546 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
552 if (m_media_downloader && m_media_downloader->isStarted()) {
553 m_media_downloader->step(this);
554 if (m_media_downloader->isDone()) {
555 delete m_media_downloader;
556 m_media_downloader = NULL;
561 If the server didn't update the inventory in a while, revert
562 the local inventory (so the player notices the lag problem
563 and knows something is wrong).
565 if (m_inventory_from_server) {
566 float interval = 10.0f;
567 float count_before = std::floor(m_inventory_from_server_age / interval);
569 m_inventory_from_server_age += dtime;
571 float count_after = std::floor(m_inventory_from_server_age / interval);
573 if (count_after != count_before) {
574 // Do this every <interval> seconds after TOCLIENT_INVENTORY
575 // Reset the locally changed inventory to the authoritative inventory
576 player->inventory = *m_inventory_from_server;
577 m_update_wielded_item = true;
582 Update positions of sounds attached to objects
585 for (auto &m_sounds_to_object : m_sounds_to_objects) {
586 int client_id = m_sounds_to_object.first;
587 u16 object_id = m_sounds_to_object.second;
588 ClientActiveObject *cao = m_env.getActiveObject(object_id);
591 m_sound->updateSoundPosition(client_id, cao->getPosition());
596 Handle removed remotely initiated sounds
598 m_removed_sounds_check_timer += dtime;
599 if(m_removed_sounds_check_timer >= 2.32) {
600 m_removed_sounds_check_timer = 0;
601 // Find removed sounds and clear references to them
602 std::vector<s32> removed_server_ids;
603 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
604 i != m_sounds_server_to_client.end();) {
605 s32 server_id = i->first;
606 int client_id = i->second;
608 if(!m_sound->soundExists(client_id)) {
609 m_sounds_server_to_client.erase(server_id);
610 m_sounds_client_to_server.erase(client_id);
611 m_sounds_to_objects.erase(client_id);
612 removed_server_ids.push_back(server_id);
617 if(!removed_server_ids.empty()) {
618 sendRemovedSounds(removed_server_ids);
622 m_mod_storage_save_timer -= dtime;
623 if (m_mod_storage_save_timer <= 0.0f) {
624 verbosestream << "Saving registered mod storages." << std::endl;
625 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
626 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
627 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
628 if (it->second->isModified()) {
629 it->second->save(getModStoragePath());
635 if (m_localdb && m_localdb_save_interval.step(dtime,
636 m_cache_save_interval)) {
637 m_localdb->endSave();
638 m_localdb->beginSave();
642 bool Client::loadMedia(const std::string &data, const std::string &filename)
644 // Silly irrlicht's const-incorrectness
645 Buffer<char> data_rw(data.c_str(), data.size());
649 const char *image_ext[] = {
650 ".png", ".jpg", ".bmp", ".tga",
651 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
654 name = removeStringEnd(filename, image_ext);
656 verbosestream<<"Client: Attempting to load image "
657 <<"file \""<<filename<<"\""<<std::endl;
659 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
660 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
662 // Create an irrlicht memory file
663 io::IReadFile *rfile = irrfs->createMemoryReadFile(
664 *data_rw, data_rw.getSize(), "_tempreadfile");
666 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
669 video::IImage *img = vdrv->createImageFromFile(rfile);
671 errorstream<<"Client: Cannot create image from data of "
672 <<"file \""<<filename<<"\""<<std::endl;
677 m_tsrc->insertSourceImage(filename, img);
683 const char *sound_ext[] = {
684 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
685 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
688 name = removeStringEnd(filename, sound_ext);
690 verbosestream<<"Client: Attempting to load sound "
691 <<"file \""<<filename<<"\""<<std::endl;
692 m_sound->loadSoundData(name, data);
696 const char *model_ext[] = {
697 ".x", ".b3d", ".md2", ".obj",
701 name = removeStringEnd(filename, model_ext);
703 verbosestream<<"Client: Storing model into memory: "
704 <<"\""<<filename<<"\""<<std::endl;
705 if(m_mesh_data.count(filename))
706 errorstream<<"Multiple models with name \""<<filename.c_str()
707 <<"\" found; replacing previous model"<<std::endl;
708 m_mesh_data[filename] = data;
712 const char *translate_ext[] = {
715 name = removeStringEnd(filename, translate_ext);
717 verbosestream << "Client: Loading translation: "
718 << "\"" << filename << "\"" << std::endl;
719 g_translations->loadTranslation(data);
723 errorstream << "Client: Don't know how to load file \""
724 << filename << "\"" << std::endl;
728 // Virtual methods from con::PeerHandler
729 void Client::peerAdded(con::Peer *peer)
731 infostream << "Client::peerAdded(): peer->id="
732 << peer->id << std::endl;
734 void Client::deletingPeer(con::Peer *peer, bool timeout)
736 infostream << "Client::deletingPeer(): "
737 "Server Peer is getting deleted "
738 << "(timeout=" << timeout << ")" << std::endl;
741 m_access_denied = true;
742 m_access_denied_reason = gettext("Connection timed out.");
748 u16 number of files requested
754 void Client::request_media(const std::vector<std::string> &file_requests)
756 std::ostringstream os(std::ios_base::binary);
757 writeU16(os, TOSERVER_REQUEST_MEDIA);
758 size_t file_requests_size = file_requests.size();
760 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
762 // Packet dynamicly resized
763 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
765 pkt << (u16) (file_requests_size & 0xFFFF);
767 for (const std::string &file_request : file_requests) {
773 infostream << "Client: Sending media request list to server ("
774 << file_requests.size() << " files. packet size)" << std::endl;
777 void Client::initLocalMapSaving(const Address &address,
778 const std::string &hostname,
779 bool is_local_server)
781 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
785 std::string world_path;
786 #define set_world_path(hostname) \
787 world_path = porting::path_user \
788 + DIR_DELIM + "worlds" \
789 + DIR_DELIM + "server_" \
790 + hostname + "_" + std::to_string(address.getPort());
792 set_world_path(hostname);
793 if (!fs::IsDir(world_path)) {
794 std::string hostname_escaped = hostname;
795 str_replace(hostname_escaped, ':', '_');
796 set_world_path(hostname_escaped);
798 #undef set_world_path
799 fs::CreateAllDirs(world_path);
801 m_localdb = new MapDatabaseSQLite3(world_path);
802 m_localdb->beginSave();
803 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
806 void Client::ReceiveAll()
809 u64 start_ms = porting::getTimeMs();
810 const u64 budget = 100;
812 // Limit time even if there would be huge amounts of data to
814 if (porting::getTimeMs() > start_ms + budget) {
815 infostream << "Client::ReceiveAll(): "
816 "Packet processing budget exceeded." << std::endl;
822 if (!m_con->TryReceive(&pkt))
825 } catch (const con::InvalidIncomingDataException &e) {
826 infostream << "Client::ReceiveAll(): "
827 "InvalidIncomingDataException: what()="
828 << e.what() << std::endl;
833 inline void Client::handleCommand(NetworkPacket* pkt)
835 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
836 (this->*opHandle.handler)(pkt);
840 sender_peer_id given to this shall be quaranteed to be a valid peer
842 void Client::ProcessData(NetworkPacket *pkt)
844 ToClientCommand command = (ToClientCommand) pkt->getCommand();
845 u32 sender_peer_id = pkt->getPeerId();
847 //infostream<<"Client: received command="<<command<<std::endl;
848 m_packetcounter.add((u16)command);
849 g_profiler->graphAdd("client_received_packets", 1);
852 If this check is removed, be sure to change the queue
853 system to know the ids
855 if(sender_peer_id != PEER_ID_SERVER) {
856 infostream << "Client::ProcessData(): Discarding data not "
857 "coming from server: peer_id=" << sender_peer_id
862 // Command must be handled into ToClientCommandHandler
863 if (command >= TOCLIENT_NUM_MSG_TYPES) {
864 infostream << "Client: Ignoring unknown command "
865 << command << std::endl;
870 * Those packets are handled before m_server_ser_ver is set, it's normal
871 * But we must use the new ToClientConnectionState in the future,
874 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
879 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
880 infostream << "Client: Server serialization"
881 " format invalid or not initialized."
882 " Skipping incoming command=" << command << std::endl;
887 Handle runtime commands
893 void Client::Send(NetworkPacket* pkt)
895 m_con->Send(PEER_ID_SERVER,
896 serverCommandFactoryTable[pkt->getCommand()].channel,
898 serverCommandFactoryTable[pkt->getCommand()].reliable);
901 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
902 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
904 v3f pf = myplayer->getPosition() * 100;
905 v3f sf = myplayer->getSpeed() * 100;
906 s32 pitch = myplayer->getPitch() * 100;
907 s32 yaw = myplayer->getYaw() * 100;
908 u32 keyPressed = myplayer->keyPressed;
909 // scaled by 80, so that pi can fit into a u8
910 u8 fov = clientMap->getCameraFov() * 80;
911 u8 wanted_range = MYMIN(255,
912 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
914 v3s32 position(pf.X, pf.Y, pf.Z);
915 v3s32 speed(sf.X, sf.Y, sf.Z);
919 [0] v3s32 position*100
921 [12+12] s32 pitch*100
922 [12+12+4] s32 yaw*100
923 [12+12+4+4] u32 keyPressed
924 [12+12+4+4+4] u8 fov*80
925 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
927 *pkt << position << speed << pitch << yaw << keyPressed;
928 *pkt << fov << wanted_range;
931 void Client::interact(InteractAction action, const PointedThing& pointed)
933 if(m_state != LC_Ready) {
934 errorstream << "Client::interact() "
935 "Canceled (not connected)"
940 LocalPlayer *myplayer = m_env.getLocalPlayer();
941 if (myplayer == NULL)
948 [5] u32 length of the next item (plen)
949 [9] serialized PointedThing
950 [9 + plen] player position information
953 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
956 pkt << myplayer->getWieldIndex();
958 std::ostringstream tmp_os(std::ios::binary);
959 pointed.serialize(tmp_os);
961 pkt.putLongString(tmp_os.str());
963 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
968 void Client::deleteAuthData()
973 switch (m_chosen_auth_mech) {
974 case AUTH_MECHANISM_FIRST_SRP:
976 case AUTH_MECHANISM_SRP:
977 case AUTH_MECHANISM_LEGACY_PASSWORD:
978 srp_user_delete((SRPUser *) m_auth_data);
981 case AUTH_MECHANISM_NONE:
984 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
988 AuthMechanism Client::choseAuthMech(const u32 mechs)
990 if (mechs & AUTH_MECHANISM_SRP)
991 return AUTH_MECHANISM_SRP;
993 if (mechs & AUTH_MECHANISM_FIRST_SRP)
994 return AUTH_MECHANISM_FIRST_SRP;
996 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
997 return AUTH_MECHANISM_LEGACY_PASSWORD;
999 return AUTH_MECHANISM_NONE;
1002 void Client::sendInit(const std::string &playerName)
1004 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1006 // we don't support network compression yet
1007 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1009 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1010 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1016 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
1018 m_chosen_auth_mech = chosen_auth_mechanism;
1019 m_is_registration_confirmation_state = true;
1022 void Client::confirmRegistration()
1024 m_is_registration_confirmation_state = false;
1025 startAuth(m_chosen_auth_mech);
1028 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1030 m_chosen_auth_mech = chosen_auth_mechanism;
1032 switch (chosen_auth_mechanism) {
1033 case AUTH_MECHANISM_FIRST_SRP: {
1034 // send srp verifier to server
1035 std::string verifier;
1037 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1040 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1041 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1046 case AUTH_MECHANISM_SRP:
1047 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1050 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1051 m_password = translate_password(getPlayerName(), m_password);
1055 std::string playername_u = lowercase(getPlayerName());
1056 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1057 getPlayerName().c_str(), playername_u.c_str(),
1058 (const unsigned char *) m_password.c_str(),
1059 m_password.length(), NULL, NULL);
1062 SRP_Result res = srp_user_start_authentication(
1063 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1064 (unsigned char **) &bytes_A, &len_A);
1065 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1067 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1068 resp_pkt << std::string(bytes_A, len_A) << based_on;
1072 case AUTH_MECHANISM_NONE:
1073 break; // not handled in this method
1077 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1079 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1081 pkt << (u8) blocks.size();
1083 for (const v3s16 &block : blocks) {
1090 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1092 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1093 pkt << (u8) blocks.size();
1094 for (const v3s16 &block : blocks)
1100 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1102 size_t server_ids = soundList.size();
1103 assert(server_ids <= 0xFFFF);
1105 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1107 pkt << (u16) (server_ids & 0xFFFF);
1109 for (s32 sound_id : soundList)
1115 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1116 const StringMap &fields)
1118 size_t fields_size = fields.size();
1120 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1122 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1124 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1126 StringMap::const_iterator it;
1127 for (it = fields.begin(); it != fields.end(); ++it) {
1128 const std::string &name = it->first;
1129 const std::string &value = it->second;
1131 pkt.putLongString(value);
1137 void Client::sendInventoryFields(const std::string &formname,
1138 const StringMap &fields)
1140 size_t fields_size = fields.size();
1141 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1143 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1144 pkt << 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::sendInventoryAction(InventoryAction *a)
1159 std::ostringstream os(std::ios_base::binary);
1164 std::string s = os.str();
1166 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1167 pkt.putRawString(s.c_str(),s.size());
1172 bool Client::canSendChatMessage() const
1174 u32 now = time(NULL);
1175 float time_passed = now - m_last_chat_message_sent;
1177 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1178 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1180 if (virt_chat_message_allowance < 1.0f)
1186 void Client::sendChatMessage(const std::wstring &message)
1188 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1189 if (canSendChatMessage()) {
1190 u32 now = time(NULL);
1191 float time_passed = now - m_last_chat_message_sent;
1192 m_last_chat_message_sent = time(NULL);
1194 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1195 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1196 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1198 m_chat_message_allowance -= 1.0f;
1200 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1205 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1206 m_out_chat_queue.push(message);
1208 infostream << "Could not queue chat message because maximum out chat queue size ("
1209 << max_queue_size << ") is reached." << std::endl;
1213 void Client::clearOutChatQueue()
1215 m_out_chat_queue = std::queue<std::wstring>();
1218 void Client::sendChangePassword(const std::string &oldpassword,
1219 const std::string &newpassword)
1221 LocalPlayer *player = m_env.getLocalPlayer();
1225 // get into sudo mode and then send new password to server
1226 m_password = oldpassword;
1227 m_new_password = newpassword;
1228 startAuth(choseAuthMech(m_sudo_auth_methods));
1232 void Client::sendDamage(u16 damage)
1234 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1239 void Client::sendRespawn()
1241 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1245 void Client::sendReady()
1247 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1248 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1250 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1251 << (u8) 0 << (u16) strlen(g_version_hash);
1253 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1254 pkt << (u16)FORMSPEC_API_VERSION;
1258 void Client::sendPlayerPos()
1260 LocalPlayer *player = m_env.getLocalPlayer();
1264 ClientMap &map = m_env.getClientMap();
1265 u8 camera_fov = map.getCameraFov();
1266 u8 wanted_range = map.getControl().wanted_range;
1268 // Save bandwidth by only updating position when
1269 // player is not dead and something changed
1271 // FIXME: This part causes breakages in mods like 3d_armor, and has been commented for now
1272 // if (m_activeobjects_received && player->isDead())
1276 player->last_position == player->getPosition() &&
1277 player->last_speed == player->getSpeed() &&
1278 player->last_pitch == player->getPitch() &&
1279 player->last_yaw == player->getYaw() &&
1280 player->last_keyPressed == player->keyPressed &&
1281 player->last_camera_fov == camera_fov &&
1282 player->last_wanted_range == wanted_range)
1285 player->last_position = player->getPosition();
1286 player->last_speed = player->getSpeed();
1287 player->last_pitch = player->getPitch();
1288 player->last_yaw = player->getYaw();
1289 player->last_keyPressed = player->keyPressed;
1290 player->last_camera_fov = camera_fov;
1291 player->last_wanted_range = wanted_range;
1293 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1295 writePlayerPos(player, &map, &pkt);
1300 void Client::removeNode(v3s16 p)
1302 std::map<v3s16, MapBlock*> modified_blocks;
1305 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1307 catch(InvalidPositionException &e) {
1310 for (const auto &modified_block : modified_blocks) {
1311 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1316 * Helper function for Client Side Modding
1317 * CSM restrictions are applied there, this should not be used for core engine
1319 * @param is_valid_position
1322 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1324 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1325 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1326 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1327 *is_valid_position = false;
1331 return m_env.getMap().getNode(p, is_valid_position);
1334 int Client::CSMClampRadius(v3s16 pos, int radius)
1336 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1338 // This is approximate and will cause some allowed nodes to be excluded
1339 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1340 u32 distance = ppos.getDistanceFrom(pos);
1341 if (distance >= m_csm_restriction_noderange)
1343 return std::min<int>(radius, m_csm_restriction_noderange - distance);
1346 v3s16 Client::CSMClampPos(v3s16 pos)
1348 if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1350 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1351 const int range = m_csm_restriction_noderange;
1353 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1354 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1355 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1359 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1361 //TimeTaker timer1("Client::addNode()");
1363 std::map<v3s16, MapBlock*> modified_blocks;
1366 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1367 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1369 catch(InvalidPositionException &e) {
1372 for (const auto &modified_block : modified_blocks) {
1373 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1377 void Client::setPlayerControl(PlayerControl &control)
1379 LocalPlayer *player = m_env.getLocalPlayer();
1381 player->control = control;
1384 void Client::setPlayerItem(u16 item)
1386 m_env.getLocalPlayer()->setWieldIndex(item);
1387 m_update_wielded_item = true;
1389 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1394 // Returns true once after the inventory of the local player
1395 // has been updated from the server.
1396 bool Client::updateWieldedItem()
1398 if (!m_update_wielded_item)
1401 m_update_wielded_item = false;
1403 LocalPlayer *player = m_env.getLocalPlayer();
1405 if (auto *list = player->inventory.getList("main"))
1406 list->setModified(false);
1407 if (auto *list = player->inventory.getList("hand"))
1408 list->setModified(false);
1413 Inventory* Client::getInventory(const InventoryLocation &loc)
1416 case InventoryLocation::UNDEFINED:
1419 case InventoryLocation::CURRENT_PLAYER:
1421 LocalPlayer *player = m_env.getLocalPlayer();
1423 return &player->inventory;
1426 case InventoryLocation::PLAYER:
1428 // Check if we are working with local player inventory
1429 LocalPlayer *player = m_env.getLocalPlayer();
1430 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1432 return &player->inventory;
1435 case InventoryLocation::NODEMETA:
1437 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1440 return meta->getInventory();
1443 case InventoryLocation::DETACHED:
1445 if (m_detached_inventories.count(loc.name) == 0)
1447 return m_detached_inventories[loc.name];
1451 FATAL_ERROR("Invalid inventory location type.");
1457 void Client::inventoryAction(InventoryAction *a)
1460 Send it to the server
1462 sendInventoryAction(a);
1465 Predict some local inventory changes
1467 a->clientApply(this, this);
1473 float Client::getAnimationTime()
1475 return m_animation_time;
1478 int Client::getCrackLevel()
1480 return m_crack_level;
1483 v3s16 Client::getCrackPos()
1488 void Client::setCrack(int level, v3s16 pos)
1490 int old_crack_level = m_crack_level;
1491 v3s16 old_crack_pos = m_crack_pos;
1493 m_crack_level = level;
1496 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1499 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1501 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1504 addUpdateMeshTaskForNode(pos, false, true);
1510 LocalPlayer *player = m_env.getLocalPlayer();
1515 bool Client::getChatMessage(std::wstring &res)
1517 if (m_chat_queue.empty())
1520 ChatMessage *chatMessage = m_chat_queue.front();
1525 switch (chatMessage->type) {
1526 case CHATMESSAGE_TYPE_RAW:
1527 case CHATMESSAGE_TYPE_ANNOUNCE:
1528 case CHATMESSAGE_TYPE_SYSTEM:
1529 res = chatMessage->message;
1531 case CHATMESSAGE_TYPE_NORMAL: {
1532 if (!chatMessage->sender.empty())
1533 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1535 res = chatMessage->message;
1546 void Client::typeChatMessage(const std::wstring &message)
1548 // Discard empty line
1549 if (message.empty())
1552 // If message was consumed by script API, don't send it to server
1553 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1557 sendChatMessage(message);
1560 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1562 // Check if the block exists to begin with. In the case when a non-existing
1563 // neighbor is automatically added, it may not. In that case we don't want
1564 // to tell the mesh update thread about it.
1565 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1569 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1572 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1575 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1577 catch(InvalidPositionException &e){}
1580 for (int i=0;i<6;i++)
1583 v3s16 p = blockpos + g_6dirs[i];
1584 addUpdateMeshTask(p, false, urgent);
1586 catch(InvalidPositionException &e){}
1590 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1594 infostream<<"Client::addUpdateMeshTaskForNode(): "
1595 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1599 v3s16 blockpos = getNodeBlockPos(nodepos);
1600 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1603 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1605 catch(InvalidPositionException &e) {}
1608 if(nodepos.X == blockpos_relative.X){
1610 v3s16 p = blockpos + v3s16(-1,0,0);
1611 addUpdateMeshTask(p, false, urgent);
1613 catch(InvalidPositionException &e){}
1616 if(nodepos.Y == blockpos_relative.Y){
1618 v3s16 p = blockpos + v3s16(0,-1,0);
1619 addUpdateMeshTask(p, false, urgent);
1621 catch(InvalidPositionException &e){}
1624 if(nodepos.Z == blockpos_relative.Z){
1626 v3s16 p = blockpos + v3s16(0,0,-1);
1627 addUpdateMeshTask(p, false, urgent);
1629 catch(InvalidPositionException &e){}
1633 ClientEvent *Client::getClientEvent()
1635 FATAL_ERROR_IF(m_client_event_queue.empty(),
1636 "Cannot getClientEvent, queue is empty.");
1638 ClientEvent *event = m_client_event_queue.front();
1639 m_client_event_queue.pop();
1643 bool Client::connectedToServer()
1645 return m_con->Connected();
1648 const Address Client::getServerAddress()
1650 return m_con->GetPeerAddress(PEER_ID_SERVER);
1653 float Client::mediaReceiveProgress()
1655 if (m_media_downloader)
1656 return m_media_downloader->getProgress();
1658 return 1.0; // downloader only exists when not yet done
1661 typedef struct TextureUpdateArgs {
1662 gui::IGUIEnvironment *guienv;
1665 const wchar_t* text_base;
1666 ITextureSource *tsrc;
1667 } TextureUpdateArgs;
1669 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1671 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1672 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1674 // update the loading menu -- if neccessary
1675 bool do_draw = false;
1676 u64 time_ms = targs->last_time_ms;
1677 if (cur_percent != targs->last_percent) {
1678 targs->last_percent = cur_percent;
1679 time_ms = porting::getTimeMs();
1680 // only draw when the user will notice something:
1681 do_draw = (time_ms - targs->last_time_ms > 100);
1685 targs->last_time_ms = time_ms;
1686 std::basic_stringstream<wchar_t> strm;
1687 strm << targs->text_base << " " << targs->last_percent << "%...";
1688 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1689 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1693 void Client::afterContentReceived()
1695 infostream<<"Client::afterContentReceived() started"<<std::endl;
1696 assert(m_itemdef_received); // pre-condition
1697 assert(m_nodedef_received); // pre-condition
1698 assert(mediaReceived()); // pre-condition
1700 const wchar_t* text = wgettext("Loading textures...");
1702 // Clear cached pre-scaled 2D GUI images, as this cache
1703 // might have images with the same name but different
1704 // content from previous sessions.
1705 guiScalingCacheClear();
1707 // Rebuild inherited images and recreate textures
1708 infostream<<"- Rebuilding images and textures"<<std::endl;
1709 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1710 m_tsrc->rebuildImagesAndTextures();
1714 infostream<<"- Rebuilding shaders"<<std::endl;
1715 text = wgettext("Rebuilding shaders...");
1716 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1717 m_shsrc->rebuildShaders();
1720 // Update node aliases
1721 infostream<<"- Updating node aliases"<<std::endl;
1722 text = wgettext("Initializing nodes...");
1723 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1724 m_nodedef->updateAliases(m_itemdef);
1725 for (const auto &path : getTextureDirs())
1726 m_nodedef->applyTextureOverrides(path + DIR_DELIM + "override.txt");
1727 m_nodedef->setNodeRegistrationStatus(true);
1728 m_nodedef->runNodeResolveCallbacks();
1731 // Update node textures and assign shaders to each tile
1732 infostream<<"- Updating node textures"<<std::endl;
1733 TextureUpdateArgs tu_args;
1734 tu_args.guienv = guienv;
1735 tu_args.last_time_ms = porting::getTimeMs();
1736 tu_args.last_percent = 0;
1737 tu_args.text_base = wgettext("Initializing nodes");
1738 tu_args.tsrc = m_tsrc;
1739 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1740 delete[] tu_args.text_base;
1742 // Start mesh update thread after setting up content definitions
1743 infostream<<"- Starting mesh update thread"<<std::endl;
1744 m_mesh_update_thread.start();
1750 m_script->on_client_ready(m_env.getLocalPlayer());
1752 text = wgettext("Done!");
1753 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1754 infostream<<"Client::afterContentReceived() done"<<std::endl;
1758 float Client::getRTT()
1760 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1763 float Client::getCurRate()
1765 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1766 m_con->getLocalStat(con::CUR_DL_RATE));
1769 void Client::makeScreenshot()
1771 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1772 irr::video::IImage* const raw_image = driver->createScreenShot();
1777 time_t t = time(NULL);
1778 struct tm *tm = localtime(&t);
1780 char timetstamp_c[64];
1781 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1783 std::string filename_base = g_settings->get("screenshot_path")
1785 + std::string("screenshot_")
1786 + std::string(timetstamp_c);
1787 std::string filename_ext = "." + g_settings->get("screenshot_format");
1788 std::string filename;
1790 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1791 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1793 // Try to find a unique filename
1794 unsigned serial = 0;
1796 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1797 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1798 std::ifstream tmp(filename.c_str());
1800 break; // File did not apparently exist, we'll go with it
1804 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1805 infostream << "Could not find suitable filename for screenshot" << std::endl;
1807 irr::video::IImage* const image =
1808 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1811 raw_image->copyTo(image);
1813 std::ostringstream sstr;
1814 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1815 sstr << "Saved screenshot to '" << filename << "'";
1817 sstr << "Failed to save screenshot '" << filename << "'";
1819 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1820 narrow_to_wide(sstr.str())));
1821 infostream << sstr.str() << std::endl;
1829 bool Client::shouldShowMinimap() const
1831 return !m_minimap_disabled_by_server;
1834 void Client::pushToEventQueue(ClientEvent *event)
1836 m_client_event_queue.push(event);
1839 void Client::showMinimap(const bool show)
1841 m_game_ui->showMinimap(show);
1844 // IGameDef interface
1846 IItemDefManager* Client::getItemDefManager()
1850 const NodeDefManager* Client::getNodeDefManager()
1854 ICraftDefManager* Client::getCraftDefManager()
1857 //return m_craftdef;
1859 ITextureSource* Client::getTextureSource()
1863 IWritableShaderSource* Client::getShaderSource()
1868 u16 Client::allocateUnknownNodeId(const std::string &name)
1870 errorstream << "Client::allocateUnknownNodeId(): "
1871 << "Client cannot allocate node IDs" << std::endl;
1872 FATAL_ERROR("Client allocated unknown node");
1874 return CONTENT_IGNORE;
1876 ISoundManager* Client::getSoundManager()
1880 MtEventManager* Client::getEventManager()
1885 ParticleManager* Client::getParticleManager()
1887 return &m_particle_manager;
1890 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1892 StringMap::const_iterator it = m_mesh_data.find(filename);
1893 if (it == m_mesh_data.end()) {
1894 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1895 << "\"" << std::endl;
1898 const std::string &data = it->second;
1900 // Create the mesh, remove it from cache and return it
1901 // This allows unique vertex colors and other properties for each instance
1902 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1903 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1904 *data_rw, data_rw.getSize(), filename.c_str());
1905 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1907 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1911 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1915 const std::string* Client::getModFile(std::string filename)
1917 // strip dir delimiter from beginning of path
1918 auto pos = filename.find_first_of(':');
1919 if (pos == std::string::npos)
1922 auto pos2 = filename.find_first_not_of('/', pos);
1924 filename.erase(pos, pos2 - pos);
1926 StringMap::const_iterator it = m_mod_vfs.find(filename);
1927 if (it == m_mod_vfs.end())
1932 bool Client::registerModStorage(ModMetadata *storage)
1934 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1935 errorstream << "Unable to register same mod storage twice. Storage name: "
1936 << storage->getModName() << std::endl;
1940 m_mod_storages[storage->getModName()] = storage;
1944 void Client::unregisterModStorage(const std::string &name)
1946 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1947 m_mod_storages.find(name);
1948 if (it != m_mod_storages.end()) {
1949 // Save unconditionaly on unregistration
1950 it->second->save(getModStoragePath());
1951 m_mod_storages.erase(name);
1955 std::string Client::getModStoragePath() const
1957 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1964 bool Client::joinModChannel(const std::string &channel)
1966 if (m_modchannel_mgr->channelRegistered(channel))
1969 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
1973 m_modchannel_mgr->joinChannel(channel, 0);
1977 bool Client::leaveModChannel(const std::string &channel)
1979 if (!m_modchannel_mgr->channelRegistered(channel))
1982 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
1986 m_modchannel_mgr->leaveChannel(channel, 0);
1990 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
1992 if (!m_modchannel_mgr->canWriteOnChannel(channel))
1995 if (message.size() > STRING_MAX_LEN) {
1996 warningstream << "ModChannel message too long, dropping before sending "
1997 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
1998 << channel << ")" << std::endl;
2002 // @TODO: do some client rate limiting
2003 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2004 pkt << channel << message;
2009 ModChannel* Client::getModChannel(const std::string &channel)
2011 return m_modchannel_mgr->getModChannel(channel);