src/remoteplayer.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2016 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2014-2016 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21 #include "remoteplayer.h"
  22 #include <json/json.h>
  23 #include "content_sao.h"
  24 #include "filesys.h"
  25 #include "gamedef.h"
  26 #include "porting.h"  // strlcpy
  27 #include "server.h"
  28 #include "settings.h"
  29 #include "convert_json.h"
  30
  31 /*
  32         RemotePlayer
  33 */
  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;
  38
  39 RemotePlayer::RemotePlayer(const char *name, IItemDefManager *idef):
  40         Player(name, idef)
  41 {
  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;
  48         }
  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;
  61
  62         // copy defaults
  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);
  69 }
  70
  71 void RemotePlayer::serializeExtraAttributes(std::string &output)
  72 {
  73         assert(m_sao);
  74         Json::Value json_root;
  75         const PlayerAttributes &attrs = m_sao->getExtendedAttributes();
  76         for (const auto &attr : attrs) {
  77                 json_root[attr.first] = attr.second;
  78         }
  79
  80         output = fastWriteJson(json_root);
  81
  82         m_sao->setExtendedAttributeModified(false);
  83 }
  84
  85
  86 void RemotePlayer::deSerialize(std::istream &is, const std::string &playername,
  87                 PlayerSAO *sao)
  88 {
  89         Settings args;
  90
  91         if (!args.parseConfigLines(is, "PlayerArgsEnd")) {
  92                 throw SerializationError("PlayerArgsEnd of player " + playername + " not found!");
  93         }
  94
  95         m_dirty = true;
  96         //args.getS32("version"); // Version field value not used
  97         const std::string &name = args.get("name");
  98         strlcpy(m_name, name.c_str(), PLAYERNAME_SIZE);
  99
 100         if (sao) {
 101                 try {
 102                         sao->setHPRaw(args.getS32("hp"));
 103                 } catch(SettingNotFoundException &e) {
 104                         sao->setHPRaw(PLAYER_MAX_HP_DEFAULT);
 105                 }
 106
 107                 try {
 108                         sao->setBasePosition(args.getV3F("position"));
 109                 } catch (SettingNotFoundException &e) {}
 110
 111                 try {
 112                         sao->setPitch(args.getFloat("pitch"));
 113                 } catch (SettingNotFoundException &e) {}
 114                 try {
 115                         sao->setYaw(args.getFloat("yaw"));
 116                 } catch (SettingNotFoundException &e) {}
 117
 118                 try {
 119                         sao->setBreath(args.getS32("breath"), false);
 120                 } catch (SettingNotFoundException &e) {}
 121
 122                 try {
 123                         const std::string &extended_attributes = args.get("extended_attributes");
 124                         std::istringstream iss(extended_attributes);
 125                         Json::CharReaderBuilder builder;
 126                         builder.settings_["collectComments"] = false;
 127                         std::string errs;
 128
 129                         Json::Value attr_root;
 130                         Json::parseFromStream(builder, iss, &attr_root, &errs);
 131
 132                         const Json::Value::Members attr_list = attr_root.getMemberNames();
 133                         for (const auto &it : attr_list) {
 134                                 Json::Value attr_value = attr_root[it];
 135                                 sao->setExtendedAttribute(it, attr_value.asString());
 136                         }
 137                 } catch (SettingNotFoundException &e) {}
 138         }
 139
 140         inventory.deSerialize(is);
 141
 142         if (inventory.getList("craftpreview") == NULL) {
 143                 // Convert players without craftpreview
 144                 inventory.addList("craftpreview", 1);
 145
 146                 bool craftresult_is_preview = true;
 147                 if(args.exists("craftresult_is_preview"))
 148                         craftresult_is_preview = args.getBool("craftresult_is_preview");
 149                 if(craftresult_is_preview)
 150                 {
 151                         // Clear craftresult
 152                         inventory.getList("craftresult")->changeItem(0, ItemStack());
 153                 }
 154         }
 155 }
 156
 157 void RemotePlayer::serialize(std::ostream &os)
 158 {
 159         // Utilize a Settings object for storing values
 160         Settings args;
 161         args.setS32("version", 1);
 162         args.set("name", m_name);
 163
 164         // This should not happen
 165         assert(m_sao);
 166         args.setS32("hp", m_sao->getHP());
 167         args.setV3F("position", m_sao->getBasePosition());
 168         args.setFloat("pitch", m_sao->getPitch());
 169         args.setFloat("yaw", m_sao->getYaw());
 170         args.setS32("breath", m_sao->getBreath());
 171
 172         std::string extended_attrs;
 173         serializeExtraAttributes(extended_attrs);
 174         args.set("extended_attributes", extended_attrs);
 175
 176         args.writeLines(os);
 177
 178         os<<"PlayerArgsEnd\n";
 179
 180         inventory.serialize(os);
 181 }
 182
 183 const RemotePlayerChatResult RemotePlayer::canSendChatMessage()
 184 {
 185         // Rate limit messages
 186         u32 now = time(NULL);
 187         float time_passed = now - m_last_chat_message_sent;
 188         m_last_chat_message_sent = now;
 189
 190         // If this feature is disabled
 191         if (m_setting_chat_message_limit_per_10sec <= 0.0) {
 192                 return RPLAYER_CHATRESULT_OK;
 193         }
 194
 195         m_chat_message_allowance += time_passed * (m_setting_chat_message_limit_per_10sec / 8.0f);
 196         if (m_chat_message_allowance > m_setting_chat_message_limit_per_10sec) {
 197                 m_chat_message_allowance = m_setting_chat_message_limit_per_10sec;
 198         }
 199
 200         if (m_chat_message_allowance < 1.0f) {
 201                 infostream << "Player " << m_name
 202                                 << " chat limited due to excessive message amount." << std::endl;
 203
 204                 // Kick player if flooding is too intensive
 205                 m_message_rate_overhead++;
 206                 if (m_message_rate_overhead > RemotePlayer::m_setting_chat_message_limit_trigger_kick) {
 207                         return RPLAYER_CHATRESULT_KICK;
 208                 }
 209
 210                 return RPLAYER_CHATRESULT_FLOODING;
 211         }
 212
 213         // Reinit message overhead
 214         if (m_message_rate_overhead > 0) {
 215                 m_message_rate_overhead = 0;
 216         }
 217
 218         m_chat_message_allowance -= 1.0f;
 219         return RPLAYER_CHATRESULT_OK;
 220 }