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
  30 /*
  31         RemotePlayer
  32 */
  33 // static config cache for remoteplayer
  34 bool RemotePlayer::m_setting_cache_loaded = false;
  35 float RemotePlayer::m_setting_chat_message_limit_per_10sec = 0.0f;
  36 u16 RemotePlayer::m_setting_chat_message_limit_trigger_kick = 0;
  37
  38 RemotePlayer::RemotePlayer(const char *name, IItemDefManager *idef):
  39         Player(name, idef)
  40 {
  41         if (!RemotePlayer::m_setting_cache_loaded) {
  42                 RemotePlayer::m_setting_chat_message_limit_per_10sec =
  43                         g_settings->getFloat("chat_message_limit_per_10sec");
  44                 RemotePlayer::m_setting_chat_message_limit_trigger_kick =
  45                         g_settings->getU16("chat_message_limit_trigger_kick");
  46                 RemotePlayer::m_setting_cache_loaded = true;
  47         }
  48         movement_acceleration_default   = g_settings->getFloat("movement_acceleration_default")   * BS;
  49         movement_acceleration_air       = g_settings->getFloat("movement_acceleration_air")       * BS;
  50         movement_acceleration_fast      = g_settings->getFloat("movement_acceleration_fast")      * BS;
  51         movement_speed_walk             = g_settings->getFloat("movement_speed_walk")             * BS;
  52         movement_speed_crouch           = g_settings->getFloat("movement_speed_crouch")           * BS;
  53         movement_speed_fast             = g_settings->getFloat("movement_speed_fast")             * BS;
  54         movement_speed_climb            = g_settings->getFloat("movement_speed_climb")            * BS;
  55         movement_speed_jump             = g_settings->getFloat("movement_speed_jump")             * BS;
  56         movement_liquid_fluidity        = g_settings->getFloat("movement_liquid_fluidity")        * BS;
  57         movement_liquid_fluidity_smooth = g_settings->getFloat("movement_liquid_fluidity_smooth") * BS;
  58         movement_liquid_sink            = g_settings->getFloat("movement_liquid_sink")            * BS;
  59         movement_gravity                = g_settings->getFloat("movement_gravity")                * BS;
  60
  61         // copy defaults
  62         m_cloud_params.density = 0.4f;
  63         m_cloud_params.color_bright = video::SColor(229, 240, 240, 255);
  64         m_cloud_params.color_ambient = video::SColor(255, 0, 0, 0);
  65         m_cloud_params.height = 120.0f;
  66         m_cloud_params.thickness = 16.0f;
  67         m_cloud_params.speed = v2f(0.0f, -2.0f);
  68 }
  69
  70 void RemotePlayer::serializeExtraAttributes(std::string &output)
  71 {
  72         assert(m_sao);
  73         Json::Value json_root;
  74         const PlayerAttributes &attrs = m_sao->getExtendedAttributes();
  75         for (const auto &attr : attrs) {
  76                 json_root[attr.first] = attr.second;
  77         }
  78
  79         Json::FastWriter writer;
  80         output = writer.write(json_root);
  81         m_sao->setExtendedAttributeModified(false);
  82 }
  83
  84
  85 void RemotePlayer::deSerialize(std::istream &is, const std::string &playername,
  86                 PlayerSAO *sao)
  87 {
  88         Settings args;
  89
  90         if (!args.parseConfigLines(is, "PlayerArgsEnd")) {
  91                 throw SerializationError("PlayerArgsEnd of player " + playername + " not found!");
  92         }
  93
  94         m_dirty = true;
  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);
  98
  99         if (sao) {
 100                 try {
 101                         sao->setHPRaw(args.getS32("hp"));
 102                 } catch(SettingNotFoundException &e) {
 103                         sao->setHPRaw(PLAYER_MAX_HP);
 104                 }
 105
 106                 try {
 107                         sao->setBasePosition(args.getV3F("position"));
 108                 } catch (SettingNotFoundException &e) {}
 109
 110                 try {
 111                         sao->setPitch(args.getFloat("pitch"));
 112                 } catch (SettingNotFoundException &e) {}
 113                 try {
 114                         sao->setYaw(args.getFloat("yaw"));
 115                 } catch (SettingNotFoundException &e) {}
 116
 117                 try {
 118                         sao->setBreath(args.getS32("breath"), false);
 119                 } catch (SettingNotFoundException &e) {}
 120
 121                 try {
 122                         const std::string &extended_attributes = args.get("extended_attributes");
 123                         Json::Reader reader;
 124                         Json::Value attr_root;
 125                         reader.parse(extended_attributes, attr_root);
 126
 127                         const Json::Value::Members attr_list = attr_root.getMemberNames();
 128                         for (const auto &it : attr_list) {
 129                                 Json::Value attr_value = attr_root[it];
 130                                 sao->setExtendedAttribute(it, attr_value.asString());
 131                         }
 132                 } catch (SettingNotFoundException &e) {}
 133         }
 134
 135         inventory.deSerialize(is);
 136
 137         if (inventory.getList("craftpreview") == NULL) {
 138                 // Convert players without craftpreview
 139                 inventory.addList("craftpreview", 1);
 140
 141                 bool craftresult_is_preview = true;
 142                 if(args.exists("craftresult_is_preview"))
 143                         craftresult_is_preview = args.getBool("craftresult_is_preview");
 144                 if(craftresult_is_preview)
 145                 {
 146                         // Clear craftresult
 147                         inventory.getList("craftresult")->changeItem(0, ItemStack());
 148                 }
 149         }
 150 }
 151
 152 void RemotePlayer::serialize(std::ostream &os)
 153 {
 154         // Utilize a Settings object for storing values
 155         Settings args;
 156         args.setS32("version", 1);
 157         args.set("name", m_name);
 158
 159         // This should not happen
 160         assert(m_sao);
 161         args.setS32("hp", m_sao->getHP());
 162         args.setV3F("position", m_sao->getBasePosition());
 163         args.setFloat("pitch", m_sao->getPitch());
 164         args.setFloat("yaw", m_sao->getYaw());
 165         args.setS32("breath", m_sao->getBreath());
 166
 167         std::string extended_attrs;
 168         serializeExtraAttributes(extended_attrs);
 169         args.set("extended_attributes", extended_attrs);
 170
 171         args.writeLines(os);
 172
 173         os<<"PlayerArgsEnd\n";
 174
 175         inventory.serialize(os);
 176 }
 177
 178 const RemotePlayerChatResult RemotePlayer::canSendChatMessage()
 179 {
 180         // Rate limit messages
 181         u32 now = time(NULL);
 182         float time_passed = now - m_last_chat_message_sent;
 183         m_last_chat_message_sent = now;
 184
 185         // If this feature is disabled
 186         if (m_setting_chat_message_limit_per_10sec <= 0.0) {
 187                 return RPLAYER_CHATRESULT_OK;
 188         }
 189
 190         m_chat_message_allowance += time_passed * (m_setting_chat_message_limit_per_10sec / 8.0f);
 191         if (m_chat_message_allowance > m_setting_chat_message_limit_per_10sec) {
 192                 m_chat_message_allowance = m_setting_chat_message_limit_per_10sec;
 193         }
 194
 195         if (m_chat_message_allowance < 1.0f) {
 196                 infostream << "Player " << m_name
 197                                 << " chat limited due to excessive message amount." << std::endl;
 198
 199                 // Kick player if flooding is too intensive
 200                 m_message_rate_overhead++;
 201                 if (m_message_rate_overhead > RemotePlayer::m_setting_chat_message_limit_trigger_kick) {
 202                         return RPLAYER_CHATRESULT_KICK;
 203                 }
 204
 205                 return RPLAYER_CHATRESULT_FLOODING;
 206         }
 207
 208         // Reinit message overhead
 209         if (m_message_rate_overhead > 0) {
 210                 m_message_rate_overhead = 0;
 211         }
 212
 213         m_chat_message_allowance -= 1.0f;
 214         return RPLAYER_CHATRESULT_OK;
 215 }