feat(core): Crash Prevention

Author: skuzzis

src/scripting/engine/events.cpp

@@ -1,6 +1,8 @@
 #include <scripting/core.h>
+#include <tools/crashreporter/crashreporter.h>
 #include <memory/gamedata/gamedata.h>
 #include <sdk/game.h>
+#include <utils/utils.h>
 
 extern std::map<std::string, std::string> gameEventsRegister;
 EValue SerializeData(std::any data, EContext* state);
@@ -178,7 +180,7 @@ LoadScriptingComponent(events, [](PluginObject plugin, EContext* ctx) -> void {
 
         IGameEventListener2* playerListener = g_GameData.FetchSignature<GetLegacyGameEventListener>("LegacyGameEventListener")(slot);
         if (!g_gameEventManager->FindListener(playerListener, data->GetData<IGameEvent*>("event_data")->GetName())) {
-            /* TODO: Crash Reporter - Report crash prevention */
+            ReportPreventionIncident("Fire Event", string_format("Tried to fire event '%s' but the client isn't listening to this event.", data->GetData<IGameEvent*>("event_data")->GetName()));
             return;
         }
         playerListener->FireGameEvent(data->GetData<IGameEvent*>("event_data"));

src/scripting/sdk/schema.cpp

@@ -11,6 +11,7 @@
 #include <sdk/components/CPlayerPawnComponent.h>
 #include <sdk/components/EmitSound_t.h>
 #include <sdk/components/CSingleRecipientFilter.h>
+#include <tools/crashreporter/crashreporter.h>
 #include <utils/common.h>
 #include <utils/utils.h>
 
@@ -311,7 +312,7 @@ void SchemaCallback(PluginObject plugin, EContext* ctx) {
 
         void* instance = data->GetData<void*>("class_ptr");
         if (!instance) {
-            /* TODO: Crash Reporter - Report crash prevention */
+            ReportPreventionIncident("Schema / SDK", string_format("Tried to get member '%s::%s' but the entity is invalid.", className.c_str(), fieldName.c_str()));
             return context->StopExecution();
         }
         context->SetReturn(AccessSDK(data->GetData<void*>("class_ptr"), className, fieldName, path, context->GetPluginContext()));
@@ -320,6 +321,12 @@ void SchemaCallback(PluginObject plugin, EContext* ctx) {
         std::string className = data->GetData<std::string>("class_name");
         std::string fieldName = explode(context->GetFunctionKey(), " ").back();
 
+        void* instance = data->GetData<void*>("class_ptr");
+        if (!instance) {
+            ReportPreventionIncident("Schema / SDK", string_format("Tried to set member '%s::%s' but the entity is invalid.", className.c_str(), fieldName.c_str()));
+            return context->StopExecution();
+        }
+
         UpdateSDK(data->GetData<void*>("class_ptr"), className, fieldName, context->GetArgument<EValue>(0), context->GetPluginContext());
         context->StopExecution();
         });
@@ -333,7 +340,7 @@ void SchemaCallback(PluginObject plugin, EContext* ctx) {
         if (classFuncs.find(path) != classFuncs.end()) {
             void* instance = data->GetData<void*>("class_ptr");
             if (!instance) {
-                /* TODO: Crash Reporter - Report crash prevention */
+                ReportPreventionIncident("Schema / SDK", string_format("Tried to call function '%s::%s' but the entity is invalid.", className.c_str(), function_name.c_str()));
                 return context->StopExecution();
             }
             return;

src/tools/crashreporter/crashreporter.cpp

@@ -53,6 +53,15 @@ bool BeginCrashListener() {
         }
     }
 
+    if (!Files::ExistsPath("addons/swiftly/dumps/prevention"))
+    {
+        if (!Files::CreateDirectory("addons/swiftly/dumps/prevention"))
+        {
+            PLUGIN_PRINTF("Crash Listener", "Couldn't create dumps prevention folder.\n");
+            return false;
+        }
+    }
+
     startup_cmd = CommandLine()->GetCmdLine();
     std::vector<std::string> exp = explode(startup_cmd, " ");
     std::vector<std::string> exp2;
@@ -181,6 +190,15 @@ bool BeginCrashListener() {
         }
     }
 
+    if (!Files::ExistsPath("addons/swiftly/dumps/prevention"))
+    {
+        if (!Files::CreateDirectory("addons/swiftly/dumps/prevention"))
+        {
+            PLUGIN_PRINTF("Crash Listener", "Couldn't create dumps prevention folder.\n");
+            return false;
+        }
+    }
+
     startup_cmd = CommandLine()->GetCmdLine();
     std::vector<std::string> exp = explode(startup_cmd, " ");
     std::vector<std::string> exp2;
@@ -253,4 +271,28 @@ void WriteCrashDump(std::vector<std::string> functionStack)
 
     Files::Append(file_path, string_format("================================\nCommand: %s\nMap: %s\nVersion: %s (%s)\n================================\n\n%s\n\n%s", startup_cmd.c_str(), engine->GetServerGlobals() ? engine->GetServerGlobals()->mapname.ToCStr() : "None", g_Plugin.GetVersion(), GITHUB_SHA, implode(functionStack, "\n").c_str(), WritePluginsCallStack().c_str()), false);
     PLUGIN_PRINTF("Crash Reporter", "A dump log file has been created at: %s\n", file_path.c_str());
+    exit(1);
+}
+
+void ReportPreventionIncident(std::string category, std::string incident_str)
+{
+    PLUGIN_PRINTF("Crash Prevention", "A crash has been prevented by Swiftly Core and the details will be listed below:\n");
+
+    TextTable backtraceTable('-', '|', '+');
+
+    backtraceTable.add(" Category ");
+    backtraceTable.add(" Message ");
+    backtraceTable.endOfRow();
+
+    backtraceTable.add(string_format(" %s ", category.c_str()));
+    backtraceTable.add(string_format(" %s ", incident_str.c_str()));
+    backtraceTable.endOfRow();
+
+    PrintTextTable("Crash Prevention", backtraceTable);
+
+    std::string file_path = string_format("addons/swiftly/dumps/prevention/incident.%s.log", get_uuid().c_str());
+    if (Files::ExistsPath(file_path)) Files::Delete(file_path);
+
+    Files::Append(file_path, string_format("================================\nCategory: %s\nDetails: %s\n\n%s", category.c_str(), incident_str.c_str(), WritePluginsCallStack().c_str()), false);
+    PLUGIN_PRINTF("Crash Prevention", "A log file has been created at: %s\n", file_path.c_str());
 }

src/tools/crashreporter/crashreporter.h

@@ -1,7 +1,11 @@
 #ifndef _tools_crashreporter_h
 #define _tools_crashreporter_h
 
+#include <string>
+
 bool BeginCrashListener();
 void EndCrashListener();
 
+void ReportPreventionIncident(std::string category, std::string incident_str);
+
 #endif