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/tile.h"
34 #include "util/auth.h"
35 #include "util/directiontables.h"
36 #include "util/pointedthing.h"
37 #include "util/serialize.h"
38 #include "util/string.h"
41 #include "mapblock_mesh.h"
44 #include "modchannels.h"
49 #include "clientmap.h"
50 #include "clientmedia.h"
52 #include "database/database-sqlite3.h"
53 #include "serialization.h"
54 #include "guiscalingfilter.h"
55 #include "script/scripting_client.h"
57 #include "chatmessage.h"
58 #include "translation.h"
60 extern gui::IGUIEnvironment* guienv;
67 const char *playername,
68 const std::string &password,
69 const std::string &address_name,
70 MapDrawControl &control,
71 IWritableTextureSource *tsrc,
72 IWritableShaderSource *shsrc,
73 IWritableItemDefManager *itemdef,
74 NodeDefManager *nodedef,
76 MtEventManager *event,
86 m_mesh_update_thread(this),
88 new ClientMap(this, control, 666),
91 m_particle_manager(&m_env),
92 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
93 m_address_name(address_name),
94 m_server_ser_ver(SER_FMT_VER_INVALID),
95 m_last_chat_message_sent(time(NULL)),
97 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
98 m_media_downloader(new ClientMediaDownloader()),
101 m_modchannel_mgr(new ModChannelMgr())
104 m_env.setLocalPlayer(new LocalPlayer(this, playername));
106 if (g_settings->getBool("enable_minimap")) {
107 m_minimap = new Minimap(this);
109 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
111 m_modding_enabled = g_settings->getBool("enable_client_modding");
112 m_script = new ClientScripting(this);
113 m_env.setScript(m_script);
114 m_script->setEnv(&m_env);
117 void Client::loadBuiltin()
120 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
122 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
125 void Client::loadMods()
127 // Don't permit to load mods twice
132 // If modding is not enabled or flavour disable it, don't load mods, just builtin
133 if (!m_modding_enabled) {
134 warningstream << "Client side mods are disabled by configuration." << std::endl;
138 if (checkCSMFlavourLimit(CSMFlavourLimit::CSM_FL_LOAD_CLIENT_MODS)) {
139 warningstream << "Client side mods are disabled by server." << std::endl;
140 // If mods loading is disabled and builtin integrity is wrong, disconnect user.
141 if (!checkBuiltinIntegrity()) {
142 // @TODO disconnect user
147 ClientModConfiguration modconf(getClientModsLuaPath());
148 m_mods = modconf.getMods();
149 // complain about mods with unsatisfied dependencies
150 if (!modconf.isConsistent()) {
151 modconf.printUnsatisfiedModsError();
155 infostream << "Client Loading mods: ";
156 for (const ModSpec &mod : m_mods)
157 infostream << mod.name << " ";
158 infostream << std::endl;
160 // Load and run "mod" scripts
161 for (const ModSpec &mod : m_mods) {
162 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
163 throw ModError("Error loading mod \"" + mod.name +
164 "\": Mod name does not follow naming conventions: "
165 "Only characters [a-z0-9_] are allowed.");
167 scanModIntoMemory(mod.name, mod.path);
170 // Load and run "mod" scripts
171 for (const ModSpec &mod : m_mods)
172 m_script->loadModFromMemory(mod.name);
174 m_mods_loaded = true;
177 bool Client::checkBuiltinIntegrity()
183 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
184 std::string mod_subpath)
186 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
187 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
188 for (const fs::DirListNode &j : mod) {
189 std::string filename = j.name;
191 scanModSubfolder(mod_name, mod_path, mod_subpath
192 + filename + DIR_DELIM);
195 std::replace( mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
196 m_mod_files[mod_name + ":" + mod_subpath + filename] = full_path + filename;
200 const std::string &Client::getBuiltinLuaPath()
202 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
206 const std::string &Client::getClientModsLuaPath()
208 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
209 return clientmods_dir;
212 const std::vector<ModSpec>& Client::getMods() const
214 static std::vector<ModSpec> client_modspec_temp;
215 return client_modspec_temp;
218 const ModSpec* Client::getModSpec(const std::string &modname) const
226 // Don't disable this part when modding is disabled, it's used in builtin
227 m_script->on_shutdown();
228 //request all client managed threads to stop
229 m_mesh_update_thread.stop();
230 // Save local server map
232 infostream << "Local map saving ended." << std::endl;
233 m_localdb->endSave();
239 bool Client::isShutdown()
241 return m_shutdown || !m_mesh_update_thread.isRunning();
249 m_mesh_update_thread.stop();
250 m_mesh_update_thread.wait();
251 while (!m_mesh_update_thread.m_queue_out.empty()) {
252 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
257 delete m_inventory_from_server;
259 // Delete detached inventories
260 for (auto &m_detached_inventorie : m_detached_inventories) {
261 delete m_detached_inventorie.second;
264 // cleanup 3d model meshes on client shutdown
265 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
266 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
269 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
275 void Client::connect(Address address, bool is_local_server)
277 initLocalMapSaving(address, m_address_name, is_local_server);
279 m_con->SetTimeoutMs(0);
280 m_con->Connect(address);
283 void Client::step(float dtime)
289 m_animation_time += dtime;
290 if(m_animation_time > 60.0)
291 m_animation_time -= 60.0;
293 m_time_of_day_update_timer += dtime;
301 float &counter = m_packetcounter_timer;
307 infostream << "Client packetcounter (" << m_packetcounter_timer
309 m_packetcounter.print(infostream);
310 m_packetcounter.clear();
314 // UGLY hack to fix 2 second startup delay caused by non existent
315 // server client startup synchronization in local server or singleplayer mode
316 static bool initial_step = true;
318 initial_step = false;
320 else if(m_state == LC_Created) {
321 if (m_is_registration_confirmation_state) {
322 // Waiting confirmation
325 float &counter = m_connection_reinit_timer;
330 LocalPlayer *myplayer = m_env.getLocalPlayer();
331 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
333 sendInit(myplayer->getName());
336 // Not connected, return
341 Do stuff if connected
345 Run Map's timers and unload unused data
347 const float map_timer_and_unload_dtime = 5.25;
348 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
349 ScopeProfiler sp(g_profiler, "Client: map timer and unload");
350 std::vector<v3s16> deleted_blocks;
351 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
352 g_settings->getFloat("client_unload_unused_data_timeout"),
353 g_settings->getS32("client_mapblock_limit"),
358 NOTE: This loop is intentionally iterated the way it is.
361 std::vector<v3s16>::iterator i = deleted_blocks.begin();
362 std::vector<v3s16> sendlist;
364 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
375 sendDeletedBlocks(sendlist);
377 if(i == deleted_blocks.end())
383 sendlist.push_back(*i);
389 Send pending messages on out chat queue
391 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
392 sendChatMessage(m_out_chat_queue.front());
393 m_out_chat_queue.pop();
399 // Control local player (0ms)
400 LocalPlayer *player = m_env.getLocalPlayer();
402 player->applyControl(dtime, &m_env);
406 m_sound->step(dtime);
411 while (m_env.hasClientEnvEvents()) {
412 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
414 if (envEvent.type == CEE_PLAYER_DAMAGE) {
415 u8 damage = envEvent.player_damage.amount;
417 if (envEvent.player_damage.send_to_server)
420 // Add to ClientEvent queue
421 ClientEvent *event = new ClientEvent();
422 event->type = CE_PLAYER_DAMAGE;
423 event->player_damage.amount = damage;
424 m_client_event_queue.push(event);
431 float &counter = m_avg_rtt_timer;
435 // connectedAndInitialized() is true, peer exists.
436 float avg_rtt = getRTT();
437 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
441 Send player position to server
444 float &counter = m_playerpos_send_timer;
446 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
454 Replace updated meshes
457 int num_processed_meshes = 0;
458 while (!m_mesh_update_thread.m_queue_out.empty())
460 num_processed_meshes++;
462 MinimapMapblock *minimap_mapblock = NULL;
463 bool do_mapper_update = true;
465 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
466 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
468 // Delete the old mesh
470 block->mesh = nullptr;
473 minimap_mapblock = r.mesh->moveMinimapMapblock();
474 if (minimap_mapblock == NULL)
475 do_mapper_update = false;
477 bool is_empty = true;
478 for (int l = 0; l < MAX_TILE_LAYERS; l++)
479 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
485 // Replace with the new mesh
486 block->mesh = r.mesh;
492 if (m_minimap && do_mapper_update)
493 m_minimap->addBlock(r.p, minimap_mapblock);
495 if (r.ack_block_to_server) {
505 if (num_processed_meshes > 0)
506 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
512 if (m_media_downloader && m_media_downloader->isStarted()) {
513 m_media_downloader->step(this);
514 if (m_media_downloader->isDone()) {
515 delete m_media_downloader;
516 m_media_downloader = NULL;
521 If the server didn't update the inventory in a while, revert
522 the local inventory (so the player notices the lag problem
523 and knows something is wrong).
525 if(m_inventory_from_server)
527 float interval = 10.0;
528 float count_before = floor(m_inventory_from_server_age / interval);
530 m_inventory_from_server_age += dtime;
532 float count_after = floor(m_inventory_from_server_age / interval);
534 if(count_after != count_before)
536 // Do this every <interval> seconds after TOCLIENT_INVENTORY
537 // Reset the locally changed inventory to the authoritative inventory
538 LocalPlayer *player = m_env.getLocalPlayer();
539 player->inventory = *m_inventory_from_server;
540 m_inventory_updated = true;
545 Update positions of sounds attached to objects
548 for (auto &m_sounds_to_object : m_sounds_to_objects) {
549 int client_id = m_sounds_to_object.first;
550 u16 object_id = m_sounds_to_object.second;
551 ClientActiveObject *cao = m_env.getActiveObject(object_id);
554 m_sound->updateSoundPosition(client_id, cao->getPosition());
559 Handle removed remotely initiated sounds
561 m_removed_sounds_check_timer += dtime;
562 if(m_removed_sounds_check_timer >= 2.32) {
563 m_removed_sounds_check_timer = 0;
564 // Find removed sounds and clear references to them
565 std::vector<s32> removed_server_ids;
566 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
567 i != m_sounds_server_to_client.end();) {
568 s32 server_id = i->first;
569 int client_id = i->second;
571 if(!m_sound->soundExists(client_id)) {
572 m_sounds_server_to_client.erase(server_id);
573 m_sounds_client_to_server.erase(client_id);
574 m_sounds_to_objects.erase(client_id);
575 removed_server_ids.push_back(server_id);
580 if(!removed_server_ids.empty()) {
581 sendRemovedSounds(removed_server_ids);
585 m_mod_storage_save_timer -= dtime;
586 if (m_mod_storage_save_timer <= 0.0f) {
587 verbosestream << "Saving registered mod storages." << std::endl;
588 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
589 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
590 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
591 if (it->second->isModified()) {
592 it->second->save(getModStoragePath());
598 if (m_localdb && m_localdb_save_interval.step(dtime,
599 m_cache_save_interval)) {
600 m_localdb->endSave();
601 m_localdb->beginSave();
605 bool Client::loadMedia(const std::string &data, const std::string &filename)
607 // Silly irrlicht's const-incorrectness
608 Buffer<char> data_rw(data.c_str(), data.size());
612 const char *image_ext[] = {
613 ".png", ".jpg", ".bmp", ".tga",
614 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
617 name = removeStringEnd(filename, image_ext);
619 verbosestream<<"Client: Attempting to load image "
620 <<"file \""<<filename<<"\""<<std::endl;
622 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
623 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
625 // Create an irrlicht memory file
626 io::IReadFile *rfile = irrfs->createMemoryReadFile(
627 *data_rw, data_rw.getSize(), "_tempreadfile");
629 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
632 video::IImage *img = vdrv->createImageFromFile(rfile);
634 errorstream<<"Client: Cannot create image from data of "
635 <<"file \""<<filename<<"\""<<std::endl;
640 m_tsrc->insertSourceImage(filename, img);
646 const char *sound_ext[] = {
647 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
648 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
651 name = removeStringEnd(filename, sound_ext);
653 verbosestream<<"Client: Attempting to load sound "
654 <<"file \""<<filename<<"\""<<std::endl;
655 m_sound->loadSoundData(name, data);
659 const char *model_ext[] = {
660 ".x", ".b3d", ".md2", ".obj",
664 name = removeStringEnd(filename, model_ext);
666 verbosestream<<"Client: Storing model into memory: "
667 <<"\""<<filename<<"\""<<std::endl;
668 if(m_mesh_data.count(filename))
669 errorstream<<"Multiple models with name \""<<filename.c_str()
670 <<"\" found; replacing previous model"<<std::endl;
671 m_mesh_data[filename] = data;
675 const char *translate_ext[] = {
678 name = removeStringEnd(filename, translate_ext);
680 verbosestream << "Client: Loading translation: "
681 << "\"" << filename << "\"" << std::endl;
682 g_translations->loadTranslation(data);
686 errorstream << "Client: Don't know how to load file \""
687 << filename << "\"" << std::endl;
691 // Virtual methods from con::PeerHandler
692 void Client::peerAdded(con::Peer *peer)
694 infostream << "Client::peerAdded(): peer->id="
695 << peer->id << std::endl;
697 void Client::deletingPeer(con::Peer *peer, bool timeout)
699 infostream << "Client::deletingPeer(): "
700 "Server Peer is getting deleted "
701 << "(timeout=" << timeout << ")" << std::endl;
704 m_access_denied = true;
705 m_access_denied_reason = gettext("Connection timed out.");
711 u16 number of files requested
717 void Client::request_media(const std::vector<std::string> &file_requests)
719 std::ostringstream os(std::ios_base::binary);
720 writeU16(os, TOSERVER_REQUEST_MEDIA);
721 size_t file_requests_size = file_requests.size();
723 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
725 // Packet dynamicly resized
726 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
728 pkt << (u16) (file_requests_size & 0xFFFF);
730 for (const std::string &file_request : file_requests) {
736 infostream << "Client: Sending media request list to server ("
737 << file_requests.size() << " files. packet size)" << std::endl;
740 void Client::initLocalMapSaving(const Address &address,
741 const std::string &hostname,
742 bool is_local_server)
744 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
748 const std::string world_path = porting::path_user
749 + DIR_DELIM + "worlds"
750 + DIR_DELIM + "server_"
751 + hostname + "_" + std::to_string(address.getPort());
753 fs::CreateAllDirs(world_path);
755 m_localdb = new MapDatabaseSQLite3(world_path);
756 m_localdb->beginSave();
757 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
760 void Client::ReceiveAll()
762 u64 start_ms = porting::getTimeMs();
765 // Limit time even if there would be huge amounts of data to
767 if(porting::getTimeMs() > start_ms + 100)
772 g_profiler->graphAdd("client_received_packets", 1);
774 catch(con::NoIncomingDataException &e) {
777 catch(con::InvalidIncomingDataException &e) {
778 infostream<<"Client::ReceiveAll(): "
779 "InvalidIncomingDataException: what()="
780 <<e.what()<<std::endl;
785 void Client::Receive()
788 m_con->Receive(&pkt);
792 inline void Client::handleCommand(NetworkPacket* pkt)
794 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
795 (this->*opHandle.handler)(pkt);
799 sender_peer_id given to this shall be quaranteed to be a valid peer
801 void Client::ProcessData(NetworkPacket *pkt)
803 ToClientCommand command = (ToClientCommand) pkt->getCommand();
804 u32 sender_peer_id = pkt->getPeerId();
806 //infostream<<"Client: received command="<<command<<std::endl;
807 m_packetcounter.add((u16)command);
810 If this check is removed, be sure to change the queue
811 system to know the ids
813 if(sender_peer_id != PEER_ID_SERVER) {
814 infostream << "Client::ProcessData(): Discarding data not "
815 "coming from server: peer_id=" << sender_peer_id
820 // Command must be handled into ToClientCommandHandler
821 if (command >= TOCLIENT_NUM_MSG_TYPES) {
822 infostream << "Client: Ignoring unknown command "
823 << command << std::endl;
828 * Those packets are handled before m_server_ser_ver is set, it's normal
829 * But we must use the new ToClientConnectionState in the future,
832 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
837 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
838 infostream << "Client: Server serialization"
839 " format invalid or not initialized."
840 " Skipping incoming command=" << command << std::endl;
845 Handle runtime commands
851 void Client::Send(NetworkPacket* pkt)
853 m_con->Send(PEER_ID_SERVER,
854 serverCommandFactoryTable[pkt->getCommand()].channel,
856 serverCommandFactoryTable[pkt->getCommand()].reliable);
859 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
860 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
862 v3f pf = myplayer->getPosition() * 100;
863 v3f sf = myplayer->getSpeed() * 100;
864 s32 pitch = myplayer->getPitch() * 100;
865 s32 yaw = myplayer->getYaw() * 100;
866 u32 keyPressed = myplayer->keyPressed;
867 // scaled by 80, so that pi can fit into a u8
868 u8 fov = clientMap->getCameraFov() * 80;
869 u8 wanted_range = MYMIN(255,
870 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
872 v3s32 position(pf.X, pf.Y, pf.Z);
873 v3s32 speed(sf.X, sf.Y, sf.Z);
877 [0] v3s32 position*100
879 [12+12] s32 pitch*100
880 [12+12+4] s32 yaw*100
881 [12+12+4+4] u32 keyPressed
882 [12+12+4+4+4] u8 fov*80
883 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
885 *pkt << position << speed << pitch << yaw << keyPressed;
886 *pkt << fov << wanted_range;
889 void Client::interact(u8 action, const PointedThing& pointed)
891 if(m_state != LC_Ready) {
892 errorstream << "Client::interact() "
893 "Canceled (not connected)"
898 LocalPlayer *myplayer = m_env.getLocalPlayer();
899 if (myplayer == NULL)
906 [5] u32 length of the next item (plen)
907 [9] serialized PointedThing
908 [9 + plen] player position information
910 0: start digging (from undersurface) or use
911 1: stop digging (all parameters ignored)
913 3: place block or item (to abovesurface)
915 5: perform secondary action of item
918 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
921 pkt << (u16)getPlayerItem();
923 std::ostringstream tmp_os(std::ios::binary);
924 pointed.serialize(tmp_os);
926 pkt.putLongString(tmp_os.str());
928 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
933 void Client::deleteAuthData()
938 switch (m_chosen_auth_mech) {
939 case AUTH_MECHANISM_FIRST_SRP:
941 case AUTH_MECHANISM_SRP:
942 case AUTH_MECHANISM_LEGACY_PASSWORD:
943 srp_user_delete((SRPUser *) m_auth_data);
946 case AUTH_MECHANISM_NONE:
949 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
953 AuthMechanism Client::choseAuthMech(const u32 mechs)
955 if (mechs & AUTH_MECHANISM_SRP)
956 return AUTH_MECHANISM_SRP;
958 if (mechs & AUTH_MECHANISM_FIRST_SRP)
959 return AUTH_MECHANISM_FIRST_SRP;
961 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
962 return AUTH_MECHANISM_LEGACY_PASSWORD;
964 return AUTH_MECHANISM_NONE;
967 void Client::sendInit(const std::string &playerName)
969 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
971 // we don't support network compression yet
972 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
974 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
975 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
981 void Client::promptConfirmRegistration(AuthMechanism chosen_auth_mechanism)
983 m_chosen_auth_mech = chosen_auth_mechanism;
984 m_is_registration_confirmation_state = true;
987 void Client::confirmRegistration()
989 m_is_registration_confirmation_state = false;
990 startAuth(m_chosen_auth_mech);
993 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
995 m_chosen_auth_mech = chosen_auth_mechanism;
997 switch (chosen_auth_mechanism) {
998 case AUTH_MECHANISM_FIRST_SRP: {
999 // send srp verifier to server
1000 std::string verifier;
1002 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1005 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1006 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1011 case AUTH_MECHANISM_SRP:
1012 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1015 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1016 m_password = translate_password(getPlayerName(), m_password);
1020 std::string playername_u = lowercase(getPlayerName());
1021 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1022 getPlayerName().c_str(), playername_u.c_str(),
1023 (const unsigned char *) m_password.c_str(),
1024 m_password.length(), NULL, NULL);
1027 SRP_Result res = srp_user_start_authentication(
1028 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1029 (unsigned char **) &bytes_A, &len_A);
1030 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1032 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1033 resp_pkt << std::string(bytes_A, len_A) << based_on;
1037 case AUTH_MECHANISM_NONE:
1038 break; // not handled in this method
1042 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1044 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1046 pkt << (u8) blocks.size();
1048 for (const v3s16 &block : blocks) {
1055 void Client::sendGotBlocks(v3s16 block)
1057 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1058 pkt << (u8) 1 << block;
1062 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1064 size_t server_ids = soundList.size();
1065 assert(server_ids <= 0xFFFF);
1067 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1069 pkt << (u16) (server_ids & 0xFFFF);
1071 for (int sound_id : soundList)
1077 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1078 const StringMap &fields)
1080 size_t fields_size = fields.size();
1082 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1084 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1086 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1088 StringMap::const_iterator it;
1089 for (it = fields.begin(); it != fields.end(); ++it) {
1090 const std::string &name = it->first;
1091 const std::string &value = it->second;
1093 pkt.putLongString(value);
1099 void Client::sendInventoryFields(const std::string &formname,
1100 const StringMap &fields)
1102 size_t fields_size = fields.size();
1103 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1105 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1106 pkt << formname << (u16) (fields_size & 0xFFFF);
1108 StringMap::const_iterator it;
1109 for (it = fields.begin(); it != fields.end(); ++it) {
1110 const std::string &name = it->first;
1111 const std::string &value = it->second;
1113 pkt.putLongString(value);
1119 void Client::sendInventoryAction(InventoryAction *a)
1121 std::ostringstream os(std::ios_base::binary);
1126 std::string s = os.str();
1128 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1129 pkt.putRawString(s.c_str(),s.size());
1134 bool Client::canSendChatMessage() const
1136 u32 now = time(NULL);
1137 float time_passed = now - m_last_chat_message_sent;
1139 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1140 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1142 if (virt_chat_message_allowance < 1.0f)
1148 void Client::sendChatMessage(const std::wstring &message)
1150 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1151 if (canSendChatMessage()) {
1152 u32 now = time(NULL);
1153 float time_passed = now - m_last_chat_message_sent;
1154 m_last_chat_message_sent = time(NULL);
1156 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1157 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1158 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1160 m_chat_message_allowance -= 1.0f;
1162 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1167 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1168 m_out_chat_queue.push(message);
1170 infostream << "Could not queue chat message because maximum out chat queue size ("
1171 << max_queue_size << ") is reached." << std::endl;
1175 void Client::clearOutChatQueue()
1177 m_out_chat_queue = std::queue<std::wstring>();
1180 void Client::sendChangePassword(const std::string &oldpassword,
1181 const std::string &newpassword)
1183 LocalPlayer *player = m_env.getLocalPlayer();
1187 // get into sudo mode and then send new password to server
1188 m_password = oldpassword;
1189 m_new_password = newpassword;
1190 startAuth(choseAuthMech(m_sudo_auth_methods));
1194 void Client::sendDamage(u8 damage)
1196 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u8));
1201 void Client::sendRespawn()
1203 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1207 void Client::sendReady()
1209 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1210 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash));
1212 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1213 << (u8) 0 << (u16) strlen(g_version_hash);
1215 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1219 void Client::sendPlayerPos()
1221 LocalPlayer *myplayer = m_env.getLocalPlayer();
1225 ClientMap &map = m_env.getClientMap();
1227 u8 camera_fov = map.getCameraFov();
1228 u8 wanted_range = map.getControl().wanted_range;
1230 // Save bandwidth by only updating position when something changed
1231 if(myplayer->last_position == myplayer->getPosition() &&
1232 myplayer->last_speed == myplayer->getSpeed() &&
1233 myplayer->last_pitch == myplayer->getPitch() &&
1234 myplayer->last_yaw == myplayer->getYaw() &&
1235 myplayer->last_keyPressed == myplayer->keyPressed &&
1236 myplayer->last_camera_fov == camera_fov &&
1237 myplayer->last_wanted_range == wanted_range)
1240 myplayer->last_position = myplayer->getPosition();
1241 myplayer->last_speed = myplayer->getSpeed();
1242 myplayer->last_pitch = myplayer->getPitch();
1243 myplayer->last_yaw = myplayer->getYaw();
1244 myplayer->last_keyPressed = myplayer->keyPressed;
1245 myplayer->last_camera_fov = camera_fov;
1246 myplayer->last_wanted_range = wanted_range;
1248 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1250 writePlayerPos(myplayer, &map, &pkt);
1255 void Client::sendPlayerItem(u16 item)
1257 LocalPlayer *myplayer = m_env.getLocalPlayer();
1261 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1268 void Client::removeNode(v3s16 p)
1270 std::map<v3s16, MapBlock*> modified_blocks;
1273 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1275 catch(InvalidPositionException &e) {
1278 for (const auto &modified_block : modified_blocks) {
1279 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1284 * Helper function for Client Side Modding
1285 * Flavour is applied there, this should not be used for core engine
1287 * @param is_valid_position
1290 MapNode Client::getNode(v3s16 p, bool *is_valid_position)
1292 if (checkCSMFlavourLimit(CSMFlavourLimit::CSM_FL_LOOKUP_NODES)) {
1293 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1294 if ((u32) ppos.getDistanceFrom(p) > m_csm_noderange_limit) {
1295 *is_valid_position = false;
1299 return m_env.getMap().getNodeNoEx(p, is_valid_position);
1302 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1304 //TimeTaker timer1("Client::addNode()");
1306 std::map<v3s16, MapBlock*> modified_blocks;
1309 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1310 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1312 catch(InvalidPositionException &e) {
1315 for (const auto &modified_block : modified_blocks) {
1316 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1320 void Client::setPlayerControl(PlayerControl &control)
1322 LocalPlayer *player = m_env.getLocalPlayer();
1324 player->control = control;
1327 void Client::selectPlayerItem(u16 item)
1329 m_playeritem = item;
1330 m_inventory_updated = true;
1331 sendPlayerItem(item);
1334 // Returns true if the inventory of the local player has been
1335 // updated from the server. If it is true, it is set to false.
1336 bool Client::getLocalInventoryUpdated()
1338 bool updated = m_inventory_updated;
1339 m_inventory_updated = false;
1343 // Copies the inventory of the local player to parameter
1344 void Client::getLocalInventory(Inventory &dst)
1346 LocalPlayer *player = m_env.getLocalPlayer();
1348 dst = player->inventory;
1351 Inventory* Client::getInventory(const InventoryLocation &loc)
1354 case InventoryLocation::UNDEFINED:
1357 case InventoryLocation::CURRENT_PLAYER:
1359 LocalPlayer *player = m_env.getLocalPlayer();
1361 return &player->inventory;
1364 case InventoryLocation::PLAYER:
1366 // Check if we are working with local player inventory
1367 LocalPlayer *player = m_env.getLocalPlayer();
1368 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1370 return &player->inventory;
1373 case InventoryLocation::NODEMETA:
1375 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1378 return meta->getInventory();
1381 case InventoryLocation::DETACHED:
1383 if (m_detached_inventories.count(loc.name) == 0)
1385 return m_detached_inventories[loc.name];
1389 FATAL_ERROR("Invalid inventory location type.");
1395 void Client::inventoryAction(InventoryAction *a)
1398 Send it to the server
1400 sendInventoryAction(a);
1403 Predict some local inventory changes
1405 a->clientApply(this, this);
1411 float Client::getAnimationTime()
1413 return m_animation_time;
1416 int Client::getCrackLevel()
1418 return m_crack_level;
1421 v3s16 Client::getCrackPos()
1426 void Client::setCrack(int level, v3s16 pos)
1428 int old_crack_level = m_crack_level;
1429 v3s16 old_crack_pos = m_crack_pos;
1431 m_crack_level = level;
1434 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1437 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1439 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1442 addUpdateMeshTaskForNode(pos, false, true);
1448 LocalPlayer *player = m_env.getLocalPlayer();
1453 bool Client::getChatMessage(std::wstring &res)
1455 if (m_chat_queue.empty())
1458 ChatMessage *chatMessage = m_chat_queue.front();
1463 switch (chatMessage->type) {
1464 case CHATMESSAGE_TYPE_RAW:
1465 case CHATMESSAGE_TYPE_ANNOUNCE:
1466 case CHATMESSAGE_TYPE_SYSTEM:
1467 res = chatMessage->message;
1469 case CHATMESSAGE_TYPE_NORMAL: {
1470 if (!chatMessage->sender.empty())
1471 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1473 res = chatMessage->message;
1484 void Client::typeChatMessage(const std::wstring &message)
1486 // Discard empty line
1487 if (message.empty())
1490 // If message was ate by script API, don't send it to server
1491 if (m_script->on_sending_message(wide_to_utf8(message))) {
1496 sendChatMessage(message);
1499 if (message[0] != L'/') {
1500 // compatibility code
1501 if (m_proto_ver < 29) {
1502 LocalPlayer *player = m_env.getLocalPlayer();
1504 std::wstring name = narrow_to_wide(player->getName());
1505 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_NORMAL, message, name));
1510 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1512 // Check if the block exists to begin with. In the case when a non-existing
1513 // neighbor is automatically added, it may not. In that case we don't want
1514 // to tell the mesh update thread about it.
1515 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1519 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1522 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1525 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1527 catch(InvalidPositionException &e){}
1530 for (int i=0;i<6;i++)
1533 v3s16 p = blockpos + g_6dirs[i];
1534 addUpdateMeshTask(p, false, urgent);
1536 catch(InvalidPositionException &e){}
1540 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1544 infostream<<"Client::addUpdateMeshTaskForNode(): "
1545 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1549 v3s16 blockpos = getNodeBlockPos(nodepos);
1550 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1553 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1555 catch(InvalidPositionException &e) {}
1558 if(nodepos.X == blockpos_relative.X){
1560 v3s16 p = blockpos + v3s16(-1,0,0);
1561 addUpdateMeshTask(p, false, urgent);
1563 catch(InvalidPositionException &e){}
1566 if(nodepos.Y == blockpos_relative.Y){
1568 v3s16 p = blockpos + v3s16(0,-1,0);
1569 addUpdateMeshTask(p, false, urgent);
1571 catch(InvalidPositionException &e){}
1574 if(nodepos.Z == blockpos_relative.Z){
1576 v3s16 p = blockpos + v3s16(0,0,-1);
1577 addUpdateMeshTask(p, false, urgent);
1579 catch(InvalidPositionException &e){}
1583 ClientEvent *Client::getClientEvent()
1585 FATAL_ERROR_IF(m_client_event_queue.empty(),
1586 "Cannot getClientEvent, queue is empty.");
1588 ClientEvent *event = m_client_event_queue.front();
1589 m_client_event_queue.pop();
1593 bool Client::connectedToServer()
1595 return m_con->Connected();
1598 const Address Client::getServerAddress()
1600 return m_con->GetPeerAddress(PEER_ID_SERVER);
1603 float Client::mediaReceiveProgress()
1605 if (m_media_downloader)
1606 return m_media_downloader->getProgress();
1608 return 1.0; // downloader only exists when not yet done
1611 typedef struct TextureUpdateArgs {
1612 gui::IGUIEnvironment *guienv;
1615 const wchar_t* text_base;
1616 ITextureSource *tsrc;
1617 } TextureUpdateArgs;
1619 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1621 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1622 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1624 // update the loading menu -- if neccessary
1625 bool do_draw = false;
1626 u64 time_ms = targs->last_time_ms;
1627 if (cur_percent != targs->last_percent) {
1628 targs->last_percent = cur_percent;
1629 time_ms = porting::getTimeMs();
1630 // only draw when the user will notice something:
1631 do_draw = (time_ms - targs->last_time_ms > 100);
1635 targs->last_time_ms = time_ms;
1636 std::basic_stringstream<wchar_t> strm;
1637 strm << targs->text_base << " " << targs->last_percent << "%...";
1638 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1639 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1643 void Client::afterContentReceived()
1645 infostream<<"Client::afterContentReceived() started"<<std::endl;
1646 assert(m_itemdef_received); // pre-condition
1647 assert(m_nodedef_received); // pre-condition
1648 assert(mediaReceived()); // pre-condition
1650 const wchar_t* text = wgettext("Loading textures...");
1652 // Clear cached pre-scaled 2D GUI images, as this cache
1653 // might have images with the same name but different
1654 // content from previous sessions.
1655 guiScalingCacheClear();
1657 // Rebuild inherited images and recreate textures
1658 infostream<<"- Rebuilding images and textures"<<std::endl;
1659 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1660 m_tsrc->rebuildImagesAndTextures();
1664 infostream<<"- Rebuilding shaders"<<std::endl;
1665 text = wgettext("Rebuilding shaders...");
1666 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1667 m_shsrc->rebuildShaders();
1670 // Update node aliases
1671 infostream<<"- Updating node aliases"<<std::endl;
1672 text = wgettext("Initializing nodes...");
1673 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1674 m_nodedef->updateAliases(m_itemdef);
1675 for (const auto &path : getTextureDirs())
1676 m_nodedef->applyTextureOverrides(path + DIR_DELIM + "override.txt");
1677 m_nodedef->setNodeRegistrationStatus(true);
1678 m_nodedef->runNodeResolveCallbacks();
1681 // Update node textures and assign shaders to each tile
1682 infostream<<"- Updating node textures"<<std::endl;
1683 TextureUpdateArgs tu_args;
1684 tu_args.guienv = guienv;
1685 tu_args.last_time_ms = porting::getTimeMs();
1686 tu_args.last_percent = 0;
1687 tu_args.text_base = wgettext("Initializing nodes");
1688 tu_args.tsrc = m_tsrc;
1689 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1690 delete[] tu_args.text_base;
1692 // Start mesh update thread after setting up content definitions
1693 infostream<<"- Starting mesh update thread"<<std::endl;
1694 m_mesh_update_thread.start();
1699 if (g_settings->getBool("enable_client_modding")) {
1700 m_script->on_client_ready(m_env.getLocalPlayer());
1703 text = wgettext("Done!");
1704 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1705 infostream<<"Client::afterContentReceived() done"<<std::endl;
1709 float Client::getRTT()
1711 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1714 float Client::getCurRate()
1716 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1717 m_con->getLocalStat(con::CUR_DL_RATE));
1720 void Client::makeScreenshot()
1722 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1723 irr::video::IImage* const raw_image = driver->createScreenShot();
1728 time_t t = time(NULL);
1729 struct tm *tm = localtime(&t);
1731 char timetstamp_c[64];
1732 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1734 std::string filename_base = g_settings->get("screenshot_path")
1736 + std::string("screenshot_")
1737 + std::string(timetstamp_c);
1738 std::string filename_ext = "." + g_settings->get("screenshot_format");
1739 std::string filename;
1741 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1742 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1744 // Try to find a unique filename
1745 unsigned serial = 0;
1747 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1748 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1749 std::ifstream tmp(filename.c_str());
1751 break; // File did not apparently exist, we'll go with it
1755 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1756 infostream << "Could not find suitable filename for screenshot" << std::endl;
1758 irr::video::IImage* const image =
1759 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1762 raw_image->copyTo(image);
1764 std::ostringstream sstr;
1765 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1766 sstr << "Saved screenshot to '" << filename << "'";
1768 sstr << "Failed to save screenshot '" << filename << "'";
1770 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1771 narrow_to_wide(sstr.str())));
1772 infostream << sstr.str() << std::endl;
1780 bool Client::shouldShowMinimap() const
1782 return !m_minimap_disabled_by_server;
1785 void Client::pushToEventQueue(ClientEvent *event)
1787 m_client_event_queue.push(event);
1790 void Client::showMinimap(const bool show)
1792 m_game_ui->showMinimap(show);
1795 // IGameDef interface
1797 IItemDefManager* Client::getItemDefManager()
1801 const NodeDefManager* Client::getNodeDefManager()
1805 ICraftDefManager* Client::getCraftDefManager()
1808 //return m_craftdef;
1810 ITextureSource* Client::getTextureSource()
1814 IShaderSource* Client::getShaderSource()
1819 u16 Client::allocateUnknownNodeId(const std::string &name)
1821 errorstream << "Client::allocateUnknownNodeId(): "
1822 << "Client cannot allocate node IDs" << std::endl;
1823 FATAL_ERROR("Client allocated unknown node");
1825 return CONTENT_IGNORE;
1827 ISoundManager* Client::getSoundManager()
1831 MtEventManager* Client::getEventManager()
1836 ParticleManager* Client::getParticleManager()
1838 return &m_particle_manager;
1841 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1843 StringMap::const_iterator it = m_mesh_data.find(filename);
1844 if (it == m_mesh_data.end()) {
1845 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1846 << "\"" << std::endl;
1849 const std::string &data = it->second;
1851 // Create the mesh, remove it from cache and return it
1852 // This allows unique vertex colors and other properties for each instance
1853 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1854 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1855 *data_rw, data_rw.getSize(), filename.c_str());
1856 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1858 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1862 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1866 const std::string* Client::getModFile(const std::string &filename)
1868 StringMap::const_iterator it = m_mod_files.find(filename);
1869 if (it == m_mod_files.end()) {
1870 errorstream << "Client::getModFile(): File not found: \"" << filename
1871 << "\"" << std::endl;
1877 bool Client::registerModStorage(ModMetadata *storage)
1879 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1880 errorstream << "Unable to register same mod storage twice. Storage name: "
1881 << storage->getModName() << std::endl;
1885 m_mod_storages[storage->getModName()] = storage;
1889 void Client::unregisterModStorage(const std::string &name)
1891 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1892 m_mod_storages.find(name);
1893 if (it != m_mod_storages.end()) {
1894 // Save unconditionaly on unregistration
1895 it->second->save(getModStoragePath());
1896 m_mod_storages.erase(name);
1900 std::string Client::getModStoragePath() const
1902 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1909 bool Client::joinModChannel(const std::string &channel)
1911 if (m_modchannel_mgr->channelRegistered(channel))
1914 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
1918 m_modchannel_mgr->joinChannel(channel, 0);
1922 bool Client::leaveModChannel(const std::string &channel)
1924 if (!m_modchannel_mgr->channelRegistered(channel))
1927 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
1931 m_modchannel_mgr->leaveChannel(channel, 0);
1935 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
1937 if (!m_modchannel_mgr->canWriteOnChannel(channel))
1940 if (message.size() > STRING_MAX_LEN) {
1941 warningstream << "ModChannel message too long, dropping before sending "
1942 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
1943 << channel << ")" << std::endl;
1947 // @TODO: do some client rate limiting
1948 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
1949 pkt << channel << message;
1954 ModChannel* Client::getModChannel(const std::string &channel)
1956 return m_modchannel_mgr->getModChannel(channel);