Closed Ghost-chu#912, Impl the shop purger

Author: Ghost-chu

src/main/java/org/maxgamer/quickshop/QuickShop.java

@@ -263,6 +263,8 @@ public class QuickShop extends JavaPlugin {
     private WorldEditAdapter worldEditAdapter;
     @Getter
     private TextManager textManager;
+    @Getter
+    private ShopPurger shopPurger;
 
     /**
      * Use for mock bukkit
@@ -949,6 +951,8 @@ public void run() {
         }
         calendarWatcher = new CalendarWatcher(this);
         calendarWatcher.start();
+        this.shopPurger = new ShopPurger(this,false);
+        shopPurger.runTaskAsynchronously(this);
         Util.debugLog("Now using display-type: " + DisplayItem.getNowUsing().name());
         getLogger().info("QuickShop Loaded! " + enableTimer.stopAndGetTimePassed() + " ms.");
     }

src/main/java/org/maxgamer/quickshop/command/CommandManager.java

@@ -326,6 +326,11 @@ public CommandManager(QuickShop plugin) {
                 .permission("quickshop.toggledisplay")
                 .executor(new SubCommand_ToggleDisplay(plugin))
                 .build());
+        registerCmd(CommandContainer.builder()
+                .prefix("purge")
+                .permission("quickshop.purge")
+                .executor(new SubCommand_ToggleDisplay(plugin))
+                .build());
 //        registerCmd(CommandContainer.builder()
 //                .prefix("backup")
 //                .permission("quickshop.backup")

src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_Purge.java

@@ -0,0 +1,40 @@
+/*
+ * This file is a part of project QuickShop, the name is SubCommand_Info.java
+ *  Copyright (C) PotatoCraft Studio and contributors
+ *
+ *  This program is free software: you can redistribute it and/or modify it
+ *  under the terms of the GNU 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 General Public License
+ *  for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package org.maxgamer.quickshop.command.subcommand;
+
+import lombok.AllArgsConstructor;
+import org.bukkit.command.CommandSender;
+import org.jetbrains.annotations.NotNull;
+import org.maxgamer.quickshop.QuickShop;
+import org.maxgamer.quickshop.command.CommandHandler;
+
+@AllArgsConstructor
+public class SubCommand_Purge implements CommandHandler<CommandSender> {
+
+    private final QuickShop plugin;
+
+    @Override
+    public void onCommand(@NotNull CommandSender sender, @NotNull String commandLabel, @NotNull String[] cmdArg) {
+        plugin.getShopPurger().runTaskAsynchronously(plugin);
+        plugin.text().of(sender,"shop-purged-start").send();
+    }
+
+
+}

src/main/java/org/maxgamer/quickshop/shop/ShopPurger.java

@@ -0,0 +1,74 @@
+package org.maxgamer.quickshop.shop;
+
+import lombok.AllArgsConstructor;
+import org.bukkit.Bukkit;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.scheduler.BukkitRunnable;
+import org.maxgamer.quickshop.QuickShop;
+import org.maxgamer.quickshop.economy.EconomyTransaction;
+import org.maxgamer.quickshop.util.Util;
+
+import java.time.temporal.ChronoUnit;
+
+@AllArgsConstructor
+public class ShopPurger extends BukkitRunnable {
+    private QuickShop plugin;
+    private volatile boolean executing;
+
+    @Override
+    public void run() {
+        Util.ensureThread(true);
+        if (executing) {
+            plugin.getLogger().info("[Shop Purger] Another purge task still running!");
+            return;
+        }
+        executing = true;
+        if (!plugin.getConfig().getBoolean("purge.enabled")) return;
+        Util.debugLog("[Shop Purger] Scanning and removing shops");
+        int days = plugin.getConfig().getInt("purge.days", 360);
+        boolean deleteBanned = plugin.getConfig().getBoolean("purge.banned");
+        boolean skipOp = plugin.getConfig().getBoolean("purge.skip-op");
+        boolean returnCreationFee = plugin.getConfig().getBoolean("purge.return-create-fee");
+        for (Shop shop : plugin.getShopManager().getAllShops()) {
+            OfflinePlayer player = Bukkit.getOfflinePlayer(shop.getOwner());
+            if (!player.hasPlayedBefore()) {
+                Util.debugLog("Shop " + shop + " detection skipped: Owner never played before.");
+                continue;
+            }
+            long lastPlayed = player.getLastPlayed();
+            if (lastPlayed == 0) {
+                continue;
+            }
+            if (player.isOnline()) {
+                continue;
+            }
+            if (player.isOp() && skipOp) {
+                continue;
+            }
+            boolean markDeletion = player.isBanned() && deleteBanned;
+            //noinspection ConstantConditions
+            long noOfDaysBetween = ChronoUnit.DAYS.between(Util.getDateTimeFromTimestamp(lastPlayed), Util.getDateTimeFromTimestamp(System.currentTimeMillis()));
+            if (noOfDaysBetween > days)
+                markDeletion = true;
+            if (!markDeletion)
+                continue;
+            plugin.getLogger().info("[Shop Purger] Shop " + shop + " has been purged.");
+            shop.delete(false);
+            if (returnCreationFee) {
+                EconomyTransaction transaction =
+                        EconomyTransaction.builder()
+                                .amount(plugin.getConfig().getDouble("shop.cost"))
+                                .allowLoan(false)
+                                .core(QuickShop.getInstance().getEconomy())
+                                .currency(shop.getCurrency())
+                                .world(shop.getLocation().getWorld())
+                                .to(shop.getOwner())
+                                .build();
+                transaction.failSafeCommit();
+            }
+            executing = false;
+            plugin.getLogger().info("[Shop Purger] Task completed");
+        }
+
+    }
+}

src/main/java/org/maxgamer/quickshop/util/Util.java

@@ -65,6 +65,9 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.text.DecimalFormat;
+import java.time.Instant;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
 import java.util.AbstractMap.SimpleEntry;
 import java.util.*;
 import java.util.Map.Entry;
@@ -1385,6 +1388,18 @@ public static void mainThreadRun(@NotNull Runnable runnable) {
             Bukkit.getScheduler().runTask(QuickShop.getInstance(), runnable);
         }
     }
+    // http://www.java2s.com/Tutorials/Java/Data_Type_How_to/Date_Convert/Convert_long_type_timestamp_to_LocalDate_and_LocalDateTime.htm
+    public static LocalDateTime getDateTimeFromTimestamp(long timestamp) {
+        if (timestamp == 0)
+            return null;
+        return LocalDateTime.ofInstant(Instant.ofEpochSecond(timestamp), TimeZone
+                .getDefault().toZoneId());
+    }
+    // http://www.java2s.com/Tutorials/Java/Data_Type_How_to/Date_Convert/Convert_long_type_timestamp_to_LocalDate_and_LocalDateTime.htm
+    public static LocalDate getDateFromTimestamp(long timestamp) {
+        LocalDateTime date = getDateTimeFromTimestamp(timestamp);
+        return date == null ? null : date.toLocalDate();
+    }
 
 
 }

src/main/resources/config.yml

@@ -768,6 +768,17 @@ protect:
 #
 custom-item-stacksize: [ ]
 
+# Shops purger
+# Will purge all shops that owner offline x days while use command or server startup
+purge:
+  enabled: false
+  days: 60
+  # At this moment, QuickShop only compatible with Vanilla banning system (e.g Essentials using)
+  banned: true
+  # At this moment, QuickShop only compatible with Vanilla OP system, LuckPerms may need add in future.
+  skip-op: true
+  return-create-fee: true
+
 debug:
   #Should we disable the debug logger?
   #This will save a lot of execution time but will make reporting bugs

src/main/resources/lang-original/messages.json

@@ -178,7 +178,8 @@
       "freeze": "&eDisable or Enable shop trading",
       "lock": "&eSwitch the shop's lock status",
       "taxaccount": "&eSet the tax account that shop using",
-      "toggledisplay": "&eToggle the shop display item status"
+      "toggledisplay": "&eToggle the shop display item status",
+      "purge": "&aStart the shop purge task in background"
     },
     "disabled": "&cThis command is disabled: &e{0}",
     "feature-not-enabled": "This feature is not enabled in the config file."
@@ -340,5 +341,6 @@
   "taxaccount-unset": "&aThis shop's tax account now following server global setting.",
   "taxaccount-invalid": "&cTarget account not invalid, please enter a valid player name or uuid(with dashes).",
   "display-turn-on": "&aSuccessfully turn on the shop display.",
-  "display-turn-off": "&aSuccessfully turn off the shop display."
+  "display-turn-off": "&aSuccessfully turn off the shop display.",
+  "shop-purged-start": "&aShop purge started, check the console for details."
 }

src/main/resources/plugin.yml

@@ -80,6 +80,10 @@ permissions:
       quickshop.other.currency: true
       quickshop.other.taxaccount: true
       quickshop.other.toggledisplay: true
+      quickshop.purge: true
+      quickshop.other.setowner: true
+
+
   quickshop.create.sell:
     description: Allows a player to sell from a shop.
     default: op
@@ -224,3 +228,6 @@ permissions:
   quickshop.other.toggledisplay:
     description: Permission to use /qs toggledisplay on others shops
     default: op
+  quickshop.purge:
+    description: Permission to use /qs purge
+    default: op