Add include-offlineplayer-for-command option

sandtechnology · sandtechnology · commit 03971d232dcf · 2023-01-15T22:12:46.000+08:00
diff --git a/src/main/java/org/maxgamer/quickshop/QuickShop.java b/src/main/java/org/maxgamer/quickshop/QuickShop.java
@@ -296,6 +296,8 @@ public class QuickShop extends JavaPlugin implements QuickShopAPI {
     @Getter
     private boolean allowStack;
     @Getter
+    private boolean includeOfflinePlayer;
+    @Getter
     private EnvironmentChecker environmentChecker;
     @Getter
     @Nullable
@@ -569,7 +571,7 @@ public boolean loadEcon() {
                                 if (Util.isUUID(taxAccount)) {
                                     tax = PlayerFinder.findOfflinePlayerByUUID(UUID.fromString(taxAccount));
                                 } else {
-                                    tax = PlayerFinder.findOfflinePlayerByUUID(PlayerFinder.findUUIDByName(Objects.requireNonNull(taxAccount), true));
+                                    tax = PlayerFinder.findOfflinePlayerByUUID(PlayerFinder.findUUIDByName(Objects.requireNonNull(taxAccount), true, true));
                                 }
                                 Economy_Vault vault = (Economy_Vault) economy;
                                 if (vault.isValid()) {
@@ -672,6 +674,7 @@ public void reloadConfiguration() {
         this.priceChangeRequiresFee = this.getConfig().getBoolean("shop.price-change-requires-fee");
         this.displayItemCheckTicks = this.getConfig().getInt("shop.display-items-check-ticks");
         this.allowStack = this.getConfig().getBoolean("shop.allow-stacks");
+        this.includeOfflinePlayer = this.getConfig().getBoolean("include-offlineplayer-for-command");
         this.currency = this.getConfig().getString("currency");
         this.loggingLocation = this.getConfig().getInt("logging.location");
         if (StringUtils.isEmpty(this.currency)) {
@@ -2220,6 +2223,10 @@ private void updateConfig(int selectedVersion) throws IOException {
             getConfig().set("database.mysql-connect-options", new ArrayList<>(Arrays.asList("autoReconnect=true", "useUnicode=true", "characterEncoding=utf8")));
             getConfig().set("config-version", ++selectedVersion);
         }
+        if (selectedVersion == 161) {
+            getConfig().set("include-offlineplayer-for-command", false);
+            getConfig().set("config-version", ++selectedVersion);
+        }
         if (getConfig().isSet("shop.shop")) {
             getConfig().set("shop.shop", null);
         }
diff --git a/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_RemoveAll.java b/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_RemoveAll.java
@@ -48,7 +48,7 @@ public void onCommand(@NotNull CommandSender sender, @NotNull String commandLabe
         if (cmdArg.length == 1) {
             //copy it first
             List<Shop> tempList = new ArrayList<>(plugin.getShopManager().getAllShops());
-            PlayerFinder.PlayerProfile shopOwner = PlayerFinder.findPlayerProfileByName(cmdArg[0], false);
+            PlayerFinder.PlayerProfile shopOwner = PlayerFinder.findPlayerProfileByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());
             if (shopOwner == null) {
                 plugin.text().of(sender, "unknown-player").send();
                 return;
diff --git a/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_SetOwner.java b/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_SetOwner.java
@@ -57,7 +57,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not
                 continue;
             }
 
-            final PlayerFinder.PlayerProfile newShopOwnerProfile = PlayerFinder.findPlayerProfileByName(cmdArg[0], false);
+            final PlayerFinder.PlayerProfile newShopOwnerProfile = PlayerFinder.findPlayerProfileByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());
             if (newShopOwnerProfile == null) {
                 plugin.text().of(sender, "unknown-player").send();
                 return;
diff --git a/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_Staff.java b/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_Staff.java
@@ -84,7 +84,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not
                             return;
                     }
                 case 2:
-                    final PlayerFinder.PlayerProfile profile = PlayerFinder.findPlayerProfileByName(cmdArg[1], false);
+                    final PlayerFinder.PlayerProfile profile = PlayerFinder.findPlayerProfileByName(cmdArg[1], false, plugin.isIncludeOfflinePlayer());
                     if (profile == null) {
                         plugin.text().of(sender, "unknown-player").send();
                         return;
diff --git a/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_TaxAccount.java b/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_TaxAccount.java
@@ -54,7 +54,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not
                 if (Util.isUUID(cmdArg[0])) {
                     shop.setTaxAccount(UUID.fromString(cmdArg[0]));
                 } else {
-                    UUID uuid = PlayerFinder.findUUIDByName(cmdArg[0], false);
+                    UUID uuid = PlayerFinder.findUUIDByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());
                     if (uuid == null) {
                         plugin.text().of(sender, "unknown-player").send();
                         return;
diff --git a/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_Transfer.java b/src/main/java/org/maxgamer/quickshop/command/subcommand/SubCommand_Transfer.java
@@ -44,7 +44,7 @@ public SubCommand_Transfer(QuickShop plugin) {
     @Override
     public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @NotNull String[] cmdArg) {
         if (cmdArg.length == 1) {
-            final PlayerFinder.PlayerProfile targetPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[0], false);
+            final PlayerFinder.PlayerProfile targetPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());
             if (targetPlayer == null) {
                 plugin.text().of(sender, "unknown-player").send();
                 return;
@@ -67,7 +67,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not
                 return;
             }
 
-            final PlayerFinder.PlayerProfile fromPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[0], false);
+            final PlayerFinder.PlayerProfile fromPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());
             if (fromPlayer == null) {
                 plugin.text().of(sender, "unknown-player").send();
                 return;
@@ -77,7 +77,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not
                 fromPlayerName = "null";
             }
             //FIXME: Update this when drop 1.15 supports
-            final PlayerFinder.PlayerProfile targetPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[1], false);
+            final PlayerFinder.PlayerProfile targetPlayer = PlayerFinder.findPlayerProfileByName(cmdArg[1], false, plugin.isIncludeOfflinePlayer());
             if (targetPlayer == null) {
                 plugin.text().of(sender, "unknown-player").send();
                 return;
diff --git a/src/main/java/org/maxgamer/quickshop/shop/ShopLoader.java b/src/main/java/org/maxgamer/quickshop/shop/ShopLoader.java
@@ -491,7 +491,7 @@ public class ShopDatabaseInfo {
                     shopModerator = SimpleShopModerator.deserialize(moderatorJson);
                 } catch (JsonSyntaxException ex) {
                     Util.debugLog("Updating old shop data... for " + moderatorJson);
-                    moderatorJson = PlayerFinder.findUUIDByName(moderatorJson, true).toString();
+                    moderatorJson = PlayerFinder.findUUIDByName(moderatorJson, true, true).toString();
                     shopModerator = new SimpleShopModerator(UUID.fromString(moderatorJson)); // New one
                     needUpdate.set(true);
                 }
diff --git a/src/main/java/org/maxgamer/quickshop/shop/SimpleShopManager.java b/src/main/java/org/maxgamer/quickshop/shop/SimpleShopManager.java
@@ -142,7 +142,7 @@ private void init() {
             if (Util.isUUID(taxAccount)) {
                 this.cacheTaxAccount = new Trader(taxAccount, PlayerFinder.findOfflinePlayerByUUID(UUID.fromString(taxAccount)));
             } else {
-                this.cacheTaxAccount = PlayerFinder.findPlayerProfileByName(taxAccount, true).getTrader();
+                this.cacheTaxAccount = PlayerFinder.findPlayerProfileByName(taxAccount, true, true).getTrader();
             }
         } else {
             // disable tax account
@@ -157,7 +157,7 @@ private void init() {
             if (Util.isUUID(uAccount)) {
                 cacheUnlimitedShopAccount = new Trader(uAccount, PlayerFinder.findOfflinePlayerByUUID(UUID.fromString(uAccount)));
             } else {
-                cacheUnlimitedShopAccount = PlayerFinder.findPlayerProfileByName(uAccount, true).getTrader();
+                cacheUnlimitedShopAccount = PlayerFinder.findPlayerProfileByName(uAccount, true, true).getTrader();
             }
         }
         this.priceLimiter = new SimplePriceLimiter(
diff --git a/src/main/java/org/maxgamer/quickshop/util/MsgUtil.java b/src/main/java/org/maxgamer/quickshop/util/MsgUtil.java
@@ -365,7 +365,7 @@ public static void loadTransactionMessages() {
                 if (Util.isUUID(owner)) {
                     ownerUUID = UUID.fromString(owner);
                 } else {
-                    ownerUUID = PlayerFinder.findUUIDByName(owner, true);
+                    ownerUUID = PlayerFinder.findUUIDByName(owner, true, true);
                 }
                 String message = rs.getString("message");
                 List<ShopTransactionMessageContainer> msgs = OUTGOING_MESSAGES.computeIfAbsent(ownerUUID, k -> new LinkedList<>());
diff --git a/src/main/java/org/maxgamer/quickshop/util/PlayerFinder.java b/src/main/java/org/maxgamer/quickshop/util/PlayerFinder.java
@@ -136,8 +136,8 @@ public static void doLargeOfflineCachingWork(QuickShop quickShop, OfflinePlayer[
      * @param forceWebRequest whether to use web request, may result blocking server thread
      * @return the uuid of this player name, null when [forceWebRequest] is false
      */
-    public static PlayerProfile findPlayerProfileByName(String name, boolean forceWebRequest) {
-        UUID uuid = findUUIDByName(name, forceWebRequest);
+    public static PlayerProfile findPlayerProfileByName(String name, boolean forceWebRequest, boolean checkOfflinePlayer) {
+        UUID uuid = findUUIDByName(name, forceWebRequest, checkOfflinePlayer);
         if (uuid != null) {
             return new PlayerProfile(findNameByUUID(uuid), uuid);
         } else {
@@ -159,10 +159,11 @@ private static void puttingToCache(String realPlayerName, UUID uuid) {
      *
      * @param name                    the player name, case ignored
      * @param includingBlockingWebReq whether to use web request, may result blocking server thread
+     * @param checkOfflinePlayer      whether to check offline player, beware that should be a large cost for some times
      * @return the uuid of this player name, null when [includingBlockingWebReq] is false
      */
     @Nullable
-    public static UUID findUUIDByName(String name, boolean includingBlockingWebReq) {
+    public static UUID findUUIDByName(String name, boolean includingBlockingWebReq, boolean checkOfflinePlayer) {
 
         UUID uuid = name2UUIDCache.getIfPresent(name.toLowerCase(Locale.ROOT));
 
@@ -177,7 +178,7 @@ public static UUID findUUIDByName(String name, boolean includingBlockingWebReq)
             //Online
             PlayerProfile profile = findProfileByName(name, server.getOnlinePlayers(), false);
             //Offline
-            if (!useOfflineStash && profile == null) {
+            if (!useOfflineStash && checkOfflinePlayer && profile == null) {
                 profile = findProfileByName(name, Arrays.asList(server.getOfflinePlayers()), true);
             }
             //Blocking web request/querying user cache
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
@@ -1,7 +1,7 @@
 # QuickShop-Reremake Plugin Configuration
 
 #Do not touch this if you don't know what you're doing!
-config-version: 162
+config-version: 163
 
 #Set the default language code the plugin should use, it will apply to:
 #Item Name
@@ -96,6 +96,12 @@ updater: true
 #It will also create a paste for data-recovery or debug when the server boots up.
 auto-report-errors: true
 
+#Should QS including offline player for the command which needed the specified player?
+#This might improve player experience, but can cause lag for large amount of offline player
+#false = Only include OnlinePlayer
+#true = Include all players that have ever joined your server.
+include-offlineplayer-for-command: false
+
 #Should QS use OfflinePlayer list for TabComplete?
 #This might improve player experience, but may cause lag due to searching what can be a long list.
 #false = Only use the OnlinePlayer list.
diff --git a/src/main/resources/lang/messages.json b/src/main/resources/lang/messages.json
@@ -5,7 +5,7 @@
   "translation-version": "Support Version: Reremake",
   "translation-contributors": "Contributors: Timtower, Netherfoam, KaiNoMood, Mgazul, JackTheChicken and Andre_601",
   "translation-country": "Language Zone: English (en_US)",
-  "language-version": "65",
+  "language-version": "66",
   "not-looking-at-valid-shop-block": "&cCould not find a block for creating shop. You need to look at one.",
   "not-looking-at-shop": "&cCould not find a QuickShop. You need to look at one.",
   "no-anythings-in-your-hand": "&cThere is nothing in your hand.",
@@ -79,7 +79,7 @@
   "warn-to-paste": "&eCollecting data and uploading it to Pastebin, this may take a while. &c&lWarning:&c The data is kept public for one week! It may leak your server configuration and other sensitive information. Make sure you only send it to &ltrusted staff/developers.",
   "price-too-high": "&cThe shop price is too high! You cannot create one with a price higher than {0}.",
   "you-cant-create-shop-in-there": "&cYou don't have permission to create a shop at this location.",
-  "unknown-player": "&cTarget player doesn't exist, please check the username you typed.",
+  "unknown-player": "&cTarget player doesn't existed or not online, please check the username you typed.",
   "shop-staff-cleared": "&aSuccessfully removed all staff members from your shop.",
   "shop-staff-added": "&aSuccessfully added {0} as a staff member for your shop.",
   "shop-staff-deleted": "&aSuccessfully removed {0} as a staff member for your shop.",

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not`
`57`	`57`	`continue;`
`58`	`58`	`}`
`59`	`59`
`60`		`- final PlayerFinder.PlayerProfile newShopOwnerProfile = PlayerFinder.findPlayerProfileByName(cmdArg[0], false);`
	`60`	`+ final PlayerFinder.PlayerProfile newShopOwnerProfile = PlayerFinder.findPlayerProfileByName(cmdArg[0], false, plugin.isIncludeOfflinePlayer());`
`61`	`61`	`if (newShopOwnerProfile == null) {`
`62`	`62`	`plugin.text().of(sender, "unknown-player").send();`
`63`	`63`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public void onCommand(@NotNull Player sender, @NotNull String commandLabel, @Not`
`84`	`84`	`return;`
`85`	`85`	`}`
`86`	`86`	`case 2:`
`87`		`- final PlayerFinder.PlayerProfile profile = PlayerFinder.findPlayerProfileByName(cmdArg[1], false);`
	`87`	`+ final PlayerFinder.PlayerProfile profile = PlayerFinder.findPlayerProfileByName(cmdArg[1], false, plugin.isIncludeOfflinePlayer());`
`88`	`88`	`if (profile == null) {`
`89`	`89`	`plugin.text().of(sender, "unknown-player").send();`
`90`	`90`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -491,7 +491,7 @@ public class ShopDatabaseInfo {`
`491`	`491`	`shopModerator = SimpleShopModerator.deserialize(moderatorJson);`
`492`	`492`	`} catch (JsonSyntaxException ex) {`
`493`	`493`	`Util.debugLog("Updating old shop data... for " + moderatorJson);`
`494`		`- moderatorJson = PlayerFinder.findUUIDByName(moderatorJson, true).toString();`
	`494`	`+ moderatorJson = PlayerFinder.findUUIDByName(moderatorJson, true, true).toString();`
`495`	`495`	`shopModerator = new SimpleShopModerator(UUID.fromString(moderatorJson)); // New one`
`496`	`496`	`needUpdate.set(true);`
`497`	`497`	`}`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ private void init() {`
`142`	`142`	`if (Util.isUUID(taxAccount)) {`
`143`	`143`	`this.cacheTaxAccount = new Trader(taxAccount, PlayerFinder.findOfflinePlayerByUUID(UUID.fromString(taxAccount)));`
`144`	`144`	`} else {`
`145`		`- this.cacheTaxAccount = PlayerFinder.findPlayerProfileByName(taxAccount, true).getTrader();`
	`145`	`+ this.cacheTaxAccount = PlayerFinder.findPlayerProfileByName(taxAccount, true, true).getTrader();`
`146`	`146`	`}`
`147`	`147`	`} else {`
`148`	`148`	`// disable tax account`
`@@ -157,7 +157,7 @@ private void init() {`
`157`	`157`	`if (Util.isUUID(uAccount)) {`
`158`	`158`	`cacheUnlimitedShopAccount = new Trader(uAccount, PlayerFinder.findOfflinePlayerByUUID(UUID.fromString(uAccount)));`
`159`	`159`	`} else {`
`160`		`- cacheUnlimitedShopAccount = PlayerFinder.findPlayerProfileByName(uAccount, true).getTrader();`
	`160`	`+ cacheUnlimitedShopAccount = PlayerFinder.findPlayerProfileByName(uAccount, true, true).getTrader();`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`	`this.priceLimiter = new SimplePriceLimiter(`
Original file line number	Diff line number	Diff line change
`@@ -365,7 +365,7 @@ public static void loadTransactionMessages() {`
`365`	`365`	`if (Util.isUUID(owner)) {`
`366`	`366`	`ownerUUID = UUID.fromString(owner);`
`367`	`367`	`} else {`
`368`		`- ownerUUID = PlayerFinder.findUUIDByName(owner, true);`
	`368`	`+ ownerUUID = PlayerFinder.findUUIDByName(owner, true, true);`
`369`	`369`	`}`
`370`	`370`	`String message = rs.getString("message");`
`371`	`371`	`List<ShopTransactionMessageContainer> msgs = OUTGOING_MESSAGES.computeIfAbsent(ownerUUID, k -> new LinkedList<>());`