feat: add config option for if the DOC should lock the file channel

- related to #2222 - effectively just a workaround as most people would not need to worry about locking the clipboard file
IntellectualSites · Dec 17, 2023 · eaf0403 · eaf0403
1 parent 17abaeb
commit eaf0403
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 15 deletions.
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Settings.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Settings.java
@@ -721,6 +721,13 @@ public static class CLIPBOARD {
                 " - Requires clipboard.use-disk to be enabled"
         })
         public boolean SAVE_CLIPBOARD_NBT_TO_DISK = true;
+        @Comment({
+                "Apply a file lock on the clipboard file (only relevant if clipboad.on-disk is enabled)",
+                " - Prevents other processes using the file whilst in use by FAWE",
+                " - This extends to other servers, useful if you have multiple servers using a unified clipboard folder",
+                " - May run into issues where a file lock is not correctly lifted"
+        })
+        public boolean LOCK_CLIPBOARD_FILE = false;
 
     }
 

diff --git a/...re/src/main/java/com/fastasyncworldedit/core/extent/clipboard/DiskOptimizedClipboard.java b/...re/src/main/java/com/fastasyncworldedit/core/extent/clipboard/DiskOptimizedClipboard.java
@@ -305,22 +305,24 @@ public File getFile() {
     private void init() throws IOException {
         if (this.fileChannel == null) {
             this.fileChannel = braf.getChannel();
-            try {
-                FileLock lock = this.fileChannel.lock();
-                LOCK_HOLDER_CACHE.put(file.getName(), new LockHolder(lock));
-            } catch (OverlappingFileLockException e) {
-                LockHolder existing = LOCK_HOLDER_CACHE.get(file.getName());
-                if (existing != null) {
-                    long ms = System.currentTimeMillis() - existing.lockHeldSince;
-                    LOGGER.error(
-                            "Cannot lock clipboard file {} acquired by thread {}, {}ms ago",
-                            file.getName(),
-                            existing.thread,
-                            ms
-                    );
+            if (Settings.settings().CLIPBOARD.LOCK_CLIPBOARD_FILE) {
+                try {
+                    FileLock lock = this.fileChannel.lock();
+                    LOCK_HOLDER_CACHE.put(file.getName(), new LockHolder(lock));
+                } catch (OverlappingFileLockException e) {
+                    LockHolder existing = LOCK_HOLDER_CACHE.get(file.getName());
+                    if (existing != null) {
+                        long ms = System.currentTimeMillis() - existing.lockHeldSince;
+                        LOGGER.error(
+                                "Cannot lock clipboard file {} acquired by thread {}, {}ms ago",
+                                file.getName(),
+                                existing.thread,
+                                ms
+                        );
+                    }
+                    // Rethrow to prevent clipboard access
+                    throw e;
                 }
-                // Rethrow to prevent clipboard access
-                throw e;
             }
             this.byteBuffer = fileChannel.map(FileChannel.MapMode.READ_WRITE, 0, braf.length());
         }