log invocation

This PR adds command-line options as outlined in #74 

Closes #74

README.md

@@ -9,8 +9,8 @@ The launcher is the way we communitcate to outside the game, it does a few autom
 In the root directory of the project,
 1. `cmake -DCMAKE_BUILD_TYPE=Release . -B bin -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static`
 2. `cmake --build bin --parallel --config Release`
-   
-Remember to change `C:/vcpkg` to wherever you have vcpkg installed. 
+
+Remember to change `C:/vcpkg` to wherever you have vcpkg installed.
 
 ## How to build - Debug
 
@@ -18,10 +18,4 @@ In the root directory of the project,
 1. `cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static`
 2. `cmake --build bin --parallel`
 
-Remember to change `C:/vcpkg` to wherever you have vcpkg installed. 
-
-Copyright (c) 2019-present Anonymous275.
-BeamMP Launcher code is not in the public domain and is not free software.
-One must be granted explicit permission by the copyright holder in order to modify or distribute any part of the source or binaries,
-the only permission that has been granted is to use the software in its compiled form as distributed from the BeamMP.com website.
-Anything else is prohibited. Modified works may not be published and have be upstreamed to the official repository.
+Remember to change `C:/vcpkg` to wherever you have vcpkg installed.

include/Network/network.hpp

@@ -26,7 +26,6 @@ extern int ClientID;
 extern int LastPort;
 extern bool ModLoaded;
 extern bool Terminate;
-extern int DEFAULT_PORT;
 extern uint64_t UDPSock;
 extern uint64_t TCPSock;
 extern std::string Branch;

include/Options.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <string>
+
+struct Options {
+#if defined(_WIN32)
+    std::string executable_name = "BeamMP-Launcher.exe";
+#elif defined(__linux__)
+    std::string executable_name = "BeamMP-Launcher";
+#endif
+    unsigned int port = 4444;
+    bool verbose = false;
+    bool no_download = false;
+    bool no_update = false;
+    bool no_launch = false;
+    const char **game_arguments = nullptr;
+    int game_arguments_length = 0;
+    const char** argv = nullptr;
+    int argc = 0;
+};
+
+void InitOptions(int argc, const char *argv[], Options &options);
+
+extern Options options;

include/Startup.h

@@ -10,12 +10,10 @@
 #include <string>
 #include <vector>
 
-void InitLauncher(int argc, char* argv[]);
-std::string GetEP(char* P = nullptr);
+void InitLauncher();
+std::string GetEP(const char* P = nullptr);
 std::string GetGamePath();
 std::string GetVer();
 std::string GetPatch();
 std::string GetEN();
 void ConfigInit();
-extern bool Dev;
-

src/Config.cpp

@@ -8,6 +8,7 @@
 #include <filesystem>
 #include <fstream>
 #include <nlohmann/json.hpp>
+#include "Options.h"
 namespace fs = std::filesystem;
 
 std::string Branch;
@@ -15,7 +16,7 @@ std::string CachingDirectory = "./Resources";
 
 void ParseConfig(const nlohmann::json& d) {
     if (d["Port"].is_number()) {
-        DEFAULT_PORT = d["Port"].get<int>();
+        options.port = d["Port"].get<int>();
     }
     // Default -1
     // Release 1
@@ -31,6 +32,14 @@ void ParseConfig(const nlohmann::json& d) {
         CachingDirectory = d["CachingDirectory"].get<std::string>();
         info("Mod caching directory: " + CachingDirectory);
     }
+
+    if (d.contains("Dev") && d["Dev"].is_boolean()) {
+        bool dev = d["Dev"].get<bool>();
+        options.verbose = dev;
+        options.no_download = dev;
+        options.no_launch = dev;
+        options.no_update = dev;
+    }
 }
 
 void ConfigInit() {

src/GameStart.cpp

@@ -23,6 +23,7 @@
 #include <Security/Init.h>
 #include <filesystem>
 #include <thread>
+#include "Options.h"
 
 unsigned long GamePID = 0;
 #if defined(_WIN32)
@@ -83,7 +84,14 @@ void StartGame(std::string Dir) {
     std::string BaseDir = Dir; //+"\\Bin64";
     // Dir += R"(\Bin64\BeamNG.drive.x64.exe)";
     Dir += "\\BeamNG.drive.exe";
-    bSuccess = CreateProcessA(Dir.c_str(), nullptr, nullptr, nullptr, TRUE, 0, nullptr, BaseDir.c_str(), &si, &pi);
+    std::string gameArgs = "";
+
+    for (int i = 0; i < options.game_arguments_length; i++) {
+        gameArgs += " ";
+        gameArgs += options.game_arguments[i];
+    }
+
+    bSuccess = CreateProcessA(nullptr, (LPSTR)(Dir + gameArgs).c_str(), nullptr, nullptr, TRUE, 0, nullptr, BaseDir.c_str(), &si, &pi);
     if (bSuccess) {
         info("Game Launched!");
         GamePID = pi.dwProcessId;
@@ -99,13 +107,19 @@ void StartGame(std::string Dir) {
 void StartGame(std::string Dir) {
     int status;
     std::string filename = (Dir + "/BinLinux/BeamNG.drive.x64");
-    char* argv[] = { filename.data(), NULL };
+    std::vector<const char*> argv;
+    argv.push_back(filename.data());
+    for (int i = 0; i < options.game_arguments_length; i++) {
+        argv.push_back(options.game_arguments[i]);
+    }
+
+    argv.push_back(nullptr);
     pid_t pid;
     posix_spawn_file_actions_t spawn_actions;
     posix_spawn_file_actions_init(&spawn_actions);
     posix_spawn_file_actions_addclose(&spawn_actions, STDOUT_FILENO);
     posix_spawn_file_actions_addclose(&spawn_actions, STDERR_FILENO);
-    int result = posix_spawn(&pid, filename.c_str(), &spawn_actions, nullptr, argv, environ);
+    int result = posix_spawn(&pid, filename.c_str(), &spawn_actions, nullptr, const_cast<char**>(argv.data()), environ);
 
     if (result != 0) {
         error("Failed to Launch the game! launcher closing soon");
@@ -121,7 +135,7 @@ void StartGame(std::string Dir) {
 #endif
 
 void InitGame(const std::string& Dir) {
-    if (!Dev) {
+    if (!options.no_launch) {
         std::thread Game(StartGame, Dir);
         Game.detach();
     }

src/Logger.cpp

@@ -12,6 +12,7 @@
 #include <fstream>
 #include <sstream>
 #include <thread>
+#include "Options.h"
 
 std::string getDate() {
     time_t tt = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
@@ -55,7 +56,7 @@ void info(const std::string& toPrint) {
 }
 void debug(const std::string& toPrint) {
     std::string Print = getDate() + "[DEBUG] " + toPrint + "\n";
-    if (Dev) {
+    if (options.verbose) {
         std::cout << Print;
     }
     addToLog(Print);

src/Network/Core.cpp

@@ -30,11 +30,11 @@
 #include <nlohmann/json.hpp>
 #include <set>
 #include <thread>
+#include "Options.h"
 
 extern int TraceBack;
 std::set<std::string>* ConfList = nullptr;
 bool TCPTerminate = false;
-int DEFAULT_PORT = 4444;
 bool Terminate = false;
 bool LoginAuth = false;
 std::string Username = "";
@@ -288,7 +288,7 @@ void localRes() {
     ConfList = new std::set<std::string>;
 }
 void CoreMain() {
-    debug("Core Network on start!");
+    debug("Core Network on start! port: " + std::to_string(options.port));
     SOCKET LSocket, CSocket;
     struct addrinfo* res = nullptr;
     struct addrinfo hints { };
@@ -306,7 +306,7 @@ void CoreMain() {
     hints.ai_socktype = SOCK_STREAM;
     hints.ai_protocol = IPPROTO_TCP;
     hints.ai_flags = AI_PASSIVE;
-    iRes = getaddrinfo(nullptr, std::to_string(DEFAULT_PORT).c_str(), &hints, &res);
+    iRes = getaddrinfo(nullptr, std::to_string(options.port).c_str(), &hints, &res);
     if (iRes) {
         debug("(Core) addr info failed with error: " + std::to_string(iRes));
         WSACleanup();

src/Network/GlobalHandler.cpp

@@ -26,6 +26,7 @@
 #include <mutex>
 #include <string>
 #include <thread>
+#include "Options.h"
 
 std::chrono::time_point<std::chrono::high_resolution_clock> PingStart, PingEnd;
 bool GConnected = false;
@@ -161,7 +162,7 @@ SOCKET SetupListener() {
     hints.ai_socktype = SOCK_STREAM;
     hints.ai_protocol = IPPROTO_TCP;
     hints.ai_flags = AI_PASSIVE;
-    iRes = getaddrinfo(nullptr, std::to_string(DEFAULT_PORT + 1).c_str(), &hints, &result);
+    iRes = getaddrinfo(nullptr, std::to_string(options.port + 1).c_str(), &hints, &result);
     if (iRes != 0) {
         error("(Proxy) info failed with error: " + std::to_string(iRes));
         WSACleanup();

src/Network/Http.cpp

@@ -78,6 +78,7 @@ std::string HTTP::Get(const std::string& IP) {
         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, CurlWriteCallback);
         curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void*)&Ret);
         curl_easy_setopt(curl, CURLOPT_TIMEOUT, 10); // seconds
+        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
         res = curl_easy_perform(curl);
         if (res != CURLE_OK) {
             error("GET to " + IP + " failed: " + std::string(curl_easy_strerror(res)));
@@ -105,6 +106,7 @@ std::string HTTP::Post(const std::string& IP, const std::string& Fields) {
         list = curl_slist_append(list, "Content-Type: application/json");
         curl_easy_setopt(curl, CURLOPT_HTTPHEADER, list);
         curl_easy_setopt(curl, CURLOPT_TIMEOUT, 10); // seconds
+        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
         res = curl_easy_perform(curl);
         curl_slist_free_all(list);
         if (res != CURLE_OK) {
@@ -134,7 +136,6 @@ bool HTTP::Download(const std::string& IP, const std::string& Path) {
     if (File.is_open()) {
         File << Ret;
         File.close();
-        std::cout << "\n";
         info("Download Complete!");
     } else {
         error("Failed to open file directory: " + Path);

src/Options.cpp

@@ -0,0 +1,107 @@
+#include "Options.h"
+
+#include "Logger.h"
+#include <cstdlib>
+#include <filesystem>
+
+void InitOptions(int argc, const char *argv[], Options &options) {
+    int i = 1;
+
+    options.argc = argc;
+    options.argv = argv;
+
+    std::string AllOptions;
+    for (int i = 0; i < argc; ++i) {
+        AllOptions += std::string(argv[i]);
+        if (i + 1 < argc) {
+            AllOptions += " ";
+        }
+    }
+    debug("Launcher was invoked as: '" + AllOptions + "'");
+
+
+    if (argc > 2) {
+        if (std::string(argv[1]) == "0" && std::string(argv[2]) == "0") {
+            options.verbose = true;
+            options.no_download = true;
+            options.no_launch = true;
+            options.no_update = true;
+            warn("You are using deprecated commandline arguments, please use --dev instead");
+            return;
+        }
+    }
+
+    options.executable_name = std::string(argv[0]);
+
+    while (i < argc) {
+        std::string argument(argv[i]);
+        if (argument == "-p" || argument == "--port") {
+            if (i + 1 >= argc) {
+                std::string error_message =
+                    "No port specified, resorting to default (";
+                error_message += std::to_string(options.port);
+                error_message += ")";
+                error(error_message);
+                i++;
+                continue;
+            }
+
+            int port = options.port;
+
+            try {
+                port = std::stoi(argv[i + 1]);
+            } catch (std::exception& e) {
+                error("Invalid port specified: " + std::string(argv[i + 1]) + " " + std::string(e.what()));
+            }
+
+            if (port <= 0) {
+                std::string error_message =
+                    "Port invalid, must be a non-zero positive "
+                    "integer, resorting to default (";
+                error_message += options.port;
+                error_message += ")";
+                error(error_message);
+                i++;
+                continue;
+            }
+
+            options.port = port;
+            i++;
+        } else if (argument == "-v" || argument == "--verbose") {
+            options.verbose = true;
+        } else if (argument == "--no-download") {
+            options.no_download = true;
+        } else if (argument == "--no-update") {
+            options.no_update = true;
+        } else if (argument == "--no-launch") {
+            options.no_launch = true;
+        } else if (argument == "--dev") {
+            options.verbose = true;
+            options.no_download = true;
+            options.no_launch = true;
+            options.no_update = true;
+        } else if (argument == "--" || argument == "--game") {
+            options.game_arguments = &argv[i + 1];
+            options.game_arguments_length = argc - i - 1;
+            break;
+        } else if (argument == "--help" || argument == "-h" || argument == "/?") {
+            std::cout << "USAGE:\n"
+                "\t" + std::filesystem::path(options.executable_name).filename().string() + " [OPTIONS] [-- <GAME ARGS>...]\n"
+                "\n"
+                "OPTIONS:\n"
+                "\t--port <port>    -p  Change the default listen port to <port>. This must be configured ingame, too\n"
+                "\t--verbose        -v  Verbose mode, prints debug messages\n"
+                "\t--no-download        Skip downloading and installing the BeamMP Lua mod\n"
+                "\t--no-update          Skip applying launcher updates (you must update manually)\n"
+                "\t--no-launch          Skip launching the game (you must launch the game manually)\n"
+                "\t--dev                Developer mode, same as --verbose --no-download --no-launch --no-update\n"
+                "\t--game <args...>     Passes ALL following arguments to the game, see also `--`\n"
+                << std::flush;
+            exit(0);
+        } else {
+            warn("Unknown option: " + argument);
+        }
+
+        i++;
+    }
+}

src/Startup.cpp

@@ -8,6 +8,7 @@
 
 #include "zip_file.h"
 #include <charconv>
+#include <cstring>
 #include <httplib.h>
 #include <nlohmann/json.hpp>
 #include <string>
@@ -25,9 +26,9 @@
 #include <filesystem>
 #include <fstream>
 #include <thread>
+#include "Options.h"
 
 extern int TraceBack;
-bool Dev = false;
 int ProxyPort = 0;
 
 namespace fs = std::filesystem;
@@ -87,7 +88,7 @@ std::string GetPatch() {
     return ".0";
 }
 
-std::string GetEP(char* P) {
+std::string GetEP(const char* P) {
     static std::string Ret = [&]() {
         std::string path(P);
         return path.substr(0, path.find_last_of("\\/") + 1);
@@ -95,11 +96,11 @@ std::string GetEP(char* P) {
     return Ret;
 }
 #if defined(_WIN32)
-void ReLaunch(int argc, char* args[]) {
+void ReLaunch() {
     std::string Arg;
-    for (int c = 2; c <= argc; c++) {
+    for (int c = 2; c <= options.argc; c++) {
+        Arg += options.argv[c - 1];
         Arg += " ";
-        Arg += args[c - 1];
     }
     info("Relaunch!");
     system("cls");
@@ -108,11 +109,11 @@ void ReLaunch(int argc, char* args[]) {
     std::this_thread::sleep_for(std::chrono::seconds(1));
     exit(1);
 }
-void URelaunch(int argc, char* args[]) {
+void URelaunch() {
     std::string Arg;
-    for (int c = 2; c <= argc; c++) {
+    for (int c = 2; c <= options.argc; c++) {
+        Arg += options.argv[c - 1];
         Arg += " ";
-        Arg += args[c - 1];
     }
     ShellExecute(nullptr, "open", (GetEP() + GetEN()).c_str(), Arg.c_str(), nullptr, SW_SHOWNORMAL);
     ShowWindow(GetConsoleWindow(), 0);
@@ -120,47 +121,50 @@ void URelaunch(int argc, char* args[]) {
     exit(1);
 }
 #elif defined(__linux__)
-void ReLaunch(int argc, char* args[]) {
+void ReLaunch() {
     std::string Arg;
-    for (int c = 2; c <= argc; c++) {
+    for (int c = 2; c <= options.argc; c++) {
+        Arg += options.argv[c - 1];
         Arg += " ";
-        Arg += args[c - 1];
     }
     info("Relaunch!");
     system("clear");
-    execl((GetEP() + GetEN()).c_str(), Arg.c_str(), NULL);
+    int ret = execv(options.executable_name.c_str(), const_cast<char**>(options.argv));
+    if (ret < 0) {
+        error(std::string("execv() failed with: ") + strerror(errno) + ". Failed to relaunch");
+        exit(1);
+    }
     std::this_thread::sleep_for(std::chrono::seconds(1));
     exit(1);
 }
-void URelaunch(int argc, char* args[]) {
-    std::string Arg;
-    for (int c = 2; c <= argc; c++) {
-        Arg += " ";
-        Arg += args[c - 1];
+void URelaunch() {
+    int ret = execv(options.executable_name.c_str(), const_cast<char**>(options.argv));
+    if (ret < 0) {
+        error(std::string("execv() failed with: ") + strerror(errno) + ". Failed to relaunch");
+        exit(1);
     }
-    execl((GetEP() + GetEN()).c_str(), Arg.c_str(), NULL);
     std::this_thread::sleep_for(std::chrono::seconds(1));
     exit(1);
 }
 #endif
 
-void CheckName(int argc, char* args[]) {
+void CheckName() {
 #if defined(_WIN32)
-    std::string DN = GetEN(), CDir = args[0], FN = CDir.substr(CDir.find_last_of('\\') + 1);
+    std::string DN = GetEN(), CDir = options.executable_name, FN = CDir.substr(CDir.find_last_of('\\') + 1);
 #elif defined(__linux__)
-    std::string DN = GetEN(), CDir = args[0], FN = CDir.substr(CDir.find_last_of('/') + 1);
+    std::string DN = GetEN(), CDir = options.executable_name, FN = CDir.substr(CDir.find_last_of('/') + 1);
 #endif
     if (FN != DN) {
         if (fs::exists(DN))
             remove(DN.c_str());
         if (fs::exists(DN))
-            ReLaunch(argc, args);
+            ReLaunch();
         std::rename(FN.c_str(), DN.c_str());
-        URelaunch(argc, args);
+        URelaunch();
     }
 }
 
-void CheckForUpdates(int argc, char* args[], const std::string& CV) {
+void CheckForUpdates(const std::string& CV) {
     std::string LatestHash = HTTP::Get("https://backend.beammp.com/sha/launcher?branch=" + Branch + "&pk=" + PublicKey);
     std::string LatestVersion = HTTP::Get(
         "https://backend.beammp.com/version/launcher?branch=" + Branch + "&pk=" + PublicKey);
@@ -170,39 +174,30 @@ void CheckForUpdates(int argc, char* args[], const std::string& CV) {
 
     std::string FileHash = hashpp::get::getFileHash(hashpp::ALGORITHMS::SHA2_256, EP);
 
-    if (FileHash != LatestHash && IsOutdated(Version(VersionStrToInts(GetVer() + GetPatch())), Version(VersionStrToInts(LatestVersion))) && !Dev) {
-        info("Launcher update found!");
+    if (FileHash != LatestHash && IsOutdated(Version(VersionStrToInts(GetVer() + GetPatch())), Version(VersionStrToInts(LatestVersion)))) {
+        if (!options.no_update) {
+            info("Launcher update found!");
 #if defined(__linux__)
-        error("Auto update is NOT implemented for the Linux version. Please update manually ASAP as updates contain security patches.");
+            error("Auto update is NOT implemented for the Linux version. Please update manually ASAP as updates contain security patches.");
 #else
-        fs::remove(Back);
-        fs::rename(EP, Back);
-        info("Downloading Launcher update " + LatestHash);
-        HTTP::Download(
-            "https://backend.beammp.com/builds/launcher?download=true"
-            "&pk="
-                + PublicKey + "&branch=" + Branch,
-            EP);
-        URelaunch(argc, args);
+            fs::remove(Back);
+            fs::rename(EP, Back);
+            info("Downloading Launcher update " + LatestHash);
+            HTTP::Download(
+                "https://backend.beammp.com/builds/launcher?download=true"
+                "&pk="
+                    + PublicKey + "&branch=" + Branch,
+                EP);
+            URelaunch();
 #endif
+        } else {
+            warn("Launcher update was found, but not updating because --no-update or --dev was specified.");
+        }
     } else
         info("Launcher version is up to date");
     TraceBack++;
 }
 
-void CustomPort(int argc, char* argv[]) {
-    if (argc > 1) {
-        std::string Port = argv[1];
-        if (Port.find_first_not_of("0123456789") == std::string::npos) {
-            if (std::stoi(Port) > 1000) {
-                DEFAULT_PORT = std::stoi(Port);
-                warn("Running on custom port : " + std::to_string(DEFAULT_PORT));
-            }
-        }
-        if (argc > 2)
-            Dev = true;
-    }
-}
 
 #ifdef _WIN32
 void LinuxPatch() {
@@ -234,25 +229,24 @@ void LinuxPatch() {
 #endif
 
 #if defined(_WIN32)
-void InitLauncher(int argc, char* argv[]) {
+
+void InitLauncher() {
     SetConsoleTitleA(("BeamMP Launcher v" + std::string(GetVer()) + GetPatch()).c_str());
     InitLog();
-    CheckName(argc, argv);
+    CheckName();
     LinuxPatch();
     CheckLocalKey();
     ConfigInit();
-    CustomPort(argc, argv);
-    CheckForUpdates(argc, argv, std::string(GetVer()) + GetPatch());
+    CheckForUpdates(std::string(GetVer()) + GetPatch());
 }
 #elif defined(__linux__)
-void InitLauncher(int argc, char* argv[]) {
-    InitLog();
+
+void InitLauncher() {
     info("BeamMP Launcher v" + GetVer() + GetPatch());
-    CheckName(argc, argv);
+    CheckName();
     CheckLocalKey();
     ConfigInit();
-    CustomPort(argc, argv);
-    CheckForUpdates(argc, argv, std::string(GetVer()) + GetPatch());
+    CheckForUpdates(std::string(GetVer()) + GetPatch());
 }
 #endif
 
@@ -316,7 +310,7 @@ void PreGame(const std::string& GamePath) {
     CheckMP(GetGamePath() + "mods/multiplayer");
     info("Game user path: " + GetGamePath());
 
-    if (!Dev) {
+    if (!options.no_download) {
         std::string LatestHash = HTTP::Get("https://backend.beammp.com/sha/mod?branch=" + Branch + "&pk=" + PublicKey);
         transform(LatestHash.begin(), LatestHash.end(), LatestHash.begin(), ::tolower);
         LatestHash.erase(std::remove_if(LatestHash.begin(), LatestHash.end(),

src/main.cpp

@@ -13,6 +13,9 @@
 #include <curl/curl.h>
 #include <iostream>
 #include <thread>
+#include "Options.h"
+
+Options options;
 
 [[noreturn]] void flush() {
     while (true) {
@@ -21,7 +24,13 @@
     }
 }
 
-int main(int argc, char** argv) try {
+int main(int argc, const char** argv) try {
+#if defined(_WIN32)
+    system("cls");
+#elif defined(__linux__)
+    system("clear");
+#endif
+
 #ifdef DEBUG
     std::thread th(flush);
     th.detach();
@@ -45,7 +54,9 @@ int main(int argc, char** argv) try {
         }
     }
 
-    InitLauncher(argc, argv);
+    InitLog();
+    InitOptions(argc, argv, options);
+    InitLauncher();
 
     info("IMPORTANT: You MUST keep this window open to play BeamMP!");