Merge branch 'main' into wayland-screenshots

Author: ProjectSynchro

CHANGELOG.md

@@ -1,4 +1,16 @@
 # SC Trade Companion
+## 1.0.4
+### Other
+- Read location from game logs
+  - *You can set your LIVE game path through a new setting*
+  - *You should still select the location in the dropdown when taking screenshots*
+- Improve performance and security
+
+## 1.0.3
+### Other
+- Handle 3.24 kiosk layout
+- Improve character recognition accuracy
+
 ## 1.0.2
 ### Other
 - Improve text-reading accuracy

build.gradle

@@ -8,7 +8,7 @@ group = 'tools.sctrade'
 version = '1.0.4'
 
 java {
-	sourceCompatibility = '17'
+	sourceCompatibility = '21'
 }
 
 repositories {

src/main/java/tools/sctrade/companion/domain/commodity/CommodityListing.java

@@ -3,7 +3,19 @@
 import java.time.Instant;
 
 public record CommodityListing(String location, TransactionType transactionType, String commodity,
-    double price, int inventory, InventoryLevel inventoryLevel, String batchId, Instant timestamp) {
+    Double price, Integer inventory, InventoryLevel inventoryLevel, Integer maxBoxSize,
+    String batchId, Instant timestamp) {
+  public CommodityListing(String location, TransactionType transactionType, String commodity,
+      double price, int inventory, InventoryLevel inventoryLevel, String batchId,
+      Instant timestamp) {
+    this(location, transactionType, commodity, price, inventory, inventoryLevel, null, batchId,
+        timestamp);
+  }
+
+  public CommodityListing(String location, TransactionType transactionType, String commodity,
+      Integer maxBoxSize, String batchId, Instant timestamp) {
+    this(location, transactionType, commodity, null, null, null, maxBoxSize, batchId, timestamp);
+  }
 
   public CommodityListing withLocation(String location) {
     return new CommodityListing(location, transactionType(), commodity(), price(), inventory(),

src/main/java/tools/sctrade/companion/domain/commodity/CommodityListingFactory.java

@@ -8,6 +8,7 @@
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Locale;
 import java.util.Optional;
 import java.util.TreeMap;
 import org.slf4j.Logger;
@@ -40,6 +41,16 @@ public CommodityListingFactory(CommodityRepository commodityRepository, ImageWri
         .withInitial(() -> new CommodityListingsTesseractOcr(preprocessingManipulations));
   }
 
+  public CommodityListing build(String shopId, String shopName, String commodity,
+      int maxBoxSizeInScu) {
+    Instant now = TimeUtil.getNow();
+    String location = String.format(Locale.ROOT, "%s#%s", shopName, shopId);
+    String batchId = HashUtil.hash(String.format(Locale.ROOT, "%s%s%d%s", location, commodity,
+        maxBoxSizeInScu, now.toString()));
+    return new CommodityListing(location, TransactionType.SELLS, commodity, maxBoxSizeInScu,
+        batchId, now);
+  }
+
   public Collection<CommodityListing> build(BufferedImage screenCapture, String location) {
     try {
       logger.debug("Reading listings...");

src/main/java/tools/sctrade/companion/domain/commodity/CommodityService.java

@@ -4,6 +4,7 @@
 import java.util.Collection;
 import java.util.Optional;
 import java.util.concurrent.Semaphore;
+import java.util.concurrent.TimeUnit;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.scheduling.annotation.Scheduled;
@@ -32,11 +33,21 @@ public CommodityService(CommoditySubmissionFactory submissionFactory,
     this.pendingSubmission = Optional.empty();
   }
 
+  public void process(CommodityListing commodityListing) throws InterruptedException {
+    CommoditySubmission submission = submissionFactory.build(commodityListing);
+
+    process(submission);
+  }
+
   @Override
   public void process(BufferedImage screenCapture) throws InterruptedException {
     CommoditySubmission submission = submissionFactory.build(screenCapture);
     notificationService.info(LocalizationUtil.get("infoCommodityListingsRead"));
 
+    process(submission);
+  }
+
+  private void process(CommoditySubmission submission) throws InterruptedException {
     try {
       logger.debug("Acquiring mutex...");
       mutex.acquire();
@@ -52,7 +63,7 @@ public void process(BufferedImage screenCapture) throws InterruptedException {
     }
   }
 
-  @Scheduled(fixedDelay = 600)
+  @Scheduled(fixedDelay = 30, timeUnit = TimeUnit.SECONDS)
   public void flush() throws InterruptedException {
     try {
       logger.debug("Acquiring mutex...");

src/main/java/tools/sctrade/companion/domain/commodity/CommoditySubmissionFactory.java

@@ -1,6 +1,7 @@
 package tools.sctrade.companion.domain.commodity;
 
 import java.awt.image.BufferedImage;
+import java.util.List;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import tools.sctrade.companion.domain.notification.NotificationService;
@@ -40,4 +41,8 @@ CommoditySubmission build(BufferedImage screenCapture) {
 
     return new CommoditySubmission(userService.get(), listings);
   }
+
+  CommoditySubmission build(CommodityListing commodityListing) {
+    return new CommoditySubmission(userService.get(), List.of(commodityListing));
+  }
 }

src/main/java/tools/sctrade/companion/domain/gamelog/FilePathObserver.java

@@ -0,0 +1,13 @@
+package tools.sctrade.companion.domain.gamelog;
+
+import tools.sctrade.companion.utils.patterns.ChainOfResponsability;
+
+public abstract class GameLogLineProcessor extends ChainOfResponsability<String> {
+
+  protected String regex;
+
+  @Override
+  protected boolean canHandle(String value) {
+    return value.matches(regex);
+  }
+}

src/main/java/tools/sctrade/companion/domain/gamelog/FilePathSubject.java

@@ -7,8 +7,9 @@
 import org.slf4j.LoggerFactory;
 import tools.sctrade.companion.domain.setting.Setting;
 import tools.sctrade.companion.domain.setting.SettingRepository;
+import tools.sctrade.companion.utils.patterns.Subject;
 
-public class GameLogPathSubject extends FilePathSubject {
+public class GameLogPathSubject extends Subject<Path> {
   static final String GAME_LOG_FILE = "Game.log";
 
   private final Logger logger = LoggerFactory.getLogger(GameLogPathSubject.class);
@@ -19,7 +20,6 @@ public GameLogPathSubject(SettingRepository settings) {
     super();
     this.settings = settings;
     this.observers = new ArrayList<>();
-    setState();
   }
 
   public void setStarCitizenLivePath(String starCitizenLivePath) {
@@ -34,7 +34,7 @@ public void setStarCitizenLivePath(String starCitizenLivePath) {
   }
 
   public Optional<String> getStarCitizenLivePath() {
-    return Optional.ofNullable(settings.get(Setting.STAR_CITIZEN_LIVE_PATH).toString());
+    return Optional.ofNullable(settings.get(Setting.STAR_CITIZEN_LIVE_PATH));
   }
 
   @Override
@@ -43,7 +43,7 @@ protected void setState() {
       return;
     }
 
-    filePath = Path.of(getStarCitizenLivePath().get(), GAME_LOG_FILE);
+    state = Path.of(getStarCitizenLivePath().get(), GAME_LOG_FILE);
     notifyObservers();
   }
 }

src/main/java/tools/sctrade/companion/domain/gamelog/GameLogLineProcessor.java

@@ -0,0 +1,20 @@
+package tools.sctrade.companion.domain.gamelog.lineprocessors;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import tools.sctrade.companion.utils.patterns.ChainOfResponsability;
+
+public class FallbackLogLineProcessor extends ChainOfResponsability<String> {
+  private final Logger logger = LoggerFactory.getLogger(FallbackLogLineProcessor.class);
+
+  @Override
+  protected boolean canHandle(String value) {
+    return true;
+  }
+
+  @Override
+  protected void handle(String value) {
+    logger.trace("No chain link could handle '{}'", value);
+  }
+
+}

src/main/java/tools/sctrade/companion/domain/gamelog/GameLogListener.java

@@ -0,0 +1,56 @@
+package tools.sctrade.companion.domain.gamelog.lineprocessors;
+
+import java.util.Locale;
+import java.util.regex.Pattern;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import tools.sctrade.companion.domain.commodity.CommodityListingFactory;
+import tools.sctrade.companion.domain.commodity.CommodityService;
+import tools.sctrade.companion.domain.gamelog.GameLogLineProcessor;
+import tools.sctrade.companion.domain.notification.NotificationService;
+import tools.sctrade.companion.utils.LocalizationUtil;
+
+public class LoadShopInventoryDataLogLineProcessor extends GameLogLineProcessor {
+  private final Logger logger =
+      LoggerFactory.getLogger(LoadShopInventoryDataLogLineProcessor.class);
+
+  private NotificationService notificationService;
+  private CommodityListingFactory commodityListingFactory;
+  private CommodityService commodityService;
+
+  public LoadShopInventoryDataLogLineProcessor(CommodityListingFactory commodityListingFactory,
+      CommodityService commodityService, NotificationService notificationService) {
+    this.regex =
+        ".+LoadShopInventoryData.+shopId\\[(?<shopId>\\d+)\\] shopName\\[(?<shopName>[\\w-]+)\\] commodityName\\[ResourceType\\.(?<commodityName>[\\w-]+)\\].+boxSize\\[(?<maxBoxSize>\\d+)\\] \\[Team_NAPU\\]\\[Shops\\]\\[UI\\]";
+    this.commodityListingFactory = commodityListingFactory;
+    this.commodityService = commodityService;
+    this.notificationService = notificationService;
+  }
+
+  @Override
+  protected void handle(String value) {
+    var pattern = Pattern.compile(regex);
+    var matcher = pattern.matcher(value);
+    matcher.matches();
+
+    var shopId = matcher.group("shopId");
+    var shopName = matcher.group("shopName");
+    var commodityName = matcher.group("commodityName");
+    var maxBoxSize = Integer.valueOf(matcher.group("maxBoxSize"));
+
+    logger.info("Shop {}#{} sells {} in boxes of up to {} SCU", shopName, shopId, commodityName,
+        maxBoxSize);
+    notificationService
+        .info(String.format(Locale.ROOT, LocalizationUtil.get("infoLocationDetectedFromLogs"),
+            String.format(Locale.ROOT, "%s#%s", shopName, shopId)));
+
+    var commodityListing =
+        commodityListingFactory.build(shopId, shopName, commodityName, maxBoxSize);
+
+    try {
+      commodityService.process(commodityListing);
+    } catch (InterruptedException e) {
+      logger.error("Could not send {} for processing", commodityListing, e);
+    }
+  }
+}

src/main/java/tools/sctrade/companion/domain/gamelog/GameLogPathSubject.java

@@ -0,0 +1,46 @@
+package tools.sctrade.companion.domain.gamelog.lineprocessors;
+
+import java.time.Instant;
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
+import java.util.Locale;
+import java.util.regex.Pattern;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import tools.sctrade.companion.utils.patterns.ChainOfResponsability;
+
+public class OldLogLineProcessor extends ChainOfResponsability<String> {
+  private static final DateTimeFormatter DATE_TIME_FORMATTER =
+      DateTimeFormatter.ofPattern("uuuu-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.ROOT); // 2024-11-13T15:01:11.106Z
+
+  private final Logger logger = LoggerFactory.getLogger(OldLogLineProcessor.class);
+
+  private final Pattern pattern = Pattern.compile("^<(?<timestamp>.{24})> .+");
+  private final Instant applicationOpenTime;
+
+  public OldLogLineProcessor() {
+    this.applicationOpenTime = Instant.now();
+  }
+
+  @Override
+  protected boolean canHandle(String value) {
+    var matcher = pattern.matcher(value);
+
+    if (matcher.matches()) {
+      var timestamp = matcher.group("timestamp");
+      var timestampInstant =
+          LocalDateTime.parse(timestamp, DATE_TIME_FORMATTER).atZone(ZoneId.of("UTC")).toInstant();
+
+      return timestampInstant.isBefore(applicationOpenTime);
+    } else {
+      return false;
+    }
+  }
+
+  @Override
+  protected void handle(String value) {
+    logger.trace("Old log line ignored: '{}'", value);
+  }
+
+}

src/main/java/tools/sctrade/companion/domain/gamelog/lineprocessors/FallbackLogLineProcessor.java

@@ -63,7 +63,8 @@ private void updateUsername() {
 
   private void buildStarCitizenLivePathField(GameLogPathSubject gameLogService) {
     var starCitizenLivePathLabel = buildLabel(3, LocalizationUtil.get("labelStarCitizenLivePath"));
-    var starCitizenLivePathField = buildTextField(3, gameLogService.getStarCitizenLivePath().get());
+    var starCitizenLivePathField =
+        buildTextField(3, gameLogService.getStarCitizenLivePath().orElse(null));
     starCitizenLivePathField.putClientProperty("JTextField.placeholderText",
         LocalizationUtil.get("textFieldStarCitizenLivePathPlaceholder"));
     starCitizenLivePathLabel.setLabelFor(starCitizenLivePathField);