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();
161 infostream << "Client loading mods: ";
162 for (const ModSpec &mod : m_mods)
163 infostream << mod.name << " ";
164 infostream << std::endl;
166 // Load and run "mod" scripts
167 for (const ModSpec &mod : m_mods) {
168 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
169 throw ModError("Error loading mod \"" + mod.name +
170 "\": Mod name does not follow naming conventions: "
171 "Only characters [a-z0-9_] are allowed.");
173 scanModIntoMemory(mod.name, mod.path);
176 // Load and run "mod" scripts
177 for (const ModSpec &mod : m_mods)
178 m_script->loadModFromMemory(mod.name);
180 // Mods are done loading. Unlock callbacks
181 m_mods_loaded = true;
183 // Run a callback when mods are loaded
184 m_script->on_mods_loaded();
185 if (m_state == LC_Ready)
186 m_script->on_client_ready(m_env.getLocalPlayer());
188 m_script->on_camera_ready(m_camera);
191 bool Client::checkBuiltinIntegrity()
197 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
198 std::string mod_subpath)
200 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
201 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
202 for (const fs::DirListNode &j : mod) {
203 std::string filename = j.name;
205 scanModSubfolder(mod_name, mod_path, mod_subpath
206 + filename + DIR_DELIM);
209 std::replace( mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
210 m_mod_files[mod_name + ":" + mod_subpath + filename] = full_path + filename;
214 const std::string &Client::getBuiltinLuaPath()
216 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
220 const std::string &Client::getClientModsLuaPath()
222 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
223 return clientmods_dir;
226 const std::vector<ModSpec>& Client::getMods() const
228 static std::vector<ModSpec> client_modspec_temp;
229 return client_modspec_temp;
232 const ModSpec* Client::getModSpec(const std::string &modname) const
241 m_script->on_shutdown();
242 //request all client managed threads to stop
243 m_mesh_update_thread.stop();
244 // Save local server map
246 infostream << "Local map saving ended." << std::endl;
247 m_localdb->endSave();
254 bool Client::isShutdown()
256 return m_shutdown || !m_mesh_update_thread.isRunning();
266 m_mesh_update_thread.stop();
267 m_mesh_update_thread.wait();
268 while (!m_mesh_update_thread.m_queue_out.empty()) {
269 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
274 delete m_inventory_from_server;
276 // Delete detached inventories
277 for (auto &m_detached_inventorie : m_detached_inventories) {
278 delete m_detached_inventorie.second;
281 // cleanup 3d model meshes on client shutdown
282 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
283 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
286 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
290 delete m_media_downloader;
293 void Client::connect(Address address, bool is_local_server)
295 initLocalMapSaving(address, m_address_name, is_local_server);
297 m_con->SetTimeoutMs(0);
298 m_con->Connect(address);
301 void Client::step(float dtime)
307 m_animation_time += dtime;
308 if(m_animation_time > 60.0)
309 m_animation_time -= 60.0;
311 m_time_of_day_update_timer += dtime;
319 float &counter = m_packetcounter_timer;
325 infostream << "Client packetcounter (" << m_packetcounter_timer
327 m_packetcounter.print(infostream);
328 m_packetcounter.clear();
332 // UGLY hack to fix 2 second startup delay caused by non existent
333 // server client startup synchronization in local server or singleplayer mode
334 static bool initial_step = true;
336 initial_step = false;
338 else if(m_state == LC_Created) {
339 if (m_is_registration_confirmation_state) {
340 // Waiting confirmation
343 float &counter = m_connection_reinit_timer;
348 LocalPlayer *myplayer = m_env.getLocalPlayer();
349 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
351 sendInit(myplayer->getName());
354 // Not connected, return
359 Do stuff if connected
363 Run Map's timers and unload unused data
365 const float map_timer_and_unload_dtime = 5.25;
366 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
367 std::vector<v3s16> deleted_blocks;
368 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
369 g_settings->getFloat("client_unload_unused_data_timeout"),
370 g_settings->getS32("client_mapblock_limit"),
375 NOTE: This loop is intentionally iterated the way it is.
378 std::vector<v3s16>::iterator i = deleted_blocks.begin();
379 std::vector<v3s16> sendlist;
381 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
392 sendDeletedBlocks(sendlist);
394 if(i == deleted_blocks.end())
400 sendlist.push_back(*i);
406 Send pending messages on out chat queue
408 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
409 sendChatMessage(m_out_chat_queue.front());
410 m_out_chat_queue.pop();
416 // Control local player (0ms)
417 LocalPlayer *player = m_env.getLocalPlayer();
419 player->applyControl(dtime, &m_env);
423 m_sound->step(dtime);
428 while (m_env.hasClientEnvEvents()) {
429 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
431 if (envEvent.type == CEE_PLAYER_DAMAGE) {
432 u16 damage = envEvent.player_damage.amount;
434 if (envEvent.player_damage.send_to_server)
437 // Add to ClientEvent queue
438 ClientEvent *event = new ClientEvent();
439 event->type = CE_PLAYER_DAMAGE;
440 event->player_damage.amount = damage;
441 m_client_event_queue.push(event);
448 float &counter = m_avg_rtt_timer;
452 // connectedAndInitialized() is true, peer exists.
453 float avg_rtt = getRTT();
454 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
458 Send player position to server
461 float &counter = m_playerpos_send_timer;
463 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
471 Replace updated meshes
474 int num_processed_meshes = 0;
475 std::vector<v3s16> blocks_to_ack;
476 while (!m_mesh_update_thread.m_queue_out.empty())
478 num_processed_meshes++;
480 MinimapMapblock *minimap_mapblock = NULL;
481 bool do_mapper_update = true;
483 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
484 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
486 // Delete the old mesh
488 block->mesh = nullptr;
491 minimap_mapblock = r.mesh->moveMinimapMapblock();
492 if (minimap_mapblock == NULL)
493 do_mapper_update = false;
495 bool is_empty = true;
496 for (int l = 0; l < MAX_TILE_LAYERS; l++)
497 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
503 // Replace with the new mesh
504 block->mesh = r.mesh;
510 if (m_minimap && do_mapper_update)
511 m_minimap->addBlock(r.p, minimap_mapblock);
513 if (r.ack_block_to_server) {
514 if (blocks_to_ack.size() == 255) {
515 sendGotBlocks(blocks_to_ack);
516 blocks_to_ack.clear();
519 blocks_to_ack.emplace_back(r.p);
522 if (blocks_to_ack.size() > 0) {
523 // Acknowledge block(s)
524 sendGotBlocks(blocks_to_ack);
527 if (num_processed_meshes > 0)
528 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
534 if (m_media_downloader && m_media_downloader->isStarted()) {
535 m_media_downloader->step(this);
536 if (m_media_downloader->isDone()) {
537 delete m_media_downloader;
538 m_media_downloader = NULL;
543 If the server didn't update the inventory in a while, revert
544 the local inventory (so the player notices the lag problem
545 and knows something is wrong).
547 if (m_inventory_from_server) {
548 float interval = 10.0f;
549 float count_before = std::floor(m_inventory_from_server_age / interval);
551 m_inventory_from_server_age += dtime;
553 float count_after = std::floor(m_inventory_from_server_age / interval);
555 if (count_after != count_before) {
556 // Do this every <interval> seconds after TOCLIENT_INVENTORY
557 // Reset the locally changed inventory to the authoritative inventory
558 player->inventory = *m_inventory_from_server;
559 m_update_wielded_item = true;
564 Update positions of sounds attached to objects
567 for (auto &m_sounds_to_object : m_sounds_to_objects) {
568 int client_id = m_sounds_to_object.first;
569 u16 object_id = m_sounds_to_object.second;
570 ClientActiveObject *cao = m_env.getActiveObject(object_id);
573 m_sound->updateSoundPosition(client_id, cao->getPosition());
578 Handle removed remotely initiated sounds
580 m_removed_sounds_check_timer += dtime;
581 if(m_removed_sounds_check_timer >= 2.32) {
582 m_removed_sounds_check_timer = 0;
583 // Find removed sounds and clear references to them
584 std::vector<s32> removed_server_ids;
585 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
586 i != m_sounds_server_to_client.end();) {
587 s32 server_id = i->first;
588 int client_id = i->second;
590 if(!m_sound->soundExists(client_id)) {
591 m_sounds_server_to_client.erase(server_id);
592 m_sounds_client_to_server.erase(client_id);
593 m_sounds_to_objects.erase(client_id);
594 removed_server_ids.push_back(server_id);
599 if(!removed_server_ids.empty()) {
600 sendRemovedSounds(removed_server_ids);
604 m_mod_storage_save_timer -= dtime;
605 if (m_mod_storage_save_timer <= 0.0f) {
606 verbosestream << "Saving registered mod storages." << std::endl;
607 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
608 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
609 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
610 if (it->second->isModified()) {
611 it->second->save(getModStoragePath());
617 if (m_localdb && m_localdb_save_interval.step(dtime,
618 m_cache_save_interval)) {
619 m_localdb->endSave();
620 m_localdb->beginSave();
624 bool Client::loadMedia(const std::string &data, const std::string &filename)
626 // Silly irrlicht's const-incorrectness
627 Buffer<char> data_rw(data.c_str(), data.size());
631 const char *image_ext[] = {
632 ".png", ".jpg", ".bmp", ".tga",
633 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
636 name = removeStringEnd(filename, image_ext);
638 verbosestream<<"Client: Attempting to load image "
639 <<"file \""<<filename<<"\""<<std::endl;
641 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
642 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
644 // Create an irrlicht memory file
645 io::IReadFile *rfile = irrfs->createMemoryReadFile(
646 *data_rw, data_rw.getSize(), "_tempreadfile");
648 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
651 video::IImage *img = vdrv->createImageFromFile(rfile);
653 errorstream<<"Client: Cannot create image from data of "
654 <<"file \""<<filename<<"\""<<std::endl;
659 m_tsrc->insertSourceImage(filename, img);
665 const char *sound_ext[] = {
666 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
667 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
670 name = removeStringEnd(filename, sound_ext);
672 verbosestream<<"Client: Attempting to load sound "
673 <<"file \""<<filename<<"\""<<std::endl;
674 m_sound->loadSoundData(name, data);
678 const char *model_ext[] = {
679 ".x", ".b3d", ".md2", ".obj",
683 name = removeStringEnd(filename, model_ext);
685 verbosestream<<"Client: Storing model into memory: "
686 <<"\""<<filename<<"\""<<std::endl;
687 if(m_mesh_data.count(filename))
688 errorstream<<"Multiple models with name \""<<filename.c_str()
689 <<"\" found; replacing previous model"<<std::endl;
690 m_mesh_data[filename] = data;
694 const char *translate_ext[] = {
697 name = removeStringEnd(filename, translate_ext);
699 verbosestream << "Client: Loading translation: "
700 << "\"" << filename << "\"" << std::endl;
701 g_translations->loadTranslation(data);
705 errorstream << "Client: Don't know how to load file \""
706 << filename << "\"" << std::endl;
710 // Virtual methods from con::PeerHandler
711 void Client::peerAdded(con::Peer *peer)
713 infostream << "Client::peerAdded(): peer->id="
714 << peer->id << std::endl;
716 void Client::deletingPeer(con::Peer *peer, bool timeout)
718 infostream << "Client::deletingPeer(): "
719 "Server Peer is getting deleted "
720 << "(timeout=" << timeout << ")" << std::endl;
723 m_access_denied = true;
724 m_access_denied_reason = gettext("Connection timed out.");
730 u16 number of files requested
736 void Client::request_media(const std::vector<std::string> &file_requests)
738 std::ostringstream os(std::ios_base::binary);
739 writeU16(os, TOSERVER_REQUEST_MEDIA);
740 size_t file_requests_size = file_requests.size();
742 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
744 // Packet dynamicly resized
745 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
747 pkt << (u16) (file_requests_size & 0xFFFF);
749 for (const std::string &file_request : file_requests) {
755 infostream << "Client: Sending media request list to server ("
756 << file_requests.size() << " files. packet size)" << std::endl;
759 void Client::initLocalMapSaving(const Address &address,
760 const std::string &hostname,
761 bool is_local_server)
763 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
767 const std::string world_path = porting::path_user
768 + DIR_DELIM + "worlds"
769 + DIR_DELIM + "server_"
770 + hostname + "_" + std::to_string(address.getPort());
772 fs::CreateAllDirs(world_path);
774 m_localdb = new MapDatabaseSQLite3(world_path);
775 m_localdb->beginSave();
776 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
779 void Client::ReceiveAll()
781 u64 start_ms = porting::getTimeMs();
784 // Limit time even if there would be huge amounts of data to
786 if(porting::getTimeMs() > start_ms + 100)
791 g_profiler->graphAdd("client_received_packets", 1);
793 catch(con::NoIncomingDataException &e) {
796 catch(con::InvalidIncomingDataException &e) {
797 infostream<<"Client::ReceiveAll(): "
798 "InvalidIncomingDataException: what()="
799 <<e.what()<<std::endl;
804 void Client::Receive()
807 m_con->Receive(&pkt);
811 inline void Client::handleCommand(NetworkPacket* pkt)
813 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
814 (this->*opHandle.handler)(pkt);
818 sender_peer_id given to this shall be quaranteed to be a valid peer
820 void Client::ProcessData(NetworkPacket *pkt)
822 ToClientCommand command = (ToClientCommand) pkt->getCommand();
823 u32 sender_peer_id = pkt->getPeerId();
825 //infostream<<"Client: received command="<<command<<std::endl;
826 m_packetcounter.add((u16)command);
829 If this check is removed, be sure to change the queue
830 system to know the ids
832 if(sender_peer_id != PEER_ID_SERVER) {
833 infostream << "Client::ProcessData(): Discarding data not "
834 "coming from server: peer_id=" << sender_peer_id
839 // Command must be handled into ToClientCommandHandler
840 if (command >= TOCLIENT_NUM_MSG_TYPES) {
841 infostream << "Client: Ignoring unknown command "
842 << command << std::endl;
847 * Those packets are handled before m_server_ser_ver is set, it's normal
848 * But we must use the new ToClientConnectionState in the future,
851 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
856 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
857 infostream << "Client: Server serialization"
858 " format invalid or not initialized."
859 " Skipping incoming command=" << command << std::endl;
864 Handle runtime commands
870 void Client::Send(NetworkPacket* pkt)
872 m_con->Send(PEER_ID_SERVER,
873 serverCommandFactoryTable[pkt->getCommand()].channel,
875 serverCommandFactoryTable[pkt->getCommand()].reliable);
878 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
879 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
881 v3f pf = myplayer->getPosition() * 100;
882 v3f sf = myplayer->getSpeed() * 100;
883 s32 pitch = myplayer->getPitch() * 100;
884 s32 yaw = myplayer->getYaw() * 100;
885 u32 keyPressed = myplayer->keyPressed;
886 // scaled by 80, so that pi can fit into a u8
887 u8 fov = clientMap->getCameraFov() * 80;
888 u8 wanted_range = MYMIN(255,
889 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
891 v3s32 position(pf.X, pf.Y, pf.Z);
892 v3s32 speed(sf.X, sf.Y, sf.Z);
896 [0] v3s32 position*100
898 [12+12] s32 pitch*100
899 [12+12+4] s32 yaw*100
900 [12+12+4+4] u32 keyPressed
901 [12+12+4+4+4] u8 fov*80
902 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
904 *pkt << position << speed << pitch << yaw << keyPressed;
905 *pkt << fov << wanted_range;
908 void Client::interact(InteractAction action, const PointedThing& pointed)
910 if(m_state != LC_Ready) {
911 errorstream << "Client::interact() "
912 "Canceled (not connected)"
917 LocalPlayer *myplayer = m_env.getLocalPlayer();
918 if (myplayer == NULL)
925 [5] u32 length of the next item (plen)
926 [9] serialized PointedThing
927 [9 + plen] player position information
930 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
933 pkt << myplayer->getWieldIndex();
935 std::ostringstream tmp_os(std::ios::binary);
936 pointed.serialize(tmp_os);
938 pkt.putLongString(tmp_os.str());
940 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
945 void Client::deleteAuthData()
950 switch (m_chosen_auth_mech) {
951 case AUTH_MECHANISM_FIRST_SRP:
953 case AUTH_MECHANISM_SRP:
954 case AUTH_MECHANISM_LEGACY_PASSWORD:
955 srp_user_delete((SRPUser *) m_auth_data);
958 case AUTH_MECHANISM_NONE:
961 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
965 AuthMechanism Client::choseAuthMech(const u32 mechs)
967 if (mechs & AUTH_MECHANISM_SRP)
968 return AUTH_MECHANISM_SRP;
970 if (mechs & AUTH_MECHANISM_FIRST_SRP)
971 return AUTH_MECHANISM_FIRST_SRP;
973 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
974 return AUTH_MECHANISM_LEGACY_PASSWORD;
976 return AUTH_MECHANISM_NONE;
979 void Client::sendInit(const std::string &playerName)
981 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
983 // we don't support network compression yet
984 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
986 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
987 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
993 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
995 m_chosen_auth_mech = chosen_auth_mechanism;
996 m_is_registration_confirmation_state = true;
999 void Client::confirmRegistration()
1001 m_is_registration_confirmation_state = false;
1002 startAuth(m_chosen_auth_mech);
1005 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1007 m_chosen_auth_mech = chosen_auth_mechanism;
1009 switch (chosen_auth_mechanism) {
1010 case AUTH_MECHANISM_FIRST_SRP: {
1011 // send srp verifier to server
1012 std::string verifier;
1014 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1017 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1018 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1023 case AUTH_MECHANISM_SRP:
1024 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1027 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1028 m_password = translate_password(getPlayerName(), m_password);
1032 std::string playername_u = lowercase(getPlayerName());
1033 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1034 getPlayerName().c_str(), playername_u.c_str(),
1035 (const unsigned char *) m_password.c_str(),
1036 m_password.length(), NULL, NULL);
1039 SRP_Result res = srp_user_start_authentication(
1040 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1041 (unsigned char **) &bytes_A, &len_A);
1042 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1044 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1045 resp_pkt << std::string(bytes_A, len_A) << based_on;
1049 case AUTH_MECHANISM_NONE:
1050 break; // not handled in this method
1054 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1056 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1058 pkt << (u8) blocks.size();
1060 for (const v3s16 &block : blocks) {
1067 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1069 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1070 pkt << (u8) blocks.size();
1071 for (const v3s16 &block : blocks)
1077 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1079 size_t server_ids = soundList.size();
1080 assert(server_ids <= 0xFFFF);
1082 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1084 pkt << (u16) (server_ids & 0xFFFF);
1086 for (int sound_id : soundList)
1092 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1093 const StringMap &fields)
1095 size_t fields_size = fields.size();
1097 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1099 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1101 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1103 StringMap::const_iterator it;
1104 for (it = fields.begin(); it != fields.end(); ++it) {
1105 const std::string &name = it->first;
1106 const std::string &value = it->second;
1108 pkt.putLongString(value);
1114 void Client::sendInventoryFields(const std::string &formname,
1115 const StringMap &fields)
1117 size_t fields_size = fields.size();
1118 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1120 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1121 pkt << formname << (u16) (fields_size & 0xFFFF);
1123 StringMap::const_iterator it;
1124 for (it = fields.begin(); it != fields.end(); ++it) {
1125 const std::string &name = it->first;
1126 const std::string &value = it->second;
1128 pkt.putLongString(value);
1134 void Client::sendInventoryAction(InventoryAction *a)
1136 std::ostringstream os(std::ios_base::binary);
1141 std::string s = os.str();
1143 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1144 pkt.putRawString(s.c_str(),s.size());
1149 bool Client::canSendChatMessage() const
1151 u32 now = time(NULL);
1152 float time_passed = now - m_last_chat_message_sent;
1154 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1155 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1157 if (virt_chat_message_allowance < 1.0f)
1163 void Client::sendChatMessage(const std::wstring &message)
1165 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1166 if (canSendChatMessage()) {
1167 u32 now = time(NULL);
1168 float time_passed = now - m_last_chat_message_sent;
1169 m_last_chat_message_sent = time(NULL);
1171 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1172 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1173 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1175 m_chat_message_allowance -= 1.0f;
1177 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1182 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1183 m_out_chat_queue.push(message);
1185 infostream << "Could not queue chat message because maximum out chat queue size ("
1186 << max_queue_size << ") is reached." << std::endl;
1190 void Client::clearOutChatQueue()
1192 m_out_chat_queue = std::queue<std::wstring>();
1195 void Client::sendChangePassword(const std::string &oldpassword,
1196 const std::string &newpassword)
1198 LocalPlayer *player = m_env.getLocalPlayer();
1202 // get into sudo mode and then send new password to server
1203 m_password = oldpassword;
1204 m_new_password = newpassword;
1205 startAuth(choseAuthMech(m_sudo_auth_methods));
1209 void Client::sendDamage(u16 damage)
1211 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1216 void Client::sendRespawn()
1218 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1222 void Client::sendReady()
1224 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1225 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1227 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1228 << (u8) 0 << (u16) strlen(g_version_hash);
1230 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1231 pkt << (u16)FORMSPEC_API_VERSION;
1235 void Client::sendPlayerPos()
1237 LocalPlayer *myplayer = m_env.getLocalPlayer();
1241 ClientMap &map = m_env.getClientMap();
1243 u8 camera_fov = map.getCameraFov();
1244 u8 wanted_range = map.getControl().wanted_range;
1246 // Save bandwidth by only updating position when
1247 // player is not dead and something changed
1249 if (m_activeobjects_received && myplayer->isDead())
1253 myplayer->last_position == myplayer->getPosition() &&
1254 myplayer->last_speed == myplayer->getSpeed() &&
1255 myplayer->last_pitch == myplayer->getPitch() &&
1256 myplayer->last_yaw == myplayer->getYaw() &&
1257 myplayer->last_keyPressed == myplayer->keyPressed &&
1258 myplayer->last_camera_fov == camera_fov &&
1259 myplayer->last_wanted_range == wanted_range)
1262 myplayer->last_position = myplayer->getPosition();
1263 myplayer->last_speed = myplayer->getSpeed();
1264 myplayer->last_pitch = myplayer->getPitch();
1265 myplayer->last_yaw = myplayer->getYaw();
1266 myplayer->last_keyPressed = myplayer->keyPressed;
1267 myplayer->last_camera_fov = camera_fov;
1268 myplayer->last_wanted_range = wanted_range;
1270 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1272 writePlayerPos(myplayer, &map, &pkt);
1277 void Client::removeNode(v3s16 p)
1279 std::map<v3s16, MapBlock*> modified_blocks;
1282 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1284 catch(InvalidPositionException &e) {
1287 for (const auto &modified_block : modified_blocks) {
1288 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1293 * Helper function for Client Side Modding
1294 * CSM restrictions are applied there, this should not be used for core engine
1296 * @param is_valid_position
1299 MapNode Client::getNode(v3s16 p, bool *is_valid_position)
1301 if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1302 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1303 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1304 *is_valid_position = false;
1308 return m_env.getMap().getNode(p, is_valid_position);
1311 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1313 //TimeTaker timer1("Client::addNode()");
1315 std::map<v3s16, MapBlock*> modified_blocks;
1318 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1319 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1321 catch(InvalidPositionException &e) {
1324 for (const auto &modified_block : modified_blocks) {
1325 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1329 void Client::setPlayerControl(PlayerControl &control)
1331 LocalPlayer *player = m_env.getLocalPlayer();
1333 player->control = control;
1336 void Client::setPlayerItem(u16 item)
1338 m_env.getLocalPlayer()->setWieldIndex(item);
1339 m_update_wielded_item = true;
1341 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1346 // Returns true once after the inventory of the local player
1347 // has been updated from the server.
1348 bool Client::updateWieldedItem()
1350 if (!m_update_wielded_item)
1353 m_update_wielded_item = false;
1355 LocalPlayer *player = m_env.getLocalPlayer();
1357 if (auto *list = player->inventory.getList("main"))
1358 list->setModified(false);
1359 if (auto *list = player->inventory.getList("hand"))
1360 list->setModified(false);
1365 Inventory* Client::getInventory(const InventoryLocation &loc)
1368 case InventoryLocation::UNDEFINED:
1371 case InventoryLocation::CURRENT_PLAYER:
1373 LocalPlayer *player = m_env.getLocalPlayer();
1375 return &player->inventory;
1378 case InventoryLocation::PLAYER:
1380 // Check if we are working with local player inventory
1381 LocalPlayer *player = m_env.getLocalPlayer();
1382 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1384 return &player->inventory;
1387 case InventoryLocation::NODEMETA:
1389 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1392 return meta->getInventory();
1395 case InventoryLocation::DETACHED:
1397 if (m_detached_inventories.count(loc.name) == 0)
1399 return m_detached_inventories[loc.name];
1403 FATAL_ERROR("Invalid inventory location type.");
1409 void Client::inventoryAction(InventoryAction *a)
1412 Send it to the server
1414 sendInventoryAction(a);
1417 Predict some local inventory changes
1419 a->clientApply(this, this);
1425 float Client::getAnimationTime()
1427 return m_animation_time;
1430 int Client::getCrackLevel()
1432 return m_crack_level;
1435 v3s16 Client::getCrackPos()
1440 void Client::setCrack(int level, v3s16 pos)
1442 int old_crack_level = m_crack_level;
1443 v3s16 old_crack_pos = m_crack_pos;
1445 m_crack_level = level;
1448 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1451 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1453 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1456 addUpdateMeshTaskForNode(pos, false, true);
1462 LocalPlayer *player = m_env.getLocalPlayer();
1467 bool Client::getChatMessage(std::wstring &res)
1469 if (m_chat_queue.empty())
1472 ChatMessage *chatMessage = m_chat_queue.front();
1477 switch (chatMessage->type) {
1478 case CHATMESSAGE_TYPE_RAW:
1479 case CHATMESSAGE_TYPE_ANNOUNCE:
1480 case CHATMESSAGE_TYPE_SYSTEM:
1481 res = chatMessage->message;
1483 case CHATMESSAGE_TYPE_NORMAL: {
1484 if (!chatMessage->sender.empty())
1485 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1487 res = chatMessage->message;
1498 void Client::typeChatMessage(const std::wstring &message)
1500 // Discard empty line
1501 if (message.empty())
1504 // If message was consumed by script API, don't send it to server
1505 if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1509 sendChatMessage(message);
1512 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1514 // Check if the block exists to begin with. In the case when a non-existing
1515 // neighbor is automatically added, it may not. In that case we don't want
1516 // to tell the mesh update thread about it.
1517 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1521 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1524 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1527 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1529 catch(InvalidPositionException &e){}
1532 for (int i=0;i<6;i++)
1535 v3s16 p = blockpos + g_6dirs[i];
1536 addUpdateMeshTask(p, false, urgent);
1538 catch(InvalidPositionException &e){}
1542 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1546 infostream<<"Client::addUpdateMeshTaskForNode(): "
1547 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1551 v3s16 blockpos = getNodeBlockPos(nodepos);
1552 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1555 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1557 catch(InvalidPositionException &e) {}
1560 if(nodepos.X == blockpos_relative.X){
1562 v3s16 p = blockpos + v3s16(-1,0,0);
1563 addUpdateMeshTask(p, false, urgent);
1565 catch(InvalidPositionException &e){}
1568 if(nodepos.Y == blockpos_relative.Y){
1570 v3s16 p = blockpos + v3s16(0,-1,0);
1571 addUpdateMeshTask(p, false, urgent);
1573 catch(InvalidPositionException &e){}
1576 if(nodepos.Z == blockpos_relative.Z){
1578 v3s16 p = blockpos + v3s16(0,0,-1);
1579 addUpdateMeshTask(p, false, urgent);
1581 catch(InvalidPositionException &e){}
1585 ClientEvent *Client::getClientEvent()
1587 FATAL_ERROR_IF(m_client_event_queue.empty(),
1588 "Cannot getClientEvent, queue is empty.");
1590 ClientEvent *event = m_client_event_queue.front();
1591 m_client_event_queue.pop();
1595 bool Client::connectedToServer()
1597 return m_con->Connected();
1600 const Address Client::getServerAddress()
1602 return m_con->GetPeerAddress(PEER_ID_SERVER);
1605 float Client::mediaReceiveProgress()
1607 if (m_media_downloader)
1608 return m_media_downloader->getProgress();
1610 return 1.0; // downloader only exists when not yet done
1613 typedef struct TextureUpdateArgs {
1614 gui::IGUIEnvironment *guienv;
1617 const wchar_t* text_base;
1618 ITextureSource *tsrc;
1619 } TextureUpdateArgs;
1621 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1623 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1624 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1626 // update the loading menu -- if neccessary
1627 bool do_draw = false;
1628 u64 time_ms = targs->last_time_ms;
1629 if (cur_percent != targs->last_percent) {
1630 targs->last_percent = cur_percent;
1631 time_ms = porting::getTimeMs();
1632 // only draw when the user will notice something:
1633 do_draw = (time_ms - targs->last_time_ms > 100);
1637 targs->last_time_ms = time_ms;
1638 std::basic_stringstream<wchar_t> strm;
1639 strm << targs->text_base << " " << targs->last_percent << "%...";
1640 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1641 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1645 void Client::afterContentReceived()
1647 infostream<<"Client::afterContentReceived() started"<<std::endl;
1648 assert(m_itemdef_received); // pre-condition
1649 assert(m_nodedef_received); // pre-condition
1650 assert(mediaReceived()); // pre-condition
1652 const wchar_t* text = wgettext("Loading textures...");
1654 // Clear cached pre-scaled 2D GUI images, as this cache
1655 // might have images with the same name but different
1656 // content from previous sessions.
1657 guiScalingCacheClear();
1659 // Rebuild inherited images and recreate textures
1660 infostream<<"- Rebuilding images and textures"<<std::endl;
1661 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1662 m_tsrc->rebuildImagesAndTextures();
1666 infostream<<"- Rebuilding shaders"<<std::endl;
1667 text = wgettext("Rebuilding shaders...");
1668 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1669 m_shsrc->rebuildShaders();
1672 // Update node aliases
1673 infostream<<"- Updating node aliases"<<std::endl;
1674 text = wgettext("Initializing nodes...");
1675 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1676 m_nodedef->updateAliases(m_itemdef);
1677 for (const auto &path : getTextureDirs())
1678 m_nodedef->applyTextureOverrides(path + DIR_DELIM + "override.txt");
1679 m_nodedef->setNodeRegistrationStatus(true);
1680 m_nodedef->runNodeResolveCallbacks();
1683 // Update node textures and assign shaders to each tile
1684 infostream<<"- Updating node textures"<<std::endl;
1685 TextureUpdateArgs tu_args;
1686 tu_args.guienv = guienv;
1687 tu_args.last_time_ms = porting::getTimeMs();
1688 tu_args.last_percent = 0;
1689 tu_args.text_base = wgettext("Initializing nodes");
1690 tu_args.tsrc = m_tsrc;
1691 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1692 delete[] tu_args.text_base;
1694 // Start mesh update thread after setting up content definitions
1695 infostream<<"- Starting mesh update thread"<<std::endl;
1696 m_mesh_update_thread.start();
1702 m_script->on_client_ready(m_env.getLocalPlayer());
1704 text = wgettext("Done!");
1705 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1706 infostream<<"Client::afterContentReceived() done"<<std::endl;
1710 float Client::getRTT()
1712 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1715 float Client::getCurRate()
1717 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1718 m_con->getLocalStat(con::CUR_DL_RATE));
1721 void Client::makeScreenshot()
1723 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1724 irr::video::IImage* const raw_image = driver->createScreenShot();
1729 time_t t = time(NULL);
1730 struct tm *tm = localtime(&t);
1732 char timetstamp_c[64];
1733 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1735 std::string filename_base = g_settings->get("screenshot_path")
1737 + std::string("screenshot_")
1738 + std::string(timetstamp_c);
1739 std::string filename_ext = "." + g_settings->get("screenshot_format");
1740 std::string filename;
1742 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1743 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1745 // Try to find a unique filename
1746 unsigned serial = 0;
1748 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1749 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1750 std::ifstream tmp(filename.c_str());
1752 break; // File did not apparently exist, we'll go with it
1756 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1757 infostream << "Could not find suitable filename for screenshot" << std::endl;
1759 irr::video::IImage* const image =
1760 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1763 raw_image->copyTo(image);
1765 std::ostringstream sstr;
1766 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1767 sstr << "Saved screenshot to '" << filename << "'";
1769 sstr << "Failed to save screenshot '" << filename << "'";
1771 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1772 narrow_to_wide(sstr.str())));
1773 infostream << sstr.str() << std::endl;
1781 bool Client::shouldShowMinimap() const
1783 return !m_minimap_disabled_by_server;
1786 void Client::pushToEventQueue(ClientEvent *event)
1788 m_client_event_queue.push(event);
1791 void Client::showMinimap(const bool show)
1793 m_game_ui->showMinimap(show);
1796 // IGameDef interface
1798 IItemDefManager* Client::getItemDefManager()
1802 const NodeDefManager* Client::getNodeDefManager()
1806 ICraftDefManager* Client::getCraftDefManager()
1809 //return m_craftdef;
1811 ITextureSource* Client::getTextureSource()
1815 IShaderSource* Client::getShaderSource()
1820 u16 Client::allocateUnknownNodeId(const std::string &name)
1822 errorstream << "Client::allocateUnknownNodeId(): "
1823 << "Client cannot allocate node IDs" << std::endl;
1824 FATAL_ERROR("Client allocated unknown node");
1826 return CONTENT_IGNORE;
1828 ISoundManager* Client::getSoundManager()
1832 MtEventManager* Client::getEventManager()
1837 ParticleManager* Client::getParticleManager()
1839 return &m_particle_manager;
1842 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1844 StringMap::const_iterator it = m_mesh_data.find(filename);
1845 if (it == m_mesh_data.end()) {
1846 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1847 << "\"" << std::endl;
1850 const std::string &data = it->second;
1852 // Create the mesh, remove it from cache and return it
1853 // This allows unique vertex colors and other properties for each instance
1854 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1855 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1856 *data_rw, data_rw.getSize(), filename.c_str());
1857 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1859 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1863 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1867 const std::string* Client::getModFile(const std::string &filename)
1869 StringMap::const_iterator it = m_mod_files.find(filename);
1870 if (it == m_mod_files.end()) {
1871 errorstream << "Client::getModFile(): File not found: \"" << filename
1872 << "\"" << std::endl;
1878 bool Client::registerModStorage(ModMetadata *storage)
1880 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1881 errorstream << "Unable to register same mod storage twice. Storage name: "
1882 << storage->getModName() << std::endl;
1886 m_mod_storages[storage->getModName()] = storage;
1890 void Client::unregisterModStorage(const std::string &name)
1892 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1893 m_mod_storages.find(name);
1894 if (it != m_mod_storages.end()) {
1895 // Save unconditionaly on unregistration
1896 it->second->save(getModStoragePath());
1897 m_mod_storages.erase(name);
1901 std::string Client::getModStoragePath() const
1903 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1910 bool Client::joinModChannel(const std::string &channel)
1912 if (m_modchannel_mgr->channelRegistered(channel))
1915 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
1919 m_modchannel_mgr->joinChannel(channel, 0);
1923 bool Client::leaveModChannel(const std::string &channel)
1925 if (!m_modchannel_mgr->channelRegistered(channel))
1928 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
1932 m_modchannel_mgr->leaveChannel(channel, 0);
1936 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
1938 if (!m_modchannel_mgr->canWriteOnChannel(channel))
1941 if (message.size() > STRING_MAX_LEN) {
1942 warningstream << "ModChannel message too long, dropping before sending "
1943 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
1944 << channel << ")" << std::endl;
1948 // @TODO: do some client rate limiting
1949 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
1950 pkt << channel << message;
1955 ModChannel* Client::getModChannel(const std::string &channel)
1957 return m_modchannel_mgr->getModChannel(channel);