remove whitespace

using lionkor's template (MIT licensed)

This is a combination of 64 commits.

.github/workflows/release.yml

@@ -113,11 +113,6 @@ jobs:
       - name: Install Dependencies
         run: bash ./scripts/ubuntu-22.04/1-install-deps.sh
 
-      - name: Setup vcpkg
-        uses: lukka/run-vcpkg@v11
-        with:
-          runVcpkgInstall: true
-
       - name: Create Build Environment
         run: bash ./scripts/ubuntu-22.04/2-configure.sh '-DCMAKE_TOOLCHAIN_FILE=./vcpkg/scripts/buildsystems/vcpkg.cmake'
 
@@ -136,7 +131,7 @@ jobs:
           asset_content_type: application/x-elf
 
   upload-release-files-windows:
-    name: Upload Windows Release Files
+    name: Build and upload Windows Release Files
     runs-on: windows-latest
     needs: create-release
     env:
@@ -153,11 +148,6 @@ jobs:
         with:
           submodules: 'recursive'
 
-      - name: Setup vcpkg
-        uses: lukka/run-vcpkg@v11
-        with:
-          runVcpkgInstall: true
-
       - name: Create Build Environment
         shell: bash
         run: ./scripts/windows/1-configure.sh
@@ -173,6 +163,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: ./bin/Release/BeamMP-Server.exe
+          asset_path: ./bin/BeamMP-Server.exe
           asset_name: BeamMP-Server.exe
           asset_content_type: application/vnd.microsoft.portable-executable

README.md

@@ -117,7 +117,7 @@ Ubuntu 22.04
 git
 libz-dev
 rapidjson-dev
-liblua5.3
+liblua5.3-dev
 libssl-dev
 libwebsocketpp-dev
 libcurl4-openssl-dev
@@ -142,7 +142,6 @@ curl
 git
 cmake
 g++
-cmake
 zlib
 boost
 websocketpp

include/Common.h

@@ -46,6 +46,7 @@ public:
         std::string Resource { "Resources" };
         std::string MapName { "/levels/gridmap_v2/info.json" };
         std::string Key {};
+        std::string Password{};
         std::string SSLKeyPath { "./.ssl/HttpServer/key.pem" };
         std::string SSLCertPath { "./.ssl/HttpServer/cert.pem" };
         bool HTTPServerEnabled { false };

include/IThreaded.h

@@ -8,7 +8,7 @@ public:
     IThreaded()
         // invokes operator() on this object
         : mThread() { }
-    ~IThreaded() noexcept {
+    virtual ~IThreaded() noexcept {
         if (mThread.joinable()) {
             mThread.join();
         }

include/TLuaEngine.h

@@ -18,6 +18,9 @@
 #include <vector>
 
 #define SOL_ALL_SAFETIES_ON 1
+#define SOL_USER_C_ASSERT SOL_ON
+#define SOL_C_ASSERT(...) \
+    beammp_lua_errorf("SOL2 assertion failure: Assertion `{}` failed in {}:{}. This *should* be a fatal error, but BeamMP Server overrides it to not be fatal. This may cause the Lua Engine to crash, or cause other issues.", #__VA_ARGS__, __FILE__, __LINE__)
 #include <sol/sol.hpp>
 
 using TLuaStateId = std::string;
@@ -41,7 +44,14 @@ struct TLuaResult {
     sol::object Result { sol::lua_nil };
     TLuaStateId StateId;
     std::string Function;
-    // TODO: Add condition_variable
+    std::shared_ptr<std::mutex> ReadyMutex {
+        std::make_shared<std::mutex>()
+    };
+    std::shared_ptr<std::condition_variable> ReadyCondition {
+        std::make_shared<std::condition_variable>()
+    };
+
+    void MarkAsReady();
     void WaitUntilReady();
 };
 
@@ -98,8 +108,8 @@ public:
         return mLuaStates.size();
     }
     std::vector<std::string> GetLuaStateNames() {
-        std::vector<std::string> names{};
-        for(auto const& [stateId, _ ] : mLuaStates) {
+        std::vector<std::string> names {};
+        for (auto const& [stateId, _] : mLuaStates) {
             names.push_back(stateId);
         }
         return names;

include/TNetwork.h

@@ -52,4 +52,5 @@ private:
     static const uint8_t* SendSplit(TClient& c, ip::tcp::socket& Socket, const uint8_t* DataPtr, size_t Size);
 };
 
+std::string HashPassword(const std::string& str);
 std::vector<uint8_t> StringToVector(const std::string& Str);

include/TPPSMonitor.h

@@ -9,6 +9,7 @@ class TNetwork;
 class TPPSMonitor : public IThreaded {
 public:
     explicit TPPSMonitor(TServer& Server);
+    virtual ~TPPSMonitor() {}
 
     void operator()() override;
 

src/Client.cpp

@@ -51,7 +51,7 @@ TClient::TVehicleDataLockPair TClient::GetAllCars() {
 std::string TClient::GetCarPositionRaw(int Ident) {
     std::unique_lock lock(mVehiclePositionMutex);
     try {
-        return mVehiclePosition.at(Ident);
+        return mVehiclePosition.at(size_t(Ident));
     } catch (const std::out_of_range& oor) {
         return "";
     }
@@ -73,7 +73,7 @@ void TClient::Disconnect(std::string_view Reason) {
 
 void TClient::SetCarPosition(int Ident, const std::string& Data) {
     std::unique_lock lock(mVehiclePositionMutex);
-    mVehiclePosition[Ident] = Data;
+    mVehiclePosition[size_t(Ident)] = Data;
 }
 
 std::string TClient::GetCarData(int Ident) {

src/TConfig.cpp

@@ -18,6 +18,7 @@ static constexpr std::string_view StrDescription = "Description";
 static constexpr std::string_view StrResourceFolder = "ResourceFolder";
 static constexpr std::string_view StrAuthKey = "AuthKey";
 static constexpr std::string_view StrLogChat = "LogChat";
+static constexpr std::string_view StrPassword = "Password";
 
 // Misc
 static constexpr std::string_view StrSendErrors = "SendErrors";
@@ -106,6 +107,8 @@ 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"][StrPassword.data()] = Application::Settings.Password;
+    SetComment(data["General"][StrPassword.data()].comments(), " Sets a password on this server, which restricts people from joining. To join, a player must enter this exact password. Leave empty ("") to disable the password.");
     // 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.");
@@ -189,6 +192,7 @@ void TConfig::ParseFromFile(std::string_view name) {
         TryReadValue(data, "General", StrResourceFolder, Application::Settings.Resource);
         TryReadValue(data, "General", StrAuthKey, Application::Settings.Key);
         TryReadValue(data, "General", StrLogChat, Application::Settings.LogChat);
+        TryReadValue(data, "General", StrPassword, Application::Settings.Password);
         // Misc
         TryReadValue(data, "Misc", StrSendErrors, Application::Settings.SendErrors);
         TryReadValue(data, "Misc", StrHideUpdateMessages, Application::Settings.HideUpdateMessages);
@@ -240,6 +244,7 @@ void TConfig::PrintDebug() {
     beammp_debug(std::string(StrHTTPServerIP) + ": \"" + Application::Settings.HTTPServerIP + "\"");
     // special!
     beammp_debug("Key Length: " + std::to_string(Application::Settings.Key.length()) + "");
+    beammp_debug("Password Protected: " + std::string(Application::Settings.Password.empty() ? "false" : "true"));
 }
 
 void TConfig::ParseOldFormat() {

src/TConsole.cpp

@@ -606,9 +606,7 @@ TConsole::TConsole() {
                     HandleLuaInternalCommand(cmd.substr(1));
                 } else {
                     auto Future = mLuaEngine->EnqueueScript(mStateId, { std::make_shared<std::string>(TrimmedCmd), "", "" });
-                    while (!Future->Ready) {
-                        std::this_thread::yield(); // TODO: Add a timeout
-                    }
+                    Future->WaitUntilReady();
                     if (Future->Error) {
                         beammp_lua_error("error in " + mStateId + ": " + Future->ErrorMessage);
                     }

src/THeartbeatThread.cpp

@@ -133,7 +133,8 @@ std::string THeartbeatThread::GenerateCall() {
         << "&modstotalsize=" << mResourceManager.MaxModSize()
         << "&modstotal=" << mResourceManager.ModsLoaded()
         << "&playerslist=" << GetPlayers()
-        << "&desc=" << Application::Settings.ServerDesc;
+        << "&desc=" << Application::Settings.ServerDesc
+        << "&pass=" << (Application::Settings.Password.empty() ? "false" : "true");
     return Ret.str();
 }
 THeartbeatThread::THeartbeatThread(TResourceManager& ResourceManager, TServer& Server)

src/TLuaEngine.cpp

@@ -286,6 +286,7 @@ void TLuaEngine::WaitForAll(std::vector<std::shared_ptr<TLuaResult>>& Results, c
         bool Cancelled = false;
         size_t ms = 0;
         std::set<std::string> WarnedResults;
+
         while (!Result->Ready && !Cancelled) {
             std::this_thread::sleep_for(std::chrono::milliseconds(10));
             ms += 10;
@@ -300,6 +301,7 @@ void TLuaEngine::WaitForAll(std::vector<std::shared_ptr<TLuaResult>>& Results, c
                 }
             }
         }
+
         if (Cancelled) {
             beammp_lua_warn("'" + Result->Function + "' in '" + Result->StateId + "' failed to execute in time and was not waited for. It may still finish executing at a later time.");
             LuaAPI::MP::Engine->ReportErrors({ Result });
@@ -425,7 +427,7 @@ sol::table TLuaEngine::StateThreadData::Lua_TriggerGlobalEvent(const std::string
                 Result->Error = true;
                 Result->ErrorMessage = "Function result in TriggerGlobalEvent was invalid";
             }
-            Result->Ready = true;
+            Result->MarkAsReady();
             Return.push_back(Result);
         }
     }
@@ -955,7 +957,7 @@ void TLuaEngine::StateThreadData::operator()() {
                     sol::error Err = Res;
                     S.second->ErrorMessage = Err.what();
                 }
-                S.second->Ready = true;
+                S.second->MarkAsReady();
             }
         }
         { // StateFunctionQueue Scope
@@ -1016,11 +1018,11 @@ void TLuaEngine::StateThreadData::operator()() {
                         sol::error Err = Res;
                         Result->ErrorMessage = Err.what();
                     }
-                    Result->Ready = true;
+                    Result->MarkAsReady();
                 } else {
                     Result->Error = true;
                     Result->ErrorMessage = BeamMPFnNotFoundError; // special error kind that we can ignore later
-                    Result->Ready = true;
+                    Result->MarkAsReady();
                 }
             }
         }
@@ -1070,11 +1072,19 @@ void TLuaEngine::StateThreadData::AddPath(const fs::path& Path) {
     mPaths.push(Path);
 }
 
-void TLuaResult::WaitUntilReady() {
-    while (!Ready) {
-        std::this_thread::yield();
-        std::this_thread::sleep_for(std::chrono::milliseconds(10));
+void TLuaResult::MarkAsReady() {
+    {
+        std::lock_guard<std::mutex> readyLock(*this->ReadyMutex);
+        this->Ready = true;
     }
+    this->ReadyCondition->notify_all();
+}
+
+void TLuaResult::WaitUntilReady() {
+    std::unique_lock readyLock(*this->ReadyMutex);
+    // wait if not ready yet
+    if(!this->Ready)
+        this->ReadyCondition->wait(readyLock);
 }
 
 TLuaChunk::TLuaChunk(std::shared_ptr<std::string> Content, std::string FileName, std::string PluginPath)

src/TNetwork.cpp

@@ -11,6 +11,8 @@
 #include <boost/asio/ip/address_v4.hpp>
 #include <cstring>
 
+typedef boost::asio::detail::socket_option::integer<SOL_SOCKET, SO_RCVTIMEO> rcv_timeout_option;
+
 std::vector<uint8_t> StringToVector(const std::string& Str) {
     return std::vector<uint8_t>(Str.data(), Str.data() + Str.size());
 }
@@ -225,6 +227,15 @@ void TNetwork::HandleDownload(TConnection&& Conn) {
     });
 }
 
+std::string HashPassword(const std::string& str) {
+    std::stringstream ret;
+    unsigned char* hash = SHA256(reinterpret_cast<const unsigned char*>(str.c_str()), str.length(), nullptr);
+    for (int i = 0; i < 32; i++) {
+        ret << std::hex << static_cast<int>(hash[i]);
+    }
+    return ret.str();
+}
+
 std::shared_ptr<TClient> TNetwork::Authentication(TConnection&& RawConnection) {
     auto Client = CreateClient(std::move(RawConnection.Socket));
     Client->SetIdentifier("ip", RawConnection.SockAddr.address().to_string());
@@ -248,7 +259,8 @@ std::shared_ptr<TClient> TNetwork::Authentication(TConnection&& RawConnection) {
         ClientKick(*Client, fmt::format("Invalid version header: '{}' ({})", std::string(reinterpret_cast<const char*>(Data.data()), Data.size()), Data.size()));
         return nullptr;
     }
-    if (!TCPSend(*Client, StringToVector("S"))) {
+
+    if (!TCPSend(*Client, StringToVector("A"))) { //changed to A for Accepted version
         // TODO: handle
     }
 
@@ -304,6 +316,22 @@ std::shared_ptr<TClient> TNetwork::Authentication(TConnection&& RawConnection) {
         return nullptr;
     }
 
+    if(!Application::Settings.Password.empty()) { // ask password
+        if(!TCPSend(*Client, StringToVector("S"))) {
+            // TODO: handle
+        }
+        beammp_info("Waiting for password");
+        Data = TCPRcv(*Client);
+        std::string Pass = std::string(reinterpret_cast<const char*>(Data.data()), Data.size());
+        if(Pass != HashPassword(Application::Settings.Password)) {
+            beammp_debug(Client->GetName() + " attempted to connect with a wrong password");
+            ClientKick(*Client, "Wrong password!");
+            return {};
+        } else {
+            beammp_debug(Client->GetName() + " used the correct password");
+        }
+    }
+
     beammp_debug("Name -> " + Client->GetName() + ", Guest -> " + std::to_string(Client->IsGuest()) + ", Roles -> " + Client->GetRoles());
     mServer.ForEachClient([&](const std::weak_ptr<TClient>& ClientPtr) -> bool {
         std::shared_ptr<TClient> Cl;
@@ -353,6 +381,7 @@ std::shared_ptr<TClient> TNetwork::Authentication(TConnection&& RawConnection) {
     } else {
         ClientKick(*Client, "Server full!");
     }
+
     return Client;
 }