diff --git a/.github/workflows/cmake-windows.yml b/.github/workflows/cmake-windows.yml index aa9b43b..b882766 100644 --- a/.github/workflows/cmake-windows.yml +++ b/.github/workflows/cmake-windows.yml @@ -20,7 +20,7 @@ jobs: with: vcpkgArguments: 'lua zlib rapidjson openssl websocketpp curl' vcpkgDirectory: '${{ runner.workspace }}/b/vcpkg' - vcpkgGitCommitId: '8dddc6c899ce6fdbeab38b525a31e7f23cb2d5bb' + vcpkgGitCommitId: 'a106de33bbee694e3be6243718aa2a549a692832' vcpkgTriplet: 'x64-windows-static' - name: Create Build Environment diff --git a/.github/workflows/release-build.yml b/.github/workflows/release-build.yml index 8d2063a..2f8e3f3 100644 --- a/.github/workflows/release-build.yml +++ b/.github/workflows/release-build.yml @@ -85,7 +85,7 @@ jobs: with: vcpkgArguments: 'lua zlib rapidjson openssl websocketpp curl' vcpkgDirectory: '${{ runner.workspace }}/b/vcpkg' - vcpkgGitCommitId: '8dddc6c899ce6fdbeab38b525a31e7f23cb2d5bb' + vcpkgGitCommitId: 'a106de33bbee694e3be6243718aa2a549a692832' vcpkgTriplet: 'x64-windows-static' - name: Create Build Environment diff --git a/CMakeLists.txt b/CMakeLists.txt index 6a36c83..7ada026 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -37,7 +37,7 @@ if (WIN32) endif() include_directories("include/sentry-native/include") -set(SENTRY_BUILD_SHARED_LIBS OFF) +set(BUILD_SHARED_LIBS OFF) if (MSVC) set(SENTRY_BUILD_RUNTIMESTATIC ON) endif() @@ -60,6 +60,10 @@ if (MSVC) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /bigobj") endif () +message(STATUS "Adding local source dependencies") +# this has to happen before -DDEBUG since it wont compile properly with -DDEBUG +add_subdirectory(deps) + message(STATUS "Setting compiler flags") if (WIN32) @@ -78,9 +82,6 @@ elseif (UNIX) endif () -message(STATUS "Adding local source dependencies") -# this has to happen before -DDEBUG since it wont compile properly with -DDEBUG -add_subdirectory(deps) set(CMAKE_CXX_STANDARD 17) diff --git a/Changelog.md b/Changelog.md index 982c893..0486505 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,14 @@ +# v3.0.2 + +- ADDED Periodic update message if a new server is released +- ADDED Config setting for the IP the http server listens on +- CHANGED Default MaxPlayers to 8 +- CHANGED Default http server listen IP to localhost +- FIXED `MP.CreateEventTimer` filling up the queue (see ) +- FIXED `MP.TriggerClientEvent` not kicking the client if it failed +- FIXED Lua result queue handling not checking all results +- FIXED bug which caused ServerConfig.toml to generate incorrectly + # v3.0.1 - ADDED Backup URLs to UpdateCheck (will fail less often now) diff --git a/deps/commandline b/deps/commandline index 71240f6..d6b1c32 160000 --- a/deps/commandline +++ b/deps/commandline @@ -1 +1 @@ -Subproject commit 71240f634b211d830679e7d2841b897c7c30dad9 +Subproject commit d6b1c32c8af6ad5306f9f001305b3be9928ae4bb diff --git a/deps/toml11 b/deps/toml11 index fda0a2b..1400dd2 160000 --- a/deps/toml11 +++ b/deps/toml11 @@ -1 +1 @@ -Subproject commit fda0a2b9abd16e356f777c40a675131821c71b00 +Subproject commit 1400dd223fb4297337266fcb5d04b700338aea71 diff --git a/include/Client.h b/include/Client.h index 93882f2..d513659 100644 --- a/include/Client.h +++ b/include/Client.h @@ -92,7 +92,7 @@ private: std::queue mPacketsSync; std::unordered_map mIdentifiers; bool mIsGuest = false; - std::mutex mVehicleDataMutex; + mutable std::mutex mVehicleDataMutex; TSetOfVehicleData mVehicleData; std::string mName = "Unknown Client"; SOCKET mSocket[2] { SOCKET(0), SOCKET(0) }; diff --git a/include/Common.h b/include/Common.h index 2cf15b9..39714d0 100644 --- a/include/Common.h +++ b/include/Common.h @@ -7,6 +7,7 @@ extern TSentry Sentry; #include #include #include +#include #include #include #include @@ -43,7 +44,7 @@ public: std::string SSLKeyPath { "./.ssl/HttpServer/key.pem" }; std::string SSLCertPath { "./.ssl/HttpServer/cert.pem" }; bool HTTPServerEnabled { false }; - int MaxPlayers { 10 }; + int MaxPlayers { 8 }; bool Private { true }; int MaxCars { 1 }; bool DebugModeEnabled { false }; @@ -52,7 +53,9 @@ public: bool SendErrors { true }; bool SendErrorsMessageEnabled { true }; int HTTPServerPort { 8080 }; - bool HTTPServerUseSSL { true }; + std::string HTTPServerIP { "127.0.0.1" }; + bool HTTPServerUseSSL { false }; + bool HideUpdateMessages { false }; [[nodiscard]] bool HasCustomIP() const { return !CustomIP.empty(); } }; @@ -119,7 +122,7 @@ private: static inline std::mutex mShutdownHandlersMutex {}; static inline std::deque mShutdownHandlers {}; - static inline Version mVersion { 3, 0, 1 }; + static inline Version mVersion { 3, 0, 2 }; }; std::string ThreadName(bool DebugModeOverride = false); diff --git a/include/TConsole.h b/include/TConsole.h index c393842..839f862 100644 --- a/include/TConsole.h +++ b/include/TConsole.h @@ -15,6 +15,7 @@ public: void WriteRaw(const std::string& str); void InitializeLuaConsole(TLuaEngine& Engine); void BackupOldLog(); + void StartLoggingToFile(); Commandline& Internal() { return mCommandline; } private: @@ -37,4 +38,6 @@ private: bool mFirstTime { true }; std::string mStateId; const std::string mDefaultStateId = "BEAMMP_SERVER_CONSOLE"; + std::ofstream mLogFileStream; + std::mutex mLogFileStreamMtx; }; diff --git a/include/TLuaEngine.h b/include/TLuaEngine.h index 9b0a884..5ca2222 100644 --- a/include/TLuaEngine.h +++ b/include/TLuaEngine.h @@ -6,6 +6,7 @@ #include #include #include +#include #include #include #include @@ -72,6 +73,18 @@ private: class TLuaEngine : IThreaded { public: + enum CallStrategy : int { + BestEffort, + Precise, + }; + + struct QueuedFunction { + std::string FunctionName; + std::shared_ptr Result; + std::vector Args; + std::string EventName; // optional, may be empty + }; + TLuaEngine(); ~TLuaEngine() noexcept { beammp_debug("Lua Engine terminated"); @@ -145,7 +158,7 @@ public: return Results; // } std::set GetEventHandlersForState(const std::string& EventName, TLuaStateId StateId); - void CreateEventTimer(const std::string& EventName, TLuaStateId StateId, size_t IntervalMS); + void CreateEventTimer(const std::string& EventName, TLuaStateId StateId, size_t IntervalMS, CallStrategy Strategy); void CancelEventTimers(const std::string& EventName, TLuaStateId StateId); sol::state_view GetStateForPlugin(const fs::path& PluginPath); TLuaStateId GetStateIDForPlugin(const fs::path& PluginPath); @@ -166,6 +179,7 @@ private: ~StateThreadData() noexcept { beammp_debug("\"" + mStateId + "\" destroyed"); } [[nodiscard]] std::shared_ptr EnqueueScript(const TLuaChunk& Script); [[nodiscard]] std::shared_ptr EnqueueFunctionCall(const std::string& FunctionName, const std::vector& Args); + [[nodiscard]] std::shared_ptr EnqueueFunctionCallFromCustomEvent(const std::string& FunctionName, const std::vector& Args, const std::string& EventName, CallStrategy Strategy); void RegisterEvent(const std::string& EventName, const std::string& FunctionName); void AddPath(const fs::path& Path); // to be added to path and cpath void operator()() override; @@ -188,7 +202,7 @@ private: std::thread mThread; std::queue>> mStateExecuteQueue; std::recursive_mutex mStateExecuteQueueMutex; - std::queue, std::vector>> mStateFunctionQueue; + std::vector mStateFunctionQueue; std::mutex mStateFunctionQueueMutex; std::condition_variable mStateFunctionQueueCond; TLuaEngine* mEngine; @@ -202,6 +216,7 @@ private: std::chrono::high_resolution_clock::time_point LastCompletion {}; std::string EventName; TLuaStateId StateId; + CallStrategy Strategy; bool Expired(); void Reset(); }; @@ -218,8 +233,9 @@ private: std::recursive_mutex mLuaEventsMutex; std::vector mTimedEvents; std::recursive_mutex mTimedEventsMutex; - std::queue> mResultsToCheck; - std::recursive_mutex mResultsToCheckMutex; + std::list> mResultsToCheck; + std::mutex mResultsToCheckMutex; + std::condition_variable mResultsToCheckCond; }; // std::any TriggerLuaEvent(const std::string& Event, bool local, TLuaPlugin* Caller, std::shared_ptr arg, bool Wait); diff --git a/src/Client.cpp b/src/Client.cpp index d5736fe..4edbbc7 100644 --- a/src/Client.cpp +++ b/src/Client.cpp @@ -27,6 +27,7 @@ void TClient::ClearCars() { int TClient::GetOpenCarID() const { int OpenID = 0; bool found; + std::unique_lock lock(mVehicleDataMutex); do { found = true; for (auto& v : mVehicleData) { diff --git a/src/Common.cpp b/src/Common.cpp index a113f74..34b28ea 100644 --- a/src/Common.cpp +++ b/src/Common.cpp @@ -97,6 +97,7 @@ void Application::SetSubsystemStatus(const std::string& Subsystem, Status status void Application::CheckForUpdates() { Application::SetSubsystemStatus("UpdateCheck", Application::Status::Starting); + static bool FirstTime = true; // checks current version against latest version std::regex VersionRegex { R"(\d+\.\d+\.\d+\n*)" }; for (const auto& url : GetBackendUrlsInOrder()) { @@ -107,24 +108,31 @@ void Application::CheckForUpdates() { auto RemoteVersion = Version(VersionStrToInts(Response)); if (IsOutdated(MyVersion, RemoteVersion)) { std::string RealVersionString = RemoteVersion.AsString(); - beammp_warn(std::string(ANSI_YELLOW_BOLD) + "NEW VERSION OUT! There's a new version (v" + RealVersionString + ") of the BeamMP-Server available! For more info visit https://wiki.beammp.com/en/home/server-maintenance#updating-the-server." + std::string(ANSI_RESET)); + beammp_warn(std::string(ANSI_YELLOW_BOLD) + "NEW VERSION IS OUT! Please update to the new version (v" + RealVersionString + ") of the BeamMP-Server! Download it here: https://beammp.com/! For a guide on how to update, visit: https://wiki.beammp.com/en/home/server-maintenance#updating-the-server" + std::string(ANSI_RESET)); } else { - beammp_info("Server up-to-date!"); + if (FirstTime) { + beammp_info("Server up-to-date!"); + } } Application::SetSubsystemStatus("UpdateCheck", Application::Status::Good); break; } else { - beammp_debug("Failed to fetch version from: " + url); - beammp_trace("got " + Response); - auto Lock = Sentry.CreateExclusiveContext(); - Sentry.SetContext("get-response", { { "response", Response } }); - Sentry.LogError("failed to get server version", _file_basename, _line); - Application::SetSubsystemStatus("UpdateCheck", Application::Status::Bad); + if (FirstTime) { + beammp_debug("Failed to fetch version from: " + url); + beammp_trace("got " + Response); + auto Lock = Sentry.CreateExclusiveContext(); + Sentry.SetContext("get-response", { { "response", Response } }); + Sentry.LogError("failed to get server version", _file_basename, _line); + Application::SetSubsystemStatus("UpdateCheck", Application::Status::Bad); + } } } if (Application::GetSubsystemStatuses().at("UpdateCheck") == Application::Status::Bad) { - beammp_warn("Unable to fetch version info from backend."); + if (FirstTime) { + beammp_warn("Unable to fetch version info from backend."); + } } + FirstTime = false; } // thread name stuff diff --git a/src/Http.cpp b/src/Http.cpp index 467fd3c..aeb66d5 100644 --- a/src/Http.cpp +++ b/src/Http.cpp @@ -293,7 +293,7 @@ Http::Server::THttpServerInstance::THttpServerInstance() { mThread.detach(); } -void Http::Server::THttpServerInstance::operator()() { +void Http::Server::THttpServerInstance::operator()() try { beammp_info("HTTP(S) Server started on port " + std::to_string(Application::Settings.HTTPServerPort)); std::unique_ptr HttpLibServerInstance; if (Application::Settings.HTTPServerUseSSL) { @@ -370,6 +370,14 @@ void Http::Server::THttpServerInstance::operator()() { HttpLibServerInstance->Get({ 0x2f, 0x6b, 0x69, 0x74, 0x74, 0x79 }, [](const httplib::Request&, httplib::Response& res) { res.set_content(std::string(Magic), "text/plain"); }); + HttpLibServerInstance->set_logger([](const httplib::Request& Req, const httplib::Response& Res) { + beammp_debug("Http Server: " + Req.method + " " + Req.target + " -> " + std::to_string(Res.status)); + }); Application::SetSubsystemStatus("HTTPServer", Application::Status::Good); - HttpLibServerInstance->listen("0.0.0.0", Application::Settings.HTTPServerPort); + auto ret = HttpLibServerInstance->listen(Application::Settings.HTTPServerIP.c_str(), Application::Settings.HTTPServerPort); + if (!ret) { + beammp_error("Failed to start http server (failed to listen). Please ensure the http server is configured properly in the ServerConfig.toml, or turn it off if you don't need it."); + } +} catch (const std::exception& e) { + beammp_error("Failed to start http server. Please ensure the http server is configured properly in the ServerConfig.toml, or turn it off if you don't need it. Error: " + std::string(e.what())); } diff --git a/src/LuaAPI.cpp b/src/LuaAPI.cpp index 14cd8f6..4a76cdc 100644 --- a/src/LuaAPI.cpp +++ b/src/LuaAPI.cpp @@ -112,7 +112,8 @@ bool LuaAPI::MP::TriggerClientEvent(int PlayerID, const std::string& EventName, } auto c = MaybeClient.value().lock(); if (!Engine->Network().Respond(*c, Packet, true)) { - beammp_lua_error("Respond failed"); + beammp_lua_error("Respond failed, dropping client " + std::to_string(PlayerID)); + Engine->Network().ClientKick(*c, "Disconnected after failing to receive packets"); return false; } } diff --git a/src/TConfig.cpp b/src/TConfig.cpp index f1c3126..531fd59 100644 --- a/src/TConfig.cpp +++ b/src/TConfig.cpp @@ -17,15 +17,19 @@ static constexpr std::string_view StrName = "Name"; static constexpr std::string_view StrDescription = "Description"; static constexpr std::string_view StrResourceFolder = "ResourceFolder"; static constexpr std::string_view StrAuthKey = "AuthKey"; + +// Misc static constexpr std::string_view StrSendErrors = "SendErrors"; static constexpr std::string_view StrSendErrorsMessageEnabled = "SendErrorsShowMessage"; -static constexpr std::string_view StrHTTPServerEnabled = "HTTPServerEnabled"; -static constexpr std::string_view StrHTTPServerUseSSL = "UseSSL"; +static constexpr std::string_view StrHideUpdateMessages = "ImScaredOfUpdates"; // HTTP +static constexpr std::string_view StrHTTPServerEnabled = "HTTPServerEnabled"; +static constexpr std::string_view StrHTTPServerUseSSL = "UseSSL"; static constexpr std::string_view StrSSLKeyPath = "SSLKeyPath"; static constexpr std::string_view StrSSLCertPath = "SSLCertPath"; static constexpr std::string_view StrHTTPServerPort = "HTTPServerPort"; +static constexpr std::string_view StrHTTPServerIP = "HTTPServerIP"; TConfig::TConfig(const std::string& ConfigFileName) : mConfigFileName(ConfigFileName) { @@ -58,8 +62,8 @@ void SetComment(CommentsT& Comments, const std::string& Comment) { * whether it is in TConfig.cpp or the configuration file. */ void TConfig::FlushToFile() { - auto data = toml::parse(mConfigFileName); - data["General"] = toml::table(); + // auto data = toml::parse(mConfigFileName); + auto data = toml::value {}; data["General"][StrAuthKey.data()] = Application::Settings.Key; SetComment(data["General"][StrAuthKey.data()].comments(), " AuthKey has to be filled out in order to run the server"); data["General"][StrDebug.data()] = Application::Settings.DebugModeEnabled; @@ -71,19 +75,39 @@ void TConfig::FlushToFile() { data["General"][StrMap.data()] = Application::Settings.MapName; data["General"][StrDescription.data()] = Application::Settings.ServerDesc; data["General"][StrResourceFolder.data()] = Application::Settings.Resource; - data["General"][StrSendErrors.data()] = Application::Settings.SendErrors; - SetComment(data["General"][StrSendErrors.data()].comments(), " You can turn on/off the SendErrors message you get on startup here"); - data["General"][StrSendErrorsMessageEnabled.data()] = Application::Settings.SendErrorsMessageEnabled; - SetComment(data["General"][StrSendErrorsMessageEnabled.data()].comments(), " If SendErrors is `true`, the server will send helpful info about crashes and other issues back to the BeamMP developers. This info may include your config, who is on your server at the time of the error, and similar general information. This kind of data is vital in helping us diagnose and fix issues faster. This has no impact on server performance. You can opt-out of this system by setting this to `false`"); + // Misc + data["Misc"][StrHideUpdateMessages.data()] = Application::Settings.HideUpdateMessages; + SetComment(data["Misc"][StrHideUpdateMessages.data()].comments(), " Hides the periodic update message which notifies you of a new server version. You should really keep this on and always update as soon as possible. For more information visit https://wiki.beammp.com/en/home/server-maintenance#updating-the-server. An update message will always appear at startup regardless."); + data["Misc"][StrSendErrors.data()] = Application::Settings.SendErrors; + SetComment(data["Misc"][StrSendErrors.data()].comments(), " You can turn on/off the SendErrors message you get on startup here"); + data["Misc"][StrSendErrorsMessageEnabled.data()] = Application::Settings.SendErrorsMessageEnabled; + SetComment(data["Misc"][StrSendErrorsMessageEnabled.data()].comments(), " If SendErrors is `true`, the server will send helpful info about crashes and other issues back to the BeamMP developers. This info may include your config, who is on your server at the time of the error, and similar general information. This kind of data is vital in helping us diagnose and fix issues faster. This has no impact on server performance. You can opt-out of this system by setting this to `false`"); + // HTTP data["HTTP"][StrSSLKeyPath.data()] = Application::Settings.SSLKeyPath; data["HTTP"][StrSSLCertPath.data()] = Application::Settings.SSLCertPath; data["HTTP"][StrHTTPServerPort.data()] = Application::Settings.HTTPServerPort; + SetComment(data["HTTP"][StrHTTPServerIP.data()].comments(), " Which IP to listen on. Pick 0.0.0.0 for a public-facing server with no specific IP, and 127.0.0.1 or 'localhost' for a local server."); + data["HTTP"][StrHTTPServerIP.data()] = Application::Settings.HTTPServerIP; data["HTTP"][StrHTTPServerUseSSL.data()] = Application::Settings.HTTPServerUseSSL; - SetComment(data["HTTP"][StrHTTPServerUseSSL.data()].comments(), " Recommended to keep enabled. With SSL the server will serve https and requires valid key and cert files"); + SetComment(data["HTTP"][StrHTTPServerUseSSL.data()].comments(), " Recommended to have enabled for servers which face the internet. With SSL the server will serve https and requires valid key and cert files"); data["HTTP"][StrHTTPServerEnabled.data()] = Application::Settings.HTTPServerEnabled; SetComment(data["HTTP"][StrHTTPServerEnabled.data()].comments(), " Enables the internal HTTP server"); - std::ofstream Stream(mConfigFileName); - Stream << data << std::flush; + std::stringstream Ss; + Ss << "# This is the BeamMP-Server config file.\n" + "# Help & Documentation: `https://wiki.beammp.com/en/home/server-maintenance`\n" + "# IMPORTANT: Fill in the AuthKey with the key you got from `https://beammp.com/k/dashboard` on the left under \"Keys\"\n" + << data; + auto File = std::fopen(mConfigFileName.c_str(), "w+"); + if (!File) { + beammp_error("Failed to create/write to config file: " + GetPlatformAgnosticErrorString()); + throw std::runtime_error("Failed to create/write to config file"); + } + auto Str = Ss.str(); + auto N = std::fwrite(Str.data(), sizeof(char), Str.size(), File); + if (N != Str.size()) { + beammp_error("Failed to write to config file properly, config file might be misshapen"); + } + std::fclose(File); } void TConfig::CreateConfigFile(std::string_view name) { @@ -98,32 +122,7 @@ void TConfig::CreateConfigFile(std::string_view name) { beammp_error("an error occurred and was ignored during config transfer: " + std::string(e.what())); } - { // create file context - std::ofstream ofs(name.data()); - } - FlushToFile(); - - size_t FileSize = fs::file_size(name); - std::fstream ofs { std::string(name), std::ios::in | std::ios::out }; - if (ofs.good()) { - std::string Contents {}; - Contents.resize(FileSize); - ofs.readsome(Contents.data(), FileSize); - ofs.seekp(0); - ofs << "# This is the BeamMP-Server config file.\n" - "# Help & Documentation: `https://wiki.beammp.com/en/home/server-maintenance`\n" - "# IMPORTANT: Fill in the AuthKey with the key you got from `https://beammp.com/k/dashboard` on the left under \"Keys\"\n" - << '\n' - << Contents; - beammp_error("There was no \"" + std::string(mConfigFileName) + "\" file (this is normal for the first time running the server), so one was generated for you. It was automatically filled with the settings from your Server.cfg, if you have one. Please open ServerConfig.toml and ensure your AuthKey and other settings are filled in and correct, then restart the server. The old Server.cfg file will no longer be used and causes a warning if it exists from now on."); - mFailed = true; - ofs.close(); - } else { - beammp_error("Couldn't create " + std::string(name) + ". Check permissions, try again, and contact support if it continues not to work."); - Application::SetSubsystemStatus("Config", Application::Status::Bad); - mFailed = true; - } } void TConfig::TryReadValue(toml::value& Table, const std::string& Category, const std::string_view& Key, std::string& OutValue) { @@ -158,12 +157,15 @@ void TConfig::ParseFromFile(std::string_view name) { TryReadValue(data, "General", StrDescription, Application::Settings.ServerDesc); TryReadValue(data, "General", StrResourceFolder, Application::Settings.Resource); TryReadValue(data, "General", StrAuthKey, Application::Settings.Key); - TryReadValue(data, "General", StrSendErrors, Application::Settings.SendErrors); - TryReadValue(data, "General", StrSendErrorsMessageEnabled, Application::Settings.SendErrorsMessageEnabled); + // Misc + TryReadValue(data, "Misc", StrSendErrors, Application::Settings.SendErrors); + TryReadValue(data, "Misc", StrHideUpdateMessages, Application::Settings.HideUpdateMessages); + TryReadValue(data, "Misc", StrSendErrorsMessageEnabled, Application::Settings.SendErrorsMessageEnabled); // HTTP TryReadValue(data, "HTTP", StrSSLKeyPath, Application::Settings.SSLKeyPath); TryReadValue(data, "HTTP", StrSSLCertPath, Application::Settings.SSLCertPath); TryReadValue(data, "HTTP", StrHTTPServerPort, Application::Settings.HTTPServerPort); + TryReadValue(data, "HTTP", StrHTTPServerIP, Application::Settings.HTTPServerIP); TryReadValue(data, "HTTP", StrHTTPServerEnabled, Application::Settings.HTTPServerEnabled); TryReadValue(data, "HTTP", StrHTTPServerUseSSL, Application::Settings.HTTPServerUseSSL); } catch (const std::exception& err) { @@ -202,6 +204,7 @@ void TConfig::PrintDebug() { beammp_debug(std::string(StrSSLKeyPath) + ": \"" + Application::Settings.SSLKeyPath + "\""); beammp_debug(std::string(StrSSLCertPath) + ": \"" + Application::Settings.SSLCertPath + "\""); beammp_debug(std::string(StrHTTPServerPort) + ": \"" + std::to_string(Application::Settings.HTTPServerPort) + "\""); + beammp_debug(std::string(StrHTTPServerIP) + ": \"" + Application::Settings.HTTPServerIP + "\""); // special! beammp_debug("Key Length: " + std::to_string(Application::Settings.Key.length()) + ""); } diff --git a/src/TConsole.cpp b/src/TConsole.cpp index 79d30a4..f6eb1fa 100644 --- a/src/TConsole.cpp +++ b/src/TConsole.cpp @@ -97,6 +97,17 @@ void TConsole::BackupOldLog() { } } +void TConsole::StartLoggingToFile() { + mLogFileStream.open("Server.log"); + Application::Console().Internal().on_write = [this](const std::string& ToWrite) { + // TODO: Sanitize by removing all ansi escape codes (vt100) + std::unique_lock Lock(mLogFileStreamMtx); + mLogFileStream.write(ToWrite.c_str(), ToWrite.size()); + mLogFileStream.write("\n", 1); + mLogFileStream.flush(); + }; +} + void TConsole::ChangeToLuaConsole(const std::string& LuaStateId) { if (!mIsLuaConsole) { if (!mLuaEngine) { diff --git a/src/THeartbeatThread.cpp b/src/THeartbeatThread.cpp index 6efdd74..d65380e 100644 --- a/src/THeartbeatThread.cpp +++ b/src/THeartbeatThread.cpp @@ -19,7 +19,9 @@ void THeartbeatThread::operator()() { static std::chrono::high_resolution_clock::time_point LastNormalUpdateTime = std::chrono::high_resolution_clock::now(); bool isAuth = false; + size_t UpdateReminderCounter = 0; while (!mShutdown) { + ++UpdateReminderCounter; Body = GenerateCall(); // a hot-change occurs when a setting has changed, to update the backend of that change. auto Now = std::chrono::high_resolution_clock::now(); @@ -62,8 +64,8 @@ void THeartbeatThread::operator()() { beammp_trace(T); Doc.Parse(T.data(), T.size()); if (Doc.HasParseError() || !Doc.IsObject()) { - beammp_error("Backend response failed to parse as valid json"); - beammp_debug("Response was: `" + T + "`"); + beammp_debug("Failed to contact backend at " + Url + " (this is not an error)."); + beammp_trace("Response was: " + T); Sentry.SetContext("JSON Response", { { "reponse", T } }); SentryReportError(Url + Target, ResponseCode); } else if (ResponseCode != 200) { @@ -105,6 +107,10 @@ void THeartbeatThread::operator()() { beammp_error("Missing/invalid json members in backend response"); Sentry.LogError("Missing/invalid json members in backend response", __FILE__, std::to_string(__LINE__)); } + } else { + if (!Application::Settings.Private) { + beammp_warn("Backend failed to respond to a heartbeat. Your server may temporarily disappear from the server list. This is not an error, and will likely resolve itself soon. Direct connect will still work."); + } } if (Ok && !isAuth) { @@ -124,6 +130,9 @@ void THeartbeatThread::operator()() { if (isAuth) { Application::SetSubsystemStatus("Heartbeat", Application::Status::Good); } + if (!Application::Settings.HideUpdateMessages && UpdateReminderCounter % 5) { + Application::CheckForUpdates(); + } } } diff --git a/src/TLuaEngine.cpp b/src/TLuaEngine.cpp index 41ffb96..1d684d8 100644 --- a/src/TLuaEngine.cpp +++ b/src/TLuaEngine.cpp @@ -44,7 +44,7 @@ void TLuaEngine::operator()() { CollectAndInitPlugins(); // now call all onInit's auto Futures = TriggerEvent("onInit", ""); - WaitForAll(Futures); + WaitForAll(Futures, std::chrono::seconds(5)); for (const auto& Future : Futures) { if (Future->Error && Future->ErrorMessage != BeamMPFnNotFoundError) { beammp_lua_error("Calling \"onInit\" on \"" + Future->StateId + "\" failed: " + Future->ErrorMessage); @@ -54,25 +54,21 @@ void TLuaEngine::operator()() { auto ResultCheckThread = std::thread([&] { RegisterThread("ResultCheckThread"); while (!mShutdown) { - std::this_thread::sleep_for(std::chrono::milliseconds(10)); std::unique_lock Lock(mResultsToCheckMutex); + mResultsToCheckCond.wait_for(Lock, std::chrono::milliseconds(20)); if (!mResultsToCheck.empty()) { - auto Res = mResultsToCheck.front(); - mResultsToCheck.pop(); - Lock.unlock(); - - if (!Res->Ready) { - Lock.lock(); - mResultsToCheck.push(Res); - Lock.unlock(); - } - if (Res->Error) { - if (Res->ErrorMessage != BeamMPFnNotFoundError) { - beammp_lua_error(Res->Function + ": " + Res->ErrorMessage); + mResultsToCheck.remove_if([](const std::shared_ptr& Ptr) -> bool { + if (Ptr->Ready) { + return true; + } else if (Ptr->Error) { + if (Ptr->ErrorMessage != BeamMPFnNotFoundError) { + beammp_lua_error(Ptr->Function + ": " + Ptr->ErrorMessage); + } + return true; } - } + return false; + }); } - std::this_thread::yield(); } }); // event loop @@ -85,21 +81,31 @@ void TLuaEngine::operator()() { std::unique_lock Lock(mTimedEventsMutex); for (auto& Timer : mTimedEvents) { if (Timer.Expired()) { + auto LastCompletionBeforeReset = Timer.LastCompletion; Timer.Reset(); auto Handlers = GetEventHandlersForState(Timer.EventName, Timer.StateId); std::unique_lock StateLock(mLuaStatesMutex); std::unique_lock Lock2(mResultsToCheckMutex); for (auto& Handler : Handlers) { - auto Res = mLuaStates[Timer.StateId]->EnqueueFunctionCall(Handler, {}); - mResultsToCheck.push(Res); + auto Res = mLuaStates[Timer.StateId]->EnqueueFunctionCallFromCustomEvent(Handler, {}, Timer.EventName, Timer.Strategy); + if (Res) { + mResultsToCheck.push_back(Res); + mResultsToCheckCond.notify_one(); + } else { + // "revert" reset + Timer.LastCompletion = LastCompletionBeforeReset; + // beammp_trace("Reverted reset of \"" + Timer.EventName + "\" timer"); + // no need to try to enqueue more handlers for this event (they will all fail) + break; + } } } } } - std::chrono::high_resolution_clock::duration Diff; - if ((Diff = std::chrono::high_resolution_clock::now() - Before) - < std::chrono::milliseconds(10)) { - std::this_thread::sleep_for(Diff); + const auto Expected = std::chrono::milliseconds(10); + if (auto Diff = std::chrono::high_resolution_clock::now() - Before; + Diff < Expected) { + std::this_thread::sleep_for(Expected - Diff); } else { beammp_trace("Event loop cannot keep up! Running " + std::to_string(Diff.count()) + "s behind"); } @@ -144,7 +150,8 @@ TLuaStateId TLuaEngine::GetStateIDForPlugin(const fs::path& PluginPath) { void TLuaEngine::AddResultToCheck(const std::shared_ptr& Result) { std::unique_lock Lock(mResultsToCheckMutex); - mResultsToCheck.push(Result); + mResultsToCheck.push_back(Result); + mResultsToCheckCond.notify_one(); } void TLuaEngine::WaitForAll(std::vector>& Results, const std::optional& Max) { @@ -155,8 +162,10 @@ void TLuaEngine::WaitForAll(std::vector>& Results, c std::this_thread::sleep_for(std::chrono::milliseconds(10)); ms += 10; if (Max.has_value() && std::chrono::milliseconds(ms) > Max.value()) { - beammp_trace("'" + Result->Function + "' in '" + Result->StateId + "' did not finish executing in time (took: " + std::to_string(ms) + "ms)"); + beammp_trace("'" + Result->Function + "' in '" + Result->StateId + "' did not finish executing in time (took: " + std::to_string(ms) + "ms)."); Cancelled = true; + } else if (ms > 1000 * 60) { + beammp_lua_warn("'" + Result->Function + "' in '" + Result->StateId + "' is taking very long. The event it's handling is too important to discard the result of this handler, but may block this event and possibly the whole lua state."); } } if (Cancelled) { @@ -174,7 +183,8 @@ void TLuaEngine::WaitForAll(std::vector>& Results, c void TLuaEngine::ReportErrors(const std::vector>& Results) { std::unique_lock Lock2(mResultsToCheckMutex); for (const auto& Result : Results) { - mResultsToCheck.push(Result); + mResultsToCheck.push_back(Result); + mResultsToCheckCond.notify_one(); } } @@ -502,11 +512,27 @@ TLuaEngine::StateThreadData::StateThreadData(const std::string& Name, std::atomi return Lua_GetPlayerIdentifiers(ID); }); MPTable.set_function("Sleep", &LuaAPI::MP::Sleep); - MPTable.set_function("CreateEventTimer", [&](const std::string& EventName, size_t IntervalMS) { + // const std::string& EventName, size_t IntervalMS, int strategy + MPTable.set_function("CreateEventTimer", [&](sol::variadic_args Args) { + if (Args.size() < 2 || Args.size() > 3) { + beammp_lua_error("CreateEventTimer expects 2 or 3 arguments."); + } + if (Args.get_type(0) != sol::type::string) { + beammp_lua_error("CreateEventTimer expects 1st argument to be a string"); + } + if (Args.get_type(1) != sol::type::number) { + beammp_lua_error("CreateEventTimer expects 2nd argument to be a number"); + } + if (Args.size() == 3 && Args.get_type(2) != sol::type::number) { + beammp_lua_error("CreateEventTimer expects 3rd argument to be a number (MP.CallStrategy)"); + } + auto EventName = Args.get(0); + auto IntervalMS = Args.get(1); + CallStrategy Strategy = Args.size() > 2 ? Args.get(2) : CallStrategy::BestEffort; if (IntervalMS < 25) { beammp_warn("Timer for \"" + EventName + "\" on \"" + mStateId + "\" is set to trigger at <25ms, which is likely too fast and won't cancel properly."); } - mEngine->CreateEventTimer(EventName, mStateId, IntervalMS); + mEngine->CreateEventTimer(EventName, mStateId, IntervalMS, Strategy); }); MPTable.set_function("CancelEventTimer", [&](const std::string& EventName) { mEngine->CancelEventTimers(EventName, mStateId); @@ -526,6 +552,10 @@ TLuaEngine::StateThreadData::StateThreadData(const std::string& Name, std::atomi "Name", 5, "Description", 6); + MPTable.create_named("CallStrategy", + "BestEffort", CallStrategy::BestEffort, + "Precise", CallStrategy::Precise); + auto FSTable = StateView.create_named_table("FS"); FSTable.set_function("CreateDirectory", &LuaAPI::FS::CreateDirectory); FSTable.set_function("Exists", &LuaAPI::FS::Exists); @@ -548,12 +578,34 @@ std::shared_ptr TLuaEngine::StateThreadData::EnqueueScript(const TLu return Result; } +std::shared_ptr TLuaEngine::StateThreadData::EnqueueFunctionCallFromCustomEvent(const std::string& FunctionName, const std::vector& Args, const std::string& EventName, CallStrategy Strategy) { + // TODO: Document all this + decltype(mStateFunctionQueue)::iterator Iter = mStateFunctionQueue.end(); + if (Strategy == CallStrategy::BestEffort) { + Iter = std::find_if(mStateFunctionQueue.begin(), mStateFunctionQueue.end(), + [&EventName](const QueuedFunction& Element) { + return Element.EventName == EventName; + }); + } + if (Iter == mStateFunctionQueue.end()) { + auto Result = std::make_shared(); + Result->StateId = mStateId; + Result->Function = FunctionName; + std::unique_lock Lock(mStateFunctionQueueMutex); + mStateFunctionQueue.push_back({ FunctionName, Result, Args, EventName }); + mStateFunctionQueueCond.notify_all(); + return Result; + } else { + return nullptr; + } +} + std::shared_ptr TLuaEngine::StateThreadData::EnqueueFunctionCall(const std::string& FunctionName, const std::vector& Args) { auto Result = std::make_shared(); Result->StateId = mStateId; Result->Function = FunctionName; std::unique_lock Lock(mStateFunctionQueueMutex); - mStateFunctionQueue.push({ FunctionName, Result, Args }); + mStateFunctionQueue.push_back({ FunctionName, Result, Args, "" }); mStateFunctionQueueCond.notify_all(); return Result; } @@ -616,12 +668,13 @@ void TLuaEngine::StateThreadData::operator()() { std::chrono::milliseconds(500), [&]() -> bool { return !mStateFunctionQueue.empty(); }); if (NotExpired) { - auto FnNameResultPair = std::move(mStateFunctionQueue.front()); - mStateFunctionQueue.pop(); + auto TheQueuedFunction = std::move(mStateFunctionQueue.front()); + mStateFunctionQueue.erase(mStateFunctionQueue.begin()); Lock.unlock(); - auto& FnName = std::get<0>(FnNameResultPair); - auto& Result = std::get<1>(FnNameResultPair); - auto Args = std::get<2>(FnNameResultPair); + auto& FnName = TheQueuedFunction.FunctionName; + auto& Result = TheQueuedFunction.Result; + auto Args = TheQueuedFunction.Args; + // TODO: Use TheQueuedFunction.EventName for errors, warnings, etc Result->StateId = mStateId; sol::state_view StateView(mState); auto Fn = StateView[FnName]; @@ -669,13 +722,14 @@ void TLuaEngine::StateThreadData::operator()() { } } -void TLuaEngine::CreateEventTimer(const std::string& EventName, TLuaStateId StateId, size_t IntervalMS) { +void TLuaEngine::CreateEventTimer(const std::string& EventName, TLuaStateId StateId, size_t IntervalMS, CallStrategy Strategy) { std::unique_lock Lock(mTimedEventsMutex); TimedEvent Event { std::chrono::high_resolution_clock::duration { std::chrono::milliseconds(IntervalMS) }, std::chrono::high_resolution_clock::now(), EventName, - StateId + StateId, + Strategy }; mTimedEvents.push_back(std::move(Event)); beammp_trace("created event timer for \"" + EventName + "\" on \"" + StateId + "\" with " + std::to_string(IntervalMS) + "ms interval"); diff --git a/src/TNetwork.cpp b/src/TNetwork.cpp index 1e0e5be..d9edc81 100644 --- a/src/TNetwork.cpp +++ b/src/TNetwork.cpp @@ -154,6 +154,19 @@ void TNetwork::TCPServerMain() { beammp_warn(("Got an invalid client socket on connect! Skipping...")); continue; } + // set timeout (DWORD, aka uint32_t) + uint32_t SendTimeoutMS = 30 * 1000; +#if defined(BEAMMP_WINDOWS) + int ret = ::setsockopt(client.Socket, SOL_SOCKET, SO_SNDTIMEO, reinterpret_cast(&SendTimeoutMS), sizeof(SendTimeoutMS)); +#else // POSIX + struct timeval optval; + optval.tv_sec = (int)(SendTimeoutMS / 1000); + optval.tv_usec = (SendTimeoutMS % 1000) * 1000; + int ret = ::setsockopt(client.Socket, SOL_SOCKET, SO_SNDTIMEO, reinterpret_cast(&optval), sizeof(optval)); +#endif + if (ret < 0) { + throw std::runtime_error("setsockopt recv timeout: " + GetPlatformAgnosticErrorString()); + } std::thread ID(&TNetwork::Identify, this, client); ID.detach(); // TODO: Add to a queue and attempt to join periodically } catch (const std::exception& e) { @@ -514,6 +527,7 @@ void TNetwork::Looper(const std::weak_ptr& c) { } } } + void TNetwork::TCPClient(const std::weak_ptr& c) { // TODO: the c.expired() might cause issues here, remove if you end up here with your debugger if (c.expired() || c.lock()->GetTCPSock() == -1) { @@ -742,11 +756,11 @@ void TNetwork::SendFile(TClient& c, const std::string& UnsafeName) { void TNetwork::SplitLoad(TClient& c, size_t Sent, size_t Size, bool D, const std::string& Name) { std::ifstream f(Name.c_str(), std::ios::binary); uint32_t Split = 0x7735940; // 125MB - char* Data; + std::vector Data; if (Size > Split) - Data = new char[Split]; + Data.resize(Split); else - Data = new char[Size]; + Data.resize(Size); SOCKET TCPSock; if (D) TCPSock = c.GetDownSock(); @@ -757,8 +771,8 @@ void TNetwork::SplitLoad(TClient& c, size_t Sent, size_t Size, bool D, const std size_t Diff = Size - Sent; if (Diff > Split) { f.seekg(Sent, std::ios_base::beg); - f.read(Data, Split); - if (!TCPSendRaw(c, TCPSock, Data, Split)) { + f.read(Data.data(), Split); + if (!TCPSendRaw(c, TCPSock, Data.data(), Split)) { if (c.GetStatus() > -1) c.SetStatus(-1); break; @@ -766,8 +780,8 @@ void TNetwork::SplitLoad(TClient& c, size_t Sent, size_t Size, bool D, const std Sent += Split; } else { f.seekg(Sent, std::ios_base::beg); - f.read(Data, Diff); - if (!TCPSendRaw(c, TCPSock, Data, int32_t(Diff))) { + f.read(Data.data(), Diff); + if (!TCPSendRaw(c, TCPSock, Data.data(), int32_t(Diff))) { if (c.GetStatus() > -1) c.SetStatus(-1); break; @@ -775,8 +789,6 @@ void TNetwork::SplitLoad(TClient& c, size_t Sent, size_t Size, bool D, const std Sent += Diff; } } - delete[] Data; - f.close(); } bool TNetwork::TCPSendRaw(TClient& C, SOCKET socket, char* Data, int32_t Size) { diff --git a/src/main.cpp b/src/main.cpp index 8b2f3c5..e220636 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -119,21 +119,20 @@ int BeamMPServerMain(MainArguments Arguments) { } Application::SetSubsystemStatus("Main", Application::Status::Starting); - bool Success = Application::Console().Internal().enable_write_to_file("Server.log"); - if (!Success) { - beammp_error("unable to open file for writing: \"Server.log\""); - } + + Application::Console().StartLoggingToFile(); SetupSignalHandlers(); bool Shutdown = false; Application::RegisterShutdownHandler([&Shutdown] { + beammp_info("If this takes too long, you can press Ctrl+C repeatedly to force a shutdown."); Application::SetSubsystemStatus("Main", Application::Status::ShuttingDown); Shutdown = true; }); Application::RegisterShutdownHandler([] { auto Futures = LuaAPI::MP::Engine->TriggerEvent("onShutdown", ""); - TLuaEngine::WaitForAll(Futures); + TLuaEngine::WaitForAll(Futures, std::chrono::seconds(5)); }); TServer Server(Arguments.List); @@ -172,6 +171,10 @@ int BeamMPServerMain(MainArguments Arguments) { Application::SetSubsystemStatus("Main", Application::Status::Good); RegisterThread("Main(Waiting)"); + std::set IgnoreSubsystems { + "UpdateCheck" // Ignore as not to confuse users (non-vital system) + }; + bool FullyStarted = false; while (!Shutdown) { if (!FullyStarted) { @@ -180,6 +183,9 @@ int BeamMPServerMain(MainArguments Arguments) { std::string SystemsBadList {}; auto Statuses = Application::GetSubsystemStatuses(); for (const auto& NameStatusPair : Statuses) { + if (IgnoreSubsystems.count(NameStatusPair.first) > 0) { + continue; // ignore + } if (NameStatusPair.second == Application::Status::Starting) { FullyStarted = false; } else if (NameStatusPair.second == Application::Status::Bad) {