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