FilePathUtils.joinZipPathSegments error on windows

core/src/main/java/de/jplag/reporting/FilePathUtil.java

@@ -8,7 +8,6 @@
 
 public final class FilePathUtil {
     private static final String ZIP_PATH_SEPARATOR = "/"; // Paths in zip files are always separated by a slash
-    private static final String WINDOWS_PATH_SEPARATOR = "\\";
 
     private FilePathUtil() {
         // private constructor to prevent instantiation
@@ -28,23 +27,26 @@ public static String getRelativeSubmissionPath(File file, Submission submission,
         return Path.of(submissionToIdFunction.apply(submission), submission.getRoot().toPath().relativize(file.toPath()).toString()).toString();
     }
 
-    /**
-     * Joins logical paths using a slash. This method ensures, that no duplicate slashes are created in between.
-     * @param left The left path segment
-     * @param right The right path segment
-     * @return The joined paths
-     */
-    public static String joinZipPathSegments(String left, String right) {
-        String rightStripped = right;
-        while (rightStripped.startsWith(ZIP_PATH_SEPARATOR) || rightStripped.startsWith(WINDOWS_PATH_SEPARATOR)) {
-            rightStripped = rightStripped.substring(1);
+    public static Path forceRelativePath(Path path) {
+        if (path.isAbsolute()) {
+            return Path.of("/").relativize(path);
         }
+        return path;
+    }
 
-        String leftStripped = left;
-        while (leftStripped.endsWith(ZIP_PATH_SEPARATOR) || leftStripped.startsWith(WINDOWS_PATH_SEPARATOR)) {
-            leftStripped = leftStripped.substring(0, leftStripped.length() - 1);
-        }
+    public static Path createRelativePath(String path) {
+        return forceRelativePath(Path.of(path));
+    }
 
-        return leftStripped + ZIP_PATH_SEPARATOR + rightStripped;
+    public static String pathAsZipPath(Path path) {
+        Path real = forceRelativePath(path);
+        StringBuilder builder = new StringBuilder();
+        for (int i = 0; i < real.getNameCount(); i++) {
+            if (i != 0) {
+                builder.append(ZIP_PATH_SEPARATOR);
+            }
+            builder.append(real.getName(i));
+        }
+        return builder.toString();
     }
 }

core/src/main/java/de/jplag/reporting/jsonfactory/ComparisonReportWriter.java

@@ -1,5 +1,6 @@
 package de.jplag.reporting.jsonfactory;
 
+import java.nio.file.Path;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Map;
@@ -58,7 +59,7 @@ private void writeComparisons(List<JPlagComparison> comparisons) {
             var comparisonReport = new ComparisonReport(firstSubmissionId, secondSubmissionId,
                     Map.of(SimilarityMetric.AVG.name(), comparison.similarity(), SimilarityMetric.MAX.name(), comparison.maximalSimilarity()),
                     convertMatchesToReportMatches(comparison), comparison.similarityOfFirst(), comparison.similarityOfSecond());
-            resultWriter.addJsonEntry(comparisonReport, fileName);
+            resultWriter.addJsonEntry(comparisonReport, Path.of(fileName));
         }
     }
 

core/src/main/java/de/jplag/reporting/reportobject/ReportObjectFactory.java

@@ -4,6 +4,7 @@
 
 import java.io.File;
 import java.io.FileNotFoundException;
+import java.nio.file.Path;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -41,17 +42,17 @@
 public class ReportObjectFactory {
     private static final Logger logger = LoggerFactory.getLogger(ReportObjectFactory.class);
 
-    public static final String OVERVIEW_FILE_NAME = "overview.json";
+    public static final Path OVERVIEW_FILE_NAME = Path.of("overview.json");
 
-    public static final String README_FILE_NAME = "README.txt";
-    public static final String OPTIONS_FILE_NAME = "options.json";
+    public static final Path README_FILE_NAME = Path.of("README.txt");
+    public static final Path OPTIONS_FILE_NAME = Path.of("options.json");
     private static final String[] README_CONTENT = new String[] {"This is a software plagiarism report generated by JPlag.",
             "To view the report go to https://jplag.github.io/JPlag/ and drag the generated zip file onto the page."};
 
-    public static final String SUBMISSION_FILE_INDEX_FILE_NAME = "submissionFileIndex.json";
+    public static final Path SUBMISSION_FILE_INDEX_FILE_NAME = Path.of("submissionFileIndex.json");
     public static final Version REPORT_VIEWER_VERSION = JPlag.JPLAG_VERSION;
 
-    private static final String SUBMISSIONS_ROOT_PATH = "files/";
+    private static final Path SUBMISSIONS_ROOT_PATH = Path.of("files");
 
     private Map<String, String> submissionNameToIdMap;
     private Function<Submission, String> submissionToIdFunction;
@@ -106,13 +107,13 @@ private void copySubmissionFilesToReport(JPlagResult result) {
         Set<Submission> submissions = getSubmissions(comparisons);
         Language language = result.getOptions().language();
         for (Submission submission : submissions) {
-            String submissionRootPath = SUBMISSIONS_ROOT_PATH + submissionToIdFunction.apply(submission);
+            Path submissionRootPath = SUBMISSIONS_ROOT_PATH.resolve(FilePathUtil.createRelativePath(submissionToIdFunction.apply(submission)));
             for (File file : submission.getFiles()) {
-                String relativeFilePath = file.getAbsolutePath().substring(submission.getRoot().getAbsolutePath().length());
-                if (relativeFilePath.isEmpty()) {
-                    relativeFilePath = file.getName();
+                Path relativeFilePath = Path.of(submission.getRoot().getAbsolutePath()).relativize(Path.of(file.getAbsolutePath()));
+                if (relativeFilePath.getNameCount() == 0 || relativeFilePath.equals(Path.of(""))) {
+                    relativeFilePath = Path.of(file.getName());
                 }
-                String zipPath = FilePathUtil.joinZipPathSegments(submissionRootPath, relativeFilePath);
+                Path zipPath = submissionRootPath.resolve(relativeFilePath);
 
                 File fileToCopy = getFileToCopy(language, file);
                 this.resultWriter.addFileContentEntry(zipPath, fileToCopy);

core/src/main/java/de/jplag/reporting/reportobject/writer/DummyResultWriter.java

@@ -1,6 +1,7 @@
 package de.jplag.reporting.reportobject.writer;
 
 import java.io.File;
+import java.nio.file.Path;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -16,17 +17,17 @@ public class DummyResultWriter implements JPlagResultWriter {
     private static final String MESSAGE_CLOSE = "DummyWriter closed.";
 
     @Override
-    public void addJsonEntry(Object jsonContent, String path) {
+    public void addJsonEntry(Object jsonContent, Path path) {
         logger.info(MESSAGE_JSON, jsonContent, path);
     }
 
     @Override
-    public void addFileContentEntry(String path, File original) {
+    public void addFileContentEntry(Path path, File original) {
         logger.info(MESSAGE_FILE, original.getAbsolutePath(), path);
     }
 
     @Override
-    public void writeStringEntry(String entry, String path) {
+    public void writeStringEntry(String entry, Path path) {
         logger.info(MESSAGE_STRING, entry, path);
     }
 

core/src/main/java/de/jplag/reporting/reportobject/writer/JPlagResultWriter.java

@@ -1,6 +1,7 @@
 package de.jplag.reporting.reportobject.writer;
 
 import java.io.File;
+import java.nio.file.Path;
 
 /**
  * Writer for JPlag result data. The way paths are resolved depends on the implementation
@@ -11,21 +12,21 @@ public interface JPlagResultWriter {
      * @param jsonContent The json content
      * @param path The path to write to
      */
-    void addJsonEntry(Object jsonContent, String path);
+    void addJsonEntry(Object jsonContent, Path path);
 
     /**
      * Writes data from a file
      * @param path The path to write to
      * @param original The original file
      */
-    void addFileContentEntry(String path, File original);
+    void addFileContentEntry(Path path, File original);
 
     /**
      * Writes data from a string
      * @param entry The string to write
      * @param path The path to write to
      */
-    void writeStringEntry(String entry, String path);
+    void writeStringEntry(String entry, Path path);
 
     /**
      * Closes the writer

core/src/main/java/de/jplag/reporting/reportobject/writer/ZipWriter.java

@@ -6,12 +6,15 @@
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import de.jplag.reporting.FilePathUtil;
+
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
@@ -39,9 +42,9 @@ public ZipWriter(File zipFile) throws FileNotFoundException {
     }
 
     @Override
-    public void addJsonEntry(Object jsonContent, String path) {
+    public void addJsonEntry(Object jsonContent, Path path) {
         try {
-            this.file.putNextEntry(new ZipEntry(path));
+            this.file.putNextEntry(new ZipEntry(FilePathUtil.pathAsZipPath(path)));
             this.file.write(objectMapper.writeValueAsBytes(jsonContent));
             this.file.closeEntry();
         } catch (IOException e) {
@@ -50,19 +53,19 @@ public void addJsonEntry(Object jsonContent, String path) {
     }
 
     @Override
-    public void addFileContentEntry(String path, File original) {
+    public void addFileContentEntry(Path path, File original) {
         try (FileInputStream inputStream = new FileInputStream(original)) {
-            this.file.putNextEntry(new ZipEntry(path));
+            this.file.putNextEntry(new ZipEntry(FilePathUtil.pathAsZipPath(path)));
             inputStream.transferTo(this.file);
         } catch (IOException e) {
             logger.error(String.format(COPY_FILE_ERROR, original.getAbsolutePath(), path), e);
         }
     }
 
     @Override
-    public void writeStringEntry(String entry, String path) {
+    public void writeStringEntry(String entry, Path path) {
         try {
-            this.file.putNextEntry(new ZipEntry(path));
+            this.file.putNextEntry(new ZipEntry(FilePathUtil.pathAsZipPath(path)));
             this.file.write(entry.getBytes(StandardCharsets.UTF_8));
         } catch (IOException e) {
             logger.error(String.format(WRITE_STRING_ERROR, path), e);