src/client/client.cpp

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