3 Copyright (C) 2010-2016 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2014-2016 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include "remoteplayer.h"
22 #include <json/json.h>
23 #include "content_sao.h"
26 #include "porting.h" // strlcpy
29 #include "convert_json.h"
34 // static config cache for remoteplayer
35 bool RemotePlayer::m_setting_cache_loaded = false;
36 float RemotePlayer::m_setting_chat_message_limit_per_10sec = 0.0f;
37 u16 RemotePlayer::m_setting_chat_message_limit_trigger_kick = 0;
39 RemotePlayer::RemotePlayer(const char *name, IItemDefManager *idef):
42 if (!RemotePlayer::m_setting_cache_loaded) {
43 RemotePlayer::m_setting_chat_message_limit_per_10sec =
44 g_settings->getFloat("chat_message_limit_per_10sec");
45 RemotePlayer::m_setting_chat_message_limit_trigger_kick =
46 g_settings->getU16("chat_message_limit_trigger_kick");
47 RemotePlayer::m_setting_cache_loaded = true;
49 movement_acceleration_default = g_settings->getFloat("movement_acceleration_default") * BS;
50 movement_acceleration_air = g_settings->getFloat("movement_acceleration_air") * BS;
51 movement_acceleration_fast = g_settings->getFloat("movement_acceleration_fast") * BS;
52 movement_speed_walk = g_settings->getFloat("movement_speed_walk") * BS;
53 movement_speed_crouch = g_settings->getFloat("movement_speed_crouch") * BS;
54 movement_speed_fast = g_settings->getFloat("movement_speed_fast") * BS;
55 movement_speed_climb = g_settings->getFloat("movement_speed_climb") * BS;
56 movement_speed_jump = g_settings->getFloat("movement_speed_jump") * BS;
57 movement_liquid_fluidity = g_settings->getFloat("movement_liquid_fluidity") * BS;
58 movement_liquid_fluidity_smooth = g_settings->getFloat("movement_liquid_fluidity_smooth") * BS;
59 movement_liquid_sink = g_settings->getFloat("movement_liquid_sink") * BS;
60 movement_gravity = g_settings->getFloat("movement_gravity") * BS;
63 m_cloud_params.density = 0.4f;
64 m_cloud_params.color_bright = video::SColor(229, 240, 240, 255);
65 m_cloud_params.color_ambient = video::SColor(255, 0, 0, 0);
66 m_cloud_params.height = 120.0f;
67 m_cloud_params.thickness = 16.0f;
68 m_cloud_params.speed = v2f(0.0f, -2.0f);
71 void RemotePlayer::serializeExtraAttributes(std::string &output)
74 Json::Value json_root;
76 const StringMap &attrs = m_sao->getMeta().getStrings();
77 for (const auto &attr : attrs) {
78 json_root[attr.first] = attr.second;
81 output = fastWriteJson(json_root);
85 void RemotePlayer::deSerialize(std::istream &is, const std::string &playername,
90 if (!args.parseConfigLines(is, "PlayerArgsEnd")) {
91 throw SerializationError("PlayerArgsEnd of player " + playername + " not found!");
95 //args.getS32("version"); // Version field value not used
96 const std::string &name = args.get("name");
97 strlcpy(m_name, name.c_str(), PLAYERNAME_SIZE);
101 sao->setHPRaw(args.getS32("hp"));
102 } catch(SettingNotFoundException &e) {
103 sao->setHPRaw(PLAYER_MAX_HP_DEFAULT);
107 sao->setBasePosition(args.getV3F("position"));
108 } catch (SettingNotFoundException &e) {}
111 sao->setLookPitch(args.getFloat("pitch"));
112 } catch (SettingNotFoundException &e) {}
114 sao->setPlayerYaw(args.getFloat("yaw"));
115 } catch (SettingNotFoundException &e) {}
118 sao->setBreath(args.getS32("breath"), false);
119 } catch (SettingNotFoundException &e) {}
122 const std::string &extended_attributes = args.get("extended_attributes");
123 std::istringstream iss(extended_attributes);
124 Json::CharReaderBuilder builder;
125 builder.settings_["collectComments"] = false;
128 Json::Value attr_root;
129 Json::parseFromStream(builder, iss, &attr_root, &errs);
131 const Json::Value::Members attr_list = attr_root.getMemberNames();
132 for (const auto &it : attr_list) {
133 Json::Value attr_value = attr_root[it];
134 sao->getMeta().setString(it, attr_value.asString());
136 sao->getMeta().setModified(false);
137 } catch (SettingNotFoundException &e) {}
141 inventory.deSerialize(is);
142 } catch (SerializationError &e) {
143 errorstream << "Failed to deserialize player inventory. player_name="
144 << name << " " << e.what() << std::endl;
147 if (!inventory.getList("craftpreview") && inventory.getList("craftresult")) {
148 // Convert players without craftpreview
149 inventory.addList("craftpreview", 1);
151 bool craftresult_is_preview = true;
152 if(args.exists("craftresult_is_preview"))
153 craftresult_is_preview = args.getBool("craftresult_is_preview");
154 if(craftresult_is_preview)
157 inventory.getList("craftresult")->changeItem(0, ItemStack());
162 void RemotePlayer::serialize(std::ostream &os)
164 // Utilize a Settings object for storing values
166 args.setS32("version", 1);
167 args.set("name", m_name);
169 // This should not happen
171 args.setS32("hp", m_sao->getHP());
172 args.setV3F("position", m_sao->getBasePosition());
173 args.setFloat("pitch", m_sao->getLookPitch());
174 args.setFloat("yaw", m_sao->getRotation().Y);
175 args.setS32("breath", m_sao->getBreath());
177 std::string extended_attrs;
178 serializeExtraAttributes(extended_attrs);
179 args.set("extended_attributes", extended_attrs);
183 os<<"PlayerArgsEnd\n";
185 inventory.serialize(os);
188 const RemotePlayerChatResult RemotePlayer::canSendChatMessage()
190 // Rate limit messages
191 u32 now = time(NULL);
192 float time_passed = now - m_last_chat_message_sent;
193 m_last_chat_message_sent = now;
195 // If this feature is disabled
196 if (m_setting_chat_message_limit_per_10sec <= 0.0) {
197 return RPLAYER_CHATRESULT_OK;
200 m_chat_message_allowance += time_passed * (m_setting_chat_message_limit_per_10sec / 8.0f);
201 if (m_chat_message_allowance > m_setting_chat_message_limit_per_10sec) {
202 m_chat_message_allowance = m_setting_chat_message_limit_per_10sec;
205 if (m_chat_message_allowance < 1.0f) {
206 infostream << "Player " << m_name
207 << " chat limited due to excessive message amount." << std::endl;
209 // Kick player if flooding is too intensive
210 m_message_rate_overhead++;
211 if (m_message_rate_overhead > RemotePlayer::m_setting_chat_message_limit_trigger_kick) {
212 return RPLAYER_CHATRESULT_KICK;
215 return RPLAYER_CHATRESULT_FLOODING;
218 // Reinit message overhead
219 if (m_message_rate_overhead > 0) {
220 m_message_rate_overhead = 0;
223 m_chat_message_allowance -= 1.0f;
224 return RPLAYER_CHATRESULT_OK;
227 void RemotePlayer::on_successful_save()
231 m_sao->getMeta().setModified(false);