New shop info sign storage method

Author: Ghost-chu

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

@@ -63,9 +63,7 @@ public class ContainerShop implements Shop {
     @JsonUtil.Hidden
     @EqualsAndHashCode.Exclude
     private static final String SHOP_SIGN_PREFIX = "§d§o §r";
-    @EqualsAndHashCode.Exclude
-    @JsonUtil.Hidden
-    private static final String SHOP_SIGN_PATTERN = "§d§o ";
+
     @NotNull
     private final Location location;
     private final YamlConfiguration extra;
@@ -1117,7 +1115,6 @@ public void setShopType(@NotNull ShopType newShopType) {
             if (b == null) {
                 continue;
             }
-
             BlockState state = PaperLib.getBlockState(b, false).getState();
             if (!(state instanceof Sign)) {
                 continue;
@@ -1126,37 +1123,25 @@ public void setShopType(@NotNull ShopType newShopType) {
                 continue;
             }
             Sign sign = (Sign) state;
-            String[] lines = sign.getLines();
-            if (lines[0].isEmpty() && lines[1].isEmpty() && lines[2].isEmpty() && lines[3].isEmpty()) {
-                signs.add(sign); //NEW SIGN
+            if(!isShopSign(sign)){
                 continue;
             }
-
-            if (lines[1].startsWith(SHOP_SIGN_PATTERN)) {
-                signs.add(sign);
-            } else {
-                String header = lines[0];
-                String adminShopHeader = plugin.text().of("signs.header", plugin.text().of("admin-shop").forLocale()).forLocale();
-                String signHeaderUsername = plugin.text().of("signs.header", this.ownerName(true)).forLocale();
-                if (header.contains(adminShopHeader) || header.contains(signHeaderUsername)) {
-                    signs.add(sign);
-                    //TEXT SIGN
-                    //continue
-                } else {
-                    adminShopHeader = plugin.text().of("signs.header", plugin.text().of("admin-shop").forLocale(), "").forLocale();
-                    signHeaderUsername = plugin.text().of("signs.header", this.ownerName(true), "").forLocale();
-                    adminShopHeader = ChatColor.stripColor(adminShopHeader).trim();
-                    signHeaderUsername = ChatColor.stripColor(signHeaderUsername).trim();
-                    if (header.contains(adminShopHeader) || header.contains(signHeaderUsername)) {
-                        signs.add(sign);
-                    }
-                }
-            }
+            claimShopSign(sign);
+            signs.add(sign);
         }
 
         return signs;
     }
 
+    private ShopSignStorage saveToShopSignStorage(){
+       return new ShopSignStorage(getLocation().getWorld().getName(),getLocation().getBlockX(),getLocation().getBlockY(),getLocation().getBlockZ());
+    }
+
+    @Override
+    public void claimShopSign(@NotNull Sign sign){
+        sign.getPersistentDataContainer().set(SHOP_NAMESPACED_KEY,ShopSignPersistentDataType.INSTANCE,saveToShopSignStorage());
+    }
+
     /**
      * @return The list of players who can manage the shop.
      */
@@ -1562,6 +1547,6 @@ public void openPreview(@NotNull Player player) {
 
     @Override
     public ShopInfoStorage saveToInfoStorage() {
-        return new ShopInfoStorage(BlockPosition.of(getLocation()), ShopModerator.serialize(getModerator()), getPrice(), Util.serialize(getItem()), isUnlimited() ? 1 : 0, getShopType().toID(), saveExtraToYaml(), getCurrency(), isDisableDisplay(), getTaxAccount());
+        return new ShopInfoStorage(getLocation().getWorld().getName(),BlockPosition.of(getLocation()), ShopModerator.serialize(getModerator()), getPrice(), Util.serialize(getItem()), isUnlimited() ? 1 : 0, getShopType().toID(), saveExtraToYaml(), getCurrency(), isDisableDisplay(), getTaxAccount());
     }
 }

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

@@ -19,7 +19,9 @@
 
 package org.maxgamer.quickshop.shop;
 
+import org.bukkit.ChatColor;
 import org.bukkit.Location;
+import org.bukkit.NamespacedKey;
 import org.bukkit.block.Block;
 import org.bukkit.block.Sign;
 import org.bukkit.configuration.ConfigurationSection;
@@ -29,12 +31,16 @@
 import org.bukkit.plugin.Plugin;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.maxgamer.quickshop.QuickShop;
 import org.maxgamer.quickshop.util.ComponentPackge;
 
 import java.util.List;
+import java.util.Objects;
 import java.util.UUID;
 
 public interface Shop {
+    NamespacedKey SHOP_NAMESPACED_KEY = new NamespacedKey(QuickShop.getInstance(),"shopsign");
+    String SHOP_SIGN_PATTERN = "§d§o ";
     /**
      * Add x ItemStack to the shop inventory
      *
@@ -535,5 +541,63 @@ default List<ComponentPackge> getSignText(String locale) {
      */
     void setTaxAccount(@Nullable UUID taxAccount);
 
+    /**
+     * Claim a sign as shop sign (modern method)
+     * @param sign The shop sign
+     */
+    void claimShopSign(@NotNull Sign sign);
+
+    /**
+     * Checks if a Sign is a ShopSign
+     * @param sign Target sign
+     * @return Is shop info sign
+     */
+    default boolean isShopSign(@NotNull Sign sign){
+        return isShopSign(sign,null);
+    }
+
+    /**
+     * Checks if a Sign is a ShopSign and also check if a ShopSign is specific shop's ShopSign.
+     * @param sign Target sign
+     * @param shop Target shop (null if you don't want check sign owner)
+     *
+     * @return Is specific shop's ShopSign.
+     */
+    default boolean isShopSign(@NotNull Sign sign, @Nullable Shop shop){
+        // Check for new shop sign
+        String[] lines = sign.getLines();
+        if (lines[0].isEmpty() && lines[1].isEmpty() && lines[2].isEmpty() && lines[3].isEmpty()) {
+            return true;
+        }
+
+        // Check for exists shop sign (modern)
+        if(sign.getPersistentDataContainer().has(SHOP_NAMESPACED_KEY,ShopSignPersistentDataType.INSTANCE)){
+            if(shop != null){
+                ShopSignStorage shopSignStorage = sign.getPersistentDataContainer().get(SHOP_NAMESPACED_KEY,ShopSignPersistentDataType.INSTANCE);
+                return Objects.equals(shopSignStorage, new ShopSignStorage(getLocation().getWorld().getName(),getLocation().getBlockX(),getLocation().getBlockY(),getLocation().getBlockZ()));
+            }
+            return true;
+        }
+
+        // Check for exists shop sign (legacy upgrade)
+        if (lines[1].startsWith(SHOP_SIGN_PATTERN)) {
+            return true;
+        } else {
+            String header = lines[0];
+            String adminShopHeader = QuickShop.getInstance().text().of("signs.header",QuickShop.getInstance().text().of("admin-shop").forLocale()).forLocale();
+            String signHeaderUsername = QuickShop.getInstance().text().of("signs.header", this.ownerName(true)).forLocale();
+            if (header.contains(adminShopHeader) || header.contains(signHeaderUsername)) {
+                return true;
+                //TEXT SIGN
+                //continue
+            } else {
+                adminShopHeader =QuickShop.getInstance().text().of("signs.header", QuickShop.getInstance().text().of("admin-shop").forLocale(), "").forLocale();
+                signHeaderUsername = QuickShop.getInstance().text().of("signs.header", this.ownerName(true), "").forLocale();
+                adminShopHeader = ChatColor.stripColor(adminShopHeader).trim();
+                signHeaderUsername = ChatColor.stripColor(signHeaderUsername).trim();
+                return header.contains(adminShopHeader) || header.contains(signHeaderUsername);
+            }
+        }
+    }
 
 }

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

@@ -33,7 +33,8 @@
 @Data
 @Builder
 public class ShopInfoStorage {
-    private final BlockPosition location;
+    private final String world;
+    private final BlockPosition position;
     private final String moderator;
     private final double price;
     private final String item;

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

@@ -0,0 +1,54 @@
+/*
+ * This file is a part of project QuickShop, the name is DisplayItemPersistentDataType.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.shop;
+
+import org.bukkit.persistence.PersistentDataAdapterContext;
+import org.bukkit.persistence.PersistentDataType;
+import org.jetbrains.annotations.NotNull;
+import org.maxgamer.quickshop.util.JsonUtil;
+
+public class ShopSignPersistentDataType
+        implements PersistentDataType<String, ShopSignStorage> {
+    static final ShopSignPersistentDataType INSTANCE = new ShopSignPersistentDataType();
+
+    @Override
+    public @NotNull Class<String> getPrimitiveType() {
+        return String.class;
+    }
+
+    @Override
+    public @NotNull Class<ShopSignStorage> getComplexType() {
+        return ShopSignStorage.class;
+    }
+
+    @NotNull
+    @Override
+    public String toPrimitive(
+            @NotNull ShopSignStorage complex, @NotNull PersistentDataAdapterContext context) {
+            return JsonUtil.getGson().toJson(complex);
+    }
+
+    @Override
+    public @NotNull ShopSignStorage fromPrimitive(
+            @NotNull String primitive, @NotNull PersistentDataAdapterContext context) {
+            return JsonUtil.getGson().fromJson(primitive, ShopSignStorage.class);
+    }
+
+}

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

@@ -0,0 +1,37 @@
+/*
+ * This file is a part of project QuickShop, the name is ShopInfoStorage.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.shop;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * TODO This class used for storage the shop sign
+ */
+@AllArgsConstructor
+@Data
+@Builder
+public class ShopSignStorage {
+    private String world;
+    private int x;
+    private int y;
+    private int z;
+}