Drop commons-io dependency in favor of JDK equivalents (#7562)

* Replace commons-io FilenameUtils with JDK equivalents

Step 1 of removing the commons-io dependency. Adds private static
helpers in BatchExporter for getExtension/removeExtension semantics
(last-dot-in-final-segment), and uses java.io.File.getName() with a
null guard in SpellsKnownTab.

* Replace commons-io FileUtils.writeLines with Files.writeString

Step 2 of removing commons-io. The behavior is preserved: UTF-8
encoding, System.lineSeparator() between lines, and a trailing
separator after the last line — matching FileUtils.writeLines.

* Add unit tests for PCGIOHandler.write party-file format

Covers the structural contract of the party file: two lines, version
prefix, comma-separated character paths, trailing line separator,
UTF-8 encoding. Verified to pass against both the old FileUtils.writeLines
implementation and the new Files.writeString one.

* Refactor test method visibility in PCGIOHandlerWriteTest

Signed-off-by: Vest <Vest@users.noreply.github.com>

* Replace commons-io FileUtils.listFiles with Files.walk in DataTest

Step 3 of removing commons-io. Adds a small private helper that
mirrors FileUtils.listFiles(File, String[], boolean) semantics:
recursive, regular files only, case-sensitive extension match.

* Drop commons-io TeeOutputStream from BatchExporter PDF export

The original code wrapped a ByteArrayOutputStream in a TeeOutputStream so
the export simultaneously fed an in-memory buffer (consumed by FOP) and
an optional debug temp file. Since the bytes are fully materialised in
memory before FOP runs, the tee was unnecessary: write the temp file
sequentially after the export completes instead. This removes the last
commons-io dependency in this file and lets us delete the internal
TeeOutputStream helper.

* Report FOP errors from exportPartyToPDF

exportCharacterToPDF inspects task.getErrorMessages() after running FOP
and returns false (with a logged message) when FOP reports problems.
exportPartyToPDF was missing the same check, so a party PDF that FOP
failed to render would silently return true and leave the user thinking
the export succeeded. Mirror the character path: log and return false
when FOP produces a non-blank error message.

* Rewrite removeTemporaryFiles to use listFiles for what it is

The previous implementation called File.list(FilenameFilter) and used
the filter lambda for its side effect — deleting matching files inside
the predicate and always returning false so list() would return an
empty array the caller then ignored. That misuse hid three real
problems:

  - tf.delete() returned false silently; failures to delete were
    invisible.
  - The defensive try/catch around the filter caught exceptions a
    FilenameFilter is not allowed to throw — pure cargo cult.
  - File.list returns null when the directory does not exist; the
    accidental side-effect form happened to tolerate that, but only
    by coincidence.

Use listFiles to actually list the temp files matching the prefix,
guard against the null result, then iterate and delete with a logged
warning when delete fails. Drop the manual File.separator concatenation
in favour of SettingsHandler.getTempPath() (already a File).

* Use StandardCharsets.UTF_8 consistently in BatchExporter

exportCharacterToNonPDF already used StandardCharsets.UTF_8 but four
sibling methods (exportPartyToNonPDF, both exportParty overloads, and
the private exportCharacter overload) still passed the literal string
"UTF-8" to OutputStreamWriter. The two forms behave identically but
the string form forces callers to deal with UnsupportedEncodingException
and lets a typo go undetected until runtime. Switch all four sites to
the constant so the file is internally consistent and the encoding is
checked at compile time.

* Use Files.delete for diagnosable temp-file cleanup failures

removeTemporaryFiles previously used File.delete, which returns a bare
boolean on failure with no indication of why the OS refused the
operation — permission denied, file locked by another process,
filesystem read-only, path no longer present, etc. The log entry could
only say "Could not delete X", which is unactionable.

Switch to Files.delete(Path), which throws an IOException carrying the
underlying cause (NoSuchFileException, AccessDeniedException, or a
generic IOException with the platform message). Log the exception
along with the path so the operator has something to act on. Sonar
S4042 flags exactly this pattern.

* Use unnamed pattern for ignored ExportException in catch block

exportCharacterToNonPDF catches ExportException only to short-circuit
to a false return; the comment "Error will already be reported to the
log" makes the intent explicit. Naming the variable "e" suggested it
might be used and forced a reader to scan the catch body to confirm it
was not.

Use the unnamed pattern (_) introduced in JEP 456 / Java 21 to declare
the variable as deliberately unused. The compiler now enforces the
intent and the discard is visible at the declaration site. Sonar S7467
flags exactly this case.

* Convert Path to File directly in getXMLTemplate

The original code converted the Path to a URI and then constructed a
File from that URI. The intermediate URI step served no purpose: it
introduced URI parsing and a second File constructor invocation while
producing an equivalent File. Use Path.toFile() instead, which is the
direct API for this conversion.

* Guard generateOutputFilename against dotless filenames

generateOutputFilename built the output name as

    charname.substring(0, charname.lastIndexOf('.')) + '.' + extension

If charname has no dot, lastIndexOf returns -1 and substring(0, -1)
throws StringIndexOutOfBoundsException. Today this cannot happen in
practice because the only caller (exportCharacter / exportParty)
gates on PCGFile.isPCGenCharacterFile / isPCGenPartyFile, which
require .pcg or .pcp suffixes. But the guard is implicit and the
crash is a latent landmine if validation ever changes upstream.

Reuse removeFileExtension, which already handles the dotless case by
returning the input unchanged. Behaviour is identical for every name
that reaches this method today and safe for any name that might in
the future.

* Replace commons-io filters in ExportUtilities with JDK Predicate

getValidFiles built its template filter as a chain of commons-io
IOFileFilter wrappers: FileFilterUtils.asFileFilter(sheetFilter) +
prefixFileFilter + and() + filterList. The SheetFilter enum already
implements java.io.FilenameFilter, and the prefix check is a one-line
String.startsWith — there is nothing here that needs the IOFileFilter
abstraction.

Combine the two checks into a single Predicate<File> lambda and run
it through Stream.filter().sorted().collect(toList()) so the result
matches the prior FileFilterUtils.filterList + Collections.sort
semantics. This drops both commons-io.filefilter imports from the
file and removes one more user of the dependency we are stripping.

* Replace commons-io filters in PrintPreviewDialog with Files.walk

SheetLoader located printable templates with FileUtils.listFiles plus
a FileFilterUtils.and() chain of pdfFilter / suffixFilter /
sheetFilter and a TrueFileFilter for directory descent. To do this it
also implemented FilenameFilter purely so its accept() could be
wrapped via FileFilterUtils.asFileFilter(this) — the class was
serving as both worker and filter without need.

Replace the listing with Files.walk(...) filtered by Files::isRegularFile
and a single Predicate<File> that combines all three checks (parent
dir name == "pdf", name does not end with .fo, name starts with the
character template prefix). Drop the FilenameFilter implementation
and the @NotNull import that came with it; the directory walk is
recursive by default so no separate dir filter is needed.

Failure mode is now explicit: an IOException from Files.walk is
logged with the offending directory rather than swallowed inside
commons-io. Removes the only remaining commons-io.* usage in this
file.

* Drop commons-io as a direct dependency

With ExportUtilities, PrintPreviewDialog, BatchExporter and the rest
of code/src/java migrated off org.apache.commons.io there are no
remaining direct call sites — verified by grep across all source
sets and by compiling main, test, itest and slowtest with the
declarations removed.

Drop the implementation declaration from build.gradle, the
forceMerge entry under the jlink block, and the corresponding
requires org.apache.commons.io from module-info.java. Commons-io
may still be pulled transitively by FOP / batik on the runtime
classpath, but our own module no longer reads it.

* Refactor BatchExporter.removeTemporaryFiles to NIO and drop commons-io

Rewrite the cleanup loop using java.nio.file: Files.list returns a
Stream<Path>, so the temp-file scan, filter, and delete collapse into
a try-with-resources block with two small helpers
(isTemporaryExportFile, deleteQuietly). Behavioural improvements:

- An unreadable temp directory is now logged, not silently treated as
  empty (the legacy listFiles returned null for both "not a directory"
  and "I/O error").
- A missing temp directory is handled explicitly via Files.isDirectory
  before listing, instead of relying on listFiles' implicit null.
- Stream is closed deterministically by try-with-resources (matters on
  Windows file locking).

This was the last in-tree usage of commons-io, so drop the dependency
from build.gradle and the requires directive from module-info.java.

* Fix XTSE0710 xsl:use-attribute-sets for equipment.title across all game modes

Replace xsl:use-attribute-sets="equipment.title" with an equivalent
xsl:call-template name="attrib" call in fantasy_common.xsl (fantasy,
5e, starfinder, pathfinder_2, 4e, sagaborn) and killshot_common.xsl.
Saxon-HE rejects references to undeclared attribute sets at compile time
(XTSE0710); the attrib template is the correct runtime skinning mechanism.

Add XsltPdfTemplateCompilationTest to guard against future regressions:
compiles each fixed file directly under Saxon and fails on any
XTSE0710/XTSE0720 error, ignoring expected fragment-level errors.

* Fix URIFactoryTest failing on Windows (#7527)

* Create separate action

* get the tag you created earlier

* upload zip artifacts for all platforms

* upload zip artifacts for all platforms

* Fix URIFactoryTest failing on Windows

Use File.toURI() instead of manually constructing a URI string with
new URI("file:" + path). On Windows, System.getProperty("user.dir")
returns backslash-separated paths (e.g. D:\a\pcgen\pcgen) which are
illegal characters in a URI, causing URISyntaxException.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Signed-off-by: Vest <Vest@users.noreply.github.com>
Co-authored-by: Martijn Verburg <martijnverburg@gmail.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: 3 people

build.gradle

@@ -220,7 +220,6 @@ dependencies {
 
     implementation fileTree(dir: 'mods/lib', include: ['javafx.*.jar'])
 
-    implementation 'commons-io:commons-io:2.22.0'
     implementation 'org.springframework:spring-web:7.0.7'
     implementation 'org.springframework:spring-beans:7.0.7'
     implementation 'org.springframework:spring-core:7.0.7'
@@ -313,7 +312,7 @@ jlink {
     options = ['--strip-debug', '--no-header-files', '--no-man-pages']
     addExtraDependencies('javafx')
     forceMerge('jep', 'fop', 'Saxon-HE',
-               'commons-lang3', 'commons-io', 'spring',
+               'commons-lang3', 'spring',
                'freemarker', 'jdom2', 'argparse4j', 'xmlunit', 'controlsfx',
                'annotations', 'spotbugs', 'xmlresolver')
 

code/src/java/module-info.java

@@ -23,7 +23,6 @@
     requires pcgen.formula;
 
     requires org.apache.commons.lang3;
-    requires org.apache.commons.io;
     requires freemarker;
     requires org.jdom2;
     requires net.sourceforge.argparse4j;

code/src/java/pcgen/gui2/dialog/PrintPreviewDialog.java

@@ -34,13 +34,18 @@
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
 import java.io.File;
-import java.io.FilenameFilter;
+import java.io.IOException;
 import java.io.PipedInputStream;
 import java.io.PipedOutputStream;
 import java.net.URI;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.text.NumberFormat;
-import java.util.Collection;
+import java.util.List;
 import java.util.concurrent.ExecutionException;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import javax.swing.BorderFactory;
 import javax.swing.Box;
@@ -69,15 +74,9 @@
 import pcgen.util.Logging;
 import pcgen.util.fop.FopTask;
 
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.filefilter.FileFilterUtils;
-import org.apache.commons.io.filefilter.IOFileFilter;
-import org.apache.commons.io.filefilter.SuffixFileFilter;
-import org.apache.commons.io.filefilter.TrueFileFilter;
 import org.apache.fop.apps.FOUserAgent;
 import org.apache.fop.render.awt.AWTRenderer;
 import org.apache.fop.render.awt.viewer.PreviewPanel;
-import org.jetbrains.annotations.NotNull;
 
 /**
  * Dialog to allow the preview of character export.
@@ -421,28 +420,30 @@ private static ComboBoxModel<String> createPagesModel(int pages)
         return new DefaultComboBoxModel<>(pageNumbers);
     }
 
-    private class SheetLoader extends SwingWorker<Object[], Object> implements FilenameFilter
+    private class SheetLoader extends SwingWorker<Object[], Object>
     {
 
-        @Override
-        public boolean accept(@NotNull File dir, @NotNull String name)
-        {
-            return dir.getName().equalsIgnoreCase("pdf");
-        }
-
         @Override
         protected Object[] doInBackground()
         {
-            IOFileFilter pdfFilter = FileFilterUtils.asFileFilter(this);
-            IOFileFilter suffixFilter = FileFilterUtils.notFileFilter(new SuffixFileFilter(".fo"));
-            IOFileFilter sheetFilter = FileFilterUtils.prefixFileFilter(Constants.CHARACTER_TEMPLATE_PREFIX);
-            IOFileFilter fileFilter = FileFilterUtils.and(pdfFilter, suffixFilter, sheetFilter);
+            Predicate<File> filter = f -> f.getParentFile().getName().equalsIgnoreCase("pdf")
+                    && !f.getName().endsWith(".fo")
+                    && f.getName().startsWith(Constants.CHARACTER_TEMPLATE_PREFIX);
 
-            IOFileFilter dirFilter = TrueFileFilter.INSTANCE;
             File dir = new File(ConfigurationSettings.getOutputSheetsDir());
-            Collection<File> files = FileUtils.listFiles(dir, fileFilter, dirFilter);
-            URI osPath = new File(ConfigurationSettings.getOutputSheetsDir()).toURI();
-            return files.stream().map(v -> osPath.relativize(v.toURI())).toArray();
+            URI osPath = dir.toURI();
+            try (Stream<Path> walk = Files.walk(dir.toPath()))
+            {
+                List<File> files = walk.filter(Files::isRegularFile)
+                                       .map(Path::toFile)
+                                       .filter(filter)
+                                       .collect(Collectors.toList());
+                return files.stream().map(v -> osPath.relativize(v.toURI())).toArray();
+            } catch (IOException ex)
+            {
+                Logging.errorPrint("could not walk output sheets directory " + dir, ex);
+                return new Object[0];
+            }
         }
 
         @Override

code/src/java/pcgen/gui2/tabs/spells/SpellsKnownTab.java

@@ -31,7 +31,6 @@
 import javax.swing.JScrollPane;
 import javax.swing.JTextField;
 
-import org.apache.commons.io.FilenameUtils;
 import pcgen.core.PCClass;
 import pcgen.facade.core.CharacterFacade;
 import pcgen.facade.core.SpellFacade;
@@ -154,7 +153,8 @@ public SortableTableModel getModel()
 			hbox.add(spellSheetButton);
 			hbox.add(Box.createHorizontalStrut(3));
 
-			String text = FilenameUtils.getName(PCGenSettings.getSelectedSpellSheet());
+			String spellSheetPath = PCGenSettings.getSelectedSpellSheet();
+			String text = spellSheetPath == null ? null : new File(spellSheetPath).getName();
 			spellSheetField.setEditable(false);
 			spellSheetField.setText(text);
 			spellSheetField.setToolTipText(text);

code/src/java/pcgen/io/ExportUtilities.java

@@ -29,6 +29,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 import freemarker.template.Configuration;
@@ -43,8 +44,6 @@
 import freemarker.template.ObjectWrapper;
 import freemarker.template.Version;
 import javafx.stage.FileChooser;
-import org.apache.commons.io.filefilter.FileFilterUtils;
-import org.apache.commons.io.filefilter.IOFileFilter;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.SystemUtils;
 
@@ -140,10 +139,8 @@ public static File templateToAbsoluteTemplate(String sheetFilterPath, URI relati
 
 	public static URI[] getValidFiles(Collection<File> myAllTemplates, SheetFilter sheetFilter, boolean doPartyExport)
 	{
-		IOFileFilter prefixFilter;
 		String outputSheetsDir;
 		String outputSheetDirectory = SettingsHandler.getGameAsProperty().get().getOutputSheetDirectory();
-		IOFileFilter ioFilter = FileFilterUtils.asFileFilter(sheetFilter);
 		if (outputSheetDirectory == null)
 		{
 			outputSheetsDir = ConfigurationSettings.getOutputSheetsDir() + '/' + sheetFilter.getPath();
@@ -154,17 +151,14 @@ public static URI[] getValidFiles(Collection<File> myAllTemplates, SheetFilter s
 					+ sheetFilter.getPath();
 		}
 
-		if (doPartyExport)
-		{
-			prefixFilter = FileFilterUtils.prefixFileFilter(Constants.PARTY_TEMPLATE_PREFIX);
-		} else
-		{
-			prefixFilter = FileFilterUtils.prefixFileFilter(Constants.CHARACTER_TEMPLATE_PREFIX);
-		}
-		IOFileFilter filter = FileFilterUtils.and(prefixFilter, ioFilter);
+		String prefix = doPartyExport ? Constants.PARTY_TEMPLATE_PREFIX : Constants.CHARACTER_TEMPLATE_PREFIX;
+		Predicate<File> filter = f -> f.getName().startsWith(prefix)
+				&& sheetFilter.accept(f.getParentFile(), f.getName());
 
-		List<File> files = FileFilterUtils.filterList(filter, myAllTemplates);
-		Collections.sort(files);
+		List<File> files = myAllTemplates.stream()
+		                                 .filter(filter)
+		                                 .sorted()
+		                                 .collect(Collectors.toList());
 		URI osPath = new File(outputSheetsDir).toURI();
 		URI[] uriList = new URI[files.size()];
 		Arrays.setAll(uriList, i -> osPath.relativize(files.get(i).toURI()));

code/src/java/pcgen/io/PCGIOHandler.java

@@ -34,6 +34,7 @@
 import java.io.Writer;
 import java.math.BigDecimal;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -60,7 +61,6 @@
 import pcgen.util.FileHelper;
 import pcgen.util.Logging;
 
-import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.Nullable;
 
@@ -520,7 +520,8 @@ public static void write(File partyFile, List<File> characterFiles)
         String filesLine = StringUtils.join(files, ',');
         try
         {
-            FileUtils.writeLines(partyFile, "UTF-8", Arrays.asList(versionLine, filesLine));
+            String eol = System.lineSeparator();
+            Files.writeString(partyFile.toPath(), versionLine + eol + filesLine + eol, StandardCharsets.UTF_8);
         } catch (IOException ex)
         {
             Logging.errorPrint("Could not save the party file: " + partyFile.getAbsolutePath(), ex);