Add AuditLog

2025-07-01 18:48:59 +02:00
parent 9988774fb4
commit 617bae5a5c
12 changed files with 210 additions and 12 deletions
@@ -0,0 +1,132 @@
+/*
+ * This file is a part of the SteamWar software.
+ *
+ * Copyright (C) 2020  SteamWar.de-Serverteam
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.steamwar.sql;
+
+import de.steamwar.sql.internal.*;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NonNull;
+
+import java.sql.Timestamp;
+import java.time.Instant;
+
+@AllArgsConstructor
+public class AuditLog {
+
+    static {
+        SqlTypeMapper.nameEnumMapper(AuditLog.Type.class);
+    }
+
+    public static final String SERVER_NAME_VELOCITY = "Velocity";
+
+    private static final Table<AuditLog> table = new Table<>(AuditLog.class);
+
+    private static final SelectStatement<AuditLog> byId = table.select(Table.PRIMARY);
+
+    private static final Statement create = table.insertFields(true, "time", "serverName", "serverOwner", "actor", "actionType", "actionText");
+
+    @Getter
+    @Field(keys = {Table.PRIMARY}, autoincrement = true)
+    private final int auditLogId;
+
+    @Getter
+    @Field
+    private final Timestamp time;
+
+    @Getter
+    @Field
+    private final String serverName;
+
+    @Field(nullable = true)
+    private final int serverOwner;
+
+    @Field
+    private final int actor;
+
+    @Getter
+    @Field
+    private final Type actionType;
+
+    @Getter
+    @Field
+    private final String actionText;
+
+    public enum Type {
+        JOIN,
+        LEAVE,
+        COMMAND,
+        SENSITIVE_COMMAND,
+
+        CHAT,
+        GUI_OPEN,
+        GUI_CLOSE,
+        GUI_CLICK,
+    }
+
+    public static AuditLog get(int auditLogId) {
+        return byId.select(auditLogId);
+    }
+
+    private static AuditLog create(String serverName, SteamwarUser serverOwner, SteamwarUser actor, Type actionType, String text) {
+        return get(create.insertGetKey(Timestamp.from(Instant.now()), serverName, serverOwner, actor, actionType, text));
+    }
+
+    public static AuditLog createJoin(@NonNull String jointServerName, SteamwarUser serverOwner, @NonNull SteamwarUser joinedPlayer) {
+        return create(jointServerName, serverOwner, joinedPlayer, Type.JOIN, "");
+    }
+
+    public static AuditLog createLeave(@NonNull String leftServerName, SteamwarUser serverOwner, @NonNull SteamwarUser joinedPlayer) {
+        return create(leftServerName, serverOwner, joinedPlayer, Type.LEAVE, "");
+    }
+
+    public static AuditLog createCommand(@NonNull String serverName, SteamwarUser serverOwner, SteamwarUser player, @NonNull String command) {
+        if (player == null) return null;
+        return create(serverName, serverOwner, player, Type.COMMAND, command);
+    }
+
+    public static AuditLog createSensitiveCommand(@NonNull String serverName, SteamwarUser serverOwner, SteamwarUser player, @NonNull String command) {
+        if (player == null) return null;
+        return create(serverName, serverOwner, player, Type.SENSITIVE_COMMAND, command);
+    }
+
+    public static AuditLog createChat(@NonNull String serverName, SteamwarUser serverOwner, @NonNull SteamwarUser chatter, @NonNull String chat) {
+        return create(serverName, serverOwner, chatter, Type.CHAT, chat);
+    }
+
+    public static AuditLog createGuiOpen(@NonNull String serverName, SteamwarUser serverOwner, @NonNull SteamwarUser player, @NonNull String guiName) {
+        return create(serverName, serverOwner, player, Type.GUI_OPEN, guiName);
+    }
+
+    public static AuditLog createGuiClick(@NonNull String serverName, SteamwarUser serverOwner, @NonNull SteamwarUser player, @NonNull String guiName, @NonNull String clickType, int slot, @NonNull String itemName) {
+        return create(serverName, serverOwner, player, Type.GUI_CLICK, "Gui: " + guiName + "\nSlot: " + slot + "\nClickType: " + clickType + "\nItemName: " + itemName);
+    }
+
+    public static AuditLog createGuiClose(@NonNull String serverName, SteamwarUser serverOwner, @NonNull SteamwarUser player, @NonNull String guiName) {
+        return create(serverName, serverOwner, player, Type.GUI_CLOSE, guiName);
+    }
+
+    public SteamwarUser getServerOwner() {
+        return SteamwarUser.get(serverOwner);
+    }
+
+    public SteamwarUser getActor() {
+        return SteamwarUser.get(actor);
+    }
+}