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