Add offline support to webprefs, closes #7

Mumfrey
1 parent b98d2088
Showing 6 changed files with 451 additions and 79 deletions
src/client/java/com/mumfrey/liteloader/client/mixin/MixinSession.java
src/client/java/com/mumfrey/webprefs/AbstractWebPreferences.java
src/client/java/com/mumfrey/webprefs/DummyOfflineWebPreferences.java
src/client/java/com/mumfrey/webprefs/OfflineWebPreferences.java
src/client/java/com/mumfrey/webprefs/WebPreferences.java
src/client/java/com/mumfrey/webprefs/WebPreferencesManager.java
@@ -5,8 +5,6 @@
  */
 package com.mumfrey.liteloader.client.mixin;
-import java.util.UUID;
-
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.asm.mixin.injection.At;
@@ -30,7 +28,6 @@ public abstract class MixinSession
     ))
     private void generateGameProfile(CallbackInfoReturnable<GameProfile> ci)
     {
-        UUID uuid = EntityPlayer.getUUID(new GameProfile((UUID)null, this.getUsername()));
-        ci.setReturnValue(new GameProfile(uuid, this.getUsername()));
+        ci.setReturnValue(new GameProfile(EntityPlayer.getOfflineUUID(this.getUsername()), this.getUsername()));
     }
 }
+package com.mumfrey.webprefs;
+
+import java.util.Set;
+import java.util.UUID;
+
+import com.mumfrey.webprefs.interfaces.IWebPreferences;
+
+/**
+ * Common base class for online/offline web preferences
+ */
+abstract class AbstractWebPreferences implements IWebPreferences
+{
+    /**
+     * Our UUID
+     */
+    protected final String uuid;
+    
+    /**
+     * True if we are a private settings set
+     */
+    protected final boolean isPrivate;
+    
+    protected final boolean isReadOnly;
+
+    AbstractWebPreferences(UUID uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        this(uuid.toString(), isPrivate, isReadOnly);
+    }
+    
+    AbstractWebPreferences(String uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        this.uuid = uuid;
+        this.isPrivate = isPrivate;
+        this.isReadOnly = isReadOnly;
+    }
+
+    void onTick()
+    {
+        // stub for subclasses
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#getUUID()
+     */
+    @Override
+    public final String getUUID()
+    {
+        return this.uuid;
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#isPrivate()
+     */
+    @Override
+    public final boolean isPrivate()
+    {
+        return this.isPrivate;
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#isReadOnly()
+     */
+    @Override
+    public final boolean isReadOnly()
+    {
+        return this.isReadOnly;
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #request(java.lang.String)
+     */
+    @Override
+    public void request(String key)
+    {
+        WebPreferences.validateKey(key);
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #request(java.lang.String[])
+     */
+    @Override
+    public void request(String... keys)
+    {
+        if (keys == null || keys.length < 1) return;
+        if (keys.length == 1) this.request(keys[0]);
+        
+        for (String key : keys)
+        {
+            this.request(key);
+        }
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #request(java.util.Set)
+     */
+    @Override
+    public void request(Set<String> keys)
+    {
+        if (keys == null || keys.size() < 1) return;
+        
+        for (String key : keys)
+        {
+            this.request(key);
+        }
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#commit(boolean)
+     */
+    @Override
+    public void commit(boolean force)
+    {
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #set(java.lang.String, java.lang.String)
+     */
+    @Override
+    public void set(String key, String value)
+    {
+        WebPreferences.validateKey(key);
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #remove(java.lang.String)
+     */
+    @Override
+    public void remove(String key)
+    {
+        this.set(key, "");
+    }
+}
+package com.mumfrey.webprefs;
+
+import java.util.UUID;
+
+/**
+ * No-op webpreferences set which is returned for nonlocal players when the
+ * client is running in offline mode.
+ */
+public class DummyOfflineWebPreferences extends AbstractWebPreferences
+{
+    DummyOfflineWebPreferences(UUID uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        this(uuid.toString(), isPrivate, isReadOnly);
+    }
+    
+    public DummyOfflineWebPreferences(String uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        super(uuid, isPrivate, isReadOnly);
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#poll()
+     */
+    @Override
+    public void poll()
+    {
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #has(java.lang.String)
+     */
+    @Override
+    public boolean has(String key)
+    {
+        WebPreferences.validateKey(key);
+        return false;
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #get(java.lang.String)
+     */
+    @Override
+    public String get(String key)
+    {
+        WebPreferences.validateKey(key);
+        return "";
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #get(java.lang.String, java.lang.String)
+     */
+    @Override
+    public String get(String key, String defaultValue)
+    {
+        WebPreferences.validateKey(key);
+        return defaultValue;
+    }
+}
 \ No newline at end of file
+package com.mumfrey.webprefs;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.mumfrey.liteloader.core.LiteLoader;
+import com.mumfrey.webprefs.exceptions.ReadOnlyPreferencesException;
+
+/**
+ * Surrogate preferences returned for a local offline player, allows offline
+ * players to use the webpreferences system with preferences just being stored
+ * locally.
+ */
+class OfflineWebPreferences extends DummyOfflineWebPreferences
+{
+    /**
+     * Gson instance for serialisation/deserialisation to local JSON file
+     */
+    private static final Gson gson = new GsonBuilder().setPrettyPrinting().create();
+
+    /**
+     * Maximum commit-to-disk rate in ticks
+     */
+    private static final int COMMIT_RATE = 20 * 3;
+    
+    /**
+     * JSON file 
+     */
+    private final File store;
+    
+    /**
+     * Local KV store
+     */
+    final Map<String, String> prefs;
+    
+    /**
+     * Tick number for write throttling
+     */
+    private int tickNumber;
+    
+    /**
+     * Flag indicating serialisation to disk is required
+     */
+    private boolean isDirty;
+    
+    OfflineWebPreferences(UUID uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        this(uuid.toString(), isPrivate, isReadOnly);
+    }
+    
+    OfflineWebPreferences(String uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        super(uuid, isPrivate, isReadOnly);
+        
+        this.store = new File(LiteLoader.getCommonConfigFolder(), String.format("%s.%sprefs.json", uuid, isPrivate ? "private" : ""));
+        this.prefs = this.loadValues();
+    }
+
+    @SuppressWarnings("unchecked")
+    private Map<String, String> loadValues()
+    {
+        if (this.store.isFile())
+        {
+            FileReader reader = null;
+            
+            try
+            {
+                reader = new FileReader(this.store);
+                return OfflineWebPreferences.gson.fromJson(reader, Map.class);
+            }
+            catch (IOException ex) {}
+            finally
+            {
+                try
+                {
+                    if (reader != null) reader.close();
+                }
+                catch (IOException ex) {}
+            }
+        }
+        
+        return new HashMap<String, String>();
+    }
+    
+    private void saveValues()
+    {
+        FileWriter writer = null;
+
+        try
+        {
+            writer = new FileWriter(this.store);
+            OfflineWebPreferences.gson.toJson(this.prefs, writer);
+        }
+        catch (IOException ex) {}
+        finally
+        {
+            try
+            {
+                if (writer != null) writer.close();
+            }
+            catch (IOException ex) {}
+        }
+    }
+    
+    @Override
+    void onTick()
+    {
+        if (this.tickNumber++ > OfflineWebPreferences.COMMIT_RATE && this.isDirty)
+        {
+            this.isDirty = false;
+            this.tickNumber = 0;
+            this.saveValues();
+        }
+    }
+
+    @Override
+    public void request(String key)
+    {
+        WebPreferences.validateKey(key);
+        if (!this.prefs.containsKey(key))
+        {
+            this.prefs.put(key, "");
+        }
+    }
+
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#commit(boolean)
+     */
+    @Override
+    public void commit(boolean force)
+    {
+        this.isDirty = true;
+    }
+    
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #has(java.lang.String)
+     */
+    @Override
+    public boolean has(String key)
+    {
+        WebPreferences.validateKey(key);
+        return this.prefs.containsKey(key);
+    }
+    
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #get(java.lang.String)
+     */
+    @Override
+    public String get(String key)
+    {
+        return this.get(key, "");
+    }
+    
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #get(java.lang.String, java.lang.String)
+     */
+    @Override
+    public String get(String key, String defaultValue)
+    {
+        WebPreferences.validateKey(key);
+        String value = this.prefs.get(key);
+        return value != null ? value : defaultValue;
+    }
+    
+    /* (non-Javadoc)
+     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
+     *      #set(java.lang.String, java.lang.String)
+     */
+    @Override
+    public void set(String key, String value)
+    {
+        if (this.isReadOnly())
+        {
+            throw new ReadOnlyPreferencesException("Preference collection for " + this.uuid + " is read-only");
+        }
+        
+        WebPreferences.validateKV(key, value);
+
+        this.prefs.put(key, value);
+        this.isDirty = true;
+    }
+}
@@ -4,6 +4,7 @@ import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
+import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.regex.Pattern;
@@ -12,11 +13,10 @@ import com.mumfrey.webprefs.exceptions.InvalidKeyException;
 import com.mumfrey.webprefs.exceptions.InvalidValueException;
 import com.mumfrey.webprefs.exceptions.ReadOnlyPreferencesException;
 import com.mumfrey.webprefs.framework.RequestFailureReason;
-import com.mumfrey.webprefs.interfaces.IWebPreferences;
 import com.mumfrey.webprefs.interfaces.IWebPreferencesClient;
 import com.mumfrey.webprefs.interfaces.IWebPreferencesProvider;
-class WebPreferences implements IWebPreferences
+class WebPreferences extends AbstractWebPreferences
 {
     /**
      * The update frequency to use when operating normally, this is the
@@ -104,18 +104,6 @@ class WebPreferences implements IWebPreferences
     private final IWebPreferencesClient client;
     /**
-     * Our UUID
-     */
-    protected final String uuid;
-    
-    /**
-     * True if we are a private settings set
-     */
-    protected final boolean isPrivate;
-    
-    protected final boolean isReadOnly;
-    
-    /**
      * Current key/value pairs
      */
     protected final Map<String, String> prefs = new ConcurrentHashMap<String, String>();
@@ -149,61 +137,30 @@ class WebPreferences implements IWebPreferences
     private volatile int updateCheckTimer = 1;
     protected int requestTimeoutTimer = 0;
+    
+    WebPreferences(IWebPreferencesProvider provider, UUID uuid, boolean isPrivate, boolean isReadOnly)
+    {
+        this(provider, uuid.toString(), isPrivate, isReadOnly);
+    }
     WebPreferences(IWebPreferencesProvider provider, String uuid, boolean isPrivate, boolean isReadOnly)
     {
+        super(uuid, isPrivate, isReadOnly);
         this.provider = provider;
-        this.uuid = uuid;
-        this.isPrivate = isPrivate;
-        this.isReadOnly = isReadOnly;
         this.client = new Client();
     }
-    /* (non-Javadoc)
-     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#getUUID()
-     */
-    @Override
-    public String getUUID()
-    {
-        return this.uuid;
-    }
-    
-    /* (non-Javadoc)
-     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#isPrivate()
-     */
-    @Override
-    public boolean isPrivate()
-    {
-        return this.isPrivate;
-    }
-    
-    /* (non-Javadoc)
-     * @see com.mumfrey.webprefs.interfaces.IWebPreferences#isReadOnly()
-     */
     @Override
-    public boolean isReadOnly()
-    {
-        return this.isReadOnly;
-    }
-    
     void onTick()
     {
-        if (this.updateCheckTimer > 0)
+        if (this.updateCheckTimer > 0 && --this.updateCheckTimer < 1)
         {
-            this.updateCheckTimer--;
-            if (this.updateCheckTimer < 1)
-            {
-                this.update();
-            }
+            this.update();
         }
-        if (this.requestTimeoutTimer > 0)
+        if (this.requestTimeoutTimer > 0 && --this.requestTimeoutTimer < 1)
         {
-            this.requestTimeoutTimer--;
-            if (this.requestTimeoutTimer < 1)
-            {
-                this.handleTimeout();
-            }
+            this.handleTimeout();
         }
     }
@@ -449,16 +406,6 @@ class WebPreferences implements IWebPreferences
         }
     }
-    /* (non-Javadoc)
-     * @see com.mumfrey.webprefs.interfaces.IWebPreferences
-     *      #remove(java.lang.String)
-     */
-    @Override
-    public void remove(String key)
-    {
-        this.set(key, "");
-    }
-    
     /**
      * Add a key to the current request set, the key will be requested from the
      * server on the next {@link #update()}
@@ -563,7 +510,7 @@ class WebPreferences implements IWebPreferences
     /**
      * @param key
      */
-    protected static final void validateKey(String key)
+    protected static void validateKey(String key)
     {
         if (key == null || !WebPreferences.keyPattern.matcher(key).matches())
         {
@@ -575,7 +522,7 @@ class WebPreferences implements IWebPreferences
      * @param key
      * @param value
      */
-    protected static final void validateKV(String key, String value)
+    protected static void validateKV(String key, String value)
     {
         WebPreferences.validateKey(key);
@@ -130,7 +130,7 @@ public final class WebPreferencesManager
     /**
      * All preference sets, for iteration purposes
      */
-    private final List<WebPreferences> allPreferences = new LinkedList<WebPreferences>();
+    private final List<AbstractWebPreferences> allPreferences = new LinkedList<AbstractWebPreferences>();
     /**
      * All public preference sets, mapped by UUID
@@ -152,7 +152,7 @@ public final class WebPreferencesManager
     {
         this.provider.onTick();
-        for (WebPreferences prefs : this.allPreferences)
+        for (AbstractWebPreferences prefs : this.allPreferences)
         {
             try
             {
@@ -164,7 +164,7 @@ public final class WebPreferencesManager
     void onJoinGame()
     {
-        for (WebPreferences prefs : this.allPreferences)
+        for (AbstractWebPreferences prefs : this.allPreferences)
         {
             try
             {
@@ -176,7 +176,9 @@ public final class WebPreferencesManager
     /**
-     * Get a public or private preferences collection for the local player
+     * Get a public or private preferences collection for the local player. If
+     * the game is running in offline mode, a local preference collection is
+     * returned instead.
      * 
      * @param privatePrefs true to fetch the player's private preferences, false
      *      to fetch public preferences 
@@ -184,11 +186,21 @@ public final class WebPreferencesManager
      */
     public IWebPreferences getLocalPreferences(boolean privatePrefs)
     {
-        return this.getPreferences(this.session.getPlayerID(), privatePrefs);
+        try
+        {
+            return this.getPreferences(this.session.getPlayerID(), privatePrefs);
+        }
+        catch (InvalidUUIDException ex)
+        {
+            UUID offlineUUID = EntityPlayer.getOfflineUUID(this.session.getUsername());
+            return this.getOfflinePreferences(offlineUUID, privatePrefs, false, false);
+        }
     }
     /**
-     * Get a public preferences collection for the specified player.
+     * Get a public preferences collection for the specified player. If the game
+     * is running in offline mode, a dummy preference collection supporting no
+     * operations is returned instead.
      * 
      * @param player Player to fetch preferences for
      * @param privatePrefs True to fetch the player's private preferences, false
@@ -198,7 +210,16 @@ public final class WebPreferencesManager
      */
     public IWebPreferences getPreferences(EntityPlayer player)
     {
-        return this.getPreferences(player, false);
+        try
+        {
+            return this.getPreferences(player, false);
+        }
+        catch (InvalidUUIDException ex)
+        {
+            String playerName = player.getName();
+            UUID offlineUUID = EntityPlayer.getOfflineUUID(playerName);
+            return this.getOfflinePreferences(offlineUUID, false, false, !playerName.equals(this.session.getUsername()));
+        }
     }
     /**
@@ -279,7 +300,6 @@ public final class WebPreferencesManager
         uuid = this.sanitiseUUID(uuid);
         Map<String, IWebPreferences> preferences = privatePrefs ? this.preferencesPrivate : this.preferencesPublic;
-        
         IWebPreferences prefs = preferences.get(uuid);
         if (prefs == null)
@@ -293,6 +313,24 @@ public final class WebPreferencesManager
         return prefs;
     }
+    private IWebPreferences getOfflinePreferences(UUID uuid, boolean privatePrefs, boolean readOnly, boolean dummy)
+    {
+        Map<String, IWebPreferences> preferences = privatePrefs ? this.preferencesPrivate : this.preferencesPublic;
+        IWebPreferences prefs = preferences.get(uuid);
+        
+        if (prefs == null)
+        {
+            AbstractWebPreferences newPrefs = dummy
+                    ? new DummyOfflineWebPreferences(uuid, privatePrefs, readOnly)
+                    : new OfflineWebPreferences(uuid, privatePrefs, readOnly);
+            this.allPreferences.add(newPrefs);
+            preferences.put(uuid.toString(), newPrefs);
+            prefs = newPrefs;
+        }
+        
+        return prefs;
+    }
+    
     private String sanitiseUUID(String uuid)
     {
         if (uuid == null)