Merge pull request #68 from myth-MC/dev/1.2

1.2.0

Author: U8092

README.md

@@ -56,13 +56,14 @@
 
 ### Compatibility chart
 
-|                                                         | Compatible? | Version | Notes                                        |
-|---------------------------------------------------------|-------------|---------|----------------------------------------------|
-| [PaperMC](https://papermc.io/)                          | ✅          | 1.20.6+ |                                              |
-| [PurpurMC](https://purpurmc.org/)                       | ✅          | 1.20.6+ |                                              |
-| [Spigot](https://www.spigotmc.org)                      | ✅          | 1.20+   | Consider using [PaperMC](https://papermc.io) |
-| [Bukkit](https://bukkit.org)                            | ✅          | 1.20+   | Consider using [PaperMC](https://papermc.io) |
-| [Folia](https://papermc.io/software/folia)              | ✅          | 1.20.6+ |                                              |
+**banco** is distributed in two builds released simultaneously. The `modern` build is compatible with PaperMC and its forks starting from Minecraft 1.21.7, while the `legacy` build supports Spigot and its forks starting from Minecraft 1.20:
+
+|                 | Minecraft version | Compatible software                              | Optimized | Full feature support |
+|-----------------|-------------------|--------------------------------------------------|-----------|----------------------|
+| Modern          | 1.21.7+           | [PaperMC](https://papermc.io/), Folia, Purpur... | ✅        | ✅                  |
+| Legacy          | 1.20+             | [Spigot](https://www.spigotmc.org)               | ❌        | ❌                  |
+
+Any software not listed here is not supported and may cause unexpected errors.
 
 ### Dependencies
 
@@ -92,12 +93,3 @@ banco comes with a very simple emerald-based economy setup that can be expanded
 * 🏷️ [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)
 * 🐣 [social](https://github.com/myth-MC/social)
 * Any other plugin with Vault support, including Factions, Towny Advanced, Jobs...
-
-<hr>
-
-<a href="https://sponsor.mythmc.ovh/">
-  <img src="https://assets.mythmc.ovh/banner_godlike.png" />
-</a>
-<div align="center">
-  <p>We're sponsored by <a href="https://sponsor.mythmc.ovh/">Godlike</a>, a high performance game server hosting. Check them out!</p>
-</div>

VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

api/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>ovh.mythmc</groupId>
         <artifactId>banco</artifactId>
-        <version>1.1.1</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>banco-api</artifactId>

api/src/main/java/ovh/mythmc/banco/api/Banco.java

@@ -21,6 +21,8 @@ public interface Banco {
      */
     String version();
 
+    boolean isShuttingDown();
+
     @NotNull AccountManager getAccountManager();
 
     @NotNull LoggerWrapper getLogger();

api/src/main/java/ovh/mythmc/banco/api/accounts/AccountDatabase.java

@@ -28,6 +28,7 @@
 import ovh.mythmc.banco.api.accounts.database.MySQLConnectionSource;
 import ovh.mythmc.banco.api.accounts.database.SQLiteConnectionSource;
 import ovh.mythmc.banco.api.logger.LoggerWrapper;
+import ovh.mythmc.banco.api.scheduler.BancoScheduler;
 
 @NoArgsConstructor
 public final class AccountDatabase {
@@ -137,7 +138,7 @@ public void delete(@NotNull Account account) {
         }
     }
 
-    public void update(@NotNull Account account) {
+    public void updateCache(@NotNull Account account) {
         cache.put(account.getIdentifier(), account);
     }
 
@@ -155,18 +156,23 @@ public void run() {
         }, Banco.get().getSettings().get().getDatabase().getCacheClearInterval(), TimeUnit.MINUTES);
     }
 
-    private void updateAllDatabaseEntries() {
+    public long updateAllDatabaseEntries() {
         var startTime = System.currentTimeMillis();
 
         if (Banco.get().getSettings().get().isDebug())
             Banco.get().getLogger().info("Updating " + cache.size() + " cached accounts...");
 
         Map.copyOf(cache).values().forEach(this::updateDatabaseEntry);
 
+        final long totalTime = System.currentTimeMillis() - startTime;
+
         if (Banco.get().getSettings().get().isDebug())
-            Banco.get().getLogger().info("Done! (took " + (System.currentTimeMillis() - startTime) + "ms)");
+            Banco.get().getLogger().info("Done! (took " + totalTime + "ms)");
+
+        return totalTime;
     }
 
+    /*
     private void updateDatabaseEntry(@NotNull Account account) {
         try {
             getDao().update(account);
@@ -177,6 +183,33 @@ private void updateDatabaseEntry(@NotNull Account account) {
             logger.error("Exception while updating account {}", e);
         }
     }
+     */
+
+    public long updateDatabaseEntry(@NotNull Account account) {
+        final Runnable task = () -> {
+            try {
+                getDao().update(account);
+    
+                // Clear cache value
+                cache.remove(account.getIdentifier());
+            } catch (SQLException e) {
+                logger.error("Exception while updating account {}", e);
+            }
+        };
+
+        final long startTime = System.currentTimeMillis();
+
+        if (Banco.get().getSettings().get().getDatabase().isAsynchronousWrites()) {
+            if (Banco.get().getSettings().get().isDebug())
+                Banco.get().getLogger().info("Saving {} ({}) asynchronously...", account.getIdentifier().uuid(), account.getIdentifier().name());
+
+            BancoScheduler.get().runAsync(task);
+        } else {
+            task.run();
+        }
+
+        return (System.currentTimeMillis() - startTime);
+    }
 
     public Collection<Account> getCachedAccounts() {
         return cache.values();

api/src/main/java/ovh/mythmc/banco/api/accounts/AccountManager.java

@@ -32,6 +32,9 @@ public final class AccountManager {
     @Getter
     private final AccountDatabase database = new AccountDatabase();
 
+    @Getter
+    private final TransactionHistory transactionHistory = new TransactionHistoryImpl();
+
     /**
      * Creates an account
      * @param uuid uuid of account to create and register
@@ -119,16 +122,37 @@ public void deposit(final @NotNull UUID uuid, final @NotNull BigDecimal amount)
         deposit(getByUuid(uuid), amount);
     }
 
+    /**
+     * Deposits an amount of money to an account
+     * @param uuid account uuid that will be modified
+     * @param amount amount of money to deposit
+     * @param loggable whether this transaction can be logged
+     */
+    public void deposit(final @NotNull UUID uuid, final @NotNull BigDecimal amount, final boolean loggable) {
+        deposit(getByUuid(uuid), amount, loggable);
+    }
+
     /**
      * Deposits an amount of money to an account
      * @param account account that will be modified
      * @param amount amount of money to deposit
      */
     public void deposit(final @NotNull Account account, final @NotNull BigDecimal amount) {
+        deposit(account, amount, true);
+    }
+
+    /**
+     * Deposits an amount of money to an account
+     * @param account account that will be modified
+     * @param amount amount of money to deposit
+     * @param loggable whether this transaction can be logged
+     */
+    public void deposit(final @NotNull Account account, final @NotNull BigDecimal amount, final boolean loggable) {
         Transaction transaction = Transaction.builder()
             .account(account)
             .amount(amount)
             .operation(Operation.DEPOSIT)
+            .loggable(loggable)
             .build();
 
         transaction.queue();
@@ -143,16 +167,37 @@ public void withdraw(final @NotNull UUID uuid, final @NotNull BigDecimal amount)
         withdraw(getByUuid(uuid), amount);
     }
 
+    /**
+     * Withdraws an amount of money from an account
+     * @param account account uuid that will be modified
+     * @param amount amount of money to withdraw
+     * @param loggable whether this transaction can be logged
+     */
+    public void withdraw(final @NotNull UUID uuid, final @NotNull BigDecimal amount, final boolean loggable) {
+        withdraw(getByUuid(uuid), amount, loggable);
+    }
+
     /**
      * Withdraws an amount of money from an account
      * @param account account that will be modified
      * @param amount amount of money to withdraw
      */
     public void withdraw(final @NotNull Account account, final @NotNull BigDecimal amount) {
+        withdraw(account, amount, true);
+    }
+
+    /**
+     * Withdraws an amount of money from an account
+     * @param account account that will be modified
+     * @param amount amount of money to withdraw
+     * @param loggable whether this transaction can be logged
+     */
+    public void withdraw(final @NotNull Account account, final @NotNull BigDecimal amount, final boolean loggable) {
         Transaction transaction = Transaction.builder()
             .account(account)
             .amount(amount)
             .operation(Operation.WITHDRAW)
+            .loggable(loggable)
             .build();
 
         transaction.queue();
@@ -228,7 +273,7 @@ public boolean has(final @NotNull Account account, final @NotNull BigDecimal amo
             uuidResolver.resolveOfflinePlayer(account.getUuid()).get().toOfflinePlayer().isOnline()) {
 
             account.setAmount(getValueOfPlayer(account.getUuid(), true));
-            database.update(account);
+            database.updateCache(account);
         }
 
         // Offline players
@@ -254,15 +299,15 @@ private synchronized BigDecimal getValueOfPlayer(final @NotNull UUID uuid, boole
     public synchronized void updateTransactions(final @NotNull Account account) {
         BigDecimal amount = account.amount();
         account.setTransactions(BigDecimal.valueOf(0));
-        database.update(account);
+        database.updateCache(account);
 
         set(account.getUuid(), amount);
     }
 
     @ApiStatus.Internal
     public void updateName(final @NotNull Account account, String newName) {
         account.setName(newName);
-        database.update(account);
+        database.updateCache(account);
     }
 
     /**

api/src/main/java/ovh/mythmc/banco/api/accounts/Transaction.java

@@ -2,6 +2,7 @@
 
 import java.math.BigDecimal;
 import java.math.RoundingMode;
+import java.time.Instant;
 
 import org.bukkit.Bukkit;
 import org.jetbrains.annotations.NotNull;
@@ -28,6 +29,9 @@ public class Transaction {
 
     private @NotNull BigDecimal amount;
 
+    @Builder.Default
+    private boolean loggable = true;
+
     public void transact() {
         // Callback
         final var callback = new BancoTransactionProcess(this);
@@ -47,6 +51,9 @@ public void transact() {
                 set(amount);
             }
         }
+
+        if (loggable)
+            Banco.get().getAccountManager().getTransactionHistory().register(account.getIdentifier(), this);
     }
 
     public void queue() {
@@ -74,7 +81,7 @@ private void set(@NotNull BigDecimal newAmount) {
 
                 // Set transactions to remaining amount
                 account.setTransactions(account.getTransactions().add(toAdd.setScale(2, RoundingMode.HALF_UP)));
-                Banco.get().getAccountManager().getDatabase().update(account);
+                Banco.get().getAccountManager().getDatabase().updateCache(account);
                 return;
             }
 
@@ -89,7 +96,7 @@ private void set(@NotNull BigDecimal newAmount) {
 
             // Register transaction if player is not online
             account.setTransactions(account.getTransactions().add(toAdd));
-            Banco.get().getAccountManager().getDatabase().update(account);
+            Banco.get().getAccountManager().getDatabase().updateCache(account);
         } else { // Remove amount from account
             BigDecimal toRemove = account.amount().subtract(newAmount);
 
@@ -103,7 +110,7 @@ private void set(@NotNull BigDecimal newAmount) {
 
                 // Set transactions to remaining amount
                 account.setTransactions(account.getTransactions().subtract(toRemove.setScale(2, RoundingMode.HALF_UP)));
-                Banco.get().getAccountManager().getDatabase().update(account);
+                Banco.get().getAccountManager().getDatabase().updateCache(account);
                 return;
             }
 
@@ -118,7 +125,7 @@ private void set(@NotNull BigDecimal newAmount) {
 
             // Register transaction if player is not online
             account.setTransactions(account.getTransactions().subtract(toRemove));
-            Banco.get().getAccountManager().getDatabase().update(account);
+            Banco.get().getAccountManager().getDatabase().updateCache(account);
         }
     }
 
@@ -132,8 +139,11 @@ public static class ImmutableView {
 
         private final Transaction transaction;
 
+        private final Instant timestamp;
+
         ImmutableView(Transaction transaction) {
             this.transaction = transaction;
+            this.timestamp = Instant.now();
         }
 
         public Account account() {
@@ -148,6 +158,10 @@ public Operation operation() {
             return transaction.operation;
         }
 
+        public Instant timestamp() {
+            return this.timestamp;
+        }
+
     }
 
 }

api/src/main/java/ovh/mythmc/banco/api/accounts/TransactionHistory.java

@@ -0,0 +1,21 @@
+package ovh.mythmc.banco.api.accounts;
+
+import java.util.List;
+
+import org.jetbrains.annotations.NotNull;
+
+public interface TransactionHistory {
+
+    @NotNull List<Transaction.ImmutableView> get(@NotNull AccountIdentifierKey accountIdentifierKey);
+
+    default @NotNull List<Transaction.ImmutableView> get(@NotNull Account account) {
+        return get(account.getIdentifier());
+    }
+
+    void register(@NotNull AccountIdentifierKey accountIdentifierKey, @NotNull Transaction.ImmutableView transaction);
+
+    default void register(@NotNull AccountIdentifierKey accountIdentifierKey, @NotNull Transaction transaction) {
+        register(accountIdentifierKey, transaction.asImmutable());
+    }
+    
+}

api/src/main/java/ovh/mythmc/banco/api/accounts/TransactionHistoryImpl.java

@@ -0,0 +1,25 @@
+package ovh.mythmc.banco.api.accounts;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+final class TransactionHistoryImpl implements TransactionHistory {
+
+    private final Map<AccountIdentifierKey, List<Transaction.ImmutableView>> transactionHistory = new HashMap<>();
+
+    @Override
+    public List<Transaction.ImmutableView> get(AccountIdentifierKey accountIdentifierKey) {
+        return transactionHistory.getOrDefault(accountIdentifierKey, List.of());
+    }
+
+    @Override
+    public void register(AccountIdentifierKey accountIdentifierKey, Transaction.ImmutableView transaction) {
+        final List<Transaction.ImmutableView> accountTransactionHistory = transactionHistory.getOrDefault(accountIdentifierKey, new ArrayList<>());
+        accountTransactionHistory.add(transaction);
+
+        transactionHistory.put(accountIdentifierKey, accountTransactionHistory);
+    }
+    
+}

api/src/main/java/ovh/mythmc/banco/api/configuration/sections/CommandsConfig.java

@@ -28,6 +28,9 @@ public class CommandsConfig {
     @Comment({"/pay - Allows players to send money to other accounts", "Permission: banco.use.pay (assigned by default)"})
     private SimpleCommand pay = new SimpleCommand(true);
 
+    @Comment({"/transactions - Allows players to see their recent transactions", "Permission: banco.use.transactions (assigned by default)"})
+    private SimpleCommand transactions = new SimpleCommand(true);
+
     public record SimpleCommand(boolean enabled) { }
 
 }