src/client/client.cpp

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