Updated SolutionParser to match with the new ZIP structure of moodle submissions ZIP. Light theme is now the default theme. Added submission time to Solution.

mikkomaran · mikkomaran · commit 92e04b7ccf02 · 2021-04-11T15:39:06.000+03:00
SimilarSolutionPair's first Solution is now always the one that was submitted first.
diff --git a/src/main/java/ee/ut/similaritydetector/backend/Analyser.java b/src/main/java/ee/ut/similaritydetector/backend/Analyser.java
@@ -157,7 +157,13 @@ private void compareSolutions(Exercise exercise) {
                 if (similarity > exercise.getSimilarityThreshold()) {
                     solution1.addSimilarSolution(solution2);
                     solution2.addSimilarSolution(solution1);
-                    similarSolutionPairs.add(new SimilarSolutionPair(similarity, solution1, solution2));
+                    SimilarSolutionPair newSolutionPair;
+                    if (solution1.getSubmissionTime().isBefore(solution2.getSubmissionTime())) {
+                        newSolutionPair = new SimilarSolutionPair(similarity, solution1, solution2);
+                    } else {
+                        newSolutionPair = new SimilarSolutionPair(similarity, solution2, solution1);
+                    }
+                    similarSolutionPairs.add(newSolutionPair);
                     System.out.println("\t" + String.format("%.1f%%", similarity * 100) + "\t" +
                             solution1.getAuthor() + ", " + solution2.getAuthor() );
                 }
diff --git a/src/main/java/ee/ut/similaritydetector/backend/Exercise.java b/src/main/java/ee/ut/similaritydetector/backend/Exercise.java
@@ -26,6 +26,10 @@ public List<Solution> getSolutions() {
         return solutions;
     }
 
+    public void replaceSolution(int index, Solution newSolution) {
+        solutions.set(index, newSolution);
+    }
+
     public void addSolution(Solution solution) {
         solutions.add(solution);
     }
diff --git a/src/main/java/ee/ut/similaritydetector/backend/Solution.java b/src/main/java/ee/ut/similaritydetector/backend/Solution.java
@@ -6,26 +6,26 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
+import java.time.LocalDateTime;
+import java.util.*;
 
 public class Solution {
 
     private final String author;
     private final String exerciseName;
     private final File sourceCodeFile;
     private final Set<Solution> similarSolutions;
+    private final LocalDateTime submissionTime;
     private File preprocessedCodeFile;
     private File sourceCodeHTMLLight;
     private File sourceCodeHTMLDark;
 
-    public Solution(String author, String exerciseName, File sourceCodeFile) {
+    public Solution(String author, String exerciseName, File sourceCodeFile, LocalDateTime submissionTime) {
         this.author = author;
         this.exerciseName = exerciseName;
         this.sourceCodeFile = sourceCodeFile;
         similarSolutions = new HashSet<>();
+        this.submissionTime = submissionTime;
     }
 
     public Set<Solution> getSimilarSolutions() {
@@ -64,6 +64,10 @@ public String getExerciseName() {
         return exerciseName;
     }
 
+    public LocalDateTime getSubmissionTime() {
+        return submissionTime;
+    }
+
     /**
      * Reads the source code file lines as a list of strings.
      *
@@ -143,5 +147,4 @@ public void generateSyntaxHighlightedHTML() {
         sourceCodeHTMLLight = new File(lightHTMLPath);
     }
 
-
 }
diff --git a/src/main/java/ee/ut/similaritydetector/backend/SolutionParser.java b/src/main/java/ee/ut/similaritydetector/backend/SolutionParser.java
@@ -8,9 +8,13 @@
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.InvalidPathException;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeFormatterBuilder;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
+import java.util.Optional;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.zip.ZipEntry;
@@ -20,15 +24,15 @@
 public class SolutionParser {
 
     public static final String outputDirectoryPath = "analyser_resources/";
-    private final File contentDirectory;
+    private final File solutionsDirectory;
     private final File outputDirectory;
     private final boolean preprocessSourceCode;
     private final boolean anonymousResults;
 
     private final Analyser analyser;
 
-    public SolutionParser(File contentDirectory, boolean preprocessSourceCode, boolean anonymousResults, Analyser analyser) {
-        this.contentDirectory = contentDirectory;
+    public SolutionParser(File solutionsDirectory, boolean preprocessSourceCode, boolean anonymousResults, Analyser analyser) {
+        this.solutionsDirectory = solutionsDirectory;
         this.outputDirectory = new File(outputDirectoryPath);
         System.out.println(outputDirectory.getAbsolutePath());
         this.preprocessSourceCode = preprocessSourceCode;
@@ -49,11 +53,11 @@ public List<Exercise> parseSolutions() {
 
         // Counts the total number of solutions for progress tracking
         try {
-            ZipFile zipFile = new ZipFile(contentDirectory);
+            ZipFile zipFile = new ZipFile(solutionsDirectory);
             Enumeration<? extends ZipEntry> zipEntries = zipFile.entries();
             while (zipEntries.hasMoreElements()) {
                 ZipEntry entry = zipEntries.nextElement();
-                if (!entry.isDirectory()) {
+                if (!entry.isDirectory() && entry.getName().endsWith(".py")) {
                     numSolutions++;
                 }
             }
@@ -62,41 +66,55 @@ public List<Exercise> parseSolutions() {
         }
         // File unzipping adapted from: https://www.baeldung.com/java-compress-and-uncompress [11.03.2021]
         byte[] buffer = new byte[1024];
-        try (ZipInputStream zis = new ZipInputStream(new FileInputStream(contentDirectory), StandardCharsets.UTF_8)) {
+        try (ZipInputStream zis = new ZipInputStream(new FileInputStream(solutionsDirectory), StandardCharsets.UTF_8)) {
             ZipEntry zipEntry = zis.getNextEntry();
             while (zipEntry != null) {
                 File newFile = newFile(outputDirectory, zipEntry);
                 if (zipEntry.isDirectory()) {
                     if (!newFile.isDirectory() && !newFile.mkdirs()) {
                         throw new IOException("Failed to create directory " + newFile);
                     }
-                } else {
-                    // fix for Windows-created archives
-                    File parent = newFile.getParentFile();
-                    if (!parent.isDirectory() && !parent.mkdirs()) {
-                        throw new IOException("Failed to create directory " + parent);
-                    }
-                    // write file content
-                    FileOutputStream fos = new FileOutputStream(newFile);
-                    int len;
-                    while ((len = zis.read(buffer)) > 0) {
-                        fos.write(buffer, 0, len);
-                    }
-                    fos.close();
-                    // parse the solution from unzipped file
-                    try {
-                        Solution solution = parseSolution(newFile);
-                        Exercise exercise = exercises.stream().filter(e -> e.getName().equals(solution.getExerciseName())).findAny().orElse(null);
-                        if (exercise != null) {
-                            exercise.addSolution(solution);
-                        } else {
-                            exercises.add(new Exercise(solution.getExerciseName(), solution));
+                }
+                // If entry is a file
+                else {
+                    if (zipEntry.getName().endsWith(".py")) {
+                        // fix for Windows-created archives
+                        File parent = newFile.getParentFile();
+                        if (!parent.isDirectory() && !parent.mkdirs()) {
+                            throw new IOException("Failed to create directory " + parent);
+                        }
+                        // write file content
+                        FileOutputStream fos = new FileOutputStream(newFile);
+                        int len;
+                        while ((len = zis.read(buffer)) > 0) {
+                            fos.write(buffer, 0, len);
+                        }
+                        fos.close();
+                        // parse the solution from unzipped file
+                        try {
+                            Solution newSolution = parseSolution(newFile);
+                            Exercise exercise = exercises.stream().filter(e -> e.getName().equals(newSolution.getExerciseName())).findAny().orElse(null);
+                            if (exercise != null) {
+                                Optional<Solution> existingSolution = exercise.getSolutions().stream().filter(sol ->
+                                        sol.getAuthor().equals(newSolution.getAuthor())).findAny();
+                                // Replace with latest submission of solution if a solution is already present for the author
+                                if (existingSolution.isPresent()) {
+                                    if (existingSolution.get().getSubmissionTime().isBefore(newSolution.getSubmissionTime())) {
+                                        System.out.println(newSolution.getAuthor() + " - " + existingSolution.get().getSubmissionTime() + " - " + newSolution.getSubmissionTime());
+                                        exercise.replaceSolution(exercise.getSolutions().indexOf(existingSolution.get()), newSolution);
+                                    }
+                                } else {
+                                    exercise.addSolution(newSolution);
+                                }
+                            } else {
+                                exercises.add(new Exercise(newSolution.getExerciseName(), newSolution));
+                            }
+                        } catch (Exception e) {
+                            e.printStackTrace();
                         }
-                    } catch (Exception e) {
-                        e.printStackTrace();
+                        parsedSolutions++;
+                        analyser.updateProcessingProgress(parsedSolutions, numSolutions);
                     }
-                    parsedSolutions ++;
-                    analyser.updateProcessingProgress(parsedSolutions, numSolutions);
                 }
                 zipEntry = zis.getNextEntry();
             }
@@ -133,20 +151,24 @@ public static File newFile(File destinationDir, ZipEntry zipEntry) throws IOExce
      */
     private Solution parseSolution(File sourceCodeFile) throws Exception {
         Solution solution;
-        Pattern solutionFolderPattern = Pattern.compile("(.+)_(.+)");
-        Matcher matcher = solutionFolderPattern.matcher(sourceCodeFile.getParentFile().getName());
+        Pattern authorFolderPattern = Pattern.compile("(.+ ?) ([0-9]+) (.+)");
+        //Pattern solutionFolderPattern = Pattern.compile("(.+)_(.+)");
+        Matcher matcher = authorFolderPattern.matcher(sourceCodeFile.getParentFile().getParentFile().getName());
         if (matcher.find()) {
             String author;
             if (anonymousResults)
-                author = matcher.group(1);
-            else
                 author = matcher.group(2);
-            solution = new Solution(author, sourceCodeFile.getName(), sourceCodeFile);
+            else
+                author = matcher.group(1);
+            LocalDateTime submissionTime = LocalDateTime.parse(
+                    sourceCodeFile.getParentFile().getName(),
+                    DateTimeFormatter.ofPattern("yyyy-MM-dd-HH-mm-ss"));
+            solution = new Solution(author, sourceCodeFile.getName(), sourceCodeFile, submissionTime);
         } else {
-            throw new InvalidPathException(sourceCodeFile.getParentFile().getName(), " is an invalid file path.");
+            throw new InvalidPathException(sourceCodeFile.getParentFile().getName(), "Invalid solution file path");
         }
         if (preprocessSourceCode) {
-            preprocessSourceCode2(sourceCodeFile.getAbsolutePath());
+            preprocessSourceCode(sourceCodeFile.getAbsolutePath());
             String sourceCodePath = sourceCodeFile.getAbsolutePath();
             File preProcessedCodeFile = new File(sourceCodePath.substring(0, sourceCodePath.length() - 3) + "_preprocessed.py");
             solution.setPreprocessedCodeFile(preProcessedCodeFile);
@@ -161,7 +183,7 @@ private Solution parseSolution(File sourceCodeFile) throws Exception {
      * @param filePath the source code file's path
      * @throws Exception if the preprocessing fails
      */
-    public void preprocessSourceCode2(String filePath) throws Exception {
+    public void preprocessSourceCode(String filePath) throws Exception {
         final String preprocessorScript = "/ee/ut/similaritydetector/python/Preprocessor.py";
 
         PythonInterpreter interpreter = new PythonInterpreter();
diff --git a/src/main/java/ee/ut/similaritydetector/ui/SimilarityDetectorLauncher.java b/src/main/java/ee/ut/similaritydetector/ui/SimilarityDetectorLauncher.java
@@ -48,7 +48,7 @@ public void loadMainView(Stage stage) throws IOException {
         // Icon from: https://icons-for-free.com/spy-131964785010048699/ [25.03.2021]
         stage.getIcons().add(new Image(getClass().getResourceAsStream("/ee/ut/similaritydetector/img/app_icon.png")));
         stage.show();
-        UserData.getInstance().setDarkMode(true);
+        UserData.getInstance().setDarkMode(false);
         stage.setOnCloseRequest(this::showExitConfirmationAlert);
         MainViewController.stage = stage;
     }
diff --git a/src/main/java/ee/ut/similaritydetector/ui/controllers/MenuBarController.java b/src/main/java/ee/ut/similaritydetector/ui/controllers/MenuBarController.java
@@ -49,17 +49,11 @@ public MenuItem getCloseAllTabsMenuItem() {
     private void initialize() {
         lightTheme.setOnAction(event -> Platform.runLater(this::activateLightTheme));
         darkTheme.setOnAction(event -> Platform.runLater(this::activateDarkTheme));
-        // When scenes are switched then persists theme
-        if (MainViewController.stage != null) {
-            if (UserData.getInstance().isDarkMode()) {
-                darkTheme.setSelected(true);
-            } else {
-                lightTheme.setSelected(true);
-            }
-        }
-        // When application is started
-        else {
-            Platform.runLater(this::activateDarkTheme);
+        // When scenes are switched then persists theme selection
+        if (UserData.getInstance().isDarkMode()) {
+            darkTheme.setSelected(true);
+        } else {
+            lightTheme.setSelected(true);
         }
     }
 
@@ -99,7 +93,7 @@ private void activateLightTheme() {
      * Persists the current theme through scene changes.
      */
     public void persistCurrentTheme() {
-        if (darkTheme.isSelected()) {
+        if (UserData.getInstance().isDarkMode()) {
             activateDarkTheme();
         } else {
             activateLightTheme();
diff --git a/src/main/java/ee/ut/similaritydetector/ui/utils/UserData.java b/src/main/java/ee/ut/similaritydetector/ui/utils/UserData.java
@@ -15,7 +15,7 @@ public UserData(boolean isDarkMode) {
 
     public static UserData getInstance() {
         if (instance == null) {
-            instance = new UserData(true);
+            instance = new UserData(false);
         }
         return instance;
     }
diff --git a/src/main/resources/ee/ut/similaritydetector/fxml/menu_bar.fxml b/src/main/resources/ee/ut/similaritydetector/fxml/menu_bar.fxml
@@ -28,7 +28,7 @@
                         <ToggleGroup fx:id="themeGroup" />
                     </toggleGroup>
                 </RadioMenuItem>
-                <RadioMenuItem fx:id="darkTheme" mnemonicParsing="false" selected="true" text="Dark" toggleGroup="$themeGroup" />
+                <RadioMenuItem fx:id="darkTheme" mnemonicParsing="false" text="Dark" toggleGroup="$themeGroup" />
             </items>
         </Menu>
         <Menu fx:id="helpMenu" mnemonicParsing="false" text="Help">
diff --git a/src/main/resources/ee/ut/similaritydetector/python/Preprocessor.py b/src/main/resources/ee/ut/similaritydetector/python/Preprocessor.py
@@ -53,4 +53,6 @@ def preprocess_source_code(source_code):
             preprocessed_code_file.write(preprocessed_code)
     # If the source code is syntactically incorrect
     except IndentationError:
-        sys.stderr.write("Syntactically incorrect program: " + source_code_file.name + "\n")
+        sys.stderr.write("[Preprocessing] Syntactically incorrect program: " + source_code_file.name + "\n")
+    except Exception:
+        sys.stderr.write("[Preprocessing] Unexpected error: " + source_code_file.name + "\n")

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,10 @@ public List<Solution> getSolutions() {`
`26`	`26`	`return solutions;`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ public void replaceSolution(int index, Solution newSolution) {`
	`30`	`+ solutions.set(index, newSolution);`
	`31`	`+ }`
	`32`	`+`
`29`	`33`	`public void addSolution(Solution solution) {`
`30`	`34`	`solutions.add(solution);`
`31`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public void loadMainView(Stage stage) throws IOException {`
`48`	`48`	`// Icon from: https://icons-for-free.com/spy-131964785010048699/ [25.03.2021]`
`49`	`49`	`stage.getIcons().add(new Image(getClass().getResourceAsStream("/ee/ut/similaritydetector/img/app_icon.png")));`
`50`	`50`	`stage.show();`
`51`		`- UserData.getInstance().setDarkMode(true);`
	`51`	`+ UserData.getInstance().setDarkMode(false);`
`52`	`52`	`stage.setOnCloseRequest(this::showExitConfirmationAlert);`
`53`	`53`	`MainViewController.stage = stage;`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public UserData(boolean isDarkMode) {`
`15`	`15`
`16`	`16`	`public static UserData getInstance() {`
`17`	`17`	`if (instance == null) {`
`18`		`- instance = new UserData(true);`
	`18`	`+ instance = new UserData(false);`
`19`	`19`	`}`
`20`	`20`	`return instance;`
`21`	`21`	`}`