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