Merge pull request #5677 from kwvanderlinde/refactor/3777-dependency-breaking

Factor common utilities into a separate subproject

Author: kwvanderlinde

build.gradle

@@ -361,6 +361,7 @@ def zipJpackageImage = tasks.register('zipJpackageImage', Zip) {
 
 // In this section you declare the dependencies for your production and test code
 dependencies {
+    implementation project(':common')
     implementation project(':clientserver')
 
     implementation(libs.bundles.log4j)

common/build.gradle

@@ -0,0 +1,24 @@
+plugins {
+    id "base"
+    id "java-library"
+}
+
+apply from: rootProject.file('buildSrc/shared.gradle')
+
+// In this section you declare the dependencies for your production and test code
+dependencies {
+    implementation(libs.findbugs.jsr305)
+
+    implementation(libs.bundles.log4j)
+    implementation(libs.slf4j.simple)
+    implementation(libs.apache.commons.logging)
+
+    implementation(libs.gson)
+
+    implementation(libs.bundles.imageio)
+    implementation(libs.batik)
+
+    implementation(libs.apache.commons.io)
+
+    implementation(libs.jts.core)
+}

common/src/main/java/net/rptools/lib/AwtUtil.java

@@ -0,0 +1,51 @@
+/*
+ * This software Copyright by the RPTools.net development team, and
+ * licensed under the Affero GPL Version 3 or, at your option, any later
+ * version.
+ *
+ * MapTool Source Code 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.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License * along with this source Code.  If not, please visit
+ * <http://www.gnu.org/licenses/> and specifically the Affero license
+ * text at <http://www.gnu.org/licenses/agpl.html>.
+ */
+package net.rptools.lib;
+
+import java.awt.Dimension;
+
+public final class AwtUtil {
+  private AwtUtil() {
+    throw new RuntimeException("AwtUtil is a static class");
+  }
+
+  public static void constrainTo(Dimension dim, int size) {
+    boolean widthBigger = dim.width > dim.height;
+
+    if (widthBigger) {
+      dim.height = (int) ((dim.height / (double) dim.width) * size);
+      dim.width = size;
+    } else {
+      dim.width = (int) ((dim.width / (double) dim.height) * size);
+      dim.height = size;
+    }
+  }
+
+  public static void constrainTo(Dimension dim, int width, int height) {
+    boolean widthBigger = dim.width > dim.height;
+
+    constrainTo(dim, widthBigger ? width : height);
+
+    if ((widthBigger && dim.height > height) || (!widthBigger && dim.width > width)) {
+      int size =
+          (int)
+              Math.round(
+                  widthBigger
+                      ? (height / (double) dim.height) * width
+                      : (width / (double) dim.width) * dim.height);
+      constrainTo(dim, size);
+    }
+  }
+}

…/java/net/rptools/lib/BackupManager.java …/java/net/rptools/lib/BackupManager.javasrc/main/java/net/rptools/lib/BackupManager.java renamed to common/src/main/java/net/rptools/lib/BackupManager.java src/main/java/net/rptools/lib/BackupManager.java renamed to common/src/main/java/net/rptools/lib/BackupManager.java

@@ -19,6 +19,7 @@
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
+import org.apache.commons.io.FileUtils;
 
 public class BackupManager {
 
@@ -70,7 +71,7 @@ public void backup(File file) throws IOException {
     }
 
     // Save
-    FileUtil.copyFile(file, newFile);
+    FileUtils.copyFile(file, newFile, false);
   }
 
   /** List of existing backup files, with the oldest at the front */

…rptools/maptool/util/CollectionUtil.java …java/net/rptools/lib/CollectionUtil.javasrc/main/java/net/rptools/maptool/util/CollectionUtil.java renamed to common/src/main/java/net/rptools/lib/CollectionUtil.java src/main/java/net/rptools/maptool/util/CollectionUtil.java renamed to common/src/main/java/net/rptools/lib/CollectionUtil.java

@@ -12,7 +12,7 @@
  * <http://www.gnu.org/licenses/> and specifically the Affero license
  * text at <http://www.gnu.org/licenses/agpl.html>.
  */
-package net.rptools.maptool.util;
+package net.rptools.lib;
 
 import java.util.EnumMap;
 import java.util.function.Function;

…in/java/net/rptools/lib/DebugStream.java …in/java/net/rptools/lib/DebugStream.javasrc/main/java/net/rptools/lib/DebugStream.java renamed to common/src/main/java/net/rptools/lib/DebugStream.java src/main/java/net/rptools/lib/DebugStream.java renamed to common/src/main/java/net/rptools/lib/DebugStream.java

@@ -14,7 +14,6 @@
  */
 package net.rptools.lib;
 
-import com.thoughtworks.xstream.XStream;
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
 import java.io.BufferedReader;
@@ -41,10 +40,6 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 import java.util.zip.ZipInputStream;
-import net.rptools.maptool.client.ui.token.BarTokenOverlay;
-import net.rptools.maptool.model.AStarCellPointConverter;
-import net.rptools.maptool.model.ShapeType;
-import net.rptools.maptool.model.converters.WallTopologyConverter;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
 import org.apache.logging.log4j.LogManager;
@@ -79,11 +74,8 @@ public static byte[] getBytes(File file) throws IOException {
     return FileUtils.readFileToByteArray(file);
   }
 
-  public static Object objFromResource(String res) throws IOException {
-    XStream xs = getConfiguredXStream();
-    try (InputStream is = FileUtil.class.getClassLoader().getResourceAsStream(res)) {
-      return xs.fromXML(new InputStreamReader(is, StandardCharsets.UTF_8));
-    }
+  public static InputStream getResourceAsStream(String res) {
+    return FileUtil.class.getClassLoader().getResourceAsStream(res);
   }
 
   public static byte[] loadResource(String resource) throws IOException {
@@ -480,21 +472,4 @@ public static void delete(File file) {
   public static String stripInvalidCharacters(String fileName) {
     return fileName = fileName.replaceAll("[^\\w\\s.,-]", "_");
   }
-
-  /**
-   * Return an XStream which allows net.rptools.**, java.awt.**, sun.awt.** May be too permissive,
-   * but it Works For Me(tm)
-   *
-   * @return a configured XStream
-   */
-  public static XStream getConfiguredXStream() {
-    XStream xStream = new XStream();
-    XStream.setupDefaultSecurity(xStream);
-    xStream.allowTypesByWildcard(new String[] {"net.rptools.**", "java.awt.**", "sun.awt.**"});
-    xStream.registerConverter(new AStarCellPointConverter());
-    xStream.registerConverter(new WallTopologyConverter(xStream));
-    xStream.addImmutableType(ShapeType.class, true);
-    xStream.addImmutableType(BarTokenOverlay.Side.class, true);
-    return xStream;
-  }
 }