Make usage of stateful patterns thread-safe (#2633)

SirYwell · web-flow · commit 7b8c7894bae2 · 2024-03-27T15:16:06.000+01:00
* Make usage of No(Axis)Patterns thread-safe

* make more pattern usage thread-safe

* make more WE patterns thread safe

* remove StatefulPattern
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/ExpressionPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/ExpressionPattern.java
@@ -1,6 +1,7 @@
 package com.fastasyncworldedit.core.function.pattern;
 
 import com.sk89q.worldedit.function.pattern.AbstractPattern;
+import com.sk89q.worldedit.function.pattern.Pattern;
 import com.sk89q.worldedit.internal.expression.EvaluationException;
 import com.sk89q.worldedit.internal.expression.Expression;
 import com.sk89q.worldedit.internal.expression.ExpressionException;
@@ -57,4 +58,9 @@ public BaseBlock applyBlock(BlockVector3 vector) {
         }
     }
 
+    @Override
+    public Pattern fork() {
+        return new ExpressionPattern(this.expression.clone());
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/Linear2DBlockPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/Linear2DBlockPattern.java
@@ -7,6 +7,8 @@
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.world.block.BaseBlock;
 
+import java.util.Arrays;
+
 import static java.lang.Math.floorDiv;
 
 /**
@@ -52,4 +54,10 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return patternsArray[index].apply(extent, get, set);
     }
 
+    @Override
+    public Pattern fork() {
+        final Pattern[] forked = Arrays.stream(this.patternsArray).map(Pattern::fork).toArray(Pattern[]::new);
+        return new Linear2DBlockPattern(forked, this.xScale, this.zScale);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/Linear3DBlockPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/Linear3DBlockPattern.java
@@ -7,6 +7,8 @@
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.world.block.BaseBlock;
 
+import java.util.Arrays;
+
 import static java.lang.Math.floorDiv;
 
 /**
@@ -56,4 +58,10 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return patternsArray[index].apply(extent, get, set);
     }
 
+    @Override
+    public Pattern fork() {
+        final Pattern[] forked = Arrays.stream(this.patternsArray).map(Pattern::fork).toArray(Pattern[]::new);
+        return new Linear3DBlockPattern(forked, this.xScale, this.yScale, this.zScale);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/LinearBlockPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/LinearBlockPattern.java
@@ -47,4 +47,10 @@ public void reset() {
         index = 0;
     }
 
+    @Override
+    public Pattern fork() {
+        final Pattern[] forked = Arrays.stream(this.patternsArray).map(Pattern::fork).toArray(Pattern[]::new);
+        return new LinearBlockPattern(forked);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/MaskedPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/MaskedPattern.java
@@ -43,4 +43,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return secondary.apply(extent, get, set);
     }
 
+    @Override
+    public Pattern fork() {
+        return new MaskedPattern(this.mask.copy(), this.primary.fork(), this.secondary.fork());
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoXPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoXPattern.java
@@ -36,4 +36,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, mutable, set);
     }
 
+    @Override
+    public Pattern fork() {
+        return new NoXPattern(this.pattern.fork());
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoYPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoYPattern.java
@@ -36,4 +36,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, mutable, set);
     }
 
+    @Override
+    public Pattern fork() {
+        return new NoYPattern(this.pattern.fork());
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoZPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/NoZPattern.java
@@ -1,6 +1,7 @@
 package com.fastasyncworldedit.core.function.pattern;
 
 import com.fastasyncworldedit.core.math.MutableBlockVector3;
+import com.fastasyncworldedit.core.queue.Filter;
 import com.sk89q.worldedit.WorldEditException;
 import com.sk89q.worldedit.extent.Extent;
 import com.sk89q.worldedit.function.pattern.AbstractPattern;
@@ -36,4 +37,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, mutable, set);
     }
 
+    @Override
+    public Pattern fork() {
+        return new NoZPattern(this.pattern.fork());
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/OffsetPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/OffsetPattern.java
@@ -60,4 +60,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, get, mutable);
     }
 
+    @Override
+    public Pattern fork() {
+        return new OffsetPattern(this.pattern.fork(), this.dx, this.dy, this.dz, this.minY, this.maxY);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/RandomOffsetPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/RandomOffsetPattern.java
@@ -72,4 +72,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, get, mutable);
     }
 
+    @Override
+    public Pattern fork() {
+        return new RandomOffsetPattern(this.pattern.fork(), this.dx, this.dy, this.dz, this.minY, this.maxY);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/RelativePattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/RelativePattern.java
@@ -63,4 +63,11 @@ public void reset() {
         origin = null;
     }
 
+    @Override
+    public Pattern fork() {
+        RelativePattern forked = new RelativePattern(this.pattern.fork(), this.minY, this.maxY);
+        forked.origin = this.origin; // maintain origin for forks
+        return forked;
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/SolidRandomOffsetPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/SolidRandomOffsetPattern.java
@@ -94,4 +94,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W
         return pattern.apply(extent, get, set);
     }
 
+    @Override
+    public Pattern fork() {
+        return new SolidRandomOffsetPattern(this.pattern.fork(), this.dx, this.dy, this.dz, this.minY, this.maxY);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/SurfaceRandomOffsetPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/SurfaceRandomOffsetPattern.java
@@ -129,4 +129,9 @@ private boolean canPassthrough(BlockVector3 v) {
         return !block.getBlockType().getMaterial().isMovementBlocker();
     }
 
+    @Override
+    public Pattern fork() {
+        return new SurfaceRandomOffsetPattern(this.pattern.fork(), this.moves, this.minY, this.maxY);
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extent/buffer/ForgetfulExtentBuffer.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extent/buffer/ForgetfulExtentBuffer.java
@@ -235,4 +235,11 @@ public Iterable<BlockVector2> asFlatRegion() {
         };
     }
 
+    //FAWE - stateful pattern
+    @Override
+    public Pattern fork() {
+        return new ForgetfulExtentBuffer(extent, mask.copy());
+    }
+    //FAWE end
+
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/ExtentBufferedCompositePattern.java b/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/ExtentBufferedCompositePattern.java
@@ -25,6 +25,8 @@
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.world.block.BaseBlock;
 
+import java.util.Arrays;
+
 import static com.google.common.base.Preconditions.checkArgument;
 
 /**
@@ -64,4 +66,12 @@ public BaseBlock applyBlock(BlockVector3 position) {
         return lastBlock;
     }
 
+    //FAWE - stateful pattern
+    @Override
+    public Pattern fork() {
+        final Pattern[] forkedPatterns = Arrays.stream(patterns).map(Pattern::fork).toArray(Pattern[]::new);
+        return new ExtentBufferedCompositePattern(getExtent(), forkedPatterns);
+    }
+    //FAWE end
+
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/Pattern.java b/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/Pattern.java
@@ -59,6 +59,11 @@ default void applyBlock(final FilterBlock block) {
         apply(block, block, block);
     }
 
+    @Override
+    default Pattern fork() { // covariant return type
+        return this;
+    }
+
     //FAWE end
 
     /**
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/RandomPattern.java b/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/RandomPattern.java
@@ -67,6 +67,13 @@ public RandomPattern(SimpleRandom random, RandomPattern parent) {
         this.collection = RandomCollection.of(weights, random);
         this.patterns = parent.patterns;
     }
+
+    private RandomPattern(SimpleRandom random, Map<Pattern, Double> weights) {
+        this.random = random;
+        this.weights = weights;
+        this.collection = RandomCollection.of(weights, random);
+        this.patterns = new LinkedHashSet<>(weights.keySet());
+    }
     //FAWE end
 
     /**
@@ -107,6 +114,14 @@ public BaseBlock applyBlock(BlockVector3 position) {
     public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws WorldEditException {
         return collection.next(get.getBlockX(), get.getBlockY(), get.getBlockZ()).apply(extent, get, set);
     }
+
+    @Override
+    public Pattern fork() {
+        final LinkedHashMap<Pattern, Double> newWeights = new LinkedHashMap<>();
+        this.weights.forEach((p, w) -> newWeights.put(p.fork(), w));
+        return new RandomPattern(this.random, newWeights);
+    }
+
     //FAWE end
 
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/StateApplyingPattern.java b/worldedit-core/src/main/java/com/sk89q/worldedit/function/pattern/StateApplyingPattern.java
@@ -29,13 +29,16 @@
 
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.concurrent.ConcurrentHashMap;
 
 import static com.sk89q.worldedit.blocks.Blocks.resolveProperties;
 
 public class StateApplyingPattern extends AbstractExtentPattern {
 
     private final Map<String, String> states;
-    private final Map<BlockType, Map<Property<Object>, Object>> cache = Maps.newHashMap();
+    //FAWE - avoid race conditions
+    private final Map<BlockType, Map<Property<Object>, Object>> cache = new ConcurrentHashMap<>();
+    //FAWE end
 
     public StateApplyingPattern(Extent extent, Map<String, String> statesToSet) {
         super(extent);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package com.fastasyncworldedit.core.function.pattern;`
`2`	`2`
`3`	`3`	`import com.sk89q.worldedit.function.pattern.AbstractPattern;`
	`4`	`+import com.sk89q.worldedit.function.pattern.Pattern;`
`4`	`5`	`import com.sk89q.worldedit.internal.expression.EvaluationException;`
`5`	`6`	`import com.sk89q.worldedit.internal.expression.Expression;`
`6`	`7`	`import com.sk89q.worldedit.internal.expression.ExpressionException;`
`@@ -57,4 +58,9 @@ public BaseBlock applyBlock(BlockVector3 vector) {`
`57`	`58`	`}`
`58`	`59`	`}`
`59`	`60`
	`61`	`+ @Override`
	`62`	`+ public Pattern fork() {`
	`63`	`+ return new ExpressionPattern(this.expression.clone());`
	`64`	`+ }`
	`65`	`+`
`60`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,4 +47,10 @@ public void reset() {`
`47`	`47`	`index = 0;`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ @Override`
	`51`	`+ public Pattern fork() {`
	`52`	`+ final Pattern[] forked = Arrays.stream(this.patternsArray).map(Pattern::fork).toArray(Pattern[]::new);`
	`53`	`+ return new LinearBlockPattern(forked);`
	`54`	`+ }`
	`55`	`+`
`50`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W`
`43`	`43`	`return secondary.apply(extent, get, set);`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ @Override`
	`47`	`+ public Pattern fork() {`
	`48`	`+ return new MaskedPattern(this.mask.copy(), this.primary.fork(), this.secondary.fork());`
	`49`	`+ }`
	`50`	`+`
`46`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W`
`36`	`36`	`return pattern.apply(extent, mutable, set);`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ @Override`
	`40`	`+ public Pattern fork() {`
	`41`	`+ return new NoXPattern(this.pattern.fork());`
	`42`	`+ }`
	`43`	`+`
`39`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,4 +60,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W`
`60`	`60`	`return pattern.apply(extent, get, mutable);`
`61`	`61`	`}`
`62`	`62`
	`63`	`+ @Override`
	`64`	`+ public Pattern fork() {`
	`65`	`+ return new OffsetPattern(this.pattern.fork(), this.dx, this.dy, this.dz, this.minY, this.maxY);`
	`66`	`+ }`
	`67`	`+`
`63`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,4 +72,9 @@ public boolean apply(Extent extent, BlockVector3 get, BlockVector3 set) throws W`
`72`	`72`	`return pattern.apply(extent, get, mutable);`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ @Override`
	`76`	`+ public Pattern fork() {`
	`77`	`+ return new RandomOffsetPattern(this.pattern.fork(), this.dx, this.dy, this.dz, this.minY, this.maxY);`
	`78`	`+ }`
	`79`	`+`
`75`	`80`	`}`