Merge pull request ArchipelagoMW#27 from mattman107/main

Update Java-Client to current network protocol

Author: cjmang

pom.xml

@@ -30,6 +30,9 @@
             <name>Kono Tyran</name>
             <email>[email protected]</email>
         </developer>
+        <developer>
+            <name>mattman107</name>
+        </developer>
     </developers>
 
     <properties>
@@ -42,22 +45,22 @@
         <dependency>
             <groupId>org.java-websocket</groupId>
             <artifactId>Java-WebSocket</artifactId>
-            <version>1.5.7</version>
+            <version>1.6.0</version>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.11.0</version>
+            <version>2.13.1</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
-            <version>5.2.1</version>
+            <version>5.4.4</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.core5</groupId>
             <artifactId>httpcore5</artifactId>
-            <version>5.2.5</version>
+            <version>5.3.4</version>
         </dependency>
     </dependencies>
 

src/main/java/dev/koifysh/archipelago/Client.java

@@ -10,17 +10,48 @@
 import dev.koifysh.archipelago.network.client.*;
 import org.apache.hc.core5.net.URIBuilder;
 
+import com.google.gson.Gson;
+
 import java.io.*;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.*;
 import java.util.logging.Logger;
 
 public abstract class Client {
 
     private final static Logger LOGGER = Logger.getLogger(Client.class.getName());
 
-    private final String dataPackageLocation = "./APData/DataPackage.ser";
+    private static String OS = System.getProperty("os.name").toLowerCase();
+
+    private static final Path windowsDataPackageCache;
+    
+    private static final Path otherDataPackageCache;
+    
+    static
+    {
+        String appData = System.getenv("LOCALAPPDATA");
+        String winHome = System.getenv("USERPROFILE");
+        String userHome = System.getProperty("user.home");
+
+        if(appData  == null || appData.isEmpty()) {
+            windowsDataPackageCache = Paths.get(winHome, "appdata","local","Archipelago","cache","datapackage");
+        } else {
+            windowsDataPackageCache = Paths.get(appData, "Archipelago", "cache", "datapackage");
+        }
+        
+        otherDataPackageCache =  Paths.get(userHome, ".cache", "Archipelago", "datapackage");
+    }
+
+    private static Path dataPackageLocation;
+
+    protected Map<String,String> versions;
+
+    protected ArrayList<String> games;
+
+    private final static Gson gson = new Gson();
 
     private int hintPoints;
 
@@ -40,7 +71,7 @@ public abstract class Client {
     private final ItemManager itemManager;
     private final EventManager eventManager;
 
-    public static final Version protocolVersion = new Version(0, 4, 7);
+    public static final Version protocolVersion = new Version(0, 6, 1);
 
     private int team;
     private int slot;
@@ -52,7 +83,16 @@ public abstract class Client {
     private int itemsHandlingFlags = 0b000;
 
     public Client() {
-        loadDataPackage();
+        //Determine what platform we are on
+        if(OS.startsWith("windows")){
+            dataPackageLocation = windowsDataPackageCache;
+        } else{
+            dataPackageLocation = otherDataPackageCache;
+        }
+
+        if(dataPackage == null){
+            dataPackage = new DataPackage();
+        }
 
         UUID = dataPackage.getUUID();
 
@@ -117,45 +157,84 @@ public void removeTag(String tag) {
     }
 
 
-    private void loadDataPackage() {
-        try {
-            FileInputStream fileInput = new FileInputStream(dataPackageLocation);
-            ObjectInputStream objectInput = new ObjectInputStream(fileInput);
-
-            dataPackage = (DataPackage) objectInput.readObject();
-            fileInput.close();
-            objectInput.close();
-
-        } catch (IOException e) {
-            LOGGER.info("no dataPackage found creating a new one.");
-            dataPackage = new DataPackage();
-            saveDataPackage();
-        } catch (ClassNotFoundException e) {
-            LOGGER.info("Failed to Read Previous datapackage. Creating new one.");
-            dataPackage = new DataPackage();
+    protected void loadDataPackage() {
+        synchronized (Client.class){
+            File directoryPath = dataPackageLocation.toFile();
+
+            //ensure the path to the cache exists
+            if(directoryPath.exists() && directoryPath.isDirectory()){
+                //loop through all Archipelago cache folders to find valid data package files 
+                Map<String,File> localGamesList = new HashMap<String,File>();
+
+                for(File gameDir : directoryPath.listFiles()){
+                    if(gameDir.isDirectory()){
+                        localGamesList.put(gameDir.getName(), gameDir);
+                    }
+                }
+
+                if(localGamesList.isEmpty()){
+                    //cache doesn't exist. Create the filepath
+                    boolean success = directoryPath.mkdirs();
+                    if(success){
+                        LOGGER.info("DataPackage directory didn't exist. Starting from a new one.");
+                    } else{
+                        LOGGER.severe("Failed to make directories for datapackage cache.");
+                    }
+                    return;
+                }
+
+                for(String gameName : games) {
+                    File dir = localGamesList.get(gameName);
+                    
+                    if(null == dir){
+                        continue;
+                    }
+                    
+                    //check all checksums
+                    for(File version : dir.listFiles()){
+                        String versionStr = versions.get(gameName);
+                        if(versionStr != null && versionStr.equals(version.getName())) {
+                            try(FileReader reader = new FileReader(version)){
+                                updateDataPackage(gson.fromJson(reader, DataPackage.class));
+                                LOGGER.info("Read datapackage for Game: ".concat(gameName).concat(" Checksum: ").concat(version.getName()));
+                            } catch (IOException e){
+                                LOGGER.info("Failed to read a datapackage. Starting with a new one.");
+                            }
+                        }
+                    }
+                }
+            }
         }
     }
 
-    void saveDataPackage() {
-        try {
-            File dataPackageFile = new File(dataPackageLocation);
-
-            //noinspection ResultOfMethodCallIgnored
-            dataPackageFile.getParentFile().mkdirs();
-            //noinspection ResultOfMethodCallIgnored
-            dataPackageFile.createNewFile();
-
-            FileOutputStream fileOut = new FileOutputStream(dataPackageFile);
-            ObjectOutputStream objectOut = new ObjectOutputStream(fileOut);
-
-            objectOut.writeObject(dataPackage);
+    public void saveDataPackage() {
+        synchronized (Client.class){
+            //Loop through games to ensure we have folders for each of them in the cache
+            for(String gameName : games){
+                File gameFolder = dataPackageLocation.resolve(gameName).toFile();
+                if(!gameFolder.exists()){
+                    //game folder not found. Make it
+                    gameFolder.mkdirs();
+                }
+
+                //save the datapackage
+                String gameVersion = versions.get(gameName); 
+                if(gameVersion == null) { 
+                    continue; 
+                }
+
+                //if key is for this game
+                File filePath = dataPackageLocation.resolve(gameName).resolve(gameVersion).toFile();
+
+                try (Writer writer = new FileWriter(filePath)){
+                    //if game is in list of games, save it
+                    gson.toJson(dataPackage.getGame(gameName), writer);
+                    LOGGER.info("Saving datapackage for Game: ".concat(gameName).concat(" Checksum: ").concat(gameVersion));
+                } catch (IOException e) {
+                    LOGGER.warning("unable to save DataPackage.");
+                }
 
-
-            fileOut.close();
-            objectOut.close();
-
-        } catch (IOException e) {
-            LOGGER.warning("unable to save DataPackage.");
+            }
         }
     }
 
@@ -518,6 +597,21 @@ public void dataStorageSetNotify(Collection<String> keys) {
      *         <td> dict[str, list[str]] </td>
      *         <td> item_name_groups belonging to the requested game. </td>
      *     </tr>
+     *     <tr>
+     *         <td> location_name_groups_{game_name} </td>
+     *         <td> dict[str, list[str]] </td>
+     *         <td> location_name_groups belonging to the requested game. </td>
+     *     </tr>
+     *     <tr>
+     *         <td> client_status_{team}_{slot} </td>
+     *         <td> ClientStatus </td>
+     *         <td> The current game status of the requested player. </td>
+     *     </tr>
+     *     <tr>
+     *         <td> race_mode </td>
+     *         <td> int </td>
+     *         <td> 0 if race mode is disabled, and 1 if it's enabled. </td>
+     *     </tr>
      * </table>
      *
      * @param keys a list of keys to retrieve values for

src/main/java/dev/koifysh/archipelago/WebSocket.java

@@ -24,6 +24,9 @@
 import dev.koifysh.archipelago.parts.NetworkSlot;
 import org.apache.hc.core5.net.URIBuilder;
 import org.java_websocket.client.WebSocketClient;
+import org.java_websocket.drafts.Draft;
+import org.java_websocket.drafts.Draft_6455;
+import org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension;
 import org.java_websocket.handshake.ServerHandshake;
 
 import javax.net.ssl.SSLException;
@@ -48,8 +51,10 @@ class WebSocket extends WebSocketClient {
     private static Timer reconnectTimer;
     private boolean downgrade = false;
 
+    private static final Draft perMessageDeflateDraft = new Draft_6455(new PerMessageDeflateExtension());
+
     public WebSocket(URI serverUri, Client client) {
-        super(serverUri);
+        super(serverUri, perMessageDeflateDraft);
         this.client = client;
         if (reconnectTimer != null) {
             reconnectTimer.cancel();
@@ -83,6 +88,11 @@ public void onMessage(String message) {
                         //save room info
                         client.setRoomInfo(roomInfo);
 
+                        client.versions = roomInfo.datapackageChecksums;
+                        client.games = roomInfo.games;
+
+                        client.loadDataPackage();
+
                         checkDataPackage(roomInfo.datapackageChecksums, roomInfo.games);
 
                         seedName = roomInfo.seedName;

src/main/java/dev/koifysh/archipelago/network/APPacketType.java

@@ -52,5 +52,7 @@ public enum APPacketType {
     @SerializedName("SetReply")
     SetReply,
     @SerializedName("InvalidPacket")
-    InvalidPacket
+    InvalidPacket,
+    @SerializedName("UpdateHint")
+    UpdateHint
 }

src/main/java/dev/koifysh/archipelago/network/client/HintStatus.java

@@ -0,0 +1,21 @@
+package dev.koifysh.archipelago.network.client;
+
+import com.google.gson.annotations.SerializedName;
+
+public enum HintStatus {
+    @SerializedName("HINT_UNSPECIFIED")
+    HINT_UNSPECIFIED(0),
+    @SerializedName("HINT_NO_PRIORITY")
+    HINT_NO_PRIORITY(10),
+    @SerializedName("HINT_AVOID")
+    HINT_AVOID(20),
+    @SerializedName("HINT_PRIORITY")
+    HINT_PRIORITY(30),
+    @SerializedName("HINT_FOUND")
+    HINT_FOUND(40);
+
+    public final int value;
+    HintStatus(int value) {
+        this.value=value;
+    }
+}

src/main/java/dev/koifysh/archipelago/network/client/SetPacket.java

@@ -92,7 +92,10 @@ private static class DataStorageOperation {
      * {@link #OR},
      * {@link #XOR},
      * {@link #LEFT_SHIFT},
-     * {@link #RIGHT_SHIFT}
+     * {@link #RIGHT_SHIFT},
+     * {@link #REMOVE},
+     * {@link #POP},
+     * {@link #UPDATE}
      */
     public enum Operation {
         /**

src/main/java/dev/koifysh/archipelago/network/client/UpdateHintPacket.java

@@ -0,0 +1,25 @@
+package dev.koifysh.archipelago.network.client;
+
+import com.google.gson.annotations.SerializedName;
+
+import dev.koifysh.archipelago.network.APPacket;
+import dev.koifysh.archipelago.network.APPacketType;
+
+public class UpdateHintPacket extends APPacket{
+    /*
+    * NEED TO IMPLEMENT STUFF FOR UPDATEHINTPACKET?
+    */
+
+    @SerializedName("player")
+    int player;    
+     
+    @SerializedName("location")
+    int location;
+
+    @SerializedName("status")
+    HintStatus status;
+
+    public UpdateHintPacket(){
+        super(APPacketType.UpdateHint);
+    }
+}

src/main/java/dev/koifysh/archipelago/network/server/SetReplyPacket.java

@@ -11,6 +11,8 @@ public class SetReplyPacket extends APPacket {
     public Object value;
     @SerializedName("original_value")
     public Object original_Value;
+    @SerializedName("slot")
+    public int slot;
     @SerializedName("request_id")
     public int requestID;