Add a sign error logger

AreaShop/pom.xml

@@ -25,11 +25,11 @@
     </repositories>
 
     <dependencies>
-        <!-- Bukkit, AreaShop aims to support 1.13.2+ -->
+        <!-- Bukkit, AreaShop aims to support 1.16.5+ -->
         <dependency>
             <groupId>org.spigotmc</groupId>
             <artifactId>spigot-api</artifactId>
-            <version>1.13.2-R0.1-SNAPSHOT</version>
+            <version>1.16.5-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
 

AreaShop/src/main/java/me/wiefferink/areashop/AreaShop.java

@@ -29,9 +29,11 @@ import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.RegisteredServiceProvider;
 import org.bukkit.plugin.java.JavaPlugin;
 
+import java.io.File;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -49,6 +51,7 @@ public final class AreaShop extends JavaPlugin implements AreaShopInterface {
     public static final String groupsFile = "groups.yml";
     public static final String defaultFile = "default.yml";
     public static final String configFile = "config.yml";
+    public static final String signLogFile = "signErrors.yml";
     public static final String configFileHidden = "hiddenConfig.yml";
     public static final String versionFile = "versions";
     // Euro tag for in the config
@@ -129,6 +132,7 @@ public final class AreaShop extends JavaPlugin implements AreaShopInterface {
     private List<String> chatprefix = null;
     private boolean ready = false;
     private GithubUpdateCheck githubUpdateCheck = null;
+    private SignErrorLogger signErrorLogger;
 
     public static AreaShop getInstance() {
         return AreaShop.instance;
@@ -419,6 +423,12 @@ public final class AreaShop extends JavaPlugin implements AreaShopInterface {
      * Register all required tasks.
      */
     private void setupTasks() {
+        long signLogTicks = Utils.millisToTicks(TimeUnit.MINUTES.toMillis(5));
+        Bukkit.getScheduler().runTaskTimerAsynchronously(this,
+                                                        () -> signErrorLogger.saveIfDirty(),
+                                                        signLogTicks,
+                                                         signLogTicks
+        );
         // Rent expiration timer
         long expirationCheck =
                 Utils.millisToTicks(Utils.getDurationFromSecondsOrString("expiration.delay"));
@@ -578,7 +588,7 @@ public final class AreaShop extends JavaPlugin implements AreaShopInterface {
             error("Vault plugin is not present or has not loaded correctly");
             error = true;
         }
-
+        signErrorLogger = new SignErrorLogger(new File(signLogFile));
         // Load all data from files and check versions
         fileManager = new FileManager();
         managers.add(fileManager);
@@ -772,6 +782,10 @@ public final class AreaShop extends JavaPlugin implements AreaShopInterface {
         return worldEdit;
     }
 
+    public SignErrorLogger getSignErrorLogger() {
+        return signErrorLogger;
+    }
+
     /**
      * Reload all files of the plugin and update all regions.
      *

AreaShop/src/main/java/me/wiefferink/areashop/features/signs/RegionSign.java

@@ -1,18 +1,18 @@
 package me.wiefferink.areashop.features.signs;
 
 import com.google.common.base.Objects;
-import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import io.papermc.lib.PaperLib;
 import io.papermc.lib.features.blockstatesnapshot.BlockStateSnapshotResult;
 import me.wiefferink.areashop.AreaShop;
+import me.wiefferink.areashop.managers.SignErrorLogger;
 import me.wiefferink.areashop.regions.GeneralRegion;
 import me.wiefferink.areashop.tools.Materials;
 import me.wiefferink.areashop.tools.Utils;
-import me.wiefferink.areashop.tools.Value;
 import me.wiefferink.interactivemessenger.processing.Message;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.Material;
+import org.bukkit.Tag;
 import org.bukkit.block.Block;
 import org.bukkit.block.BlockFace;
 import org.bukkit.block.BlockState;
@@ -111,7 +111,7 @@ public class RegionSign {
     /**
      * Get the material of the sign as saved in the config.
      *
-     * @return Material of the sign, usually {@link Material#WALL_SIGN}, {@link Material#SIGN}, or one of the other wood types (different result for 1.13-), Material.AIR if none.
+     * @return Material of the sign, usually or one of the other wood types (different result for 1.13-), Material.AIR if none.
      */
     public Material getMaterial() {
         String name = getRegion().getConfig().getString("general.signs." + key + ".signType");
@@ -163,30 +163,31 @@ public class RegionSign {
             return true;
         }
 
-        final BlockStateSnapshotResult snapshot = PaperLib.getBlockState(block, true);
+        final BlockStateSnapshotResult snapshot = PaperLib.getBlockState(block, false);
         final BlockState blockState = snapshot.getState();
         final BlockData blockData = blockState.getBlockData();
-
+        final SignErrorLogger errorLogger = AreaShop.getInstance().getSignErrorLogger();
+        Material signType = getMaterial();
         // Place the sign back (with proper rotation and type) after it has been hidden or (indirectly) destroyed
-        if (!Materials.isSign(block.getType())) {
-            Material signType = getMaterial();
-            if (signType.name().contains("SIGN")) {
-                // Don't do physics here, we first need to update the direction
-                blockState.setType(signType);
-                if (blockData instanceof WallSign) {
-                    ((WallSign) blockData).setFacing(getFacing());
-                } else if (blockData instanceof Sign) {
-                    ((org.bukkit.block.data.type.Sign) blockData).setRotation(getFacing());
-                }
-                blockState.setBlockData(blockData);
-                // Check if the sign has popped
-                if (!Materials.isSign(block.getType())) {
-                    AreaShop.warn("Setting sign", key, "of region", region.getName(), "failed, could not set sign block back");
-                    return false;
-                }
-            } else {
-                AreaShop.warn("Setting sign", key, "of region", region.getName(), "failed, RegionSign material was: " + signType.name());
+        if (!Tag.SIGNS.isTagged(blockState.getType())) {
+            // Don't do physics here, we first need to update the direction
+            blockState.setType(signType);
+            if (blockData instanceof WallSign) {
+                ((WallSign) blockData).setFacing(getFacing());
+            } else if (blockData instanceof Sign) {
+                ((org.bukkit.block.data.type.Sign) blockData).setRotation(getFacing());
             }
+            blockState.setBlockData(blockData);
+            blockState.update(false, true);
+            // Check if the sign has popped
+            if (!Materials.isSign(block.getType())) {
+                final String message = String.format("Setting sign of $1%s of region $2%s failed, could not set sign block back", key, region.getName());
+                errorLogger.submitWarning(message);
+                return false;
+            }
+        } else {
+            final String message = "Setting sign $1%s of region $2%s failed, RegionSign material was: $3%s";
+            errorLogger.submitWarning(String.format(message, key, region.getName(), signType.name()));
         }
 
         // Save current rotation and type

AreaShop/src/main/java/me/wiefferink/areashop/features/signs/SignsFeature.java

@@ -7,6 +7,7 @@ import me.wiefferink.areashop.events.ask.AddingRegionEvent;
 import me.wiefferink.areashop.events.notify.UpdateRegionEvent;
 import me.wiefferink.areashop.features.RegionFeature;
 import me.wiefferink.areashop.managers.FileManager;
+import me.wiefferink.areashop.managers.SignErrorLogger;
 import me.wiefferink.areashop.regions.BuyRegion;
 import me.wiefferink.areashop.regions.GeneralRegion;
 import me.wiefferink.areashop.regions.RentRegion;
@@ -55,12 +56,14 @@ public class SignsFeature extends RegionFeature {
         signs = new HashMap<>();
         // Setup current signs
         ConfigurationSection signSection = region.getConfig().getConfigurationSection("general.signs");
+        SignErrorLogger errorLogger = AreaShop.getInstance().getSignErrorLogger();
         if (signSection != null) {
             for (String signKey : signSection.getKeys(false)) {
                 RegionSign sign = new RegionSign(this, signKey);
                 Location location = sign.getLocation();
                 if (location == null) {
-                    AreaShop.warn("Sign with key " + signKey + " of region " + region.getName() + " does not have a proper location");
+                    final String message = "Sign with key $1%s of region $2%s does not have a proper location";
+                    errorLogger.submitWarning(String.format(message, signKey,  region.getName()));
                     continue;
                 }
                 signs.put(sign.getStringLocation(), sign);

AreaShop/src/main/java/me/wiefferink/areashop/managers/SignErrorLogger.java

@@ -0,0 +1,79 @@
+package me.wiefferink.areashop.managers;
+
+import me.wiefferink.areashop.AreaShop;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.nio.charset.StandardCharsets;
+import java.sql.Date;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.time.Instant;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Objects;
+import java.util.StringJoiner;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public class SignErrorLogger {
+
+    public static final String PREFIX_WARN = "[Warning] [Sign Feature] ";
+    public static final DateFormat FORMAT = new SimpleDateFormat("MM/dd/yy HH:mm:ss");
+
+    private final List<String> cache = new LinkedList<>();
+    private final AtomicBoolean needsSaving = new AtomicBoolean(false);
+
+    private final File file;
+
+    public SignErrorLogger(File file) {
+        this.file = Objects.requireNonNull(file);
+    }
+
+    public void clearCache() {
+        synchronized (this.cache) {
+            this.cache.clear();
+        }
+    }
+
+    public SignErrorLogger submitWarning(String message) {
+        final String actual = FORMAT.format(Date.from(Instant.now())) + PREFIX_WARN + message;
+        synchronized (this.cache) {
+            this.cache.add(actual);
+        }
+        return this;
+    }
+
+    public void queueSave() {
+        this.needsSaving.set(true);
+    }
+
+    public void saveIfDirty() {
+        if (this.needsSaving.get()) {
+            save();
+        }
+    }
+
+    public synchronized void save() {
+        AreaShop.debugTask("[Sign Feature] Dumping sign errors to disk...");
+        final String[] copy;
+        synchronized (this.cache) {
+            copy = cache.toArray(new String[0]);
+        }
+        final StringJoiner joiner = new StringJoiner(System.lineSeparator());
+        for (String s : copy) {
+            joiner.add(s);
+        }
+        try (OutputStream os = new FileOutputStream(file);
+             OutputStreamWriter writer = new OutputStreamWriter(os, StandardCharsets.UTF_8)) {
+            writer.write(joiner.toString());
+        } catch (IOException ex) {
+            ex.printStackTrace();
+            AreaShop.error("Failed to update the sign error log!");
+        } finally {
+            AreaShop.debugTask("[Sign Feature] Error dump complete.");
+        }
+    }
+}