From 2af59c621e1a6d52008442b52aeaff4f030f6284 Mon Sep 17 00:00:00 2001 From: gsd Date: Sun, 4 Feb 2024 13:38:20 +0300 Subject: [PATCH] logging --- .../app/annotations/enums/CollectStages.java | 6 +++ .../impl/CollectStatisticAspect.java | 35 ++++++++++++---- .../app/annotations/impl/WebAccessAspect.java | 41 +++++++++++-------- .../interfaces/CollectStatistic.java | 3 ++ .../java/app/controllers/StatsController.java | 1 + .../app/controllers/admin/BanController.java | 5 ++- .../app/controllers/admin/DBController.java | 5 ++- .../app/controllers/admin/KickController.java | 3 +- .../app/controllers/admin/MuteContoller.java | 5 ++- .../app/controllers/admin/RconController.java | 3 +- .../app/controllers/admin/VIPController.java | 5 ++- .../app/entities/db/CollectableStatistic.java | 28 +++++++++---- .../services/db/CollectStatisticService.java | 3 ++ 13 files changed, 102 insertions(+), 41 deletions(-) create mode 100644 src/main/java/app/annotations/enums/CollectStages.java diff --git a/src/main/java/app/annotations/enums/CollectStages.java b/src/main/java/app/annotations/enums/CollectStages.java new file mode 100644 index 0000000..e2575bb --- /dev/null +++ b/src/main/java/app/annotations/enums/CollectStages.java @@ -0,0 +1,6 @@ +package app.annotations.enums; + +public enum CollectStages { + COMBINED, BEFORE, AFTER; + +} diff --git a/src/main/java/app/annotations/impl/CollectStatisticAspect.java b/src/main/java/app/annotations/impl/CollectStatisticAspect.java index dbbd01d..345299c 100644 --- a/src/main/java/app/annotations/impl/CollectStatisticAspect.java +++ b/src/main/java/app/annotations/impl/CollectStatisticAspect.java @@ -1,39 +1,60 @@ package app.annotations.impl; +import app.annotations.enums.CollectStages; +import app.annotations.interfaces.CollectStatistic; import app.entities.db.CollectableStatistic; import app.services.db.CollectStatisticService; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.After; -import org.aspectj.lang.annotation.AfterReturning; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; +import org.aspectj.lang.reflect.MethodSignature; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; -import java.util.Arrays; +import java.sql.Timestamp; +import java.time.Instant; + @Aspect @Configuration public class CollectStatisticAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); - private CollectStatisticService collectStatisticService; - private HttpServletRequest request; + private HttpServletResponse response; @Autowired - public CollectStatisticAspect(CollectStatisticService collectStatisticService, HttpServletRequest request) { + public CollectStatisticAspect(CollectStatisticService collectStatisticService, + HttpServletRequest request, + HttpServletResponse response) { this.collectStatisticService = collectStatisticService; this.request = request; + this.response = response; } @Before("@annotation(app.annotations.interfaces.CollectStatistic)") - public void before() { - collectStatisticService.add(new CollectableStatistic(request)); + public void before(JoinPoint joinPoint) { + CollectStages collectStages = ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(CollectStatistic.class).stage(); + if (collectStages.equals(CollectStages.COMBINED) || collectStages.equals(CollectStages.BEFORE)) + if (request != null) + collectStatisticService.add(new CollectableStatistic(request)); + else return; + } + + @After("@annotation(app.annotations.interfaces.CollectStatistic)") + public void after(JoinPoint joinPoint) { + CollectStages collectStages = ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(CollectStatistic.class).stage(); + if (collectStages.equals(CollectStages.COMBINED) || collectStages.equals(CollectStages.AFTER)) + if (response != null) + logger.info("[RES] [{}] {}", Timestamp.from(Instant.now()).toString(), response.getStatus()); + else + logger.warn("[RES] [{}] response in null", Timestamp.from(Instant.now()).toString()); + else return; } } diff --git a/src/main/java/app/annotations/impl/WebAccessAspect.java b/src/main/java/app/annotations/impl/WebAccessAspect.java index 34baa03..0d252b6 100644 --- a/src/main/java/app/annotations/impl/WebAccessAspect.java +++ b/src/main/java/app/annotations/impl/WebAccessAspect.java @@ -60,7 +60,12 @@ public class WebAccessAspect { List rawCookie = session.getHandshakeHeaders().get("cookie"); switch (auth_method) { case SECRET_KEY -> { - String secret_key = rawCookie.stream().filter(s -> s.contains("secretkey=")).map(s -> s.split("=")[1]).findFirst().orElse(null); + String secret_key = ""; + try { + secret_key = rawCookie.stream().filter(s -> s.contains("secretkey=")).map(s -> s.split("=")[1]).findFirst().orElse(null); + } catch (Exception e) { + session.close(CloseStatus.NOT_ACCEPTABLE); + } if(!saltedCookie.ValidateSecretKey(secret_key)){ logger.error("Invalid secret key on session {}", session.getId()); session.close(CloseStatus.NOT_ACCEPTABLE); @@ -91,22 +96,26 @@ public class WebAccessAspect { String steam64_secured = ""; String secret_key = ""; - for(String rawCookie: rawCookieParams) { - if((!steam64.isEmpty() && !steam64_secured.isEmpty() || (!steam64.isEmpty() && !secret_key.isEmpty()))) { - break; - } - if(rawCookie.contains("steam64=")) { - steam64 = rawCookie.split("=")[1]; - continue; - } - if(rawCookie.contains("steam64_secured=")) { - steam64_secured = rawCookie.split("=")[1]; - continue; - } - if(rawCookie.contains("secretkey=")) { - secret_key = rawCookie.split("=")[1]; - continue; + try { + for (String rawCookie : rawCookieParams) { + if ((!steam64.isEmpty() && !steam64_secured.isEmpty() || (!steam64.isEmpty() && !secret_key.isEmpty()))) { + break; + } + if (rawCookie.contains("steam64=")) { + steam64 = rawCookie.split("=")[1]; + continue; + } + if (rawCookie.contains("steam64_secured=")) { + steam64_secured = rawCookie.split("=")[1]; + continue; + } + if (rawCookie.contains("secretkey=")) { + secret_key = rawCookie.split("=")[1]; + continue; + } } + } catch (Exception e) { + throw new InvalidSecretKey(); } switch (auth_method){ diff --git a/src/main/java/app/annotations/interfaces/CollectStatistic.java b/src/main/java/app/annotations/interfaces/CollectStatistic.java index 45a3303..69ac7dd 100644 --- a/src/main/java/app/annotations/interfaces/CollectStatistic.java +++ b/src/main/java/app/annotations/interfaces/CollectStatistic.java @@ -1,5 +1,7 @@ package app.annotations.interfaces; +import app.annotations.enums.CollectStages; + import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -8,4 +10,5 @@ import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface CollectStatistic { + public CollectStages stage() default CollectStages.BEFORE; } diff --git a/src/main/java/app/controllers/StatsController.java b/src/main/java/app/controllers/StatsController.java index fb75b0c..58af121 100644 --- a/src/main/java/app/controllers/StatsController.java +++ b/src/main/java/app/controllers/StatsController.java @@ -1,5 +1,6 @@ package app.controllers; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.BurstUpdatePlayers; import app.annotations.interfaces.CollectStatistic; import app.entities.Stats; diff --git a/src/main/java/app/controllers/admin/BanController.java b/src/main/java/app/controllers/admin/BanController.java index d8a98cc..d389cd8 100644 --- a/src/main/java/app/controllers/admin/BanController.java +++ b/src/main/java/app/controllers/admin/BanController.java @@ -1,6 +1,7 @@ package app.controllers.admin; import app.annotations.enums.AuthMethod; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.*; import app.entities.db.Ban; import app.services.ProfileService; @@ -36,7 +37,7 @@ public class BanController { @CheckPermitionFlag(flag = "d") @BurstUpdatePlayers @WaitAfterNext(order = "ban") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity banPlayer( HttpServletRequest request, @CookieValue(value = "steam64") String admin_steam64, @@ -62,7 +63,7 @@ public class BanController { @CheckWebAccess @CheckPermitionFlag(flag = "e") @WaitAfterNext(order = "unban") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity unbanPlayer( HttpServletRequest request, @CookieValue(value = "steam64") String admin_steam64, diff --git a/src/main/java/app/controllers/admin/DBController.java b/src/main/java/app/controllers/admin/DBController.java index a4d06ec..f024445 100644 --- a/src/main/java/app/controllers/admin/DBController.java +++ b/src/main/java/app/controllers/admin/DBController.java @@ -1,6 +1,7 @@ package app.controllers.admin; import app.annotations.enums.AuthMethod; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.CheckPermitionFlag; import app.annotations.interfaces.CheckWebAccess; import app.annotations.interfaces.CollectStatistic; @@ -27,7 +28,7 @@ public class DBController { @GetMapping(value = "/alt") @CheckWebAccess @CheckPermitionFlag(flag = "d") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public List getAltAccountPerAccount(HttpServletRequest request, @RequestParam(value = "steam64", required = false, defaultValue = "") String steam64) { return detectService.getAccountsPerSteamID(SteamIDConverter.getSteamID(steam64)).stream().map(s -> s.community_url).toList(); @@ -35,7 +36,7 @@ public class DBController { @RequestMapping(value = "/alt", method = RequestMethod.OPTIONS) @CheckWebAccess - @CheckPermitionFlag(flag = "d") + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity check4getAltAccountPerAccount(HttpServletRequest request) { return ResponseEntity.ok().build(); } diff --git a/src/main/java/app/controllers/admin/KickController.java b/src/main/java/app/controllers/admin/KickController.java index 7581033..328d4bc 100644 --- a/src/main/java/app/controllers/admin/KickController.java +++ b/src/main/java/app/controllers/admin/KickController.java @@ -1,5 +1,6 @@ package app.controllers.admin; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.*; import app.entities.PlayerProfile; import app.services.ProfileService; @@ -35,7 +36,7 @@ public class KickController { @CheckPermitionFlag(flag = "c") @BurstUpdatePlayers @WaitAfterNext(order = "kick") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity kickPlayer( HttpServletRequest request, @CookieValue(value = "steam64") String steam64, diff --git a/src/main/java/app/controllers/admin/MuteContoller.java b/src/main/java/app/controllers/admin/MuteContoller.java index 7286acd..e9ffa81 100644 --- a/src/main/java/app/controllers/admin/MuteContoller.java +++ b/src/main/java/app/controllers/admin/MuteContoller.java @@ -1,5 +1,6 @@ package app.controllers.admin; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.*; import app.entities.PlayerProfile; import app.services.ProfileService; @@ -35,7 +36,7 @@ public class MuteContoller { @CheckPermitionFlag(flag = "c") @BurstUpdatePlayers @WaitAfterNext(order = "mute") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity mutePlayer( HttpServletRequest request, @CookieValue(value = "steam64") String steam64, @@ -54,7 +55,7 @@ public class MuteContoller { @CheckPermitionFlag(flag = "c") @BurstUpdatePlayers @WaitAfterNext(order = "unmute") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity unmutePlayer( HttpServletRequest request, @CookieValue(value = "steam64") String steam64, diff --git a/src/main/java/app/controllers/admin/RconController.java b/src/main/java/app/controllers/admin/RconController.java index ea7927b..0c9f55c 100644 --- a/src/main/java/app/controllers/admin/RconController.java +++ b/src/main/java/app/controllers/admin/RconController.java @@ -1,5 +1,6 @@ package app.controllers.admin; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.CheckPermitionFlag; import app.annotations.interfaces.CheckWebAccess; import app.annotations.interfaces.CollectStatistic; @@ -26,7 +27,7 @@ public class RconController { @CheckWebAccess @CheckPermitionFlag(flag = "m") @WaitAfterNext(order = "rcon") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity rcon(HttpServletRequest request, @RequestParam String srv, @RequestParam String command) { diff --git a/src/main/java/app/controllers/admin/VIPController.java b/src/main/java/app/controllers/admin/VIPController.java index cfcb506..c84b214 100644 --- a/src/main/java/app/controllers/admin/VIPController.java +++ b/src/main/java/app/controllers/admin/VIPController.java @@ -1,5 +1,6 @@ package app.controllers.admin; +import app.annotations.enums.CollectStages; import app.annotations.interfaces.CheckPermitionFlag; import app.annotations.interfaces.CheckWebAccess; import app.annotations.interfaces.CollectStatistic; @@ -27,7 +28,7 @@ public class VIPController { @CheckWebAccess @CheckPermitionFlag(flag = "z") @WaitAfterNext(order = "givevip") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity giveVIP( HttpServletRequest request, @CookieValue(value = "steam64") String admin_steam64, @@ -49,7 +50,7 @@ public class VIPController { @CheckWebAccess @CheckPermitionFlag(flag = "z") @WaitAfterNext(order = "removevip") - @CollectStatistic + @CollectStatistic(stage = CollectStages.COMBINED) public ResponseEntity removeVIP( HttpServletRequest request, @CookieValue(value = "steam64") String admin_steam64, diff --git a/src/main/java/app/entities/db/CollectableStatistic.java b/src/main/java/app/entities/db/CollectableStatistic.java index 386da0b..706b499 100644 --- a/src/main/java/app/entities/db/CollectableStatistic.java +++ b/src/main/java/app/entities/db/CollectableStatistic.java @@ -35,14 +35,22 @@ public class CollectableStatistic { @Override public String toString() { - return - "Time: " + timestamp.toString() + "\n" + - "IP: " + client_ip + "\n" + - "Steam64: " + steam64 + "\n" + - "Method: " + method + "\n" + - "Path: " + path + "\n" + - "Query: " + query + "\n" + - "UA: " + useragent + "\n"; + StringBuilder sb = new StringBuilder(); + sb.append("[REQ] ["); + sb.append(timestamp.toString()); + sb.append("] ["); + sb.append(client_ip); + sb.append("|"); + sb.append(steam64); + sb.append("] "); + sb.append(method); + sb.append(" "); + sb.append(path); + if (query != null) { + sb.append("?"); + sb.append(query); + } + return sb.toString(); } private String getCookie(HttpServletRequest request, String cookie_name) { @@ -58,4 +66,8 @@ public class CollectableStatistic { public boolean isIgnoreRule() { return getPath() != null && getPath().equals("/api/stats") && getQuery() != null && !getQuery().contains("filter=servers"); } + + public boolean isStatsRequests() { + return getPath().equals("/api/stats"); + } } diff --git a/src/main/java/app/services/db/CollectStatisticService.java b/src/main/java/app/services/db/CollectStatisticService.java index d3e6862..584d09f 100644 --- a/src/main/java/app/services/db/CollectStatisticService.java +++ b/src/main/java/app/services/db/CollectStatisticService.java @@ -33,6 +33,9 @@ public class CollectStatisticService extends BaseUpdater { if (collectableStatistic.isServerRequest()) return; if (collectableStatistic.isIgnoreRule()) return; try { + if (!collectableStatistic.isStatsRequests()) + logger.info(collectableStatistic.toString()); + entityManager.createNativeQuery("INSERT INTO `web_statistic` (`steam64`, `client_ip`, `method`, `path`, `query`, `useragent`) VALUES (?1, ?2, ?3, ?4, ?5, ?6)") .setParameter(1, collectableStatistic.getSteam64()) .setParameter(2, collectableStatistic.getClient_ip())