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