implement individual intervals for payouts

#53

Plugin/src/main/java/de/Linus122/TimeIsMoney/Listeners.java

@@ -28,7 +28,7 @@ public class Listeners implements Listener {
 
             pending.forEach(k -> {
                 System.out.println("paying user from pending payout: " + k);
-                main.pay(event.getPlayer());
+                main.pay(event.getPlayer(), main.getPayouts().get(k), main.getPluginData().getPlayerData(event.getPlayer()).getPayoutData(k));
             });
 
         }

Plugin/src/main/java/de/Linus122/TimeIsMoney/Main.java

@@ -12,12 +12,9 @@ import java.util.*;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
-import de.Linus122.TimeIsMoney.data.MySQLPluginData;
-import de.Linus122.TimeIsMoney.data.PlayerData;
-import de.Linus122.TimeIsMoney.data.PluginData;
-import de.Linus122.TimeIsMoney.data.YamlPluginData;
+import de.Linus122.TimeIsMoney.data.*;
+import de.Linus122.TimeIsMoney.tools.Utils;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.Server;
@@ -172,22 +169,33 @@ public class Main extends JavaPlugin {
 	}
 	
 	public void startPlaytimeWatcher() {
+		String intervalString = getConfig().getString("global_interval", getConfig().getInt("give_money_every_second") + "s");
+		int globalTimerSeconds = Utils.parseTimeFormat(intervalString);
+
 		playtimeWatcherTask = Bukkit.getScheduler().runTaskTimer(this, () -> {
 			for (Player player : Bukkit.getOnlinePlayers()) {
 				if (disabledWorlds.contains(player.getWorld().getName())) continue;
 				PlayerData playerData = this.pluginData.getPlayerData(player);
 
-				playerData.setSecondsSinceLastPayout(playerData.getSecondsSinceLastPayout() + 1);
-				if (playerData.getSecondsSinceLastPayout() >= getConfig().getInt("give_money_every_second")) {
-					// new payout triggered, handling the payout
-					pay(player);
+				for(Payout payout : this.getApplicablePayoutsForPlayer(player)) {
+					PayoutData playerPayoutData = playerData.getPayoutData(payout.id);
+					playerPayoutData.setSecondsSinceLastPayout(playerPayoutData.getSecondsSinceLastPayout() + 1);
+
+					int intervalSeconds = payout.interval != 0 ? payout.interval : globalTimerSeconds;
+
+					if (playerPayoutData.getSecondsSinceLastPayout() >= intervalSeconds) {
+						// new payout triggered, handling the payout
+						pay(player, payout, playerPayoutData);
 
-					if(this.pluginData instanceof MySQLPluginData) {
-						// let other servers know of this payout
-						((MySQLPluginData) this.pluginData).createPendingPayout(player);
+						if(this.pluginData instanceof MySQLPluginData) {
+							// let other servers know of this payout
+							((MySQLPluginData) this.pluginData).createPendingPayout(player);
+						}
+						playerPayoutData.setSecondsSinceLastPayout(0);
 					}
-					playerData.setSecondsSinceLastPayout(0);
 				}
+
+
 			}
 		}, 20L, 20L);
 	}
@@ -221,6 +229,7 @@ public class Main extends JavaPlugin {
 			payouts.clear();
 			for (String key : finalconfig.getConfigurationSection("payouts").getKeys(false)) {
 				Payout payout = new Payout();
+				payout.id = Integer.parseInt(key);
 				payout.max_payout_per_day = finalconfig.getDouble("payouts." + key + ".max_payout_per_day");
 				payout.payout_amount = finalconfig.getDouble("payouts." + key + ".payout_amount");
 				if (finalconfig.isSet("payouts." + key + ".permission")) {
@@ -236,6 +245,10 @@ public class Main extends JavaPlugin {
 				if (finalconfig.isSet("payouts." + key + ".chance")) {
 					payout.chance = finalconfig.getDouble("payouts." + key + ".chance");
 				}
+				if (finalconfig.isSet("payouts." + key + ".interval")) {
+					// TODO: Add error message when parsing failed
+					payout.interval = Utils.parseTimeFormat(finalconfig.getString("payouts." + key + ".interval"));
+				}
 				payouts.add(payout);
 			}
 			logger.info("[TimeIsMoney] &aLoaded " + finalconfig.getConfigurationSection("payouts").getKeys(false).size() + " Payouts!");
@@ -267,7 +280,32 @@ public class Main extends JavaPlugin {
 	private List<Payout> getApplicablePayoutsForPlayer(Player player){
 		if (!this.getConfig().getBoolean("choose-payout-by-chance")) {
 			// Choose applicable payouts by permission
-			return payouts.stream().filter(payout -> player.hasPermission(payout.permission) || payout.permission.length() == 0).collect(Collectors.toList());
+			List<Payout> payouts_ = payouts.stream().filter(payout -> player.hasPermission(payout.permission) || payout.permission.length() == 0).collect(Collectors.toList());
+
+			if(finalconfig.getBoolean("choose-only-one-payout", true)) {
+				List<Payout> finalPayouts = new ArrayList<>();
+				// add payouts with a custom timer anyways
+				finalPayouts.addAll(payouts_.stream().filter(payout -> payout.interval != 0).collect(Collectors.toList()));
+
+				// choose the last element of the payouts that does not have a custom timer
+				List<Payout> payoutsWithoutInterval = payouts_.stream().filter(payout -> payout.interval == 0).collect(Collectors.toList());
+				finalPayouts.add(payoutsWithoutInterval.get(payoutsWithoutInterval.size() - 1));
+				return finalPayouts;
+			} else if(this.getConfig().getBoolean("merge-payouts")) {
+				// Mering multiple payouts to one
+				Payout payout = new Payout();
+				payout.id = 1;
+				for (Payout payout_ : payouts_) {
+					if(payout_.interval != 0) {
+						continue;
+					}
+					payout.commands.addAll(payout_.commands);
+					payout.commands_if_afk.addAll(payout_.commands_if_afk);
+					payout.payout_amount += payout_.payout_amount;
+					payout.max_payout_per_day += payout_.max_payout_per_day;
+				}
+			}
+			return payouts_;
 		}else {
 			// Get a random payout
 			Random rnd = new Random();
@@ -290,34 +328,11 @@ public class Main extends JavaPlugin {
 	 *
 	 * @param player The player to pay.
 	 */
-	public void pay(Player player) {
+	public void pay(Player player, Payout payout, PayoutData payoutPlayerData) {
 		if (player == null) return;
 
-		PlayerData playerData = this.pluginData.getPlayerData(player);
-		
-		//REACHED MAX PAYOUT CHECK
-
-		List<Payout> applicablePayouts = this.getApplicablePayoutsForPlayer(player);
-		if (applicablePayouts.size() == 0) {
-			return;
-		}
-		
-		Payout payout = new Payout();
-		
-		if(this.getConfig().getBoolean("merge-payouts")) {
-			// Mering multiple payouts to one
-			for (Payout payout_ : applicablePayouts) {
-				payout.commands.addAll(payout_.commands);
-				payout.commands_if_afk.addAll(payout_.commands_if_afk);
-				payout.payout_amount += payout_.payout_amount;
-				payout.max_payout_per_day += payout_.max_payout_per_day;
-			}	
-		}else {
-			payout = applicablePayouts.get(applicablePayouts.size() - 1);
-		}
-
 		if (payout.max_payout_per_day != -1) {
-			if (playerData.getReceivedToday() >= payout.max_payout_per_day) { //Reached max payout
+			if (payoutPlayerData.getReceivedToday() >= payout.max_payout_per_day) { //Reached max payout
 				
 				if(finalconfig.getBoolean("display-payout-limit-reached-message-once") && payoutLimitReached.contains(player.getUniqueId())) {
 					return;
@@ -440,7 +455,7 @@ public class Main extends JavaPlugin {
 		}
 		
 		//ADD PAYED MONEY
-		playerData.setReceivedToday(playerData.getReceivedToday() + payout_amt);
+		payoutPlayerData.setReceivedToday(payoutPlayerData.getReceivedToday() + payout_amt);
 
 		
 		lastLocation.put(player.getUniqueId(), player.getLocation());
@@ -565,4 +580,8 @@ public class Main extends JavaPlugin {
 	public PluginData getPluginData() {
 		return pluginData;
 	}
+
+	public List<Payout> getPayouts() {
+		return payouts;
+	}
 }

Plugin/src/main/java/de/Linus122/TimeIsMoney/Payout.java

@@ -10,6 +10,7 @@ import java.util.List;
  * @since 1.9.6.1
  */
 class Payout {
+	int id;
 	/**
 	 * The payout amount.
 	 */
@@ -34,4 +35,9 @@ class Payout {
 	 * The list of commands to execute if this payout is earned while afk.
 	 */
 	List<String> commands_if_afk = new ArrayList<>();
+
+	/**
+	 * Interval seconds
+	 */
+	int interval = 0;
 }

Plugin/src/main/java/de/Linus122/TimeIsMoney/data/MySQLPluginData.java

@@ -31,11 +31,13 @@ public class MySQLPluginData extends PluginData{
             this.plugin.getLogger().info(String.format("MySQL connected!", host, port, database));
 
             // table for the player data
-            String sqlCreate = "CREATE TABLE IF NOT EXISTS playerData ("
-                    + "   uuid                     VARCHAR(36) PRIMARY KEY,"
+            String sqlCreate = "CREATE TABLE IF NOT EXISTS payoutData ("
+                    + "   uuid                     VARCHAR(36),"
+                    + "   id                       INT,"
                     + "   receivedToday            DOUBLE,"
                     + "   secondsSinceLastPayout   INTEGER,"
-                    + "   lastPayoutDate           DATE)";
+                    + "   lastPayoutDate           DATE,"
+                    + "   primary key (uuid, id))";
 
             Statement statement = connection.createStatement();
             statement.execute(sqlCreate);
@@ -73,19 +75,22 @@ public class MySQLPluginData extends PluginData{
     }
 
     public void savePlayerData(UUID uuid, PlayerData playerData) {
-        try {
-            PreparedStatement preparedStatement = connection
-                    .prepareStatement("REPLACE INTO playerData (uuid, receivedToday, secondsSinceLastPayout, lastPayoutDate) VALUES (?, ?, ? ,?)");
-            preparedStatement.setString(1, uuid.toString());
-            preparedStatement.setDouble(2, playerData.getReceivedToday());
-            preparedStatement.setInt(3, playerData.getSecondsSinceLastPayout());
-            preparedStatement.setDate(4, new java.sql.Date(playerData.getLastPayoutDate().getTime()));
-
-            preparedStatement.execute();
-
-        } catch (SQLException e) {
-            e.printStackTrace();
-        }
+        playerData.getPayoutDataMap().forEach((payoutID, payoutData) -> {
+            try {
+                PreparedStatement preparedStatement = connection
+                        .prepareStatement("REPLACE INTO playerData (uuid, payout_id receivedToday, secondsSinceLastPayout, lastPayoutDate) VALUES (?, ?, ?, ? ,?)");
+                preparedStatement.setString(1, uuid.toString());
+                preparedStatement.setInt(1, payoutID);
+                preparedStatement.setDouble(2, payoutData.getReceivedToday());
+                preparedStatement.setInt(3, payoutData.getSecondsSinceLastPayout());
+                preparedStatement.setDate(4, new java.sql.Date(payoutData.getLastPayoutDate().getTime()));
+
+                preparedStatement.execute();
+
+            } catch (SQLException e) {
+                e.printStackTrace();
+            }
+        });
     }
 
     @Override
@@ -93,13 +98,12 @@ public class MySQLPluginData extends PluginData{
 
     }
 
-    private AbstractMap.Entry<UUID, PlayerData> readPlayerData(ResultSet result) throws SQLException {
-        UUID uuid = UUID.fromString(result.getString("uuid"));
+    private PayoutData readPayoutData(ResultSet result) throws SQLException {
         double receivedToday = result.getDouble("receivedToday");
         int secondsOnline = result.getInt("secondsSinceLastPayout");
         Date date = new Date(result.getDate("lastPayoutDate").getTime());
 
-        return new AbstractMap.SimpleEntry<>(uuid, new PlayerData(receivedToday, date, secondsOnline));
+        return new PayoutData(receivedToday, date, secondsOnline);
     }
 
     @Blocking
@@ -108,14 +112,16 @@ public class MySQLPluginData extends PluginData{
             return playerDataMap.get(player.getUniqueId());
         }
         try{
+            PlayerData playerData = new PlayerData();
             // get data from DB
             ResultSet result = connection.prepareStatement("SELECT * FROM playerData WHERE uuid='" + player.getUniqueId() + "'").executeQuery();
-            if(result.next()) {
-                AbstractMap.Entry<UUID, PlayerData> data = this.readPlayerData(result);
-                playerDataMap.put(data.getKey(), data.getValue());
-            } else {
-                // no entry, create new object
-                playerDataMap.put(player.getUniqueId(), new PlayerData(0, new java.util.Date(), 0));
+            while(result.next()) {
+                UUID uuid = UUID.fromString(result.getString("uuid"));
+                int payoutID = result.getInt("payout_id");
+
+                PayoutData payoutData = this.readPayoutData(result);
+                playerData.getPayoutDataMap().put(payoutID, payoutData);
+                playerDataMap.put(uuid, playerData);
             }
         } catch (SQLException e) {
             e.printStackTrace();

Plugin/src/main/java/de/Linus122/TimeIsMoney/data/PayoutData.java

@@ -0,0 +1,52 @@
+package de.Linus122.TimeIsMoney.data;
+
+import org.apache.commons.lang.time.DateUtils;
+
+import java.util.Date;
+
+public class PayoutData {
+    private double receivedToday = 0d;
+    private Date lastPayoutDate;
+    private int secondsSinceLastPayout = 0;
+
+    public PayoutData(double receivedToday, Date lastPayoutDate, int secondsSinceLastPayout) {
+        this.receivedToday = receivedToday;
+        this.lastPayoutDate = lastPayoutDate;
+        this.secondsSinceLastPayout = secondsSinceLastPayout;
+    }
+
+    public double getReceivedToday() {
+        if(lastPayoutDate == null || !DateUtils.isSameDay(lastPayoutDate, new Date())) {
+            // new day, reset total money received
+            receivedToday = 0d;
+        }
+        return receivedToday;
+    }
+
+
+    /**
+     * Sets the total amount of money received for today and updates the {@link #lastPayoutDate} variable to now.
+     * @param receivedToday     Amount of money received today
+     * @since 1.9.7
+     */
+    public void setReceivedToday(double receivedToday) {
+        this.receivedToday = receivedToday;
+        lastPayoutDate = new Date();
+    }
+
+    public int getSecondsSinceLastPayout() {
+        return secondsSinceLastPayout;
+    }
+
+    public void setSecondsSinceLastPayout(int secondsSinceLastPayout) {
+        this.secondsSinceLastPayout = secondsSinceLastPayout;
+    }
+
+    public Date getLastPayoutDate() {
+        return lastPayoutDate;
+    }
+
+    public void setLastPayoutDate(Date lastPayoutDate) {
+        this.lastPayoutDate = lastPayoutDate;
+    }
+}

Plugin/src/main/java/de/Linus122/TimeIsMoney/data/PlayerData.java

@@ -1,55 +1,28 @@
 package de.Linus122.TimeIsMoney.data;
 
-import org.apache.commons.lang.time.DateUtils;
-
 
 import java.util.Date;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
 
-public class PlayerData {
-
-    private double receivedToday = 0d;
-    private Date lastPayoutDate;
-    private int secondsSinceLastPayout = 0;
-
-    public PlayerData(double receivedToday, Date lastPayoutDate, int secondsSinceLastPayout) {
-        this.receivedToday = receivedToday;
-        this.lastPayoutDate = lastPayoutDate;
-        this.secondsSinceLastPayout = secondsSinceLastPayout;
-    }
 
-    public double getReceivedToday() {
-        if(lastPayoutDate == null || !DateUtils.isSameDay(lastPayoutDate, new Date())) {
-            // new day, reset total money received
-            receivedToday = 0d;
+public class PlayerData {
+    // stores per payout data (key as defined in config.yml)
+    private final HashMap<Integer, PayoutData> payoutData = new LinkedHashMap<>();
+    
+    public PayoutData getPayoutData(int payout_id) {
+        if(payoutData.containsKey(payout_id)) {
+            return payoutData.get(payout_id);
         }
-        return receivedToday;
-    }
-
-
-    /**
-     * Sets the total amount of money received for today and updates the {@link #lastPayoutDate} variable to now.
-     * @param receivedToday     Amount of money received today
-     * @since 1.9.7
-     */
-    public void setReceivedToday(double receivedToday) {
-        this.receivedToday = receivedToday;
-        lastPayoutDate = new Date();
-    }
-
-    public int getSecondsSinceLastPayout() {
-        return secondsSinceLastPayout;
-    }
-
-    public void setSecondsSinceLastPayout(int secondsSinceLastPayout) {
-        this.secondsSinceLastPayout = secondsSinceLastPayout;
-    }
-
-    public Date getLastPayoutDate() {
-        return lastPayoutDate;
+        PayoutData payoutDataEntry = new PayoutData(0, new Date(), 0);
+        
+        payoutData.put(payout_id, payoutDataEntry);
+        
+        return payoutDataEntry;
     }
 
-    public void setLastPayoutDate(Date lastPayoutDate) {
-        this.lastPayoutDate = lastPayoutDate;
+    public HashMap<Integer, PayoutData> getPayoutDataMap() {
+        return this.payoutData;
     }
 
 }

Plugin/src/main/java/de/Linus122/TimeIsMoney/data/YamlPluginData.java

@@ -33,12 +33,20 @@ public class YamlPluginData extends PluginData{
 
             for(String key : yamlConfiguration.getKeys(false)) {
                 UUID uuid = UUID.fromString(key);
-
-                double receivedToday = yamlConfiguration.getDouble(key + ".receivedToday");
-                int secondsOnline = yamlConfiguration.getInt(key + ".secondsSinceLastPayout");
-                Date date = yamlConfiguration.getObject(key + ".lastPayoutDate", Date.class);
-
-                PlayerData playerData = new PlayerData(receivedToday, date, secondsOnline);
+                PlayerData playerData = new PlayerData();
+                for(String payout_id : yamlConfiguration.getConfigurationSection(key).getKeys(false)) {
+                    try {
+                        Integer.parseInt(payout_id);
+                    } catch(NumberFormatException e) {
+                        continue;
+                    }
+                    double receivedToday = yamlConfiguration.getDouble(key + "." + payout_id + ".receivedToday");
+                    int secondsOnline = yamlConfiguration.getInt(key + "." + payout_id + ".secondsSinceLastPayout");
+                    Date date = yamlConfiguration.getObject(key + "." + payout_id + ".lastPayoutDate", Date.class);
+
+                    PayoutData payoutData = new PayoutData(receivedToday, date, secondsOnline);
+                    playerData.getPayoutDataMap().put(Integer.parseInt(payout_id), payoutData);
+                }
 
                 playerDataMap.put(uuid, playerData);
             }
@@ -58,9 +66,11 @@ public class YamlPluginData extends PluginData{
         }
         YamlConfiguration yamlConfiguration = new YamlConfiguration();
         super.playerDataMap.forEach((uuid, playerData) -> {
-            yamlConfiguration.set(uuid + ".receivedToday" , playerData.getReceivedToday());
-            yamlConfiguration.set(uuid + ".secondsSinceLastPayout" , playerData.getSecondsSinceLastPayout());
-            yamlConfiguration.set(uuid + ".lastPayoutDate" , playerData.getLastPayoutDate());
+            playerData.getPayoutDataMap().forEach((payout_id, payoutData) -> {
+                yamlConfiguration.set(uuid + "." + payout_id + ".receivedToday" , payoutData.getReceivedToday());
+                yamlConfiguration.set(uuid + "." + payout_id + ".secondsSinceLastPayout" , payoutData.getSecondsSinceLastPayout());
+                yamlConfiguration.set(uuid + "." + payout_id + ".lastPayoutDate" , payoutData.getLastPayoutDate());
+            });
 
         });
         try {
@@ -73,7 +83,7 @@ public class YamlPluginData extends PluginData{
     public PlayerData getPlayerData(@NotNull Player player) {
         if(!this.playerDataMap.containsKey(player.getUniqueId())) {
             // create a new PlayerData object
-            PlayerData playerData = new PlayerData(0, new Date(), 0);
+            PlayerData playerData = new PlayerData();
 
             this.playerDataMap.put(player.getUniqueId(), playerData);
             return playerData;

Plugin/src/main/resources/config.yml

@@ -19,7 +19,6 @@ afk_use_essentials: true
 display-messages-in-chat: true
 display-messages-in-actionbar: true
 display-messages-in-actionbar-time: 10
-give_money_every_second: 600
 
 # defines whether the money should be stored in the bank (access it using /atm or an [ATM] sign, see more below)
 store-money-in-bank: false
@@ -40,8 +39,19 @@ bank-account: ""
 choose-payout-by-chance: false
 
 # Enable this if you want to add up all lower payouts to the final payout (only relevant when using permissions)
+# doesn't merge payouts with individual intervals. Also doesn't merge when choose-only-one-payout is enabled.
 merge-payouts: false
 
+# Should it choose the last payout a player has permission for from the list? In the payout configuration below,
+# this would mean that VIPs (players with the tim.vip perm) would receive the last payout, while normal players the
+# first in the list. Does not apply for payouts with individual intervals
+choose-only-one-payout: true
+
+# Interval for all payouts; how long should a player need to play on the server to receive one of the payouts?
+# (previously called give_money_every_second)
+# It accepts seconds (s), minutes (m), and hours (h)
+global_interval: "10m"
+
 # You can add as many payouts you want. You only can choose between "permission"
 # and "chance", not both.
 payouts:
@@ -49,7 +59,7 @@ payouts:
     payout_amount: 50
     max_payout_per_day: 1000
     # chance: 10
-    permission:
+    permission: ""
   2:
     payout_amount: 100
     max_payout_per_day: 10000
@@ -60,6 +70,13 @@ payouts:
     # chance: 90
     # You can use any permission name you want. e.g. myserver.donor
     permission: tim.vip
+#  3:
+#    payout_amount: 1000
+#    max_payout_per_day: 10000
+#    # you can define a custom interval for individual payouts
+#    interval: 10h
+#    permission: ""
+
 
 # Translations
 # Both legacy color codes, &c etc. and hex RGB color codes, #&FF00FF, are supported.

Tools/src/main/java/de/Linus122/TimeIsMoney/tools/Utils.java

@@ -60,4 +60,31 @@ public class Utils {
 		}
 		return msg;
 	}
+
+	/**
+	 * Return the seconds of a time format, valid suffixes are s (seconds), m (minutes) and h (hours)
+	 * @param format the formatted time, examples: 10m, 8h, 30s.
+	 * @return converted seconds, invalid return -1
+	 */
+	public static int parseTimeFormat(String format) {
+		Pattern pattern = Pattern.compile("^(?:(\\d+)s|(\\d+)m|(\\d+)h)$");
+		Matcher matcher = pattern.matcher(format);
+
+		if (matcher.matches()) {
+			String seconds = matcher.group(1);
+			String minutes = matcher.group(2);
+			String hours = matcher.group(3);
+
+			if (seconds != null) {
+				return Integer.parseInt(seconds);
+			}
+			if (minutes != null) {
+				return Integer.parseInt(minutes) * 60;
+			}
+			if (hours != null) {
+				return Integer.parseInt(hours) * 60 * 60;
+			}
+		}
+		return -1;
+	}
 }