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>
25 #include "threading/mutex_auto_lock.h"
26 #include "client/renderingengine.h"
27 #include "util/auth.h"
28 #include "util/directiontables.h"
29 #include "util/pointedthing.h"
30 #include "util/serialize.h"
31 #include "util/string.h"
34 #include "network/clientopcodes.h"
36 #include "mapblock_mesh.h"
42 #include "clientmap.h"
43 #include "clientmedia.h"
45 #include "database-sqlite3.h"
46 #include "serialization.h"
47 #include "guiscalingfilter.h"
48 #include "script/scripting_client.h"
50 #include "chatmessage.h"
52 extern gui::IGUIEnvironment* guienv;
59 const char *playername,
60 const std::string &password,
61 const std::string &address_name,
62 MapDrawControl &control,
63 IWritableTextureSource *tsrc,
64 IWritableShaderSource *shsrc,
65 IWritableItemDefManager *itemdef,
66 IWritableNodeDefManager *nodedef,
68 MtEventManager *event,
70 GameUIFlags *game_ui_flags
78 m_mesh_update_thread(this),
80 new ClientMap(this, control, 666),
83 m_particle_manager(&m_env),
84 m_con(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this),
85 m_address_name(address_name),
86 m_server_ser_ver(SER_FMT_VER_INVALID),
87 m_last_chat_message_sent(time(NULL)),
89 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
90 m_media_downloader(new ClientMediaDownloader()),
92 m_game_ui_flags(game_ui_flags)
95 m_env.setLocalPlayer(new LocalPlayer(this, playername));
97 if (g_settings->getBool("enable_minimap")) {
98 m_minimap = new Minimap(this);
100 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
102 m_modding_enabled = g_settings->getBool("enable_client_modding");
103 m_script = new ClientScripting(this);
104 m_env.setScript(m_script);
105 m_script->setEnv(&m_env);
108 void Client::loadMods()
111 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
113 // If modding is not enabled, don't load mods, just builtin
114 if (!m_modding_enabled) {
117 ClientModConfiguration modconf(getClientModsLuaPath());
118 m_mods = modconf.getMods();
119 std::vector<ModSpec> unsatisfied_mods = modconf.getUnsatisfiedMods();
120 // complain about mods with unsatisfied dependencies
121 if (!modconf.isConsistent()) {
122 modconf.printUnsatisfiedModsError();
126 infostream << "Client Loading mods: ";
127 for (const ModSpec &mod : m_mods)
128 infostream << mod.name << " ";
129 infostream << std::endl;
131 // Load and run "mod" scripts
132 for (const ModSpec &mod : m_mods) {
133 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
134 throw ModError("Error loading mod \"" + mod.name +
135 "\": Mod name does not follow naming conventions: "
136 "Only characters [a-z0-9_] are allowed.");
138 scanModIntoMemory(mod.name, mod.path);
142 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
143 std::string mod_subpath)
145 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
146 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
147 for (unsigned int j=0; j < mod.size(); j++){
148 std::string filename = mod[j].name;
150 scanModSubfolder(mod_name, mod_path, mod_subpath
151 + filename + DIR_DELIM);
154 std::replace( mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
155 m_mod_files[mod_name + ":" + mod_subpath + filename] = full_path + filename;
159 void Client::initMods()
161 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
163 // If modding is not enabled, don't load mods, just builtin
164 if (!m_modding_enabled) {
168 // Load and run "mod" scripts
169 for (const ModSpec &mod : m_mods)
170 m_script->loadModFromMemory(mod.name);
173 const std::string &Client::getBuiltinLuaPath()
175 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
179 const std::string &Client::getClientModsLuaPath()
181 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
182 return clientmods_dir;
185 const std::vector<ModSpec>& Client::getMods() const
187 static std::vector<ModSpec> client_modspec_temp;
188 return client_modspec_temp;
191 const ModSpec* Client::getModSpec(const std::string &modname) const
199 // Don't disable this part when modding is disabled, it's used in builtin
200 m_script->on_shutdown();
201 //request all client managed threads to stop
202 m_mesh_update_thread.stop();
203 // Save local server map
205 infostream << "Local map saving ended." << std::endl;
206 m_localdb->endSave();
212 bool Client::isShutdown()
214 return m_shutdown || !m_mesh_update_thread.isRunning();
222 m_mesh_update_thread.stop();
223 m_mesh_update_thread.wait();
224 while (!m_mesh_update_thread.m_queue_out.empty()) {
225 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
230 delete m_inventory_from_server;
232 // Delete detached inventories
233 for (std::unordered_map<std::string, Inventory*>::iterator
234 i = m_detached_inventories.begin();
235 i != m_detached_inventories.end(); ++i) {
239 // cleanup 3d model meshes on client shutdown
240 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
241 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
244 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
250 void Client::connect(Address address, bool is_local_server)
252 DSTACK(FUNCTION_NAME);
254 initLocalMapSaving(address, m_address_name, is_local_server);
256 m_con.SetTimeoutMs(0);
257 m_con.Connect(address);
260 void Client::step(float dtime)
262 DSTACK(FUNCTION_NAME);
268 if(m_ignore_damage_timer > dtime)
269 m_ignore_damage_timer -= dtime;
271 m_ignore_damage_timer = 0.0;
273 m_animation_time += dtime;
274 if(m_animation_time > 60.0)
275 m_animation_time -= 60.0;
277 m_time_of_day_update_timer += dtime;
285 float &counter = m_packetcounter_timer;
291 infostream << "Client packetcounter (" << m_packetcounter_timer
293 m_packetcounter.print(infostream);
294 m_packetcounter.clear();
298 // UGLY hack to fix 2 second startup delay caused by non existent
299 // server client startup synchronization in local server or singleplayer mode
300 static bool initial_step = true;
302 initial_step = false;
304 else if(m_state == LC_Created) {
305 float &counter = m_connection_reinit_timer;
310 LocalPlayer *myplayer = m_env.getLocalPlayer();
311 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
313 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
314 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
316 if (proto_version_min < 25) {
317 // Send TOSERVER_INIT_LEGACY
318 // [0] u16 TOSERVER_INIT_LEGACY
319 // [2] u8 SER_FMT_VER_HIGHEST_READ
320 // [3] u8[20] player_name
321 // [23] u8[28] password (new in some version)
322 // [51] u16 minimum supported network protocol version (added sometime)
323 // [53] u16 maximum supported network protocol version (added later than the previous one)
325 char pName[PLAYERNAME_SIZE];
326 char pPassword[PASSWORD_SIZE];
327 memset(pName, 0, PLAYERNAME_SIZE * sizeof(char));
328 memset(pPassword, 0, PASSWORD_SIZE * sizeof(char));
330 std::string hashed_password = translate_password(myplayer->getName(), m_password);
331 snprintf(pName, PLAYERNAME_SIZE, "%s", myplayer->getName());
332 snprintf(pPassword, PASSWORD_SIZE, "%s", hashed_password.c_str());
334 sendLegacyInit(pName, pPassword);
336 if (CLIENT_PROTOCOL_VERSION_MAX >= 25)
337 sendInit(myplayer->getName());
340 // Not connected, return
345 Do stuff if connected
349 Run Map's timers and unload unused data
351 const float map_timer_and_unload_dtime = 5.25;
352 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
353 ScopeProfiler sp(g_profiler, "Client: map timer and unload");
354 std::vector<v3s16> deleted_blocks;
355 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
356 g_settings->getFloat("client_unload_unused_data_timeout"),
357 g_settings->getS32("client_mapblock_limit"),
362 NOTE: This loop is intentionally iterated the way it is.
365 std::vector<v3s16>::iterator i = deleted_blocks.begin();
366 std::vector<v3s16> sendlist;
368 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
379 sendDeletedBlocks(sendlist);
381 if(i == deleted_blocks.end())
387 sendlist.push_back(*i);
393 Send pending messages on out chat queue
395 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
396 sendChatMessage(m_out_chat_queue.front());
397 m_out_chat_queue.pop();
403 // Control local player (0ms)
404 LocalPlayer *player = m_env.getLocalPlayer();
406 player->applyControl(dtime);
410 m_sound->step(dtime);
415 while (m_env.hasClientEnvEvents()) {
416 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
418 if (envEvent.type == CEE_PLAYER_DAMAGE) {
419 if (m_ignore_damage_timer <= 0) {
420 u8 damage = envEvent.player_damage.amount;
422 if (envEvent.player_damage.send_to_server)
425 // Add to ClientEvent queue
427 event.type = CE_PLAYER_DAMAGE;
428 event.player_damage.amount = damage;
429 m_client_event_queue.push(event);
432 // Protocol v29 or greater obsoleted this event
433 else if (envEvent.type == CEE_PLAYER_BREATH && m_proto_ver < 29) {
434 u16 breath = envEvent.player_breath.amount;
442 float &counter = m_avg_rtt_timer;
446 // connectedAndInitialized() is true, peer exists.
447 float avg_rtt = getRTT();
448 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
452 Send player position to server
455 float &counter = m_playerpos_send_timer;
457 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
465 Replace updated meshes
468 int num_processed_meshes = 0;
469 while (!m_mesh_update_thread.m_queue_out.empty())
471 num_processed_meshes++;
473 MinimapMapblock *minimap_mapblock = NULL;
474 bool do_mapper_update = true;
476 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
477 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
479 // Delete the old mesh
481 block->mesh = nullptr;
484 minimap_mapblock = r.mesh->moveMinimapMapblock();
485 if (minimap_mapblock == NULL)
486 do_mapper_update = false;
488 bool is_empty = true;
489 for (int l = 0; l < MAX_TILE_LAYERS; l++)
490 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
496 // Replace with the new mesh
497 block->mesh = r.mesh;
503 if (m_minimap && do_mapper_update)
504 m_minimap->addBlock(r.p, minimap_mapblock);
506 if (r.ack_block_to_server) {
516 if (num_processed_meshes > 0)
517 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
523 if (m_media_downloader && m_media_downloader->isStarted()) {
524 m_media_downloader->step(this);
525 if (m_media_downloader->isDone()) {
526 delete m_media_downloader;
527 m_media_downloader = NULL;
532 If the server didn't update the inventory in a while, revert
533 the local inventory (so the player notices the lag problem
534 and knows something is wrong).
536 if(m_inventory_from_server)
538 float interval = 10.0;
539 float count_before = floor(m_inventory_from_server_age / interval);
541 m_inventory_from_server_age += dtime;
543 float count_after = floor(m_inventory_from_server_age / interval);
545 if(count_after != count_before)
547 // Do this every <interval> seconds after TOCLIENT_INVENTORY
548 // Reset the locally changed inventory to the authoritative inventory
549 LocalPlayer *player = m_env.getLocalPlayer();
550 player->inventory = *m_inventory_from_server;
551 m_inventory_updated = true;
556 Update positions of sounds attached to objects
559 for(std::unordered_map<int, u16>::iterator i = m_sounds_to_objects.begin();
560 i != m_sounds_to_objects.end(); ++i) {
561 int client_id = i->first;
562 u16 object_id = i->second;
563 ClientActiveObject *cao = m_env.getActiveObject(object_id);
566 v3f pos = cao->getPosition();
567 m_sound->updateSoundPosition(client_id, pos);
572 Handle removed remotely initiated sounds
574 m_removed_sounds_check_timer += dtime;
575 if(m_removed_sounds_check_timer >= 2.32) {
576 m_removed_sounds_check_timer = 0;
577 // Find removed sounds and clear references to them
578 std::vector<s32> removed_server_ids;
579 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
580 i != m_sounds_server_to_client.end();) {
581 s32 server_id = i->first;
582 int client_id = i->second;
584 if(!m_sound->soundExists(client_id)) {
585 m_sounds_server_to_client.erase(server_id);
586 m_sounds_client_to_server.erase(client_id);
587 m_sounds_to_objects.erase(client_id);
588 removed_server_ids.push_back(server_id);
593 if(!removed_server_ids.empty()) {
594 sendRemovedSounds(removed_server_ids);
598 m_mod_storage_save_timer -= dtime;
599 if (m_mod_storage_save_timer <= 0.0f) {
600 verbosestream << "Saving registered mod storages." << std::endl;
601 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
602 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
603 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
604 if (it->second->isModified()) {
605 it->second->save(getModStoragePath());
611 if (m_localdb && m_localdb_save_interval.step(dtime,
612 m_cache_save_interval)) {
613 m_localdb->endSave();
614 m_localdb->beginSave();
618 bool Client::loadMedia(const std::string &data, const std::string &filename)
620 // Silly irrlicht's const-incorrectness
621 Buffer<char> data_rw(data.c_str(), data.size());
625 const char *image_ext[] = {
626 ".png", ".jpg", ".bmp", ".tga",
627 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
630 name = removeStringEnd(filename, image_ext);
633 verbosestream<<"Client: Attempting to load image "
634 <<"file \""<<filename<<"\""<<std::endl;
636 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
637 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
639 // Create an irrlicht memory file
640 io::IReadFile *rfile = irrfs->createMemoryReadFile(
641 *data_rw, data_rw.getSize(), "_tempreadfile");
643 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
646 video::IImage *img = vdrv->createImageFromFile(rfile);
648 errorstream<<"Client: Cannot create image from data of "
649 <<"file \""<<filename<<"\""<<std::endl;
654 m_tsrc->insertSourceImage(filename, img);
661 const char *sound_ext[] = {
662 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
663 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
666 name = removeStringEnd(filename, sound_ext);
669 verbosestream<<"Client: Attempting to load sound "
670 <<"file \""<<filename<<"\""<<std::endl;
671 m_sound->loadSoundData(name, data);
675 const char *model_ext[] = {
676 ".x", ".b3d", ".md2", ".obj",
679 name = removeStringEnd(filename, model_ext);
682 verbosestream<<"Client: Storing model into memory: "
683 <<"\""<<filename<<"\""<<std::endl;
684 if(m_mesh_data.count(filename))
685 errorstream<<"Multiple models with name \""<<filename.c_str()
686 <<"\" found; replacing previous model"<<std::endl;
687 m_mesh_data[filename] = data;
691 errorstream<<"Client: Don't know how to load file \""
692 <<filename<<"\""<<std::endl;
696 // Virtual methods from con::PeerHandler
697 void Client::peerAdded(con::Peer *peer)
699 infostream << "Client::peerAdded(): peer->id="
700 << peer->id << std::endl;
702 void Client::deletingPeer(con::Peer *peer, bool timeout)
704 infostream << "Client::deletingPeer(): "
705 "Server Peer is getting deleted "
706 << "(timeout=" << timeout << ")" << std::endl;
709 m_access_denied = true;
710 m_access_denied_reason = gettext("Connection timed out.");
716 u16 number of files requested
722 void Client::request_media(const std::vector<std::string> &file_requests)
724 std::ostringstream os(std::ios_base::binary);
725 writeU16(os, TOSERVER_REQUEST_MEDIA);
726 size_t file_requests_size = file_requests.size();
728 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
730 // Packet dynamicly resized
731 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
733 pkt << (u16) (file_requests_size & 0xFFFF);
735 for(std::vector<std::string>::const_iterator i = file_requests.begin();
736 i != file_requests.end(); ++i) {
742 infostream << "Client: Sending media request list to server ("
743 << file_requests.size() << " files. packet size)" << std::endl;
746 void Client::initLocalMapSaving(const Address &address,
747 const std::string &hostname,
748 bool is_local_server)
750 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
754 const std::string world_path = porting::path_user
755 + DIR_DELIM + "worlds"
756 + DIR_DELIM + "server_"
757 + hostname + "_" + std::to_string(address.getPort());
759 fs::CreateAllDirs(world_path);
761 m_localdb = new MapDatabaseSQLite3(world_path);
762 m_localdb->beginSave();
763 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
766 void Client::ReceiveAll()
768 DSTACK(FUNCTION_NAME);
769 u64 start_ms = porting::getTimeMs();
772 // Limit time even if there would be huge amounts of data to
774 if(porting::getTimeMs() > start_ms + 100)
779 g_profiler->graphAdd("client_received_packets", 1);
781 catch(con::NoIncomingDataException &e) {
784 catch(con::InvalidIncomingDataException &e) {
785 infostream<<"Client::ReceiveAll(): "
786 "InvalidIncomingDataException: what()="
787 <<e.what()<<std::endl;
792 void Client::Receive()
794 DSTACK(FUNCTION_NAME);
800 inline void Client::handleCommand(NetworkPacket* pkt)
802 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
803 (this->*opHandle.handler)(pkt);
807 sender_peer_id given to this shall be quaranteed to be a valid peer
809 void Client::ProcessData(NetworkPacket *pkt)
811 DSTACK(FUNCTION_NAME);
813 ToClientCommand command = (ToClientCommand) pkt->getCommand();
814 u32 sender_peer_id = pkt->getPeerId();
816 //infostream<<"Client: received command="<<command<<std::endl;
817 m_packetcounter.add((u16)command);
820 If this check is removed, be sure to change the queue
821 system to know the ids
823 if(sender_peer_id != PEER_ID_SERVER) {
824 infostream << "Client::ProcessData(): Discarding data not "
825 "coming from server: peer_id=" << sender_peer_id
830 // Command must be handled into ToClientCommandHandler
831 if (command >= TOCLIENT_NUM_MSG_TYPES) {
832 infostream << "Client: Ignoring unknown command "
833 << command << std::endl;
838 * Those packets are handled before m_server_ser_ver is set, it's normal
839 * But we must use the new ToClientConnectionState in the future,
842 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
847 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
848 infostream << "Client: Server serialization"
849 " format invalid or not initialized."
850 " Skipping incoming command=" << command << std::endl;
855 Handle runtime commands
861 void Client::Send(NetworkPacket* pkt)
863 m_con.Send(PEER_ID_SERVER,
864 serverCommandFactoryTable[pkt->getCommand()].channel,
866 serverCommandFactoryTable[pkt->getCommand()].reliable);
869 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
870 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
872 v3f pf = myplayer->getPosition() * 100;
873 v3f sf = myplayer->getSpeed() * 100;
874 s32 pitch = myplayer->getPitch() * 100;
875 s32 yaw = myplayer->getYaw() * 100;
876 u32 keyPressed = myplayer->keyPressed;
877 // scaled by 80, so that pi can fit into a u8
878 u8 fov = clientMap->getCameraFov() * 80;
879 u8 wanted_range = MYMIN(255,
880 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
882 v3s32 position(pf.X, pf.Y, pf.Z);
883 v3s32 speed(sf.X, sf.Y, sf.Z);
887 [0] v3s32 position*100
889 [12+12] s32 pitch*100
890 [12+12+4] s32 yaw*100
891 [12+12+4+4] u32 keyPressed
892 [12+12+4+4+4] u8 fov*80
893 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
895 *pkt << position << speed << pitch << yaw << keyPressed;
896 *pkt << fov << wanted_range;
899 void Client::interact(u8 action, const PointedThing& pointed)
901 if(m_state != LC_Ready) {
902 errorstream << "Client::interact() "
903 "Canceled (not connected)"
908 LocalPlayer *myplayer = m_env.getLocalPlayer();
909 if (myplayer == NULL)
916 [5] u32 length of the next item (plen)
917 [9] serialized PointedThing
918 [9 + plen] player position information
920 0: start digging (from undersurface) or use
921 1: stop digging (all parameters ignored)
923 3: place block or item (to abovesurface)
925 5: perform secondary action of item
928 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
931 pkt << (u16)getPlayerItem();
933 std::ostringstream tmp_os(std::ios::binary);
934 pointed.serialize(tmp_os);
936 pkt.putLongString(tmp_os.str());
938 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
943 void Client::deleteAuthData()
948 switch (m_chosen_auth_mech) {
949 case AUTH_MECHANISM_FIRST_SRP:
951 case AUTH_MECHANISM_SRP:
952 case AUTH_MECHANISM_LEGACY_PASSWORD:
953 srp_user_delete((SRPUser *) m_auth_data);
956 case AUTH_MECHANISM_NONE:
959 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
963 AuthMechanism Client::choseAuthMech(const u32 mechs)
965 if (mechs & AUTH_MECHANISM_SRP)
966 return AUTH_MECHANISM_SRP;
968 if (mechs & AUTH_MECHANISM_FIRST_SRP)
969 return AUTH_MECHANISM_FIRST_SRP;
971 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
972 return AUTH_MECHANISM_LEGACY_PASSWORD;
974 return AUTH_MECHANISM_NONE;
977 void Client::sendLegacyInit(const char* playerName, const char* playerPassword)
979 NetworkPacket pkt(TOSERVER_INIT_LEGACY,
980 1 + PLAYERNAME_SIZE + PASSWORD_SIZE + 2 + 2);
982 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
983 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
985 pkt << (u8) SER_FMT_VER_HIGHEST_READ;
986 pkt.putRawString(playerName,PLAYERNAME_SIZE);
987 pkt.putRawString(playerPassword, PASSWORD_SIZE);
988 pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
993 void Client::sendInit(const std::string &playerName)
995 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
997 // we don't support network compression yet
998 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1000 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
1001 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
1003 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1004 pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1010 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1012 m_chosen_auth_mech = chosen_auth_mechanism;
1014 switch (chosen_auth_mechanism) {
1015 case AUTH_MECHANISM_FIRST_SRP: {
1016 // send srp verifier to server
1017 std::string verifier;
1019 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1022 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1023 resp_pkt << salt << verifier << (u8)((m_password == "") ? 1 : 0);
1028 case AUTH_MECHANISM_SRP:
1029 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1032 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1033 m_password = translate_password(getPlayerName(), m_password);
1037 std::string playername_u = lowercase(getPlayerName());
1038 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1039 getPlayerName().c_str(), playername_u.c_str(),
1040 (const unsigned char *) m_password.c_str(),
1041 m_password.length(), NULL, NULL);
1044 SRP_Result res = srp_user_start_authentication(
1045 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1046 (unsigned char **) &bytes_A, &len_A);
1047 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1049 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1050 resp_pkt << std::string(bytes_A, len_A) << based_on;
1054 case AUTH_MECHANISM_NONE:
1055 break; // not handled in this method
1059 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1061 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1063 pkt << (u8) blocks.size();
1066 for(std::vector<v3s16>::iterator
1068 j != blocks.end(); ++j) {
1076 void Client::sendGotBlocks(v3s16 block)
1078 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1079 pkt << (u8) 1 << block;
1083 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1085 size_t server_ids = soundList.size();
1086 assert(server_ids <= 0xFFFF);
1088 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1090 pkt << (u16) (server_ids & 0xFFFF);
1092 for(std::vector<s32>::iterator i = soundList.begin();
1093 i != soundList.end(); ++i)
1099 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1100 const StringMap &fields)
1102 size_t fields_size = fields.size();
1104 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1106 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1108 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1110 StringMap::const_iterator it;
1111 for (it = fields.begin(); it != fields.end(); ++it) {
1112 const std::string &name = it->first;
1113 const std::string &value = it->second;
1115 pkt.putLongString(value);
1121 void Client::sendInventoryFields(const std::string &formname,
1122 const StringMap &fields)
1124 size_t fields_size = fields.size();
1125 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1127 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1128 pkt << formname << (u16) (fields_size & 0xFFFF);
1130 StringMap::const_iterator it;
1131 for (it = fields.begin(); it != fields.end(); ++it) {
1132 const std::string &name = it->first;
1133 const std::string &value = it->second;
1135 pkt.putLongString(value);
1141 void Client::sendInventoryAction(InventoryAction *a)
1143 std::ostringstream os(std::ios_base::binary);
1148 std::string s = os.str();
1150 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1151 pkt.putRawString(s.c_str(),s.size());
1156 bool Client::canSendChatMessage() const
1158 u32 now = time(NULL);
1159 float time_passed = now - m_last_chat_message_sent;
1161 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1162 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1164 if (virt_chat_message_allowance < 1.0f)
1170 void Client::sendChatMessage(const std::wstring &message)
1172 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1173 if (canSendChatMessage()) {
1174 u32 now = time(NULL);
1175 float time_passed = now - m_last_chat_message_sent;
1176 m_last_chat_message_sent = time(NULL);
1178 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1179 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1180 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1182 m_chat_message_allowance -= 1.0f;
1184 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1189 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1190 m_out_chat_queue.push(message);
1192 infostream << "Could not queue chat message because maximum out chat queue size ("
1193 << max_queue_size << ") is reached." << std::endl;
1197 void Client::clearOutChatQueue()
1199 m_out_chat_queue = std::queue<std::wstring>();
1202 void Client::sendChangePassword(const std::string &oldpassword,
1203 const std::string &newpassword)
1205 LocalPlayer *player = m_env.getLocalPlayer();
1209 std::string playername = player->getName();
1210 if (m_proto_ver >= 25) {
1211 // get into sudo mode and then send new password to server
1212 m_password = oldpassword;
1213 m_new_password = newpassword;
1214 startAuth(choseAuthMech(m_sudo_auth_methods));
1216 std::string oldpwd = translate_password(playername, oldpassword);
1217 std::string newpwd = translate_password(playername, newpassword);
1219 NetworkPacket pkt(TOSERVER_PASSWORD_LEGACY, 2 * PASSWORD_SIZE);
1221 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1222 pkt << (u8) (i < oldpwd.length() ? oldpwd[i] : 0);
1225 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1226 pkt << (u8) (i < newpwd.length() ? newpwd[i] : 0);
1233 void Client::sendDamage(u8 damage)
1235 DSTACK(FUNCTION_NAME);
1237 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u8));
1242 void Client::sendBreath(u16 breath)
1244 DSTACK(FUNCTION_NAME);
1246 // Protocol v29 make this obsolete
1247 if (m_proto_ver >= 29)
1250 NetworkPacket pkt(TOSERVER_BREATH, sizeof(u16));
1255 void Client::sendRespawn()
1257 DSTACK(FUNCTION_NAME);
1259 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1263 void Client::sendReady()
1265 DSTACK(FUNCTION_NAME);
1267 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1268 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash));
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));
1277 void Client::sendPlayerPos()
1279 LocalPlayer *myplayer = m_env.getLocalPlayer();
1280 if(myplayer == NULL)
1283 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 something changed
1289 if(myplayer->last_position == myplayer->getPosition() &&
1290 myplayer->last_speed == myplayer->getSpeed() &&
1291 myplayer->last_pitch == myplayer->getPitch() &&
1292 myplayer->last_yaw == myplayer->getYaw() &&
1293 myplayer->last_keyPressed == myplayer->keyPressed &&
1294 myplayer->last_camera_fov == camera_fov &&
1295 myplayer->last_wanted_range == wanted_range)
1298 myplayer->last_position = myplayer->getPosition();
1299 myplayer->last_speed = myplayer->getSpeed();
1300 myplayer->last_pitch = myplayer->getPitch();
1301 myplayer->last_yaw = myplayer->getYaw();
1302 myplayer->last_keyPressed = myplayer->keyPressed;
1303 myplayer->last_camera_fov = camera_fov;
1304 myplayer->last_wanted_range = wanted_range;
1306 //infostream << "Sending Player Position information" << std::endl;
1310 //MutexAutoLock lock(m_con_mutex); //bulk comment-out
1311 our_peer_id = m_con.GetPeerID();
1314 // Set peer id if not set already
1315 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1316 myplayer->peer_id = our_peer_id;
1318 assert(myplayer->peer_id == our_peer_id);
1320 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1322 writePlayerPos(myplayer, &map, &pkt);
1327 void Client::sendPlayerItem(u16 item)
1329 LocalPlayer *myplayer = m_env.getLocalPlayer();
1330 if(myplayer == NULL)
1333 u16 our_peer_id = m_con.GetPeerID();
1335 // Set peer id if not set already
1336 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1337 myplayer->peer_id = our_peer_id;
1338 assert(myplayer->peer_id == our_peer_id);
1340 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1347 void Client::removeNode(v3s16 p)
1349 std::map<v3s16, MapBlock*> modified_blocks;
1352 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1354 catch(InvalidPositionException &e) {
1357 for(std::map<v3s16, MapBlock *>::iterator
1358 i = modified_blocks.begin();
1359 i != modified_blocks.end(); ++i) {
1360 addUpdateMeshTaskWithEdge(i->first, false, true);
1364 MapNode Client::getNode(v3s16 p, bool *is_valid_position)
1366 return m_env.getMap().getNodeNoEx(p, is_valid_position);
1369 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1371 //TimeTaker timer1("Client::addNode()");
1373 std::map<v3s16, MapBlock*> modified_blocks;
1376 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1377 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1379 catch(InvalidPositionException &e) {
1382 for(std::map<v3s16, MapBlock *>::iterator
1383 i = modified_blocks.begin();
1384 i != modified_blocks.end(); ++i) {
1385 addUpdateMeshTaskWithEdge(i->first, false, true);
1389 void Client::setPlayerControl(PlayerControl &control)
1391 LocalPlayer *player = m_env.getLocalPlayer();
1393 player->control = control;
1396 void Client::selectPlayerItem(u16 item)
1398 m_playeritem = item;
1399 m_inventory_updated = true;
1400 sendPlayerItem(item);
1403 // Returns true if the inventory of the local player has been
1404 // updated from the server. If it is true, it is set to false.
1405 bool Client::getLocalInventoryUpdated()
1407 bool updated = m_inventory_updated;
1408 m_inventory_updated = false;
1412 // Copies the inventory of the local player to parameter
1413 void Client::getLocalInventory(Inventory &dst)
1415 LocalPlayer *player = m_env.getLocalPlayer();
1417 dst = player->inventory;
1420 Inventory* Client::getInventory(const InventoryLocation &loc)
1423 case InventoryLocation::UNDEFINED:
1426 case InventoryLocation::CURRENT_PLAYER:
1428 LocalPlayer *player = m_env.getLocalPlayer();
1430 return &player->inventory;
1433 case InventoryLocation::PLAYER:
1435 // Check if we are working with local player inventory
1436 LocalPlayer *player = m_env.getLocalPlayer();
1437 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1439 return &player->inventory;
1442 case InventoryLocation::NODEMETA:
1444 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1447 return meta->getInventory();
1450 case InventoryLocation::DETACHED:
1452 if (m_detached_inventories.count(loc.name) == 0)
1454 return m_detached_inventories[loc.name];
1458 FATAL_ERROR("Invalid inventory location type.");
1464 void Client::inventoryAction(InventoryAction *a)
1467 Send it to the server
1469 sendInventoryAction(a);
1472 Predict some local inventory changes
1474 a->clientApply(this, this);
1480 float Client::getAnimationTime()
1482 return m_animation_time;
1485 int Client::getCrackLevel()
1487 return m_crack_level;
1490 v3s16 Client::getCrackPos()
1495 void Client::setCrack(int level, v3s16 pos)
1497 int old_crack_level = m_crack_level;
1498 v3s16 old_crack_pos = m_crack_pos;
1500 m_crack_level = level;
1503 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1506 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1508 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1511 addUpdateMeshTaskForNode(pos, false, true);
1517 LocalPlayer *player = m_env.getLocalPlayer();
1522 bool Client::getChatMessage(std::wstring &res)
1524 if (m_chat_queue.empty())
1527 ChatMessage *chatMessage = m_chat_queue.front();
1532 switch (chatMessage->type) {
1533 case CHATMESSAGE_TYPE_RAW:
1534 case CHATMESSAGE_TYPE_ANNOUNCE:
1535 case CHATMESSAGE_TYPE_SYSTEM:
1536 res = chatMessage->message;
1538 case CHATMESSAGE_TYPE_NORMAL: {
1539 if (!chatMessage->sender.empty())
1540 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1542 res = chatMessage->message;
1553 void Client::typeChatMessage(const std::wstring &message)
1555 // Discard empty line
1559 // If message was ate by script API, don't send it to server
1560 if (m_script->on_sending_message(wide_to_utf8(message))) {
1565 sendChatMessage(message);
1568 if (message[0] != L'/') {
1569 // compatibility code
1570 if (m_proto_ver < 29) {
1571 LocalPlayer *player = m_env.getLocalPlayer();
1573 std::wstring name = narrow_to_wide(player->getName());
1574 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_NORMAL, message, name));
1579 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1581 // Check if the block exists to begin with. In the case when a non-existing
1582 // neighbor is automatically added, it may not. In that case we don't want
1583 // to tell the mesh update thread about it.
1584 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1588 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1591 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1594 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1596 catch(InvalidPositionException &e){}
1599 for (int i=0;i<6;i++)
1602 v3s16 p = blockpos + g_6dirs[i];
1603 addUpdateMeshTask(p, false, urgent);
1605 catch(InvalidPositionException &e){}
1609 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1613 infostream<<"Client::addUpdateMeshTaskForNode(): "
1614 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1618 v3s16 blockpos = getNodeBlockPos(nodepos);
1619 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1622 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1624 catch(InvalidPositionException &e) {}
1627 if(nodepos.X == blockpos_relative.X){
1629 v3s16 p = blockpos + v3s16(-1,0,0);
1630 addUpdateMeshTask(p, false, urgent);
1632 catch(InvalidPositionException &e){}
1635 if(nodepos.Y == blockpos_relative.Y){
1637 v3s16 p = blockpos + v3s16(0,-1,0);
1638 addUpdateMeshTask(p, false, urgent);
1640 catch(InvalidPositionException &e){}
1643 if(nodepos.Z == blockpos_relative.Z){
1645 v3s16 p = blockpos + v3s16(0,0,-1);
1646 addUpdateMeshTask(p, false, urgent);
1648 catch(InvalidPositionException &e){}
1652 ClientEvent Client::getClientEvent()
1654 FATAL_ERROR_IF(m_client_event_queue.empty(),
1655 "Cannot getClientEvent, queue is empty.");
1657 ClientEvent event = m_client_event_queue.front();
1658 m_client_event_queue.pop();
1662 float Client::mediaReceiveProgress()
1664 if (m_media_downloader)
1665 return m_media_downloader->getProgress();
1667 return 1.0; // downloader only exists when not yet done
1670 typedef struct TextureUpdateArgs {
1671 gui::IGUIEnvironment *guienv;
1674 const wchar_t* text_base;
1675 ITextureSource *tsrc;
1676 } TextureUpdateArgs;
1678 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1680 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1681 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1683 // update the loading menu -- if neccessary
1684 bool do_draw = false;
1685 u64 time_ms = targs->last_time_ms;
1686 if (cur_percent != targs->last_percent) {
1687 targs->last_percent = cur_percent;
1688 time_ms = porting::getTimeMs();
1689 // only draw when the user will notice something:
1690 do_draw = (time_ms - targs->last_time_ms > 100);
1694 targs->last_time_ms = time_ms;
1695 std::basic_stringstream<wchar_t> strm;
1696 strm << targs->text_base << " " << targs->last_percent << "%...";
1697 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1698 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1702 void Client::afterContentReceived()
1704 infostream<<"Client::afterContentReceived() started"<<std::endl;
1705 assert(m_itemdef_received); // pre-condition
1706 assert(m_nodedef_received); // pre-condition
1707 assert(mediaReceived()); // pre-condition
1709 const wchar_t* text = wgettext("Loading textures...");
1711 // Clear cached pre-scaled 2D GUI images, as this cache
1712 // might have images with the same name but different
1713 // content from previous sessions.
1714 guiScalingCacheClear();
1716 // Rebuild inherited images and recreate textures
1717 infostream<<"- Rebuilding images and textures"<<std::endl;
1718 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1719 m_tsrc->rebuildImagesAndTextures();
1723 infostream<<"- Rebuilding shaders"<<std::endl;
1724 text = wgettext("Rebuilding shaders...");
1725 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1726 m_shsrc->rebuildShaders();
1729 // Update node aliases
1730 infostream<<"- Updating node aliases"<<std::endl;
1731 text = wgettext("Initializing nodes...");
1732 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1733 m_nodedef->updateAliases(m_itemdef);
1734 std::string texture_path = g_settings->get("texture_path");
1735 if (texture_path != "" && fs::IsDir(texture_path))
1736 m_nodedef->applyTextureOverrides(texture_path + DIR_DELIM + "override.txt");
1737 m_nodedef->setNodeRegistrationStatus(true);
1738 m_nodedef->runNodeResolveCallbacks();
1741 // Update node textures and assign shaders to each tile
1742 infostream<<"- Updating node textures"<<std::endl;
1743 TextureUpdateArgs tu_args;
1744 tu_args.guienv = guienv;
1745 tu_args.last_time_ms = porting::getTimeMs();
1746 tu_args.last_percent = 0;
1747 tu_args.text_base = wgettext("Initializing nodes");
1748 tu_args.tsrc = m_tsrc;
1749 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1750 delete[] tu_args.text_base;
1752 // Start mesh update thread after setting up content definitions
1753 infostream<<"- Starting mesh update thread"<<std::endl;
1754 m_mesh_update_thread.start();
1759 if (g_settings->getBool("enable_client_modding")) {
1760 m_script->on_client_ready(m_env.getLocalPlayer());
1761 m_script->on_connect();
1764 text = wgettext("Done!");
1765 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1766 infostream<<"Client::afterContentReceived() done"<<std::endl;
1770 float Client::getRTT()
1772 return m_con.getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1775 float Client::getCurRate()
1777 return (m_con.getLocalStat(con::CUR_INC_RATE) +
1778 m_con.getLocalStat(con::CUR_DL_RATE));
1781 void Client::makeScreenshot()
1783 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1784 irr::video::IImage* const raw_image = driver->createScreenShot();
1789 time_t t = time(NULL);
1790 struct tm *tm = localtime(&t);
1792 char timetstamp_c[64];
1793 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1795 std::string filename_base = g_settings->get("screenshot_path")
1797 + std::string("screenshot_")
1798 + std::string(timetstamp_c);
1799 std::string filename_ext = "." + g_settings->get("screenshot_format");
1800 std::string filename;
1802 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1803 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1805 // Try to find a unique filename
1806 unsigned serial = 0;
1808 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1809 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1810 std::ifstream tmp(filename.c_str());
1812 break; // File did not apparently exist, we'll go with it
1816 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1817 infostream << "Could not find suitable filename for screenshot" << std::endl;
1819 irr::video::IImage* const image =
1820 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1823 raw_image->copyTo(image);
1825 std::ostringstream sstr;
1826 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1827 sstr << "Saved screenshot to '" << filename << "'";
1829 sstr << "Failed to save screenshot '" << filename << "'";
1831 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1832 narrow_to_wide(sstr.str())));
1833 infostream << sstr.str() << std::endl;
1841 bool Client::shouldShowMinimap() const
1843 return !m_minimap_disabled_by_server;
1846 void Client::showGameChat(const bool show)
1848 m_game_ui_flags->show_chat = show;
1851 void Client::showGameHud(const bool show)
1853 m_game_ui_flags->show_hud = show;
1856 void Client::showMinimap(const bool show)
1858 m_game_ui_flags->show_minimap = show;
1861 void Client::showProfiler(const bool show)
1863 m_game_ui_flags->show_profiler_graph = show;
1866 void Client::showGameFog(const bool show)
1868 m_game_ui_flags->force_fog_off = !show;
1871 void Client::showGameDebug(const bool show)
1873 m_game_ui_flags->show_debug = show;
1876 // IGameDef interface
1878 IItemDefManager* Client::getItemDefManager()
1882 INodeDefManager* Client::getNodeDefManager()
1886 ICraftDefManager* Client::getCraftDefManager()
1889 //return m_craftdef;
1891 ITextureSource* Client::getTextureSource()
1895 IShaderSource* Client::getShaderSource()
1900 u16 Client::allocateUnknownNodeId(const std::string &name)
1902 errorstream << "Client::allocateUnknownNodeId(): "
1903 << "Client cannot allocate node IDs" << std::endl;
1904 FATAL_ERROR("Client allocated unknown node");
1906 return CONTENT_IGNORE;
1908 ISoundManager* Client::getSoundManager()
1912 MtEventManager* Client::getEventManager()
1917 ParticleManager* Client::getParticleManager()
1919 return &m_particle_manager;
1922 scene::IAnimatedMesh* Client::getMesh(const std::string &filename)
1924 StringMap::const_iterator it = m_mesh_data.find(filename);
1925 if (it == m_mesh_data.end()) {
1926 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1927 << "\"" << std::endl;
1930 const std::string &data = it->second;
1932 // Create the mesh, remove it from cache and return it
1933 // This allows unique vertex colors and other properties for each instance
1934 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1935 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1936 *data_rw, data_rw.getSize(), filename.c_str());
1937 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1939 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1941 // NOTE: By playing with Irrlicht refcounts, maybe we could cache a bunch
1942 // of uniquely named instances and re-use them
1944 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1948 const std::string* Client::getModFile(const std::string &filename)
1950 StringMap::const_iterator it = m_mod_files.find(filename);
1951 if (it == m_mod_files.end()) {
1952 errorstream << "Client::getModFile(): File not found: \"" << filename
1953 << "\"" << std::endl;
1959 bool Client::registerModStorage(ModMetadata *storage)
1961 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1962 errorstream << "Unable to register same mod storage twice. Storage name: "
1963 << storage->getModName() << std::endl;
1967 m_mod_storages[storage->getModName()] = storage;
1971 void Client::unregisterModStorage(const std::string &name)
1973 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1974 m_mod_storages.find(name);
1975 if (it != m_mod_storages.end()) {
1976 // Save unconditionaly on unregistration
1977 it->second->save(getModStoragePath());
1978 m_mod_storages.erase(name);
1982 std::string Client::getModStoragePath() const
1984 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";