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/renderingengine.h"
32 #include "util/auth.h"
33 #include "util/directiontables.h"
34 #include "util/pointedthing.h"
35 #include "util/serialize.h"
36 #include "util/string.h"
39 #include "mapblock_mesh.h"
42 #include "modchannels.h"
47 #include "clientmap.h"
48 #include "clientmedia.h"
50 #include "database-sqlite3.h"
51 #include "serialization.h"
52 #include "guiscalingfilter.h"
53 #include "script/scripting_client.h"
55 #include "chatmessage.h"
56 #include "translation.h"
58 extern gui::IGUIEnvironment* guienv;
65 const char *playername,
66 const std::string &password,
67 const std::string &address_name,
68 MapDrawControl &control,
69 IWritableTextureSource *tsrc,
70 IWritableShaderSource *shsrc,
71 IWritableItemDefManager *itemdef,
72 IWritableNodeDefManager *nodedef,
74 MtEventManager *event,
76 GameUIFlags *game_ui_flags
84 m_mesh_update_thread(this),
86 new ClientMap(this, control, 666),
89 m_particle_manager(&m_env),
90 m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
91 m_address_name(address_name),
92 m_server_ser_ver(SER_FMT_VER_INVALID),
93 m_last_chat_message_sent(time(NULL)),
95 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
96 m_media_downloader(new ClientMediaDownloader()),
98 m_game_ui_flags(game_ui_flags),
99 m_modchannel_mgr(new ModChannelMgr())
102 m_env.setLocalPlayer(new LocalPlayer(this, playername));
104 if (g_settings->getBool("enable_minimap")) {
105 m_minimap = new Minimap(this);
107 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
109 m_modding_enabled = g_settings->getBool("enable_client_modding");
110 m_script = new ClientScripting(this);
111 m_env.setScript(m_script);
112 m_script->setEnv(&m_env);
115 void Client::loadMods()
118 scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
120 // If modding is not enabled, don't load mods, just builtin
121 if (!m_modding_enabled) {
124 ClientModConfiguration modconf(getClientModsLuaPath());
125 m_mods = modconf.getMods();
126 std::vector<ModSpec> unsatisfied_mods = modconf.getUnsatisfiedMods();
127 // complain about mods with unsatisfied dependencies
128 if (!modconf.isConsistent()) {
129 modconf.printUnsatisfiedModsError();
133 infostream << "Client Loading mods: ";
134 for (const ModSpec &mod : m_mods)
135 infostream << mod.name << " ";
136 infostream << std::endl;
138 // Load and run "mod" scripts
139 for (const ModSpec &mod : m_mods) {
140 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
141 throw ModError("Error loading mod \"" + mod.name +
142 "\": Mod name does not follow naming conventions: "
143 "Only characters [a-z0-9_] are allowed.");
145 scanModIntoMemory(mod.name, mod.path);
149 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
150 std::string mod_subpath)
152 std::string full_path = mod_path + DIR_DELIM + mod_subpath;
153 std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
154 for (const fs::DirListNode &j : mod) {
155 std::string filename = j.name;
157 scanModSubfolder(mod_name, mod_path, mod_subpath
158 + filename + DIR_DELIM);
161 std::replace( mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
162 m_mod_files[mod_name + ":" + mod_subpath + filename] = full_path + filename;
166 void Client::initMods()
168 m_script->loadModFromMemory(BUILTIN_MOD_NAME);
170 // If modding is not enabled, don't load mods, just builtin
171 if (!m_modding_enabled) {
175 // Load and run "mod" scripts
176 for (const ModSpec &mod : m_mods)
177 m_script->loadModFromMemory(mod.name);
180 const std::string &Client::getBuiltinLuaPath()
182 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
186 const std::string &Client::getClientModsLuaPath()
188 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
189 return clientmods_dir;
192 const std::vector<ModSpec>& Client::getMods() const
194 static std::vector<ModSpec> client_modspec_temp;
195 return client_modspec_temp;
198 const ModSpec* Client::getModSpec(const std::string &modname) const
206 // Don't disable this part when modding is disabled, it's used in builtin
207 m_script->on_shutdown();
208 //request all client managed threads to stop
209 m_mesh_update_thread.stop();
210 // Save local server map
212 infostream << "Local map saving ended." << std::endl;
213 m_localdb->endSave();
219 bool Client::isShutdown()
221 return m_shutdown || !m_mesh_update_thread.isRunning();
229 m_mesh_update_thread.stop();
230 m_mesh_update_thread.wait();
231 while (!m_mesh_update_thread.m_queue_out.empty()) {
232 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
237 delete m_inventory_from_server;
239 // Delete detached inventories
240 for (auto &m_detached_inventorie : m_detached_inventories) {
241 delete m_detached_inventorie.second;
244 // cleanup 3d model meshes on client shutdown
245 while (RenderingEngine::get_mesh_cache()->getMeshCount() != 0) {
246 scene::IAnimatedMesh *mesh = RenderingEngine::get_mesh_cache()->getMeshByIndex(0);
249 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
255 void Client::connect(Address address, bool is_local_server)
257 initLocalMapSaving(address, m_address_name, is_local_server);
259 m_con->SetTimeoutMs(0);
260 m_con->Connect(address);
263 void Client::step(float dtime)
269 if(m_ignore_damage_timer > dtime)
270 m_ignore_damage_timer -= dtime;
272 m_ignore_damage_timer = 0.0;
274 m_animation_time += dtime;
275 if(m_animation_time > 60.0)
276 m_animation_time -= 60.0;
278 m_time_of_day_update_timer += dtime;
286 float &counter = m_packetcounter_timer;
292 infostream << "Client packetcounter (" << m_packetcounter_timer
294 m_packetcounter.print(infostream);
295 m_packetcounter.clear();
299 // UGLY hack to fix 2 second startup delay caused by non existent
300 // server client startup synchronization in local server or singleplayer mode
301 static bool initial_step = true;
303 initial_step = false;
305 else if(m_state == LC_Created) {
306 float &counter = m_connection_reinit_timer;
311 LocalPlayer *myplayer = m_env.getLocalPlayer();
312 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
314 sendInit(myplayer->getName());
317 // Not connected, return
322 Do stuff if connected
326 Run Map's timers and unload unused data
328 const float map_timer_and_unload_dtime = 5.25;
329 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
330 ScopeProfiler sp(g_profiler, "Client: map timer and unload");
331 std::vector<v3s16> deleted_blocks;
332 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
333 g_settings->getFloat("client_unload_unused_data_timeout"),
334 g_settings->getS32("client_mapblock_limit"),
339 NOTE: This loop is intentionally iterated the way it is.
342 std::vector<v3s16>::iterator i = deleted_blocks.begin();
343 std::vector<v3s16> sendlist;
345 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
356 sendDeletedBlocks(sendlist);
358 if(i == deleted_blocks.end())
364 sendlist.push_back(*i);
370 Send pending messages on out chat queue
372 if (!m_out_chat_queue.empty() && canSendChatMessage()) {
373 sendChatMessage(m_out_chat_queue.front());
374 m_out_chat_queue.pop();
380 // Control local player (0ms)
381 LocalPlayer *player = m_env.getLocalPlayer();
383 player->applyControl(dtime, &m_env);
387 m_sound->step(dtime);
392 while (m_env.hasClientEnvEvents()) {
393 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
395 if (envEvent.type == CEE_PLAYER_DAMAGE) {
396 if (m_ignore_damage_timer <= 0) {
397 u8 damage = envEvent.player_damage.amount;
399 if (envEvent.player_damage.send_to_server)
402 // Add to ClientEvent queue
403 ClientEvent *event = new ClientEvent();
404 event->type = CE_PLAYER_DAMAGE;
405 event->player_damage.amount = damage;
406 m_client_event_queue.push(event);
414 float &counter = m_avg_rtt_timer;
418 // connectedAndInitialized() is true, peer exists.
419 float avg_rtt = getRTT();
420 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
424 Send player position to server
427 float &counter = m_playerpos_send_timer;
429 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
437 Replace updated meshes
440 int num_processed_meshes = 0;
441 while (!m_mesh_update_thread.m_queue_out.empty())
443 num_processed_meshes++;
445 MinimapMapblock *minimap_mapblock = NULL;
446 bool do_mapper_update = true;
448 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
449 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
451 // Delete the old mesh
453 block->mesh = nullptr;
456 minimap_mapblock = r.mesh->moveMinimapMapblock();
457 if (minimap_mapblock == NULL)
458 do_mapper_update = false;
460 bool is_empty = true;
461 for (int l = 0; l < MAX_TILE_LAYERS; l++)
462 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
468 // Replace with the new mesh
469 block->mesh = r.mesh;
475 if (m_minimap && do_mapper_update)
476 m_minimap->addBlock(r.p, minimap_mapblock);
478 if (r.ack_block_to_server) {
488 if (num_processed_meshes > 0)
489 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
495 if (m_media_downloader && m_media_downloader->isStarted()) {
496 m_media_downloader->step(this);
497 if (m_media_downloader->isDone()) {
498 delete m_media_downloader;
499 m_media_downloader = NULL;
504 If the server didn't update the inventory in a while, revert
505 the local inventory (so the player notices the lag problem
506 and knows something is wrong).
508 if(m_inventory_from_server)
510 float interval = 10.0;
511 float count_before = floor(m_inventory_from_server_age / interval);
513 m_inventory_from_server_age += dtime;
515 float count_after = floor(m_inventory_from_server_age / interval);
517 if(count_after != count_before)
519 // Do this every <interval> seconds after TOCLIENT_INVENTORY
520 // Reset the locally changed inventory to the authoritative inventory
521 LocalPlayer *player = m_env.getLocalPlayer();
522 player->inventory = *m_inventory_from_server;
523 m_inventory_updated = true;
528 Update positions of sounds attached to objects
531 for (auto &m_sounds_to_object : m_sounds_to_objects) {
532 int client_id = m_sounds_to_object.first;
533 u16 object_id = m_sounds_to_object.second;
534 ClientActiveObject *cao = m_env.getActiveObject(object_id);
537 m_sound->updateSoundPosition(client_id, cao->getPosition());
542 Handle removed remotely initiated sounds
544 m_removed_sounds_check_timer += dtime;
545 if(m_removed_sounds_check_timer >= 2.32) {
546 m_removed_sounds_check_timer = 0;
547 // Find removed sounds and clear references to them
548 std::vector<s32> removed_server_ids;
549 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
550 i != m_sounds_server_to_client.end();) {
551 s32 server_id = i->first;
552 int client_id = i->second;
554 if(!m_sound->soundExists(client_id)) {
555 m_sounds_server_to_client.erase(server_id);
556 m_sounds_client_to_server.erase(client_id);
557 m_sounds_to_objects.erase(client_id);
558 removed_server_ids.push_back(server_id);
563 if(!removed_server_ids.empty()) {
564 sendRemovedSounds(removed_server_ids);
568 m_mod_storage_save_timer -= dtime;
569 if (m_mod_storage_save_timer <= 0.0f) {
570 verbosestream << "Saving registered mod storages." << std::endl;
571 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
572 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
573 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
574 if (it->second->isModified()) {
575 it->second->save(getModStoragePath());
581 if (m_localdb && m_localdb_save_interval.step(dtime,
582 m_cache_save_interval)) {
583 m_localdb->endSave();
584 m_localdb->beginSave();
588 bool Client::loadMedia(const std::string &data, const std::string &filename)
590 // Silly irrlicht's const-incorrectness
591 Buffer<char> data_rw(data.c_str(), data.size());
595 const char *image_ext[] = {
596 ".png", ".jpg", ".bmp", ".tga",
597 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
600 name = removeStringEnd(filename, image_ext);
602 verbosestream<<"Client: Attempting to load image "
603 <<"file \""<<filename<<"\""<<std::endl;
605 io::IFileSystem *irrfs = RenderingEngine::get_filesystem();
606 video::IVideoDriver *vdrv = RenderingEngine::get_video_driver();
608 // Create an irrlicht memory file
609 io::IReadFile *rfile = irrfs->createMemoryReadFile(
610 *data_rw, data_rw.getSize(), "_tempreadfile");
612 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
615 video::IImage *img = vdrv->createImageFromFile(rfile);
617 errorstream<<"Client: Cannot create image from data of "
618 <<"file \""<<filename<<"\""<<std::endl;
623 m_tsrc->insertSourceImage(filename, img);
629 const char *sound_ext[] = {
630 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
631 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
634 name = removeStringEnd(filename, sound_ext);
636 verbosestream<<"Client: Attempting to load sound "
637 <<"file \""<<filename<<"\""<<std::endl;
638 m_sound->loadSoundData(name, data);
642 const char *model_ext[] = {
643 ".x", ".b3d", ".md2", ".obj",
647 name = removeStringEnd(filename, model_ext);
649 verbosestream<<"Client: Storing model into memory: "
650 <<"\""<<filename<<"\""<<std::endl;
651 if(m_mesh_data.count(filename))
652 errorstream<<"Multiple models with name \""<<filename.c_str()
653 <<"\" found; replacing previous model"<<std::endl;
654 m_mesh_data[filename] = data;
658 const char *translate_ext[] = {
661 name = removeStringEnd(filename, translate_ext);
663 verbosestream << "Client: Loading translation: "
664 << "\"" << filename << "\"" << std::endl;
665 g_translations->loadTranslation(data);
669 errorstream << "Client: Don't know how to load file \""
670 << filename << "\"" << std::endl;
674 // Virtual methods from con::PeerHandler
675 void Client::peerAdded(con::Peer *peer)
677 infostream << "Client::peerAdded(): peer->id="
678 << peer->id << std::endl;
680 void Client::deletingPeer(con::Peer *peer, bool timeout)
682 infostream << "Client::deletingPeer(): "
683 "Server Peer is getting deleted "
684 << "(timeout=" << timeout << ")" << std::endl;
687 m_access_denied = true;
688 m_access_denied_reason = gettext("Connection timed out.");
694 u16 number of files requested
700 void Client::request_media(const std::vector<std::string> &file_requests)
702 std::ostringstream os(std::ios_base::binary);
703 writeU16(os, TOSERVER_REQUEST_MEDIA);
704 size_t file_requests_size = file_requests.size();
706 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
708 // Packet dynamicly resized
709 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
711 pkt << (u16) (file_requests_size & 0xFFFF);
713 for (const std::string &file_request : file_requests) {
719 infostream << "Client: Sending media request list to server ("
720 << file_requests.size() << " files. packet size)" << std::endl;
723 void Client::initLocalMapSaving(const Address &address,
724 const std::string &hostname,
725 bool is_local_server)
727 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
731 const std::string world_path = porting::path_user
732 + DIR_DELIM + "worlds"
733 + DIR_DELIM + "server_"
734 + hostname + "_" + std::to_string(address.getPort());
736 fs::CreateAllDirs(world_path);
738 m_localdb = new MapDatabaseSQLite3(world_path);
739 m_localdb->beginSave();
740 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
743 void Client::ReceiveAll()
745 u64 start_ms = porting::getTimeMs();
748 // Limit time even if there would be huge amounts of data to
750 if(porting::getTimeMs() > start_ms + 100)
755 g_profiler->graphAdd("client_received_packets", 1);
757 catch(con::NoIncomingDataException &e) {
760 catch(con::InvalidIncomingDataException &e) {
761 infostream<<"Client::ReceiveAll(): "
762 "InvalidIncomingDataException: what()="
763 <<e.what()<<std::endl;
768 void Client::Receive()
771 m_con->Receive(&pkt);
775 inline void Client::handleCommand(NetworkPacket* pkt)
777 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
778 (this->*opHandle.handler)(pkt);
782 sender_peer_id given to this shall be quaranteed to be a valid peer
784 void Client::ProcessData(NetworkPacket *pkt)
786 ToClientCommand command = (ToClientCommand) pkt->getCommand();
787 u32 sender_peer_id = pkt->getPeerId();
789 //infostream<<"Client: received command="<<command<<std::endl;
790 m_packetcounter.add((u16)command);
793 If this check is removed, be sure to change the queue
794 system to know the ids
796 if(sender_peer_id != PEER_ID_SERVER) {
797 infostream << "Client::ProcessData(): Discarding data not "
798 "coming from server: peer_id=" << sender_peer_id
803 // Command must be handled into ToClientCommandHandler
804 if (command >= TOCLIENT_NUM_MSG_TYPES) {
805 infostream << "Client: Ignoring unknown command "
806 << command << std::endl;
811 * Those packets are handled before m_server_ser_ver is set, it's normal
812 * But we must use the new ToClientConnectionState in the future,
815 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
820 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
821 infostream << "Client: Server serialization"
822 " format invalid or not initialized."
823 " Skipping incoming command=" << command << std::endl;
828 Handle runtime commands
834 void Client::Send(NetworkPacket* pkt)
836 m_con->Send(PEER_ID_SERVER,
837 serverCommandFactoryTable[pkt->getCommand()].channel,
839 serverCommandFactoryTable[pkt->getCommand()].reliable);
842 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
843 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
845 v3f pf = myplayer->getPosition() * 100;
846 v3f sf = myplayer->getSpeed() * 100;
847 s32 pitch = myplayer->getPitch() * 100;
848 s32 yaw = myplayer->getYaw() * 100;
849 u32 keyPressed = myplayer->keyPressed;
850 // scaled by 80, so that pi can fit into a u8
851 u8 fov = clientMap->getCameraFov() * 80;
852 u8 wanted_range = MYMIN(255,
853 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
855 v3s32 position(pf.X, pf.Y, pf.Z);
856 v3s32 speed(sf.X, sf.Y, sf.Z);
860 [0] v3s32 position*100
862 [12+12] s32 pitch*100
863 [12+12+4] s32 yaw*100
864 [12+12+4+4] u32 keyPressed
865 [12+12+4+4+4] u8 fov*80
866 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
868 *pkt << position << speed << pitch << yaw << keyPressed;
869 *pkt << fov << wanted_range;
872 void Client::interact(u8 action, const PointedThing& pointed)
874 if(m_state != LC_Ready) {
875 errorstream << "Client::interact() "
876 "Canceled (not connected)"
881 LocalPlayer *myplayer = m_env.getLocalPlayer();
882 if (myplayer == NULL)
889 [5] u32 length of the next item (plen)
890 [9] serialized PointedThing
891 [9 + plen] player position information
893 0: start digging (from undersurface) or use
894 1: stop digging (all parameters ignored)
896 3: place block or item (to abovesurface)
898 5: perform secondary action of item
901 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
904 pkt << (u16)getPlayerItem();
906 std::ostringstream tmp_os(std::ios::binary);
907 pointed.serialize(tmp_os);
909 pkt.putLongString(tmp_os.str());
911 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
916 void Client::deleteAuthData()
921 switch (m_chosen_auth_mech) {
922 case AUTH_MECHANISM_FIRST_SRP:
924 case AUTH_MECHANISM_SRP:
925 case AUTH_MECHANISM_LEGACY_PASSWORD:
926 srp_user_delete((SRPUser *) m_auth_data);
929 case AUTH_MECHANISM_NONE:
932 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
936 AuthMechanism Client::choseAuthMech(const u32 mechs)
938 if (mechs & AUTH_MECHANISM_SRP)
939 return AUTH_MECHANISM_SRP;
941 if (mechs & AUTH_MECHANISM_FIRST_SRP)
942 return AUTH_MECHANISM_FIRST_SRP;
944 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
945 return AUTH_MECHANISM_LEGACY_PASSWORD;
947 return AUTH_MECHANISM_NONE;
950 void Client::sendInit(const std::string &playerName)
952 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
954 // we don't support network compression yet
955 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
957 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
958 pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
964 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
966 m_chosen_auth_mech = chosen_auth_mechanism;
968 switch (chosen_auth_mechanism) {
969 case AUTH_MECHANISM_FIRST_SRP: {
970 // send srp verifier to server
971 std::string verifier;
973 generate_srp_verifier_and_salt(getPlayerName(), m_password,
976 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
977 resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
982 case AUTH_MECHANISM_SRP:
983 case AUTH_MECHANISM_LEGACY_PASSWORD: {
986 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
987 m_password = translate_password(getPlayerName(), m_password);
991 std::string playername_u = lowercase(getPlayerName());
992 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
993 getPlayerName().c_str(), playername_u.c_str(),
994 (const unsigned char *) m_password.c_str(),
995 m_password.length(), NULL, NULL);
998 SRP_Result res = srp_user_start_authentication(
999 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1000 (unsigned char **) &bytes_A, &len_A);
1001 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1003 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1004 resp_pkt << std::string(bytes_A, len_A) << based_on;
1008 case AUTH_MECHANISM_NONE:
1009 break; // not handled in this method
1013 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1015 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1017 pkt << (u8) blocks.size();
1019 for (const v3s16 &block : blocks) {
1026 void Client::sendGotBlocks(v3s16 block)
1028 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1029 pkt << (u8) 1 << block;
1033 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1035 size_t server_ids = soundList.size();
1036 assert(server_ids <= 0xFFFF);
1038 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1040 pkt << (u16) (server_ids & 0xFFFF);
1042 for (int sound_id : soundList)
1048 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1049 const StringMap &fields)
1051 size_t fields_size = fields.size();
1053 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1055 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1057 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1059 StringMap::const_iterator it;
1060 for (it = fields.begin(); it != fields.end(); ++it) {
1061 const std::string &name = it->first;
1062 const std::string &value = it->second;
1064 pkt.putLongString(value);
1070 void Client::sendInventoryFields(const std::string &formname,
1071 const StringMap &fields)
1073 size_t fields_size = fields.size();
1074 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1076 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1077 pkt << formname << (u16) (fields_size & 0xFFFF);
1079 StringMap::const_iterator it;
1080 for (it = fields.begin(); it != fields.end(); ++it) {
1081 const std::string &name = it->first;
1082 const std::string &value = it->second;
1084 pkt.putLongString(value);
1090 void Client::sendInventoryAction(InventoryAction *a)
1092 std::ostringstream os(std::ios_base::binary);
1097 std::string s = os.str();
1099 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1100 pkt.putRawString(s.c_str(),s.size());
1105 bool Client::canSendChatMessage() const
1107 u32 now = time(NULL);
1108 float time_passed = now - m_last_chat_message_sent;
1110 float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1111 (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1113 if (virt_chat_message_allowance < 1.0f)
1119 void Client::sendChatMessage(const std::wstring &message)
1121 const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1122 if (canSendChatMessage()) {
1123 u32 now = time(NULL);
1124 float time_passed = now - m_last_chat_message_sent;
1125 m_last_chat_message_sent = time(NULL);
1127 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1128 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1129 m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1131 m_chat_message_allowance -= 1.0f;
1133 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1138 } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size == -1) {
1139 m_out_chat_queue.push(message);
1141 infostream << "Could not queue chat message because maximum out chat queue size ("
1142 << max_queue_size << ") is reached." << std::endl;
1146 void Client::clearOutChatQueue()
1148 m_out_chat_queue = std::queue<std::wstring>();
1151 void Client::sendChangePassword(const std::string &oldpassword,
1152 const std::string &newpassword)
1154 LocalPlayer *player = m_env.getLocalPlayer();
1158 // get into sudo mode and then send new password to server
1159 m_password = oldpassword;
1160 m_new_password = newpassword;
1161 startAuth(choseAuthMech(m_sudo_auth_methods));
1165 void Client::sendDamage(u8 damage)
1167 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u8));
1172 void Client::sendRespawn()
1174 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1178 void Client::sendReady()
1180 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1181 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash));
1183 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1184 << (u8) 0 << (u16) strlen(g_version_hash);
1186 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1190 void Client::sendPlayerPos()
1192 LocalPlayer *myplayer = m_env.getLocalPlayer();
1193 if(myplayer == NULL)
1196 ClientMap &map = m_env.getClientMap();
1198 u8 camera_fov = map.getCameraFov();
1199 u8 wanted_range = map.getControl().wanted_range;
1201 // Save bandwidth by only updating position when something changed
1202 if(myplayer->last_position == myplayer->getPosition() &&
1203 myplayer->last_speed == myplayer->getSpeed() &&
1204 myplayer->last_pitch == myplayer->getPitch() &&
1205 myplayer->last_yaw == myplayer->getYaw() &&
1206 myplayer->last_keyPressed == myplayer->keyPressed &&
1207 myplayer->last_camera_fov == camera_fov &&
1208 myplayer->last_wanted_range == wanted_range)
1211 myplayer->last_position = myplayer->getPosition();
1212 myplayer->last_speed = myplayer->getSpeed();
1213 myplayer->last_pitch = myplayer->getPitch();
1214 myplayer->last_yaw = myplayer->getYaw();
1215 myplayer->last_keyPressed = myplayer->keyPressed;
1216 myplayer->last_camera_fov = camera_fov;
1217 myplayer->last_wanted_range = wanted_range;
1219 //infostream << "Sending Player Position information" << std::endl;
1221 session_t our_peer_id = m_con->GetPeerID();
1223 // Set peer id if not set already
1224 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1225 myplayer->peer_id = our_peer_id;
1227 assert(myplayer->peer_id == our_peer_id);
1229 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1231 writePlayerPos(myplayer, &map, &pkt);
1236 void Client::sendPlayerItem(u16 item)
1238 LocalPlayer *myplayer = m_env.getLocalPlayer();
1239 if(myplayer == NULL)
1242 session_t our_peer_id = m_con->GetPeerID();
1244 // Set peer id if not set already
1245 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1246 myplayer->peer_id = our_peer_id;
1247 assert(myplayer->peer_id == our_peer_id);
1249 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1256 void Client::removeNode(v3s16 p)
1258 std::map<v3s16, MapBlock*> modified_blocks;
1261 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1263 catch(InvalidPositionException &e) {
1266 for (const auto &modified_block : modified_blocks) {
1267 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1272 * Helper function for Client Side Modding
1273 * Flavour is applied there, this should not be used for core engine
1275 * @param is_valid_position
1278 MapNode Client::getNode(v3s16 p, bool *is_valid_position)
1280 if (checkCSMFlavourLimit(CSMFlavourLimit::CSM_FL_LOOKUP_NODES)) {
1281 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1282 if ((u32) ppos.getDistanceFrom(p) > m_csm_noderange_limit) {
1283 *is_valid_position = false;
1287 return m_env.getMap().getNodeNoEx(p, is_valid_position);
1290 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1292 //TimeTaker timer1("Client::addNode()");
1294 std::map<v3s16, MapBlock*> modified_blocks;
1297 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1298 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1300 catch(InvalidPositionException &e) {
1303 for (const auto &modified_block : modified_blocks) {
1304 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1308 void Client::setPlayerControl(PlayerControl &control)
1310 LocalPlayer *player = m_env.getLocalPlayer();
1312 player->control = control;
1315 void Client::selectPlayerItem(u16 item)
1317 m_playeritem = item;
1318 m_inventory_updated = true;
1319 sendPlayerItem(item);
1322 // Returns true if the inventory of the local player has been
1323 // updated from the server. If it is true, it is set to false.
1324 bool Client::getLocalInventoryUpdated()
1326 bool updated = m_inventory_updated;
1327 m_inventory_updated = false;
1331 // Copies the inventory of the local player to parameter
1332 void Client::getLocalInventory(Inventory &dst)
1334 LocalPlayer *player = m_env.getLocalPlayer();
1336 dst = player->inventory;
1339 Inventory* Client::getInventory(const InventoryLocation &loc)
1342 case InventoryLocation::UNDEFINED:
1345 case InventoryLocation::CURRENT_PLAYER:
1347 LocalPlayer *player = m_env.getLocalPlayer();
1349 return &player->inventory;
1352 case InventoryLocation::PLAYER:
1354 // Check if we are working with local player inventory
1355 LocalPlayer *player = m_env.getLocalPlayer();
1356 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1358 return &player->inventory;
1361 case InventoryLocation::NODEMETA:
1363 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1366 return meta->getInventory();
1369 case InventoryLocation::DETACHED:
1371 if (m_detached_inventories.count(loc.name) == 0)
1373 return m_detached_inventories[loc.name];
1377 FATAL_ERROR("Invalid inventory location type.");
1383 void Client::inventoryAction(InventoryAction *a)
1386 Send it to the server
1388 sendInventoryAction(a);
1391 Predict some local inventory changes
1393 a->clientApply(this, this);
1399 float Client::getAnimationTime()
1401 return m_animation_time;
1404 int Client::getCrackLevel()
1406 return m_crack_level;
1409 v3s16 Client::getCrackPos()
1414 void Client::setCrack(int level, v3s16 pos)
1416 int old_crack_level = m_crack_level;
1417 v3s16 old_crack_pos = m_crack_pos;
1419 m_crack_level = level;
1422 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1425 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1427 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1430 addUpdateMeshTaskForNode(pos, false, true);
1436 LocalPlayer *player = m_env.getLocalPlayer();
1441 bool Client::getChatMessage(std::wstring &res)
1443 if (m_chat_queue.empty())
1446 ChatMessage *chatMessage = m_chat_queue.front();
1451 switch (chatMessage->type) {
1452 case CHATMESSAGE_TYPE_RAW:
1453 case CHATMESSAGE_TYPE_ANNOUNCE:
1454 case CHATMESSAGE_TYPE_SYSTEM:
1455 res = chatMessage->message;
1457 case CHATMESSAGE_TYPE_NORMAL: {
1458 if (!chatMessage->sender.empty())
1459 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1461 res = chatMessage->message;
1472 void Client::typeChatMessage(const std::wstring &message)
1474 // Discard empty line
1475 if (message.empty())
1478 // If message was ate by script API, don't send it to server
1479 if (m_script->on_sending_message(wide_to_utf8(message))) {
1484 sendChatMessage(message);
1487 if (message[0] != L'/') {
1488 // compatibility code
1489 if (m_proto_ver < 29) {
1490 LocalPlayer *player = m_env.getLocalPlayer();
1492 std::wstring name = narrow_to_wide(player->getName());
1493 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_NORMAL, message, name));
1498 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1500 // Check if the block exists to begin with. In the case when a non-existing
1501 // neighbor is automatically added, it may not. In that case we don't want
1502 // to tell the mesh update thread about it.
1503 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1507 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1510 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1513 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1515 catch(InvalidPositionException &e){}
1518 for (int i=0;i<6;i++)
1521 v3s16 p = blockpos + g_6dirs[i];
1522 addUpdateMeshTask(p, false, urgent);
1524 catch(InvalidPositionException &e){}
1528 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1532 infostream<<"Client::addUpdateMeshTaskForNode(): "
1533 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1537 v3s16 blockpos = getNodeBlockPos(nodepos);
1538 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1541 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1543 catch(InvalidPositionException &e) {}
1546 if(nodepos.X == blockpos_relative.X){
1548 v3s16 p = blockpos + v3s16(-1,0,0);
1549 addUpdateMeshTask(p, false, urgent);
1551 catch(InvalidPositionException &e){}
1554 if(nodepos.Y == blockpos_relative.Y){
1556 v3s16 p = blockpos + v3s16(0,-1,0);
1557 addUpdateMeshTask(p, false, urgent);
1559 catch(InvalidPositionException &e){}
1562 if(nodepos.Z == blockpos_relative.Z){
1564 v3s16 p = blockpos + v3s16(0,0,-1);
1565 addUpdateMeshTask(p, false, urgent);
1567 catch(InvalidPositionException &e){}
1571 ClientEvent *Client::getClientEvent()
1573 FATAL_ERROR_IF(m_client_event_queue.empty(),
1574 "Cannot getClientEvent, queue is empty.");
1576 ClientEvent *event = m_client_event_queue.front();
1577 m_client_event_queue.pop();
1581 bool Client::connectedToServer()
1583 return m_con->Connected();
1586 const Address Client::getServerAddress()
1588 return m_con->GetPeerAddress(PEER_ID_SERVER);
1591 float Client::mediaReceiveProgress()
1593 if (m_media_downloader)
1594 return m_media_downloader->getProgress();
1596 return 1.0; // downloader only exists when not yet done
1599 typedef struct TextureUpdateArgs {
1600 gui::IGUIEnvironment *guienv;
1603 const wchar_t* text_base;
1604 ITextureSource *tsrc;
1605 } TextureUpdateArgs;
1607 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1609 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1610 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1612 // update the loading menu -- if neccessary
1613 bool do_draw = false;
1614 u64 time_ms = targs->last_time_ms;
1615 if (cur_percent != targs->last_percent) {
1616 targs->last_percent = cur_percent;
1617 time_ms = porting::getTimeMs();
1618 // only draw when the user will notice something:
1619 do_draw = (time_ms - targs->last_time_ms > 100);
1623 targs->last_time_ms = time_ms;
1624 std::basic_stringstream<wchar_t> strm;
1625 strm << targs->text_base << " " << targs->last_percent << "%...";
1626 RenderingEngine::draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1627 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1631 void Client::afterContentReceived()
1633 infostream<<"Client::afterContentReceived() started"<<std::endl;
1634 assert(m_itemdef_received); // pre-condition
1635 assert(m_nodedef_received); // pre-condition
1636 assert(mediaReceived()); // pre-condition
1638 const wchar_t* text = wgettext("Loading textures...");
1640 // Clear cached pre-scaled 2D GUI images, as this cache
1641 // might have images with the same name but different
1642 // content from previous sessions.
1643 guiScalingCacheClear();
1645 // Rebuild inherited images and recreate textures
1646 infostream<<"- Rebuilding images and textures"<<std::endl;
1647 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 70);
1648 m_tsrc->rebuildImagesAndTextures();
1652 infostream<<"- Rebuilding shaders"<<std::endl;
1653 text = wgettext("Rebuilding shaders...");
1654 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 71);
1655 m_shsrc->rebuildShaders();
1658 // Update node aliases
1659 infostream<<"- Updating node aliases"<<std::endl;
1660 text = wgettext("Initializing nodes...");
1661 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 72);
1662 m_nodedef->updateAliases(m_itemdef);
1663 std::string texture_path = g_settings->get("texture_path");
1664 if (!texture_path.empty() && fs::IsDir(texture_path))
1665 m_nodedef->applyTextureOverrides(texture_path + DIR_DELIM + "override.txt");
1666 m_nodedef->setNodeRegistrationStatus(true);
1667 m_nodedef->runNodeResolveCallbacks();
1670 // Update node textures and assign shaders to each tile
1671 infostream<<"- Updating node textures"<<std::endl;
1672 TextureUpdateArgs tu_args;
1673 tu_args.guienv = guienv;
1674 tu_args.last_time_ms = porting::getTimeMs();
1675 tu_args.last_percent = 0;
1676 tu_args.text_base = wgettext("Initializing nodes");
1677 tu_args.tsrc = m_tsrc;
1678 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1679 delete[] tu_args.text_base;
1681 // Start mesh update thread after setting up content definitions
1682 infostream<<"- Starting mesh update thread"<<std::endl;
1683 m_mesh_update_thread.start();
1688 if (g_settings->getBool("enable_client_modding")) {
1689 m_script->on_client_ready(m_env.getLocalPlayer());
1690 m_script->on_connect();
1693 text = wgettext("Done!");
1694 RenderingEngine::draw_load_screen(text, guienv, m_tsrc, 0, 100);
1695 infostream<<"Client::afterContentReceived() done"<<std::endl;
1699 float Client::getRTT()
1701 return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1704 float Client::getCurRate()
1706 return (m_con->getLocalStat(con::CUR_INC_RATE) +
1707 m_con->getLocalStat(con::CUR_DL_RATE));
1710 void Client::makeScreenshot()
1712 irr::video::IVideoDriver *driver = RenderingEngine::get_video_driver();
1713 irr::video::IImage* const raw_image = driver->createScreenShot();
1718 time_t t = time(NULL);
1719 struct tm *tm = localtime(&t);
1721 char timetstamp_c[64];
1722 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1724 std::string filename_base = g_settings->get("screenshot_path")
1726 + std::string("screenshot_")
1727 + std::string(timetstamp_c);
1728 std::string filename_ext = "." + g_settings->get("screenshot_format");
1729 std::string filename;
1731 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1732 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1734 // Try to find a unique filename
1735 unsigned serial = 0;
1737 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1738 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1739 std::ifstream tmp(filename.c_str());
1741 break; // File did not apparently exist, we'll go with it
1745 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1746 infostream << "Could not find suitable filename for screenshot" << std::endl;
1748 irr::video::IImage* const image =
1749 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1752 raw_image->copyTo(image);
1754 std::ostringstream sstr;
1755 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1756 sstr << "Saved screenshot to '" << filename << "'";
1758 sstr << "Failed to save screenshot '" << filename << "'";
1760 pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1761 narrow_to_wide(sstr.str())));
1762 infostream << sstr.str() << std::endl;
1770 bool Client::shouldShowMinimap() const
1772 return !m_minimap_disabled_by_server;
1775 void Client::pushToEventQueue(ClientEvent *event)
1777 m_client_event_queue.push(event);
1780 void Client::showGameChat(const bool show)
1782 m_game_ui_flags->show_chat = show;
1785 void Client::showGameHud(const bool show)
1787 m_game_ui_flags->show_hud = show;
1790 void Client::showMinimap(const bool show)
1792 m_game_ui_flags->show_minimap = show;
1795 void Client::showProfiler(const bool show)
1797 m_game_ui_flags->show_profiler_graph = show;
1800 void Client::showGameFog(const bool show)
1802 m_game_ui_flags->force_fog_off = !show;
1805 void Client::showGameDebug(const bool show)
1807 m_game_ui_flags->show_debug = show;
1810 // IGameDef interface
1812 IItemDefManager* Client::getItemDefManager()
1816 INodeDefManager* Client::getNodeDefManager()
1820 ICraftDefManager* Client::getCraftDefManager()
1823 //return m_craftdef;
1825 ITextureSource* Client::getTextureSource()
1829 IShaderSource* Client::getShaderSource()
1834 u16 Client::allocateUnknownNodeId(const std::string &name)
1836 errorstream << "Client::allocateUnknownNodeId(): "
1837 << "Client cannot allocate node IDs" << std::endl;
1838 FATAL_ERROR("Client allocated unknown node");
1840 return CONTENT_IGNORE;
1842 ISoundManager* Client::getSoundManager()
1846 MtEventManager* Client::getEventManager()
1851 ParticleManager* Client::getParticleManager()
1853 return &m_particle_manager;
1856 scene::IAnimatedMesh* Client::getMesh(const std::string &filename)
1858 StringMap::const_iterator it = m_mesh_data.find(filename);
1859 if (it == m_mesh_data.end()) {
1860 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1861 << "\"" << std::endl;
1864 const std::string &data = it->second;
1866 // Create the mesh, remove it from cache and return it
1867 // This allows unique vertex colors and other properties for each instance
1868 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1869 io::IReadFile *rfile = RenderingEngine::get_filesystem()->createMemoryReadFile(
1870 *data_rw, data_rw.getSize(), filename.c_str());
1871 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1873 scene::IAnimatedMesh *mesh = RenderingEngine::get_scene_manager()->getMesh(rfile);
1875 // NOTE: By playing with Irrlicht refcounts, maybe we could cache a bunch
1876 // of uniquely named instances and re-use them
1878 RenderingEngine::get_mesh_cache()->removeMesh(mesh);
1882 const std::string* Client::getModFile(const std::string &filename)
1884 StringMap::const_iterator it = m_mod_files.find(filename);
1885 if (it == m_mod_files.end()) {
1886 errorstream << "Client::getModFile(): File not found: \"" << filename
1887 << "\"" << std::endl;
1893 bool Client::registerModStorage(ModMetadata *storage)
1895 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1896 errorstream << "Unable to register same mod storage twice. Storage name: "
1897 << storage->getModName() << std::endl;
1901 m_mod_storages[storage->getModName()] = storage;
1905 void Client::unregisterModStorage(const std::string &name)
1907 std::unordered_map<std::string, ModMetadata *>::const_iterator it =
1908 m_mod_storages.find(name);
1909 if (it != m_mod_storages.end()) {
1910 // Save unconditionaly on unregistration
1911 it->second->save(getModStoragePath());
1912 m_mod_storages.erase(name);
1916 std::string Client::getModStoragePath() const
1918 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";
1925 bool Client::joinModChannel(const std::string &channel)
1927 if (m_modchannel_mgr->channelRegistered(channel))
1930 NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
1934 m_modchannel_mgr->joinChannel(channel, 0);
1938 bool Client::leaveModChannel(const std::string &channel)
1940 if (!m_modchannel_mgr->channelRegistered(channel))
1943 NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
1947 m_modchannel_mgr->leaveChannel(channel, 0);
1951 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
1953 if (!m_modchannel_mgr->canWriteOnChannel(channel))
1956 if (message.size() > STRING_MAX_LEN) {
1957 warningstream << "ModChannel message too long, dropping before sending "
1958 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
1959 << channel << ")" << std::endl;
1963 // @TODO: do some client rate limiting
1964 NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
1965 pkt << channel << message;
1970 ModChannel* Client::getModChannel(const std::string &channel)
1972 return m_modchannel_mgr->getModChannel(channel);