Improvements related to thread-safety and some general cleanup

Also add duration a search took into the result message

Author: Phoenix616

README.md

@@ -1,6 +1,6 @@
 # <img src="assets/icon.png" height="32px" alt="Entity Detection Icon"/> EntityDetection
 
-EntityDetection is a Paper plugin with which you can quickly find chunks with a large amount of Monsters, Animals or even Tile Entities like Hoppers in it.
+EntityDetection is a Paper/Folia plugin with which you can quickly find chunks with a large amount of Monsters, Animals or even Tile Entities like Hoppers in it.
 
 Very useful if you want to find XP-Farms that accumulate a large amount of mobs or that one infinite chicken or villager breeder that brings your server to its knees!
 
@@ -17,7 +17,7 @@ Very useful if you want to find XP-Farms that accumulate a large amount of mobs
 
 ## Dependencies
 
-This plugin does not require any other plugin to run, but it requires [Paper](https://papermc.io/) to be used as the server software and can optionally integrate with [WorldGuard](https://worldguard.enginehub.org/) for region-based entity detection.
+This plugin does not require any other plugin to run, but it requires [Paper](https://papermc.io/downloads/paper) or [Folia](https://papermc.io/downloads/folia) to be used as the server software and can optionally integrate with [WorldGuard](https://worldguard.enginehub.org/) for region-based entity detection.
 
 ## Usage
 

pom.xml

@@ -7,14 +7,14 @@
     <groupId>de.themoep</groupId>
     <artifactId>entitydetection</artifactId>
     <version>1.3.1-SNAPSHOT</version>
-    <description>Paper plugin to find groups of mobs, animals or other (tile) entities.</description>
+    <description>Paper/Folia plugin to find groups of mobs, animals or other (tile) entities.</description>
     <name>EntityDetection</name>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <minecraft.plugin.version>${project.version} ${buildDescription}</minecraft.plugin.version>
-        <maven.compiler.source>1.8</maven.compiler.source>
-        <maven.compiler.target>1.8</maven.compiler.target>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
     </properties>
 
     <repositories>
@@ -103,7 +103,7 @@
     </profiles>
 
     <build>
-        <finalName>${project.name}-${project.version}</finalName>
+        <finalName>${project.name}</finalName>
         <resources>
             <resource>
                 <filtering>true</filtering>

src/main/java/de/themoep/entitydetection/EntityDetection.java

@@ -77,7 +77,7 @@ public Component getMessage(CommandSender sender, String key, String... replacem
     }
 
     public boolean startSearch(EntitySearch search) {
-        if(currentSearch != null && currentSearch.isRunning()) {
+        if (currentSearch != null && currentSearch.isRunning()) {
             return false;
         }
         currentSearch = search;
@@ -86,7 +86,7 @@ public boolean startSearch(EntitySearch search) {
     }
 
     public boolean stopSearch(String stopper) {
-        if(currentSearch == null || !currentSearch.isRunning()) {
+        if (currentSearch == null || !currentSearch.isRunning()) {
             return false;
         }
         currentSearch.stop(stopper);
@@ -95,7 +95,7 @@ public boolean stopSearch(String stopper) {
     }
 
     public void addResult(SearchResult<?> result) {
-        if(result.getType() == SearchType.CUSTOM && result.getSearched().size() == 1) {
+        if (result.getType() == SearchType.CUSTOM && result.getSearched().size() == 1) {
             Set<String> searchedEntities = result.getSearched();
             customResults.put(searchedEntities.toArray(new String[searchedEntities.size()])[0], result);
         } else {
@@ -128,7 +128,7 @@ public void send(CommandSender sender, SearchResult<?> result, int page) {
                     .append(getMessage(sender, "result.searched-types.entry", "type", Utils.enumToHumanName(typeIter.next())));
         }
 
-        Component message = getMessage(sender, "result.head", "type", Utils.enumToHumanName(result.getType()), "timestamp", dateStr);
+        Component message = getMessage(sender, "result.head", "type", Utils.enumToHumanName(result.getType()), "timestamp", dateStr, "duration", String.valueOf(result.getDuration()));
         message = Replacer.replaceIn(message, "searchedtypes", searchedTypes);
 
         List<? extends SearchResultEntry<?>> results = result.getSortedEntries();

src/main/java/de/themoep/entitydetection/searcher/ChunkSearchResult.java

@@ -1,6 +1,5 @@
 package de.themoep.entitydetection.searcher;
 
-import com.tcoded.folialib.impl.PlatformScheduler;
 import de.themoep.entitydetection.ChunkLocation;
 import de.themoep.entitydetection.Utils;
 import org.bukkit.Bukkit;
@@ -14,11 +13,8 @@
 
 public class ChunkSearchResult extends SearchResult<ChunkLocation> {
 
-    private final PlatformScheduler scheduler;
-
     public ChunkSearchResult(EntitySearch search) {
         super(search);
-        this.scheduler = search.getScheduler();
     }
 
     @Override
@@ -35,7 +31,7 @@ public void addBlockState(BlockState blockState) {
     public void add(Location location, String type) {
         ChunkLocation chunkLocation = new ChunkLocation(location);
 
-        if(!resultEntryMap.containsKey(chunkLocation)) {
+        if (!resultEntryMap.containsKey(chunkLocation)) {
             resultEntryMap.put(chunkLocation, new SearchResultEntry<>(chunkLocation));
         }
         resultEntryMap.get(chunkLocation).increment(type);
@@ -56,18 +52,18 @@ public void teleport(Player sender, SearchResultEntry<ChunkLocation> entry, int
             int anchorZ = (cz << 4) + 8;
             Location location = new Location(targetWorld, anchorX, 64, anchorZ);
 
-            targetWorld.getChunkAtAsync(cx, cz, true, chunk -> scheduler.runAtLocation(location, task -> {
+            scheduler.runAtLocation(location, task -> targetWorld.getChunkAtAsync(cx, cz, false, chunk -> {
                 Location loc = null;
 
-                for(Entity e : chunk.getEntities()) {
-                    if(e.getType().toString().equals(entry.getEntryCount().get(0).getKey())) {
+                for (Entity e : chunk.getEntities()) {
+                    if (e.getType().toString().equals(entry.getEntryCount().get(0).getKey())) {
                         loc = e.getLocation();
                         break;
                     }
                 }
 
                 for (BlockState b : chunk.getTileEntities()) {
-                    if(b.getType().toString().equals(entry.getEntryCount().get(0).getKey())) {
+                    if (b.getType().toString().equals(entry.getEntryCount().get(0).getKey())) {
                         loc = b.getLocation().add(0, 1, 0);
                         break;
                     }

src/main/java/de/themoep/entitydetection/searcher/EntitySearch.java

@@ -1,24 +1,27 @@
 package de.themoep.entitydetection.searcher;
 
+import com.google.common.collect.Multimap;
+import com.google.common.collect.MultimapBuilder;
 import com.tcoded.folialib.impl.PlatformScheduler;
 import com.tcoded.folialib.wrapper.task.WrappedTask;
 import de.themoep.entitydetection.EntityDetection;
 import net.md_5.bungee.api.ChatColor;
 import org.bukkit.Chunk;
+import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.World;
 import org.bukkit.block.BlockState;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.EntityType;
 
-import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.HashSet;
-import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Consumer;
 
 /**
  * Copyright 2016 Max Lee (https://github.com/Phoenix616/)
@@ -35,7 +38,7 @@
  * You should have received a copy of the Mozilla Public License v2.0
  * along with this program. If not, see <http://mozilla.org/MPL/2.0/>.
  */
-public class EntitySearch implements Runnable {
+public class EntitySearch implements Consumer<WrappedTask> {
     private final EntityDetection plugin;
     private final PlatformScheduler scheduler;
     private final CommandSender owner;
@@ -45,8 +48,8 @@ public class EntitySearch implements Runnable {
     private Set<Material> searchedMaterial = new HashSet<>();
     private long startTime;
     private boolean running = true;
-    private List<Entity> entities = new ArrayList<>();
-    private List<BlockState> blockStates = new ArrayList<>();
+    private Multimap<EntityType, Location> entities = MultimapBuilder.hashKeys().arrayListValues().build();
+    private Map<Material, Multimap<Class, Location>> blockStates = new HashMap<>();
 
     private boolean isWorldGuardRegion = false;
     private final AtomicInteger pending = new AtomicInteger(0);
@@ -117,6 +120,7 @@ public boolean isWorldGuardRegion() {
     public void setWorldGuardRegion(boolean value) {
         this.isWorldGuardRegion = value;
     }
+
     /**
      * Get the duration since this search started
      * @return The duration in seconds
@@ -125,18 +129,20 @@ public long getDuration() {
         return (System.currentTimeMillis() - getStartTime()) / 1000;
     }
 
-    public WrappedTask start() {
+    public void start() {
         int scheduled = 0;
         if (searchedEntities.size() > 0) {
             for (World world : plugin.getServer().getWorlds()) {
                 pending.incrementAndGet();
                 scheduled++;
                 scheduler.runAtLocation(world.getSpawnLocation(), task -> {
                     try {
-                        entities.addAll(world.getEntities());
+                        for (Entity entity : world.getEntities()) {
+                            entities.put(entity.getType(), entity.getLocation());
+                        }
                     } finally {
                         if (pending.decrementAndGet() == 0) {
-                            scheduler.runLaterAsync(this, 1L);
+                            scheduler.runAsync(this);
                         }
                     }
                 });
@@ -149,20 +155,26 @@ public WrappedTask start() {
                     scheduled++;
                     scheduler.runAtLocation(chunk.getBlock(0, 0, 0).getLocation(), task -> {
                         try {
-                            blockStates.addAll(Arrays.asList(chunk.getTileEntities()));
+                            for (BlockState state : chunk.getTileEntities()) {
+                                Multimap<Class, Location> multiMap = blockStates.get(state.getType());
+                                if (multiMap == null) {
+                                    multiMap = MultimapBuilder.hashKeys().arrayListValues().build();
+                                    blockStates.put(state.getType(), multiMap);
+                                }
+                                multiMap.put(state.getClass(), state.getLocation());
+                            }
                         } finally {
                             if (pending.decrementAndGet() == 0) {
-                                scheduler.runLaterAsync(this, 1L);
+                                scheduler.runAsync(this);
                             }
                         }
                     });
                 }
             }
         }
         if (scheduled == 0) {
-            return scheduler.runLaterAsync(this, 1L);
+            scheduler.runAsync(this);
         }
-        return null;
     }
 
     public boolean isRunning() {
@@ -176,28 +188,28 @@ public void stop(String name) {
         }
     }
 
-    public void run() {
+    public void accept(WrappedTask task) {
         startTime = System.currentTimeMillis();
         SearchResult<?> result;
-        if(isWorldGuardRegion) result = new WGSearchResult(this);
+        if (isWorldGuardRegion) result = new WGSearchResult(this);
         else result = new ChunkSearchResult(this);
 
-        for(Entity e : entities) {
-            if(!running) {
-                return;
+        entities.forEach((type, location) -> {
+            if (searchedEntities.contains(type)) {
+                result.add(location, type.toString());
             }
-            if(searchedEntities.contains(e.getType())) {
-                result.addEntity(e);
-            }
-        }
+        });
 
-        for (BlockState blockState : blockStates) {
-            if (!running) {
-                return;
-            }
-            if (searchedBlockStates.contains(BlockState.class) || searchedMaterial.contains(blockState.getType()) || searchedBlockStates.contains(blockState.getClass())) {
-                result.addBlockState(blockState);
-            }
+        blockStates.forEach((type, blockLocations) -> {
+            blockLocations.forEach((clazz, location) -> {
+                if (searchedBlockStates.contains(BlockState.class) || searchedMaterial.contains(type) || searchedBlockStates.contains(clazz)) {
+                    result.add(location, type.toString());
+                }
+            });
+        });
+
+        if (!running) {
+            return;
         }
 
         result.sort();

src/main/java/de/themoep/entitydetection/searcher/SearchResult.java

@@ -1,5 +1,6 @@
 package de.themoep.entitydetection.searcher;
 
+import com.tcoded.folialib.impl.PlatformScheduler;
 import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.block.BlockState;
@@ -31,6 +32,7 @@
  * along with this program. If not, see <http://mozilla.org/MPL/2.0/>.
  */
 public abstract class SearchResult<T> {
+    protected final PlatformScheduler scheduler;
     private SearchType type;
     private Set<String> searched;
     private long startTime;
@@ -47,6 +49,7 @@ public abstract class SearchResult<T> {
     protected List<SearchResultEntry<T>> resultEntryList = new ArrayList<>();
 
     public SearchResult(EntitySearch search) {
+        scheduler = search.getScheduler();
         type = search.getType();
         searched = new HashSet<>();
         for (EntityType e : search.getSearchedEntities()) {
@@ -87,6 +90,10 @@ public long getEndTime() {
         return endTime == 0 ? System.currentTimeMillis() : endTime;
     }
 
+    /**
+     * Get the time this search took to finish
+     * @return The duration in milliseconds
+     */
     public long getDuration() {
         return getEndTime() - getStartTime();
     }

src/main/java/de/themoep/entitydetection/searcher/SearchResultEntry.java

@@ -34,7 +34,7 @@ public class SearchResultEntry<T> implements Comparable<SearchResultEntry<T>> {
 
     public void increment(String type) {
         size++;
-        if(!entryCount.containsKey(type)) {
+        if (!entryCount.containsKey(type)) {
             entryCount.put(type, 1);
         } else {
             entryCount.put(type, entryCount.get(type) + 1);

src/main/java/de/themoep/entitydetection/searcher/WGSearchResult.java

@@ -6,7 +6,6 @@
 import com.sk89q.worldguard.protection.flags.Flags;
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import com.sk89q.worldguard.protection.regions.RegionQuery;
-import com.tcoded.folialib.impl.PlatformScheduler;
 import de.themoep.entitydetection.Utils;
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
@@ -20,11 +19,9 @@
 import java.util.Objects;
 
 public class WGSearchResult extends SearchResult<WGSearchResult.ProtectedRegionEntry> {
-    private final PlatformScheduler scheduler;
 
     public WGSearchResult(EntitySearch search) {
         super(search);
-        this.scheduler = search.getScheduler();
     }
 
     @Override
@@ -44,7 +41,7 @@ public void add(Location location, String type) {
 
         applicableRegions.forEach(region -> {
             ProtectedRegionEntry protectedRegionEntry = new ProtectedRegionEntry(location.getWorld(), region);
-            if(!resultEntryMap.containsKey(protectedRegionEntry)) {
+            if (!resultEntryMap.containsKey(protectedRegionEntry)) {
                 resultEntryMap.put(protectedRegionEntry, new SearchResultEntry<>(protectedRegionEntry));
             }
             resultEntryMap.get(protectedRegionEntry).increment(type);
@@ -56,18 +53,17 @@ public void teleport(Player sender, SearchResultEntry<WGSearchResult.ProtectedRe
         com.sk89q.worldedit.util.Location wgLocation = entry.getLocation().region.getFlag(Flags.TELE_LOC);
         try {
             World world = entry.getLocation().world.get();
-            if(world == null) {
+            if (world == null) {
                 sender.sendMessage(ChatColor.RED + "World " + ChatColor.WHITE + entry.getLocation().worldName + ChatColor.RED + " is not loaded anymore.");
                 return;
             }
             Location loc = wgLocation != null ? BukkitAdapter.adapt(wgLocation) : null;
-            if(loc == null) {
+            if (loc == null) {
                 loc = BukkitAdapter.adapt(world, entry.getLocation().region.getMinimumPoint().add(
                         entry.getLocation().region.getMaximumPoint().subtract(entry.getLocation().region.getMinimumPoint()).divide(2)));
             }
 
-            Location finalLoc = loc;
-            scheduler.teleportAsync(sender, finalLoc, PlayerTeleportEvent.TeleportCause.PLUGIN);
+            scheduler.teleportAsync(sender, loc, PlayerTeleportEvent.TeleportCause.PLUGIN);
 
             sender.sendMessage(
                     ChatColor.GREEN + "Teleported to entry " + ChatColor.WHITE + i + ": " +

src/main/resources/languages/lang.en.yml

@@ -12,7 +12,7 @@ help:
     none: "&red&No sub commands for command %command% found."
   usage: "Usage: &yellow&%usage%"
 result:
-  head: "[%type% search](green hover=%searchedtypes%) from %timestamp%:"
+  head: "[%type% search](green hover=%searchedtypes%) from %timestamp% (%duration%ms):"
   searched-types:
     head: "&yellow&Entity Types:"
     entry: " &dark_purple&%type%"