Merge branch 'puzzle-improvements' into 'master'

Puzzle improvements

See merge request core-developers/forge!2330

forge-gui-desktop/src/main/java/forge/screens/home/puzzle/CSubmenuPuzzleSolve.java

@@ -96,6 +96,13 @@ public enum CSubmenuPuzzleSolve implements ICDoc, IMenuProvider {
             }
         });
 
+        hostedMatch.setEndGameHook((new Runnable() {
+            @Override
+            public void run() {
+                selected.savePuzzleSolve(hostedMatch.getGame().getOutcome().isWinner(GamePlayerUtil.getGuiPlayer()));
+            }
+        }));
+
         final List<RegisteredPlayer> players = new ArrayList<>();
         final RegisteredPlayer human = new RegisteredPlayer(new Deck()).setPlayer(GamePlayerUtil.getGuiPlayer());
         human.setStartingHand(0);

forge-gui/src/main/java/forge/match/HostedMatch.java

@@ -60,6 +60,7 @@ public class HostedMatch {
     private String title;
     public HashMap<LobbySlot, IGameController> gameControllers = null;
     private Runnable startGameHook = null;
+    private Runnable endGameHook = null;
     private final List<PlayerControllerHuman> humanControllers = Lists.newArrayList();
     private Map<RegisteredPlayer, IGuiGame> guis;
     private int humanCount;
@@ -73,6 +74,7 @@ public class HostedMatch {
     public void setStartGameHook(Runnable hook) {
         startGameHook = hook;
     }
+    public void setEndGameHook(Runnable hook) { endGameHook = hook; }
 
     private static GameRules getDefaultRules(final GameType gameType) {
         final GameRules gameRules = new GameRules(gameType);
@@ -241,6 +243,10 @@ public class HostedMatch {
                 }
                 // Actually start the game!
                 match.startGame(game, startGameHook);
+                // this function waits?
+                if (endGameHook != null){
+                    endGameHook.run();
+                }
 
                 // After game is over...
                 isMatchOver = match.isMatchOver();

forge-gui/src/main/java/forge/properties/ForgeConstants.java

@@ -214,6 +214,7 @@ public final class ForgeConstants {
     public static final String USER_PREFS_DIR       = USER_DIR + "preferences" + PATH_SEPARATOR;
     public static final String USER_GAMES_DIR       = USER_DIR + "games" + PATH_SEPARATOR;
     public static final String USER_FORMATS_DIR     = USER_DIR + "customformats" + PATH_SEPARATOR;
+    public static final String USER_PUZZLE_DIR      = USER_DIR + "puzzle" + PATH_SEPARATOR;
     public static final String LOG_FILE             = USER_DIR + "forge.log";
     public static final String ACHIEVEMENTS_DIR     = USER_DIR + "achievements" + PATH_SEPARATOR;
     public static final String DECK_DRAFT_DIR       = DECK_BASE_DIR + "draft" + PATH_SEPARATOR;

forge-gui/src/main/java/forge/puzzle/Puzzle.java

@@ -14,12 +14,16 @@ import forge.game.zone.ZoneType;
 import forge.item.IPaperCard;
 import forge.item.InventoryItem;
 import forge.model.FModel;
+import forge.properties.ForgeConstants;
 
+import java.io.File;
+import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 
 public class Puzzle extends GameState implements InventoryItem, Comparable<Puzzle> {
     String name;
+    String filename;
     String goal;
     String url;
     String difficulty;
@@ -27,16 +31,23 @@ public class Puzzle extends GameState implements InventoryItem, Comparable<Puzzl
     String targets;
     int targetCount = 1;
     int turns;
+    boolean completed;
 
     public Puzzle(Map<String, List<String>> puzzleLines) {
+        this(puzzleLines, "", false);
+    }
+
+    public Puzzle(Map<String, List<String>> puzzleLines, String filename, boolean completed) {
         loadMetaData(puzzleLines.get("metadata"));
         loadGameState(puzzleLines.get("state"));
         // Generate goal enforcement
+        this.filename = filename;
+        this.completed = completed;
     }
 
     private void loadMetaData(List<String> metadataLines) {
         for(String line : metadataLines) {
-            String[] split = line.split(":");
+            String[] split = line.split(":", 2);
             if ("Name".equalsIgnoreCase(split[0])) {
                 this.name = split[1].trim();
             } else if ("Goal".equalsIgnoreCase(split[0])) {
@@ -215,13 +226,50 @@ public class Puzzle extends GameState implements InventoryItem, Comparable<Puzzl
         return name;
     }
 
-    public String toString() { return name; }
+    public boolean getCompleted() { return completed; }
+
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        if (this.completed) {
+            sb.append("[COMPLETED] ");
+        }
+        sb.append(name);
+        return sb.toString();
+    }
 
     public int compareTo(Puzzle pzl) throws ClassCastException {
         if (!(pzl instanceof Puzzle)) {
             throw new ClassCastException("Tried to compare a Puzzle object to a non-Puzzle object.");
         }
 
+        if (this.completed == pzl.getCompleted()) {
             return getName().compareTo(pzl.getName());
+        } else if (this.completed) {
+            return 1;
+        } else {
+            return -1;
+        }
+    }
+
+    public boolean savePuzzleSolve(final boolean completed) {
+        if (!completed) {
+            return false;
+        }
+
+        File directory = new File(ForgeConstants.USER_PUZZLE_DIR);
+        if (!directory.exists()) {
+            directory.mkdirs();
+        }
+
+        File store = new File(ForgeConstants.USER_PUZZLE_DIR, filename + PuzzleIO.SUFFIX_COMPLETE);
+        if (!store.exists()) {
+            try {
+                store.createNewFile();
+            } catch (IOException e) {
+                e.printStackTrace();
+            }
+            this.completed = true;
+        }
+        return true;
     }
 }

forge-gui/src/main/java/forge/puzzle/PuzzleIO.java

@@ -14,6 +14,7 @@ public class PuzzleIO {
 
     public static final String TXF_PROMPT = "[New Puzzle]";
     public static final String SUFFIX_DATA = ".pzl";
+    public static final String SUFFIX_COMPLETE = ".complete";
 
     public static ArrayList<Puzzle> loadPuzzles() {
         String[] pList;
@@ -33,13 +34,18 @@ public class PuzzleIO {
         for (final String element : pList) {
             if (element.endsWith(SUFFIX_DATA)) {
                 final List<String> pfData = FileUtil.readFile(ForgeConstants.PUZZLE_DIR + element);
-                puzzles.add(new Puzzle(parsePuzzleSections(pfData)));
+
+                String filename = element.replace(SUFFIX_DATA, "");
+                boolean completed = FileUtil.doesFileExist(ForgeConstants.USER_PUZZLE_DIR + element.replace(SUFFIX_DATA, SUFFIX_COMPLETE));
+
+                // Pass file name into Puzzle so it can save the completed name to match
+                puzzles.add(new Puzzle(parsePuzzleSections(pfData), filename, completed));
             }
         }
         return puzzles;
     }
 
-    public static final Map<String, List<String>> parsePuzzleSections(List<String> pfData) {
+    public static Map<String, List<String>> parsePuzzleSections(List<String> pfData) {
         return FileSection.parseSections(pfData);
     }