src/client/client.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #include <iostream>
  21 #include <algorithm>
  22 #include <sstream>
  23 #include <cmath>
  24 #include <IFileSystem.h>
  25 #include "client.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/sound.h"
  34 #include "client/tile.h"
  35 #include "util/auth.h"
  36 #include "util/directiontables.h"
  37 #include "util/pointedthing.h"
  38 #include "util/serialize.h"
  39 #include "util/string.h"
  40 #include "util/srp.h"
  41 #include "filesys.h"
  42 #include "mapblock_mesh.h"
  43 #include "mapblock.h"
  44 #include "minimap.h"
  45 #include "modchannels.h"
  46 #include "content/mods.h"
  47 #include "profiler.h"
  48 #include "shader.h"
  49 #include "gettext.h"
  50 #include "clientmap.h"
  51 #include "clientmedia.h"
  52 #include "version.h"
  53 #include "database/database-files.h"
  54 #include "database/database-sqlite3.h"
  55 #include "serialization.h"
  56 #include "guiscalingfilter.h"
  57 #include "script/scripting_client.h"
  58 #include "game.h"
  59 #include "chatmessage.h"
  60 #include "translation.h"
  61 #include "content/mod_configuration.h"
  62
  63 extern gui::IGUIEnvironment* guienv;
  64
  65 /*
  66         Utility classes
  67 */
  68
  69 u32 PacketCounter::sum() const
  70 {
  71         u32 n = 0;
  72         for (const auto &it : m_packets)
  73                 n += it.second;
  74         return n;
  75 }
  76
  77 void PacketCounter::print(std::ostream &o) const
  78 {
  79         for (const auto &it : m_packets) {
  80                 auto name = it.first >= TOCLIENT_NUM_MSG_TYPES ? "?"
  81                         : toClientCommandTable[it.first].name;
  82                 o << "cmd " << it.first << " (" << name << ") count "
  83                         << it.second << std::endl;
  84         }
  85 }
  86
  87 /*
  88         Client
  89 */
  90
  91 Client::Client(
  92                 const char *playername,
  93                 const std::string &password,
  94                 const std::string &address_name,
  95                 MapDrawControl &control,
  96                 IWritableTextureSource *tsrc,
  97                 IWritableShaderSource *shsrc,
  98                 IWritableItemDefManager *itemdef,
  99                 NodeDefManager *nodedef,
 100                 ISoundManager *sound,
 101                 MtEventManager *event,
 102                 RenderingEngine *rendering_engine,
 103                 bool ipv6,
 104                 GameUI *game_ui,
 105                 ELoginRegister allow_login_or_register
 106 ):
 107         m_tsrc(tsrc),
 108         m_shsrc(shsrc),
 109         m_itemdef(itemdef),
 110         m_nodedef(nodedef),
 111         m_sound(sound),
 112         m_event(event),
 113         m_rendering_engine(rendering_engine),
 114         m_mesh_update_manager(this),
 115         m_env(
 116                 new ClientMap(this, rendering_engine, control, 666),
 117                 tsrc, this
 118         ),
 119         m_particle_manager(&m_env),
 120         m_con(new con::Connection(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this)),
 121         m_address_name(address_name),
 122         m_allow_login_or_register(allow_login_or_register),
 123         m_server_ser_ver(SER_FMT_VER_INVALID),
 124         m_last_chat_message_sent(time(NULL)),
 125         m_password(password),
 126         m_chosen_auth_mech(AUTH_MECHANISM_NONE),
 127         m_media_downloader(new ClientMediaDownloader()),
 128         m_state(LC_Created),
 129         m_game_ui(game_ui),
 130         m_modchannel_mgr(new ModChannelMgr())
 131 {
 132         // Add local player
 133         m_env.setLocalPlayer(new LocalPlayer(this, playername));
 134
 135         // Make the mod storage database and begin the save for later
 136         m_mod_storage_database =
 137                         new ModStorageDatabaseSQLite3(porting::path_user + DIR_DELIM + "client");
 138         m_mod_storage_database->beginSave();
 139
 140         if (g_settings->getBool("enable_minimap")) {
 141                 m_minimap = new Minimap(this);
 142         }
 143
 144         m_cache_save_interval = g_settings->getU16("server_map_save_interval");
 145 }
 146
 147 void Client::migrateModStorage()
 148 {
 149         std::string mod_storage_dir = porting::path_user + DIR_DELIM + "client";
 150         std::string old_mod_storage = mod_storage_dir + DIR_DELIM + "mod_storage";
 151         if (fs::IsDir(old_mod_storage)) {
 152                 infostream << "Migrating client mod storage to SQLite3 database" << std::endl;
 153                 {
 154                         ModStorageDatabaseFiles files_db(mod_storage_dir);
 155                         std::vector<std::string> mod_list;
 156                         files_db.listMods(&mod_list);
 157                         for (const std::string &modname : mod_list) {
 158                                 infostream << "Migrating client mod storage for mod " << modname << std::endl;
 159                                 StringMap meta;
 160                                 files_db.getModEntries(modname, &meta);
 161                                 for (const auto &pair : meta) {
 162                                         m_mod_storage_database->setModEntry(modname, pair.first, pair.second);
 163                                 }
 164                         }
 165                 }
 166                 if (!fs::Rename(old_mod_storage, old_mod_storage + ".bak")) {
 167                         // Execution cannot move forward if the migration does not complete.
 168                         throw BaseException("Could not finish migrating client mod storage");
 169                 }
 170                 infostream << "Finished migration of client mod storage" << std::endl;
 171         }
 172 }
 173
 174 void Client::loadMods()
 175 {
 176         // Don't load mods twice.
 177         // If client scripting is disabled by the client, don't load builtin or
 178         // client-provided mods.
 179         if (m_mods_loaded || !g_settings->getBool("enable_client_modding"))
 180                 return;
 181
 182         // If client scripting is disabled by the server, don't load builtin or
 183         // client-provided mods.
 184         // TODO Delete this code block when server-sent CSM and verifying of builtin are
 185         // complete.
 186         if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOAD_CLIENT_MODS)) {
 187                 warningstream << "Client-provided mod loading is disabled by server." <<
 188                         std::endl;
 189                 return;
 190         }
 191
 192         m_script = new ClientScripting(this);
 193         m_env.setScript(m_script);
 194         m_script->setEnv(&m_env);
 195
 196         // Load builtin
 197         scanModIntoMemory(BUILTIN_MOD_NAME, getBuiltinLuaPath());
 198         m_script->loadModFromMemory(BUILTIN_MOD_NAME);
 199         m_script->checkSetByBuiltin();
 200
 201         ModConfiguration modconf;
 202         {
 203                 std::unordered_map<std::string, std::string> paths;
 204                 std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
 205                 const auto modsPath = getClientModsLuaPath();
 206                 if (modsPath != path_user) {
 207                         paths["share"] = modsPath;
 208                 }
 209                 paths["mods"] = path_user;
 210
 211                 std::string settings_path = path_user + DIR_DELIM + "mods.conf";
 212                 modconf.addModsFromConfig(settings_path, paths);
 213                 modconf.checkConflictsAndDeps();
 214         }
 215
 216         m_mods = modconf.getMods();
 217
 218         // complain about mods with unsatisfied dependencies
 219         if (!modconf.isConsistent()) {
 220                 errorstream << modconf.getUnsatisfiedModsError() << std::endl;
 221                 return;
 222         }
 223
 224         // Print mods
 225         infostream << "Client loading mods: ";
 226         for (const ModSpec &mod : m_mods)
 227                 infostream << mod.name << " ";
 228         infostream << std::endl;
 229
 230         // Load "mod" scripts
 231         for (const ModSpec &mod : m_mods) {
 232                 mod.checkAndLog();
 233                 scanModIntoMemory(mod.name, mod.path);
 234         }
 235
 236         // Run them
 237         for (const ModSpec &mod : m_mods)
 238                 m_script->loadModFromMemory(mod.name);
 239
 240         // Mods are done loading. Unlock callbacks
 241         m_mods_loaded = true;
 242
 243         // Run a callback when mods are loaded
 244         m_script->on_mods_loaded();
 245
 246         // Create objects if they're ready
 247         if (m_state == LC_Ready)
 248                 m_script->on_client_ready(m_env.getLocalPlayer());
 249         if (m_camera)
 250                 m_script->on_camera_ready(m_camera);
 251         if (m_minimap)
 252                 m_script->on_minimap_ready(m_minimap);
 253 }
 254
 255 void Client::scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
 256                         std::string mod_subpath)
 257 {
 258         std::string full_path = mod_path + DIR_DELIM + mod_subpath;
 259         std::vector<fs::DirListNode> mod = fs::GetDirListing(full_path);
 260         for (const fs::DirListNode &j : mod) {
 261                 if (j.name[0] == '.')
 262                         continue;
 263
 264                 if (j.dir) {
 265                         scanModSubfolder(mod_name, mod_path, mod_subpath + j.name + DIR_DELIM);
 266                         continue;
 267                 }
 268                 std::replace(mod_subpath.begin(), mod_subpath.end(), DIR_DELIM_CHAR, '/');
 269
 270                 std::string real_path = full_path + j.name;
 271                 std::string vfs_path = mod_name + ":" + mod_subpath + j.name;
 272                 infostream << "Client::scanModSubfolder(): Loading \"" << real_path
 273                                 << "\" as \"" << vfs_path << "\"." << std::endl;
 274
 275                 std::string contents;
 276                 if (!fs::ReadFile(real_path, contents)) {
 277                         errorstream << "Client::scanModSubfolder(): Can't read file \""
 278                                         << real_path << "\"." << std::endl;
 279                         continue;
 280                 }
 281
 282                 m_mod_vfs.emplace(vfs_path, contents);
 283         }
 284 }
 285
 286 const std::string &Client::getBuiltinLuaPath()
 287 {
 288         static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
 289         return builtin_dir;
 290 }
 291
 292 const std::string &Client::getClientModsLuaPath()
 293 {
 294         static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
 295         return clientmods_dir;
 296 }
 297
 298 const std::vector<ModSpec>& Client::getMods() const
 299 {
 300         static std::vector<ModSpec> client_modspec_temp;
 301         return client_modspec_temp;
 302 }
 303
 304 const ModSpec* Client::getModSpec(const std::string &modname) const
 305 {
 306         return NULL;
 307 }
 308
 309 void Client::Stop()
 310 {
 311         m_shutdown = true;
 312         if (m_mods_loaded)
 313                 m_script->on_shutdown();
 314         //request all client managed threads to stop
 315         m_mesh_update_manager.stop();
 316         // Save local server map
 317         if (m_localdb) {
 318                 infostream << "Local map saving ended." << std::endl;
 319                 m_localdb->endSave();
 320         }
 321
 322         if (m_mods_loaded)
 323                 delete m_script;
 324 }
 325
 326 bool Client::isShutdown()
 327 {
 328         return m_shutdown || !m_mesh_update_manager.isRunning();
 329 }
 330
 331 Client::~Client()
 332 {
 333         m_shutdown = true;
 334         m_con->Disconnect();
 335
 336         deleteAuthData();
 337
 338         m_mesh_update_manager.stop();
 339         m_mesh_update_manager.wait();
 340
 341         MeshUpdateResult r;
 342         while (m_mesh_update_manager.getNextResult(r))
 343                 delete r.mesh;
 344
 345         delete m_inventory_from_server;
 346
 347         // Delete detached inventories
 348         for (auto &m_detached_inventorie : m_detached_inventories) {
 349                 delete m_detached_inventorie.second;
 350         }
 351
 352         // cleanup 3d model meshes on client shutdown
 353         m_rendering_engine->cleanupMeshCache();
 354
 355         guiScalingCacheClear();
 356
 357         delete m_minimap;
 358         m_minimap = nullptr;
 359
 360         delete m_media_downloader;
 361
 362         // Write the changes and delete
 363         if (m_mod_storage_database)
 364                 m_mod_storage_database->endSave();
 365         delete m_mod_storage_database;
 366 }
 367
 368 void Client::connect(Address address, bool is_local_server)
 369 {
 370         initLocalMapSaving(address, m_address_name, is_local_server);
 371
 372         // Since we use TryReceive() a timeout here would be ineffective anyway
 373         m_con->SetTimeoutMs(0);
 374         m_con->Connect(address);
 375 }
 376
 377 void Client::step(float dtime)
 378 {
 379         // Limit a bit
 380         if (dtime > 2.0)
 381                 dtime = 2.0;
 382
 383         m_animation_time += dtime;
 384         if(m_animation_time > 60.0)
 385                 m_animation_time -= 60.0;
 386
 387         m_time_of_day_update_timer += dtime;
 388
 389         ReceiveAll();
 390
 391         /*
 392                 Packet counter
 393         */
 394         {
 395                 float &counter = m_packetcounter_timer;
 396                 counter -= dtime;
 397                 if(counter <= 0.0f)
 398                 {
 399                         counter = 30.0f;
 400                         u32 sum = m_packetcounter.sum();
 401                         float avg = sum / counter;
 402
 403                         infostream << "Client packetcounter (" << counter << "s): "
 404                                         << "sum=" << sum << " avg=" << avg << "/s" << std::endl;
 405                         m_packetcounter.print(infostream);
 406                         m_packetcounter.clear();
 407                 }
 408         }
 409
 410         // UGLY hack to fix 2 second startup delay caused by non existent
 411         // server client startup synchronization in local server or singleplayer mode
 412         static bool initial_step = true;
 413         if (initial_step) {
 414                 initial_step = false;
 415         }
 416         else if(m_state == LC_Created) {
 417                 float &counter = m_connection_reinit_timer;
 418                 counter -= dtime;
 419                 if(counter <= 0.0) {
 420                         counter = 2.0;
 421
 422                         LocalPlayer *myplayer = m_env.getLocalPlayer();
 423                         FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
 424
 425                         sendInit(myplayer->getName());
 426                 }
 427
 428                 // Not connected, return
 429                 return;
 430         }
 431
 432         /*
 433                 Do stuff if connected
 434         */
 435
 436         /*
 437                 Run Map's timers and unload unused data
 438         */
 439         const float map_timer_and_unload_dtime = 5.25;
 440         if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
 441                 std::vector<v3s16> deleted_blocks;
 442                 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
 443                         std::max(g_settings->getFloat("client_unload_unused_data_timeout"), 0.0f),
 444                         g_settings->getS32("client_mapblock_limit"),
 445                         &deleted_blocks);
 446
 447                 /*
 448                         Send info to server
 449                         NOTE: This loop is intentionally iterated the way it is.
 450                 */
 451
 452                 std::vector<v3s16>::iterator i = deleted_blocks.begin();
 453                 std::vector<v3s16> sendlist;
 454                 for(;;) {
 455                         if(sendlist.size() == 255 || i == deleted_blocks.end()) {
 456                                 if(sendlist.empty())
 457                                         break;
 458                                 /*
 459                                         [0] u16 command
 460                                         [2] u8 count
 461                                         [3] v3s16 pos_0
 462                                         [3+6] v3s16 pos_1
 463                                         ...
 464                                 */
 465
 466                                 sendDeletedBlocks(sendlist);
 467
 468                                 if(i == deleted_blocks.end())
 469                                         break;
 470
 471                                 sendlist.clear();
 472                         }
 473
 474                         sendlist.push_back(*i);
 475                         ++i;
 476                 }
 477         }
 478
 479         /*
 480                 Send pending messages on out chat queue
 481         */
 482         if (!m_out_chat_queue.empty() && canSendChatMessage()) {
 483                 sendChatMessage(m_out_chat_queue.front());
 484                 m_out_chat_queue.pop();
 485         }
 486
 487         /*
 488                 Handle environment
 489         */
 490         LocalPlayer *player = m_env.getLocalPlayer();
 491
 492         // Step environment (also handles player controls)
 493         m_env.step(dtime);
 494         m_sound->step(dtime);
 495
 496         /*
 497                 Get events
 498         */
 499         while (m_env.hasClientEnvEvents()) {
 500                 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
 501
 502                 if (envEvent.type == CEE_PLAYER_DAMAGE) {
 503                         u16 damage = envEvent.player_damage.amount;
 504
 505                         if (envEvent.player_damage.send_to_server)
 506                                 sendDamage(damage);
 507
 508                         // Add to ClientEvent queue
 509                         ClientEvent *event = new ClientEvent();
 510                         event->type = CE_PLAYER_DAMAGE;
 511                         event->player_damage.amount = damage;
 512                         event->player_damage.effect = true;
 513                         m_client_event_queue.push(event);
 514                 }
 515         }
 516
 517         /*
 518                 Print some info
 519         */
 520         float &counter = m_avg_rtt_timer;
 521         counter += dtime;
 522         if(counter >= 10) {
 523                 counter = 0.0;
 524                 // connectedAndInitialized() is true, peer exists.
 525                 float avg_rtt = getRTT();
 526                 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
 527         }
 528
 529         /*
 530                 Send player position to server
 531         */
 532         {
 533                 float &counter = m_playerpos_send_timer;
 534                 counter += dtime;
 535                 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
 536                 {
 537                         counter = 0.0;
 538                         sendPlayerPos();
 539                 }
 540         }
 541
 542         /*
 543                 Replace updated meshes
 544         */
 545         {
 546                 int num_processed_meshes = 0;
 547                 std::vector<v3s16> blocks_to_ack;
 548                 bool force_update_shadows = false;
 549                 MeshUpdateResult r;
 550                 while (m_mesh_update_manager.getNextResult(r))
 551                 {
 552                         num_processed_meshes++;
 553
 554                         MinimapMapblock *minimap_mapblock = NULL;
 555                         bool do_mapper_update = true;
 556
 557                         MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
 558                         if (block) {
 559                                 // Delete the old mesh
 560                                 delete block->mesh;
 561                                 block->mesh = nullptr;
 562
 563                                 if (r.mesh) {
 564                                         minimap_mapblock = r.mesh->moveMinimapMapblock();
 565                                         if (minimap_mapblock == NULL)
 566                                                 do_mapper_update = false;
 567
 568                                         bool is_empty = true;
 569                                         for (int l = 0; l < MAX_TILE_LAYERS; l++)
 570                                                 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
 571                                                         is_empty = false;
 572
 573                                         if (is_empty)
 574                                                 delete r.mesh;
 575                                         else {
 576                                                 // Replace with the new mesh
 577                                                 block->mesh = r.mesh;
 578                                                 if (r.urgent)
 579                                                         force_update_shadows = true;
 580                                         }
 581                                 }
 582                         } else {
 583                                 delete r.mesh;
 584                         }
 585
 586                         if (m_minimap && do_mapper_update)
 587                                 m_minimap->addBlock(r.p, minimap_mapblock);
 588
 589                         if (r.ack_block_to_server) {
 590                                 if (blocks_to_ack.size() == 255) {
 591                                         sendGotBlocks(blocks_to_ack);
 592                                         blocks_to_ack.clear();
 593                                 }
 594
 595                                 blocks_to_ack.emplace_back(r.p);
 596                         }
 597                 }
 598                 if (blocks_to_ack.size() > 0) {
 599                                 // Acknowledge block(s)
 600                                 sendGotBlocks(blocks_to_ack);
 601                 }
 602
 603                 if (num_processed_meshes > 0)
 604                         g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
 605
 606                 auto shadow_renderer = RenderingEngine::get_shadow_renderer();
 607                 if (shadow_renderer && force_update_shadows)
 608                         shadow_renderer->setForceUpdateShadowMap();
 609         }
 610
 611         /*
 612                 Load fetched media
 613         */
 614         if (m_media_downloader && m_media_downloader->isStarted()) {
 615                 m_media_downloader->step(this);
 616                 if (m_media_downloader->isDone()) {
 617                         delete m_media_downloader;
 618                         m_media_downloader = NULL;
 619                 }
 620         }
 621         {
 622                 // Acknowledge dynamic media downloads to server
 623                 std::vector<u32> done;
 624                 for (auto it = m_pending_media_downloads.begin();
 625                                 it != m_pending_media_downloads.end();) {
 626                         assert(it->second->isStarted());
 627                         it->second->step(this);
 628                         if (it->second->isDone()) {
 629                                 done.emplace_back(it->first);
 630
 631                                 it = m_pending_media_downloads.erase(it);
 632                         } else {
 633                                 it++;
 634                         }
 635
 636                         if (done.size() == 255) { // maximum in one packet
 637                                 sendHaveMedia(done);
 638                                 done.clear();
 639                         }
 640                 }
 641                 if (!done.empty())
 642                         sendHaveMedia(done);
 643         }
 644
 645         /*
 646                 If the server didn't update the inventory in a while, revert
 647                 the local inventory (so the player notices the lag problem
 648                 and knows something is wrong).
 649         */
 650         if (m_inventory_from_server) {
 651                 float interval = 10.0f;
 652                 float count_before = std::floor(m_inventory_from_server_age / interval);
 653
 654                 m_inventory_from_server_age += dtime;
 655
 656                 float count_after = std::floor(m_inventory_from_server_age / interval);
 657
 658                 if (count_after != count_before) {
 659                         // Do this every <interval> seconds after TOCLIENT_INVENTORY
 660                         // Reset the locally changed inventory to the authoritative inventory
 661                         player->inventory = *m_inventory_from_server;
 662                         m_update_wielded_item = true;
 663                 }
 664         }
 665
 666         /*
 667                 Update positions of sounds attached to objects
 668         */
 669         {
 670                 for (auto &m_sounds_to_object : m_sounds_to_objects) {
 671                         int client_id = m_sounds_to_object.first;
 672                         u16 object_id = m_sounds_to_object.second;
 673                         ClientActiveObject *cao = m_env.getActiveObject(object_id);
 674                         if (!cao)
 675                                 continue;
 676                         m_sound->updateSoundPosition(client_id, cao->getPosition());
 677                 }
 678         }
 679
 680         /*
 681                 Handle removed remotely initiated sounds
 682         */
 683         m_removed_sounds_check_timer += dtime;
 684         if(m_removed_sounds_check_timer >= 2.32) {
 685                 m_removed_sounds_check_timer = 0;
 686                 // Find removed sounds and clear references to them
 687                 std::vector<s32> removed_server_ids;
 688                 for (std::unordered_map<s32, int>::iterator i = m_sounds_server_to_client.begin();
 689                                 i != m_sounds_server_to_client.end();) {
 690                         s32 server_id = i->first;
 691                         int client_id = i->second;
 692                         ++i;
 693                         if(!m_sound->soundExists(client_id)) {
 694                                 m_sounds_server_to_client.erase(server_id);
 695                                 m_sounds_client_to_server.erase(client_id);
 696                                 m_sounds_to_objects.erase(client_id);
 697                                 removed_server_ids.push_back(server_id);
 698                         }
 699                 }
 700
 701                 // Sync to server
 702                 if(!removed_server_ids.empty()) {
 703                         sendRemovedSounds(removed_server_ids);
 704                 }
 705         }
 706
 707         // Write changes to the mod storage
 708         m_mod_storage_save_timer -= dtime;
 709         if (m_mod_storage_save_timer <= 0.0f) {
 710                 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
 711                 m_mod_storage_database->endSave();
 712                 m_mod_storage_database->beginSave();
 713         }
 714
 715         // Write server map
 716         if (m_localdb && m_localdb_save_interval.step(dtime,
 717                         m_cache_save_interval)) {
 718                 m_localdb->endSave();
 719                 m_localdb->beginSave();
 720         }
 721 }
 722
 723 bool Client::loadMedia(const std::string &data, const std::string &filename,
 724         bool from_media_push)
 725 {
 726         std::string name;
 727
 728         const char *image_ext[] = {
 729                 ".png", ".jpg", ".bmp", ".tga",
 730                 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
 731                 NULL
 732         };
 733         name = removeStringEnd(filename, image_ext);
 734         if (!name.empty()) {
 735                 TRACESTREAM(<< "Client: Attempting to load image "
 736                         << "file \"" << filename << "\"" << std::endl);
 737
 738                 io::IFileSystem *irrfs = m_rendering_engine->get_filesystem();
 739                 video::IVideoDriver *vdrv = m_rendering_engine->get_video_driver();
 740
 741                 io::IReadFile *rfile = irrfs->createMemoryReadFile(
 742                                 data.c_str(), data.size(), "_tempreadfile");
 743
 744                 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
 745
 746                 // Read image
 747                 video::IImage *img = vdrv->createImageFromFile(rfile);
 748                 if (!img) {
 749                         errorstream<<"Client: Cannot create image from data of "
 750                                         <<"file \""<<filename<<"\""<<std::endl;
 751                         rfile->drop();
 752                         return false;
 753                 }
 754
 755                 m_tsrc->insertSourceImage(filename, img);
 756                 img->drop();
 757                 rfile->drop();
 758                 return true;
 759         }
 760
 761         const char *sound_ext[] = {
 762                 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
 763                 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
 764                 ".ogg", NULL
 765         };
 766         name = removeStringEnd(filename, sound_ext);
 767         if (!name.empty()) {
 768                 TRACESTREAM(<< "Client: Attempting to load sound "
 769                         << "file \"" << filename << "\"" << std::endl);
 770                 return m_sound->loadSoundData(name, data);
 771         }
 772
 773         const char *model_ext[] = {
 774                 ".x", ".b3d", ".md2", ".obj",
 775                 NULL
 776         };
 777         name = removeStringEnd(filename, model_ext);
 778         if (!name.empty()) {
 779                 verbosestream<<"Client: Storing model into memory: "
 780                                 <<"\""<<filename<<"\""<<std::endl;
 781                 if(m_mesh_data.count(filename))
 782                         errorstream<<"Multiple models with name \""<<filename.c_str()
 783                                         <<"\" found; replacing previous model"<<std::endl;
 784                 m_mesh_data[filename] = data;
 785                 return true;
 786         }
 787
 788         const char *translate_ext[] = {
 789                 ".tr", NULL
 790         };
 791         name = removeStringEnd(filename, translate_ext);
 792         if (!name.empty()) {
 793                 if (from_media_push)
 794                         return false;
 795                 TRACESTREAM(<< "Client: Loading translation: "
 796                                 << "\"" << filename << "\"" << std::endl);
 797                 g_client_translations->loadTranslation(data);
 798                 return true;
 799         }
 800
 801         errorstream << "Client: Don't know how to load file \""
 802                 << filename << "\"" << std::endl;
 803         return false;
 804 }
 805
 806 // Virtual methods from con::PeerHandler
 807 void Client::peerAdded(con::Peer *peer)
 808 {
 809         infostream << "Client::peerAdded(): peer->id="
 810                         << peer->id << std::endl;
 811 }
 812
 813 void Client::deletingPeer(con::Peer *peer, bool timeout)
 814 {
 815         infostream << "Client::deletingPeer(): "
 816                         "Server Peer is getting deleted "
 817                         << "(timeout=" << timeout << ")" << std::endl;
 818
 819         m_access_denied = true;
 820         if (timeout)
 821                 m_access_denied_reason = gettext("Connection timed out.");
 822         else if (m_access_denied_reason.empty())
 823                 m_access_denied_reason = gettext("Connection aborted (protocol error?).");
 824 }
 825
 826 /*
 827         u16 command
 828         u16 number of files requested
 829         for each file {
 830                 u16 length of name
 831                 string name
 832         }
 833 */
 834 void Client::request_media(const std::vector<std::string> &file_requests)
 835 {
 836         std::ostringstream os(std::ios_base::binary);
 837         writeU16(os, TOSERVER_REQUEST_MEDIA);
 838         size_t file_requests_size = file_requests.size();
 839
 840         FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
 841
 842         // Packet dynamicly resized
 843         NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
 844
 845         pkt << (u16) (file_requests_size & 0xFFFF);
 846
 847         for (const std::string &file_request : file_requests) {
 848                 pkt << file_request;
 849         }
 850
 851         Send(&pkt);
 852
 853         infostream << "Client: Sending media request list to server ("
 854                         << file_requests.size() << " files, packet size "
 855                         << pkt.getSize() << ")" << std::endl;
 856 }
 857
 858 void Client::initLocalMapSaving(const Address &address,
 859                 const std::string &hostname,
 860                 bool is_local_server)
 861 {
 862         if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
 863                 return;
 864         }
 865
 866         std::string world_path;
 867 #define set_world_path(hostname) \
 868         world_path = porting::path_user \
 869                 + DIR_DELIM + "worlds" \
 870                 + DIR_DELIM + "server_" \
 871                 + hostname + "_" + std::to_string(address.getPort());
 872
 873         set_world_path(hostname);
 874         if (!fs::IsDir(world_path)) {
 875                 std::string hostname_escaped = hostname;
 876                 str_replace(hostname_escaped, ':', '_');
 877                 set_world_path(hostname_escaped);
 878         }
 879 #undef set_world_path
 880         fs::CreateAllDirs(world_path);
 881
 882         m_localdb = new MapDatabaseSQLite3(world_path);
 883         m_localdb->beginSave();
 884         actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
 885 }
 886
 887 void Client::ReceiveAll()
 888 {
 889         NetworkPacket pkt;
 890         u64 start_ms = porting::getTimeMs();
 891         const u64 budget = 100;
 892         for(;;) {
 893                 // Limit time even if there would be huge amounts of data to
 894                 // process
 895                 if (porting::getTimeMs() > start_ms + budget) {
 896                         infostream << "Client::ReceiveAll(): "
 897                                         "Packet processing budget exceeded." << std::endl;
 898                         break;
 899                 }
 900
 901                 pkt.clear();
 902                 try {
 903                         if (!m_con->TryReceive(&pkt))
 904                                 break;
 905                         ProcessData(&pkt);
 906                 } catch (const con::InvalidIncomingDataException &e) {
 907                         infostream << "Client::ReceiveAll(): "
 908                                         "InvalidIncomingDataException: what()="
 909                                          << e.what() << std::endl;
 910                 }
 911         }
 912 }
 913
 914 inline void Client::handleCommand(NetworkPacket* pkt)
 915 {
 916         const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
 917         (this->*opHandle.handler)(pkt);
 918 }
 919
 920 /*
 921         sender_peer_id given to this shall be quaranteed to be a valid peer
 922 */
 923 void Client::ProcessData(NetworkPacket *pkt)
 924 {
 925         ToClientCommand command = (ToClientCommand) pkt->getCommand();
 926         u32 sender_peer_id = pkt->getPeerId();
 927
 928         //infostream<<"Client: received command="<<command<<std::endl;
 929         m_packetcounter.add((u16)command);
 930         g_profiler->graphAdd("client_received_packets", 1);
 931
 932         /*
 933                 If this check is removed, be sure to change the queue
 934                 system to know the ids
 935         */
 936         if(sender_peer_id != PEER_ID_SERVER) {
 937                 infostream << "Client::ProcessData(): Discarding data not "
 938                         "coming from server: peer_id=" << sender_peer_id << " command=" << pkt->getCommand()
 939                         << std::endl;
 940                 return;
 941         }
 942
 943         // Command must be handled into ToClientCommandHandler
 944         if (command >= TOCLIENT_NUM_MSG_TYPES) {
 945                 infostream << "Client: Ignoring unknown command "
 946                         << command << std::endl;
 947                 return;
 948         }
 949
 950         /*
 951          * Those packets are handled before m_server_ser_ver is set, it's normal
 952          * But we must use the new ToClientConnectionState in the future,
 953          * as a byte mask
 954          */
 955         if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
 956                 handleCommand(pkt);
 957                 return;
 958         }
 959
 960         if(m_server_ser_ver == SER_FMT_VER_INVALID) {
 961                 infostream << "Client: Server serialization"
 962                                 " format invalid or not initialized."
 963                                 " Skipping incoming command=" << command << std::endl;
 964                 return;
 965         }
 966
 967         /*
 968           Handle runtime commands
 969         */
 970
 971         handleCommand(pkt);
 972 }
 973
 974 void Client::Send(NetworkPacket* pkt)
 975 {
 976         m_con->Send(PEER_ID_SERVER,
 977                 serverCommandFactoryTable[pkt->getCommand()].channel,
 978                 pkt,
 979                 serverCommandFactoryTable[pkt->getCommand()].reliable);
 980 }
 981
 982 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
 983 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
 984 {
 985         v3f pf           = myplayer->getPosition() * 100;
 986         v3f sf           = myplayer->getSpeed() * 100;
 987         s32 pitch        = myplayer->getPitch() * 100;
 988         s32 yaw          = myplayer->getYaw() * 100;
 989         u32 keyPressed   = myplayer->control.getKeysPressed();
 990         // scaled by 80, so that pi can fit into a u8
 991         u8 fov           = clientMap->getCameraFov() * 80;
 992         u8 wanted_range  = MYMIN(255,
 993                         std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
 994
 995         v3s32 position(pf.X, pf.Y, pf.Z);
 996         v3s32 speed(sf.X, sf.Y, sf.Z);
 997
 998         /*
 999                 Format:
1000                 [0] v3s32 position*100
1001                 [12] v3s32 speed*100
1002                 [12+12] s32 pitch*100
1003                 [12+12+4] s32 yaw*100
1004                 [12+12+4+4] u32 keyPressed
1005                 [12+12+4+4+4] u8 fov*80
1006                 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
1007         */
1008         *pkt << position << speed << pitch << yaw << keyPressed;
1009         *pkt << fov << wanted_range;
1010 }
1011
1012 void Client::interact(InteractAction action, const PointedThing& pointed)
1013 {
1014         if(m_state != LC_Ready) {
1015                 errorstream << "Client::interact() "
1016                                 "Canceled (not connected)"
1017                                 << std::endl;
1018                 return;
1019         }
1020
1021         LocalPlayer *myplayer = m_env.getLocalPlayer();
1022         if (myplayer == NULL)
1023                 return;
1024
1025         /*
1026                 [0] u16 command
1027                 [2] u8 action
1028                 [3] u16 item
1029                 [5] u32 length of the next item (plen)
1030                 [9] serialized PointedThing
1031                 [9 + plen] player position information
1032         */
1033
1034         NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
1035
1036         pkt << (u8)action;
1037         pkt << myplayer->getWieldIndex();
1038
1039         std::ostringstream tmp_os(std::ios::binary);
1040         pointed.serialize(tmp_os);
1041
1042         pkt.putLongString(tmp_os.str());
1043
1044         writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
1045
1046         Send(&pkt);
1047 }
1048
1049 void Client::deleteAuthData()
1050 {
1051         if (!m_auth_data)
1052                 return;
1053
1054         switch (m_chosen_auth_mech) {
1055                 case AUTH_MECHANISM_FIRST_SRP:
1056                         break;
1057                 case AUTH_MECHANISM_SRP:
1058                 case AUTH_MECHANISM_LEGACY_PASSWORD:
1059                         srp_user_delete((SRPUser *) m_auth_data);
1060                         m_auth_data = NULL;
1061                         break;
1062                 case AUTH_MECHANISM_NONE:
1063                         break;
1064         }
1065         m_chosen_auth_mech = AUTH_MECHANISM_NONE;
1066 }
1067
1068
1069 AuthMechanism Client::choseAuthMech(const u32 mechs)
1070 {
1071         if (mechs & AUTH_MECHANISM_SRP)
1072                 return AUTH_MECHANISM_SRP;
1073
1074         if (mechs & AUTH_MECHANISM_FIRST_SRP)
1075                 return AUTH_MECHANISM_FIRST_SRP;
1076
1077         if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
1078                 return AUTH_MECHANISM_LEGACY_PASSWORD;
1079
1080         return AUTH_MECHANISM_NONE;
1081 }
1082
1083 void Client::sendInit(const std::string &playerName)
1084 {
1085         NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
1086
1087         // we don't support network compression yet
1088         u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1089
1090         pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1091         pkt << (u16) CLIENT_PROTOCOL_VERSION_MIN << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1092         pkt << playerName;
1093
1094         Send(&pkt);
1095 }
1096
1097 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1098 {
1099         m_chosen_auth_mech = chosen_auth_mechanism;
1100
1101         switch (chosen_auth_mechanism) {
1102                 case AUTH_MECHANISM_FIRST_SRP: {
1103                         // send srp verifier to server
1104                         std::string verifier;
1105                         std::string salt;
1106                         generate_srp_verifier_and_salt(getPlayerName(), m_password,
1107                                 &verifier, &salt);
1108
1109                         NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1110                         resp_pkt << salt << verifier << (u8)((m_password.empty()) ? 1 : 0);
1111
1112                         Send(&resp_pkt);
1113                         break;
1114                 }
1115                 case AUTH_MECHANISM_SRP:
1116                 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1117                         u8 based_on = 1;
1118
1119                         if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1120                                 m_password = translate_password(getPlayerName(), m_password);
1121                                 based_on = 0;
1122                         }
1123
1124                         std::string playername_u = lowercase(getPlayerName());
1125                         m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1126                                 getPlayerName().c_str(), playername_u.c_str(),
1127                                 (const unsigned char *) m_password.c_str(),
1128                                 m_password.length(), NULL, NULL);
1129                         char *bytes_A = 0;
1130                         size_t len_A = 0;
1131                         SRP_Result res = srp_user_start_authentication(
1132                                 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1133                                 (unsigned char **) &bytes_A, &len_A);
1134                         FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1135
1136                         NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1137                         resp_pkt << std::string(bytes_A, len_A) << based_on;
1138                         Send(&resp_pkt);
1139                         break;
1140                 }
1141                 case AUTH_MECHANISM_NONE:
1142                         break; // not handled in this method
1143         }
1144 }
1145
1146 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1147 {
1148         NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1149
1150         pkt << (u8) blocks.size();
1151
1152         for (const v3s16 &block : blocks) {
1153                 pkt << block;
1154         }
1155
1156         Send(&pkt);
1157 }
1158
1159 void Client::sendGotBlocks(const std::vector<v3s16> &blocks)
1160 {
1161         NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6 * blocks.size());
1162         pkt << (u8) blocks.size();
1163         for (const v3s16 &block : blocks)
1164                 pkt << block;
1165
1166         Send(&pkt);
1167 }
1168
1169 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1170 {
1171         size_t server_ids = soundList.size();
1172         assert(server_ids <= 0xFFFF);
1173
1174         NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1175
1176         pkt << (u16) (server_ids & 0xFFFF);
1177
1178         for (s32 sound_id : soundList)
1179                 pkt << sound_id;
1180
1181         Send(&pkt);
1182 }
1183
1184 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1185                 const StringMap &fields)
1186 {
1187         size_t fields_size = fields.size();
1188
1189         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1190
1191         NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1192
1193         pkt << p << formname << (u16) (fields_size & 0xFFFF);
1194
1195         StringMap::const_iterator it;
1196         for (it = fields.begin(); it != fields.end(); ++it) {
1197                 const std::string &name = it->first;
1198                 const std::string &value = it->second;
1199                 pkt << name;
1200                 pkt.putLongString(value);
1201         }
1202
1203         Send(&pkt);
1204 }
1205
1206 void Client::sendInventoryFields(const std::string &formname,
1207                 const StringMap &fields)
1208 {
1209         size_t fields_size = fields.size();
1210         FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1211
1212         NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1213         pkt << formname << (u16) (fields_size & 0xFFFF);
1214
1215         StringMap::const_iterator it;
1216         for (it = fields.begin(); it != fields.end(); ++it) {
1217                 const std::string &name  = it->first;
1218                 const std::string &value = it->second;
1219                 pkt << name;
1220                 pkt.putLongString(value);
1221         }
1222
1223         Send(&pkt);
1224 }
1225
1226 void Client::sendInventoryAction(InventoryAction *a)
1227 {
1228         std::ostringstream os(std::ios_base::binary);
1229
1230         a->serialize(os);
1231
1232         // Make data buffer
1233         std::string s = os.str();
1234
1235         NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1236         pkt.putRawString(s.c_str(),s.size());
1237
1238         Send(&pkt);
1239 }
1240
1241 bool Client::canSendChatMessage() const
1242 {
1243         u32 now = time(NULL);
1244         float time_passed = now - m_last_chat_message_sent;
1245
1246         float virt_chat_message_allowance = m_chat_message_allowance + time_passed *
1247                         (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1248
1249         if (virt_chat_message_allowance < 1.0f)
1250                 return false;
1251
1252         return true;
1253 }
1254
1255 void Client::sendChatMessage(const std::wstring &message)
1256 {
1257         const s16 max_queue_size = g_settings->getS16("max_out_chat_queue_size");
1258         if (canSendChatMessage()) {
1259                 u32 now = time(NULL);
1260                 float time_passed = now - m_last_chat_message_sent;
1261                 m_last_chat_message_sent = now;
1262
1263                 m_chat_message_allowance += time_passed * (CLIENT_CHAT_MESSAGE_LIMIT_PER_10S / 8.0f);
1264                 if (m_chat_message_allowance > CLIENT_CHAT_MESSAGE_LIMIT_PER_10S)
1265                         m_chat_message_allowance = CLIENT_CHAT_MESSAGE_LIMIT_PER_10S;
1266
1267                 m_chat_message_allowance -= 1.0f;
1268
1269                 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1270
1271                 pkt << message;
1272
1273                 Send(&pkt);
1274         } else if (m_out_chat_queue.size() < (u16) max_queue_size || max_queue_size < 0) {
1275                 m_out_chat_queue.push(message);
1276         } else {
1277                 infostream << "Could not queue chat message because maximum out chat queue size ("
1278                                 << max_queue_size << ") is reached." << std::endl;
1279         }
1280 }
1281
1282 void Client::clearOutChatQueue()
1283 {
1284         m_out_chat_queue = std::queue<std::wstring>();
1285 }
1286
1287 void Client::sendChangePassword(const std::string &oldpassword,
1288         const std::string &newpassword)
1289 {
1290         LocalPlayer *player = m_env.getLocalPlayer();
1291         if (player == NULL)
1292                 return;
1293
1294         // get into sudo mode and then send new password to server
1295         m_password = oldpassword;
1296         m_new_password = newpassword;
1297         startAuth(choseAuthMech(m_sudo_auth_methods));
1298 }
1299
1300
1301 void Client::sendDamage(u16 damage)
1302 {
1303         NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u16));
1304         pkt << damage;
1305         Send(&pkt);
1306 }
1307
1308 void Client::sendRespawn()
1309 {
1310         NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1311         Send(&pkt);
1312 }
1313
1314 void Client::sendReady()
1315 {
1316         NetworkPacket pkt(TOSERVER_CLIENT_READY,
1317                         1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash) + 2);
1318
1319         pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1320                 << (u8) 0 << (u16) strlen(g_version_hash);
1321
1322         pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1323         pkt << (u16)FORMSPEC_API_VERSION;
1324         Send(&pkt);
1325 }
1326
1327 void Client::sendPlayerPos()
1328 {
1329         LocalPlayer *player = m_env.getLocalPlayer();
1330         if (!player)
1331                 return;
1332
1333         // Save bandwidth by only updating position when
1334         // player is not dead and something changed
1335
1336         if (m_activeobjects_received && player->isDead())
1337                 return;
1338
1339         ClientMap &map = m_env.getClientMap();
1340         u8 camera_fov   = map.getCameraFov();
1341         u8 wanted_range = map.getControl().wanted_range;
1342
1343         u32 keyPressed = player->control.getKeysPressed();
1344
1345         if (
1346                         player->last_position     == player->getPosition() &&
1347                         player->last_speed        == player->getSpeed()    &&
1348                         player->last_pitch        == player->getPitch()    &&
1349                         player->last_yaw          == player->getYaw()      &&
1350                         player->last_keyPressed   == keyPressed            &&
1351                         player->last_camera_fov   == camera_fov            &&
1352                         player->last_wanted_range == wanted_range)
1353                 return;
1354
1355         player->last_position     = player->getPosition();
1356         player->last_speed        = player->getSpeed();
1357         player->last_pitch        = player->getPitch();
1358         player->last_yaw          = player->getYaw();
1359         player->last_keyPressed   = keyPressed;
1360         player->last_camera_fov   = camera_fov;
1361         player->last_wanted_range = wanted_range;
1362
1363         NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1364
1365         writePlayerPos(player, &map, &pkt);
1366
1367         Send(&pkt);
1368 }
1369
1370 void Client::sendHaveMedia(const std::vector<u32> &tokens)
1371 {
1372         NetworkPacket pkt(TOSERVER_HAVE_MEDIA, 1 + tokens.size() * 4);
1373
1374         sanity_check(tokens.size() < 256);
1375
1376         pkt << static_cast<u8>(tokens.size());
1377         for (u32 token : tokens)
1378                 pkt << token;
1379
1380         Send(&pkt);
1381 }
1382
1383 void Client::removeNode(v3s16 p)
1384 {
1385         std::map<v3s16, MapBlock*> modified_blocks;
1386
1387         try {
1388                 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1389         }
1390         catch(InvalidPositionException &e) {
1391         }
1392
1393         for (const auto &modified_block : modified_blocks) {
1394                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1395         }
1396 }
1397
1398 /**
1399  * Helper function for Client Side Modding
1400  * CSM restrictions are applied there, this should not be used for core engine
1401  * @param p
1402  * @param is_valid_position
1403  * @return
1404  */
1405 MapNode Client::CSMGetNode(v3s16 p, bool *is_valid_position)
1406 {
1407         if (checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES)) {
1408                 v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1409                 if ((u32) ppos.getDistanceFrom(p) > m_csm_restriction_noderange) {
1410                         *is_valid_position = false;
1411                         return {};
1412                 }
1413         }
1414         return m_env.getMap().getNode(p, is_valid_position);
1415 }
1416
1417 int Client::CSMClampRadius(v3s16 pos, int radius)
1418 {
1419         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1420                 return radius;
1421         // This is approximate and will cause some allowed nodes to be excluded
1422         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1423         u32 distance = ppos.getDistanceFrom(pos);
1424         if (distance >= m_csm_restriction_noderange)
1425                 return 0;
1426         return std::min<int>(radius, m_csm_restriction_noderange - distance);
1427 }
1428
1429 v3s16 Client::CSMClampPos(v3s16 pos)
1430 {
1431         if (!checkCSMRestrictionFlag(CSMRestrictionFlags::CSM_RF_LOOKUP_NODES))
1432                 return pos;
1433         v3s16 ppos = floatToInt(m_env.getLocalPlayer()->getPosition(), BS);
1434         const int range = m_csm_restriction_noderange;
1435         return v3s16(
1436                 core::clamp<int>(pos.X, (int)ppos.X - range, (int)ppos.X + range),
1437                 core::clamp<int>(pos.Y, (int)ppos.Y - range, (int)ppos.Y + range),
1438                 core::clamp<int>(pos.Z, (int)ppos.Z - range, (int)ppos.Z + range)
1439         );
1440 }
1441
1442 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1443 {
1444         //TimeTaker timer1("Client::addNode()");
1445
1446         std::map<v3s16, MapBlock*> modified_blocks;
1447
1448         try {
1449                 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1450                 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1451         }
1452         catch(InvalidPositionException &e) {
1453         }
1454
1455         for (const auto &modified_block : modified_blocks) {
1456                 addUpdateMeshTaskWithEdge(modified_block.first, false, true);
1457         }
1458 }
1459
1460 void Client::setPlayerControl(PlayerControl &control)
1461 {
1462         LocalPlayer *player = m_env.getLocalPlayer();
1463         assert(player);
1464         player->control = control;
1465 }
1466
1467 void Client::setPlayerItem(u16 item)
1468 {
1469         m_env.getLocalPlayer()->setWieldIndex(item);
1470         m_update_wielded_item = true;
1471
1472         NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1473         pkt << item;
1474         Send(&pkt);
1475 }
1476
1477 // Returns true once after the inventory of the local player
1478 // has been updated from the server.
1479 bool Client::updateWieldedItem()
1480 {
1481         if (!m_update_wielded_item)
1482                 return false;
1483
1484         m_update_wielded_item = false;
1485
1486         LocalPlayer *player = m_env.getLocalPlayer();
1487         assert(player);
1488         if (auto *list = player->inventory.getList("main"))
1489                 list->setModified(false);
1490         if (auto *list = player->inventory.getList("hand"))
1491                 list->setModified(false);
1492
1493         return true;
1494 }
1495
1496 scene::ISceneManager* Client::getSceneManager()
1497 {
1498         return m_rendering_engine->get_scene_manager();
1499 }
1500
1501 Inventory* Client::getInventory(const InventoryLocation &loc)
1502 {
1503         switch(loc.type){
1504         case InventoryLocation::UNDEFINED:
1505         {}
1506         break;
1507         case InventoryLocation::CURRENT_PLAYER:
1508         {
1509                 LocalPlayer *player = m_env.getLocalPlayer();
1510                 assert(player);
1511                 return &player->inventory;
1512         }
1513         break;
1514         case InventoryLocation::PLAYER:
1515         {
1516                 // Check if we are working with local player inventory
1517                 LocalPlayer *player = m_env.getLocalPlayer();
1518                 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1519                         return NULL;
1520                 return &player->inventory;
1521         }
1522         break;
1523         case InventoryLocation::NODEMETA:
1524         {
1525                 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1526                 if(!meta)
1527                         return NULL;
1528                 return meta->getInventory();
1529         }
1530         break;
1531         case InventoryLocation::DETACHED:
1532         {
1533                 if (m_detached_inventories.count(loc.name) == 0)
1534                         return NULL;
1535                 return m_detached_inventories[loc.name];
1536         }
1537         break;
1538         default:
1539                 FATAL_ERROR("Invalid inventory location type.");
1540                 break;
1541         }
1542         return NULL;
1543 }
1544
1545 void Client::inventoryAction(InventoryAction *a)
1546 {
1547         /*
1548                 Send it to the server
1549         */
1550         sendInventoryAction(a);
1551
1552         /*
1553                 Predict some local inventory changes
1554         */
1555         a->clientApply(this, this);
1556
1557         // Remove it
1558         delete a;
1559 }
1560
1561 float Client::getAnimationTime()
1562 {
1563         return m_animation_time;
1564 }
1565
1566 int Client::getCrackLevel()
1567 {
1568         return m_crack_level;
1569 }
1570
1571 v3s16 Client::getCrackPos()
1572 {
1573         return m_crack_pos;
1574 }
1575
1576 void Client::setCrack(int level, v3s16 pos)
1577 {
1578         int old_crack_level = m_crack_level;
1579         v3s16 old_crack_pos = m_crack_pos;
1580
1581         m_crack_level = level;
1582         m_crack_pos = pos;
1583
1584         if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1585         {
1586                 // remove old crack
1587                 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1588         }
1589         if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1590         {
1591                 // add new crack
1592                 addUpdateMeshTaskForNode(pos, false, true);
1593         }
1594 }
1595
1596 u16 Client::getHP()
1597 {
1598         LocalPlayer *player = m_env.getLocalPlayer();
1599         assert(player);
1600         return player->hp;
1601 }
1602
1603 bool Client::getChatMessage(std::wstring &res)
1604 {
1605         if (m_chat_queue.empty())
1606                 return false;
1607
1608         ChatMessage *chatMessage = m_chat_queue.front();
1609         m_chat_queue.pop();
1610
1611         res = L"";
1612
1613         switch (chatMessage->type) {
1614                 case CHATMESSAGE_TYPE_RAW:
1615                 case CHATMESSAGE_TYPE_ANNOUNCE:
1616                 case CHATMESSAGE_TYPE_SYSTEM:
1617                         res = chatMessage->message;
1618                         break;
1619                 case CHATMESSAGE_TYPE_NORMAL: {
1620                         if (!chatMessage->sender.empty())
1621                                 res = L"<" + chatMessage->sender + L"> " + chatMessage->message;
1622                         else
1623                                 res = chatMessage->message;
1624                         break;
1625                 }
1626                 default:
1627                         break;
1628         }
1629
1630         delete chatMessage;
1631         return true;
1632 }
1633
1634 void Client::typeChatMessage(const std::wstring &message)
1635 {
1636         // Discard empty line
1637         if (message.empty())
1638                 return;
1639
1640         // If message was consumed by script API, don't send it to server
1641         if (m_mods_loaded && m_script->on_sending_message(wide_to_utf8(message)))
1642                 return;
1643
1644         // Send to others
1645         sendChatMessage(message);
1646 }
1647
1648 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1649 {
1650         // Check if the block exists to begin with. In the case when a non-existing
1651         // neighbor is automatically added, it may not. In that case we don't want
1652         // to tell the mesh update thread about it.
1653         MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1654         if (b == NULL)
1655                 return;
1656
1657         m_mesh_update_manager.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1658 }
1659
1660 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1661 {
1662         m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, true);
1663 }
1664
1665 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1666 {
1667         {
1668                 v3s16 p = nodepos;
1669                 infostream<<"Client::addUpdateMeshTaskForNode(): "
1670                                 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1671                                 <<std::endl;
1672         }
1673
1674         v3s16 blockpos = getNodeBlockPos(nodepos);
1675         v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1676         m_mesh_update_manager.updateBlock(&m_env.getMap(), blockpos, ack_to_server, urgent, false);
1677         // Leading edge
1678         if (nodepos.X == blockpos_relative.X)
1679                 addUpdateMeshTask(blockpos + v3s16(-1, 0, 0), false, urgent);
1680         if (nodepos.Y == blockpos_relative.Y)
1681                 addUpdateMeshTask(blockpos + v3s16(0, -1, 0), false, urgent);
1682         if (nodepos.Z == blockpos_relative.Z)
1683                 addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
1684 }
1685
1686 ClientEvent *Client::getClientEvent()
1687 {
1688         FATAL_ERROR_IF(m_client_event_queue.empty(),
1689                         "Cannot getClientEvent, queue is empty.");
1690
1691         ClientEvent *event = m_client_event_queue.front();
1692         m_client_event_queue.pop();
1693         return event;
1694 }
1695
1696 const Address Client::getServerAddress()
1697 {
1698         return m_con->GetPeerAddress(PEER_ID_SERVER);
1699 }
1700
1701 float Client::mediaReceiveProgress()
1702 {
1703         if (m_media_downloader)
1704                 return m_media_downloader->getProgress();
1705
1706         return 1.0; // downloader only exists when not yet done
1707 }
1708
1709 struct TextureUpdateArgs {
1710         gui::IGUIEnvironment *guienv;
1711         u64 last_time_ms;
1712         u16 last_percent;
1713         const wchar_t* text_base;
1714         ITextureSource *tsrc;
1715 };
1716
1717 void Client::showUpdateProgressTexture(void *args, u32 progress, u32 max_progress)
1718 {
1719                 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1720                 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1721
1722                 // update the loading menu -- if necessary
1723                 bool do_draw = false;
1724                 u64 time_ms = targs->last_time_ms;
1725                 if (cur_percent != targs->last_percent) {
1726                         targs->last_percent = cur_percent;
1727                         time_ms = porting::getTimeMs();
1728                         // only draw when the user will notice something:
1729                         do_draw = (time_ms - targs->last_time_ms > 100);
1730                 }
1731
1732                 if (do_draw) {
1733                         targs->last_time_ms = time_ms;
1734                         std::wostringstream strm;
1735                         strm << targs->text_base << L" " << targs->last_percent << L"%...";
1736                         m_rendering_engine->draw_load_screen(strm.str(), targs->guienv, targs->tsrc, 0,
1737                                 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1738                 }
1739 }
1740
1741 void Client::afterContentReceived()
1742 {
1743         infostream<<"Client::afterContentReceived() started"<<std::endl;
1744         assert(m_itemdef_received); // pre-condition
1745         assert(m_nodedef_received); // pre-condition
1746         assert(mediaReceived()); // pre-condition
1747
1748         const wchar_t* text = wgettext("Loading textures...");
1749
1750         // Clear cached pre-scaled 2D GUI images, as this cache
1751         // might have images with the same name but different
1752         // content from previous sessions.
1753         guiScalingCacheClear();
1754
1755         // Rebuild inherited images and recreate textures
1756         infostream<<"- Rebuilding images and textures"<<std::endl;
1757         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 70);
1758         m_tsrc->rebuildImagesAndTextures();
1759         delete[] text;
1760
1761         // Rebuild shaders
1762         infostream<<"- Rebuilding shaders"<<std::endl;
1763         text = wgettext("Rebuilding shaders...");
1764         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 71);
1765         m_shsrc->rebuildShaders();
1766         delete[] text;
1767
1768         // Update node aliases
1769         infostream<<"- Updating node aliases"<<std::endl;
1770         text = wgettext("Initializing nodes...");
1771         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 72);
1772         m_nodedef->updateAliases(m_itemdef);
1773         for (const auto &path : getTextureDirs()) {
1774                 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
1775                 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
1776                 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
1777         }
1778         m_nodedef->setNodeRegistrationStatus(true);
1779         m_nodedef->runNodeResolveCallbacks();
1780         delete[] text;
1781
1782         // Update node textures and assign shaders to each tile
1783         infostream<<"- Updating node textures"<<std::endl;
1784         TextureUpdateArgs tu_args;
1785         tu_args.guienv = guienv;
1786         tu_args.last_time_ms = porting::getTimeMs();
1787         tu_args.last_percent = 0;
1788         tu_args.text_base = wgettext("Initializing nodes");
1789         tu_args.tsrc = m_tsrc;
1790         m_nodedef->updateTextures(this, &tu_args);
1791         delete[] tu_args.text_base;
1792
1793         // Start mesh update thread after setting up content definitions
1794         infostream<<"- Starting mesh update thread"<<std::endl;
1795         m_mesh_update_manager.start();
1796
1797         m_state = LC_Ready;
1798         sendReady();
1799
1800         if (m_mods_loaded)
1801                 m_script->on_client_ready(m_env.getLocalPlayer());
1802
1803         text = wgettext("Done!");
1804         m_rendering_engine->draw_load_screen(text, guienv, m_tsrc, 0, 100);
1805         infostream<<"Client::afterContentReceived() done"<<std::endl;
1806         delete[] text;
1807 }
1808
1809 float Client::getRTT()
1810 {
1811         return m_con->getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1812 }
1813
1814 float Client::getCurRate()
1815 {
1816         return (m_con->getLocalStat(con::CUR_INC_RATE) +
1817                         m_con->getLocalStat(con::CUR_DL_RATE));
1818 }
1819
1820 void Client::makeScreenshot()
1821 {
1822         irr::video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
1823         irr::video::IImage* const raw_image = driver->createScreenShot();
1824
1825         if (!raw_image)
1826                 return;
1827
1828         const struct tm tm = mt_localtime();
1829
1830         char timetstamp_c[64];
1831         strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", &tm);
1832
1833         std::string screenshot_dir;
1834
1835         if (fs::IsPathAbsolute(g_settings->get("screenshot_path")))
1836                 screenshot_dir = g_settings->get("screenshot_path");
1837         else
1838                 screenshot_dir = porting::path_user + DIR_DELIM + g_settings->get("screenshot_path");
1839
1840         std::string filename_base = screenshot_dir
1841                         + DIR_DELIM
1842                         + std::string("screenshot_")
1843                         + std::string(timetstamp_c);
1844         std::string filename_ext = "." + g_settings->get("screenshot_format");
1845         std::string filename;
1846
1847         // Create the directory if it doesn't already exist.
1848         // Otherwise, saving the screenshot would fail.
1849         fs::CreateDir(screenshot_dir);
1850
1851         u32 quality = (u32)g_settings->getS32("screenshot_quality");
1852         quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1853
1854         // Try to find a unique filename
1855         unsigned serial = 0;
1856
1857         while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1858                 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1859                 std::ifstream tmp(filename.c_str());
1860                 if (!tmp.good())
1861                         break;  // File did not apparently exist, we'll go with it
1862                 serial++;
1863         }
1864
1865         if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1866                 infostream << "Could not find suitable filename for screenshot" << std::endl;
1867         } else {
1868                 irr::video::IImage* const image =
1869                                 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1870
1871                 if (image) {
1872                         raw_image->copyTo(image);
1873
1874                         std::ostringstream sstr;
1875                         if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1876                                 sstr << "Saved screenshot to '" << filename << "'";
1877                         } else {
1878                                 sstr << "Failed to save screenshot '" << filename << "'";
1879                         }
1880                         pushToChatQueue(new ChatMessage(CHATMESSAGE_TYPE_SYSTEM,
1881                                         utf8_to_wide(sstr.str())));
1882                         infostream << sstr.str() << std::endl;
1883                         image->drop();
1884                 }
1885         }
1886
1887         raw_image->drop();
1888 }
1889
1890 bool Client::shouldShowMinimap() const
1891 {
1892         return !m_minimap_disabled_by_server;
1893 }
1894
1895 void Client::pushToEventQueue(ClientEvent *event)
1896 {
1897         m_client_event_queue.push(event);
1898 }
1899
1900 void Client::showMinimap(const bool show)
1901 {
1902         m_game_ui->showMinimap(show);
1903 }
1904
1905 // IGameDef interface
1906 // Under envlock
1907 IItemDefManager* Client::getItemDefManager()
1908 {
1909         return m_itemdef;
1910 }
1911 const NodeDefManager* Client::getNodeDefManager()
1912 {
1913         return m_nodedef;
1914 }
1915 ICraftDefManager* Client::getCraftDefManager()
1916 {
1917         return NULL;
1918         //return m_craftdef;
1919 }
1920 ITextureSource* Client::getTextureSource()
1921 {
1922         return m_tsrc;
1923 }
1924 IWritableShaderSource* Client::getShaderSource()
1925 {
1926         return m_shsrc;
1927 }
1928
1929 u16 Client::allocateUnknownNodeId(const std::string &name)
1930 {
1931         errorstream << "Client::allocateUnknownNodeId(): "
1932                         << "Client cannot allocate node IDs" << std::endl;
1933         FATAL_ERROR("Client allocated unknown node");
1934
1935         return CONTENT_IGNORE;
1936 }
1937 ISoundManager* Client::getSoundManager()
1938 {
1939         return m_sound;
1940 }
1941 MtEventManager* Client::getEventManager()
1942 {
1943         return m_event;
1944 }
1945
1946 ParticleManager* Client::getParticleManager()
1947 {
1948         return &m_particle_manager;
1949 }
1950
1951 scene::IAnimatedMesh* Client::getMesh(const std::string &filename, bool cache)
1952 {
1953         StringMap::const_iterator it = m_mesh_data.find(filename);
1954         if (it == m_mesh_data.end()) {
1955                 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1956                         << "\"" << std::endl;
1957                 return NULL;
1958         }
1959         const std::string &data    = it->second;
1960
1961         // Create the mesh, remove it from cache and return it
1962         // This allows unique vertex colors and other properties for each instance
1963         io::IReadFile *rfile = m_rendering_engine->get_filesystem()->createMemoryReadFile(
1964                         data.c_str(), data.size(), filename.c_str());
1965         FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1966
1967         scene::IAnimatedMesh *mesh = m_rendering_engine->get_scene_manager()->getMesh(rfile);
1968         rfile->drop();
1969         if (!mesh)
1970                 return nullptr;
1971         mesh->grab();
1972         if (!cache)
1973                 m_rendering_engine->removeMesh(mesh);
1974         return mesh;
1975 }
1976
1977 const std::string* Client::getModFile(std::string filename)
1978 {
1979         // strip dir delimiter from beginning of path
1980         auto pos = filename.find_first_of(':');
1981         if (pos == std::string::npos)
1982                 return nullptr;
1983         pos++;
1984         auto pos2 = filename.find_first_not_of('/', pos);
1985         if (pos2 > pos)
1986                 filename.erase(pos, pos2 - pos);
1987
1988         StringMap::const_iterator it = m_mod_vfs.find(filename);
1989         if (it == m_mod_vfs.end())
1990                 return nullptr;
1991         return &it->second;
1992 }
1993
1994 /*
1995  * Mod channels
1996  */
1997
1998 bool Client::joinModChannel(const std::string &channel)
1999 {
2000         if (m_modchannel_mgr->channelRegistered(channel))
2001                 return false;
2002
2003         NetworkPacket pkt(TOSERVER_MODCHANNEL_JOIN, 2 + channel.size());
2004         pkt << channel;
2005         Send(&pkt);
2006
2007         m_modchannel_mgr->joinChannel(channel, 0);
2008         return true;
2009 }
2010
2011 bool Client::leaveModChannel(const std::string &channel)
2012 {
2013         if (!m_modchannel_mgr->channelRegistered(channel))
2014                 return false;
2015
2016         NetworkPacket pkt(TOSERVER_MODCHANNEL_LEAVE, 2 + channel.size());
2017         pkt << channel;
2018         Send(&pkt);
2019
2020         m_modchannel_mgr->leaveChannel(channel, 0);
2021         return true;
2022 }
2023
2024 bool Client::sendModChannelMessage(const std::string &channel, const std::string &message)
2025 {
2026         if (!m_modchannel_mgr->canWriteOnChannel(channel))
2027                 return false;
2028
2029         if (message.size() > STRING_MAX_LEN) {
2030                 warningstream << "ModChannel message too long, dropping before sending "
2031                                 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
2032                                 << channel << ")" << std::endl;
2033                 return false;
2034         }
2035
2036         // @TODO: do some client rate limiting
2037         NetworkPacket pkt(TOSERVER_MODCHANNEL_MSG, 2 + channel.size() + 2 + message.size());
2038         pkt << channel << message;
2039         Send(&pkt);
2040         return true;
2041 }
2042
2043 ModChannel* Client::getModChannel(const std::string &channel)
2044 {
2045         return m_modchannel_mgr->getModChannel(channel);
2046 }