remote: do not ping all the time
[fanfix.git] / src / be / nikiroo / fanfix / library / RemoteLibrary.java
index d3263e218312e07d9b366ff5eb2da2cd8bf3dcdb..653c25743e6730f59b1bd233ace4d11525ccafce 100644 (file)
@@ -7,12 +7,13 @@ import java.net.UnknownHostException;
 import java.util.ArrayList;
 import java.util.List;
 
+import javax.net.ssl.SSLException;
+
 import be.nikiroo.fanfix.Instance;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Story;
 import be.nikiroo.utils.Image;
 import be.nikiroo.utils.Progress;
-import be.nikiroo.utils.StringUtils;
 import be.nikiroo.utils.Version;
 import be.nikiroo.utils.serial.server.ConnectActionClientObject;
 
@@ -27,9 +28,47 @@ public class RemoteLibrary extends BasicLibrary {
        private String host;
        private int port;
        private final String key;
+       private final String subkey;
+
+       // informative only (server will make the actual checks)
+       private boolean rw;
+
+       // TODO: error handling is not up to par!
 
        /**
         * Create a {@link RemoteLibrary} linked to the given server.
+        * <p>
+        * Note that the key is structured:
+        * <tt><b><i>xxx</i></b>(|<b><i>yyy</i></b>|<b>wl</b>)(|<b>rw</b>)</tt>
+        * <p>
+        * Note that anything before the first pipe (<tt>|</tt>) character is
+        * considered to be the encryption key, anything after that character is
+        * called the subkey (including the other pipe characters and flags!).
+        * <p>
+        * This is important because the subkey (including the pipe characters and
+        * flags) must be present as-is in the server configuration file to be
+        * allowed.
+        * <ul>
+        * <li><b><i>xxx</i></b>: the encryption key used to communicate with the
+        * server</li>
+        * <li><b><i>yyy</i></b>: the secondary key</li>
+        * <li><b>rw</b>: flag to allow read and write access if it is not the
+        * default on this server</li>
+        * <li><b>wl</b>: flag to allow access to all the stories (bypassing the
+        * whitelist if it exists)</li>
+        * </ul>
+        * 
+        * Some examples:
+        * <ul>
+        * <li><b>my_key</b>: normal connection, will take the default server
+        * options</li>
+        * <li><b>my_key|agzyzz|wl</b>: will ask to bypass the white list (if it
+        * exists)</li>
+        * <li><b>my_key|agzyzz|rw</b>: will ask read-write access (if the default
+        * is read-only)</li>
+        * <li><b>my_key|agzyzz|wl|rw</b>: will ask both read-write access and white
+        * list bypass</li>
+        * </ul>
         * 
         * @param key
         *            the key that will allow us to exchange information with the
@@ -40,7 +79,19 @@ public class RemoteLibrary extends BasicLibrary {
         *            the port to contact it on
         */
        public RemoteLibrary(String key, String host, int port) {
-               this.key = key;
+               int index = -1;
+               if (key != null) {
+                       index = key.indexOf('|');
+               }
+
+               if (index >= 0) {
+                       this.key = key.substring(0, index);
+                       this.subkey = key.substring(index + 1);
+               } else {
+                       this.key = key;
+                       this.subkey = "";
+               }
+
                this.host = host;
                this.port = port;
        }
@@ -52,31 +103,41 @@ public class RemoteLibrary extends BasicLibrary {
 
        @Override
        public Status getStatus() {
+               Instance.getTraceHandler().trace("Getting remote lib status...");
+               Status status = getStatusDo();
+               Instance.getTraceHandler().trace("Remote lib status: " + status);
+               return status;
+       }
+
+       private Status getStatusDo() {
                final Status[] result = new Status[1];
 
                result[0] = Status.INVALID;
 
                try {
-                       Instance.getTraceHandler().trace("Getting remote lib status...");
                        new ConnectActionClientObject(host, port, key) {
                                @Override
                                public void action(Version serverVersion) throws Exception {
-                                       try {
-                                               Object rep = sendCmd(this, new Object[] { "PING" });
-
-                                               if ("PONG".equals(rep)) {
-                                                       result[0] = Status.READY;
-                                               } else {
-                                                       result[0] = Status.UNAUTORIZED;
-                                               }
-                                       } catch (IllegalArgumentException e) {
-                                               result[0] = Status.UNAUTORIZED;
+                                       Object rep = send(new Object[] { subkey, "PING" });
+
+                                       if ("r/w".equals(rep)) {
+                                               rw = true;
+                                               result[0] = Status.READY;
+                                       } else if ("r/o".equals(rep)) {
+                                               rw = false;
+                                               result[0] = Status.READY;
+                                       } else {
+                                               result[0] = Status.UNAUTHORIZED;
                                        }
                                }
 
                                @Override
                                protected void onError(Exception e) {
-                                       result[0] = Status.UNAVAILABLE;
+                                       if (e instanceof SSLException) {
+                                               result[0] = Status.UNAUTHORIZED;
+                                       } else {
+                                               result[0] = Status.UNAVAILABLE;
+                                       }
                                }
                        }.connect();
                } catch (UnknownHostException e) {
@@ -87,7 +148,6 @@ public class RemoteLibrary extends BasicLibrary {
                        result[0] = Status.UNAVAILABLE;
                }
 
-               Instance.getTraceHandler().trace("Remote lib status: " + result[0]);
                return result[0];
        }
 
@@ -99,14 +159,18 @@ public class RemoteLibrary extends BasicLibrary {
                        new ConnectActionClientObject(host, port, key) {
                                @Override
                                public void action(Version serverVersion) throws Exception {
-                                       Object rep = sendCmd(this,
-                                                       new Object[] { "GET_COVER", luid });
+                                       Object rep = send(new Object[] { subkey, "GET_COVER", luid });
                                        result[0] = (Image) rep;
                                }
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (Exception e) {
@@ -134,14 +198,19 @@ public class RemoteLibrary extends BasicLibrary {
                        new ConnectActionClientObject(host, port, key) {
                                @Override
                                public void action(Version serverVersion) throws Exception {
-                                       Object rep = sendCmd(this, new Object[] {
+                                       Object rep = send(new Object[] { subkey,
                                                        "GET_CUSTOM_COVER", type, source });
                                        result[0] = (Image) rep;
                                }
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (Exception e) {
@@ -165,8 +234,7 @@ public class RemoteLibrary extends BasicLibrary {
                                                pg = new Progress();
                                        }
 
-                                       Object rep = sendCmd(this,
-                                                       new Object[] { "GET_STORY", luid });
+                                       Object rep = send(new Object[] { subkey, "GET_STORY", luid });
 
                                        MetaData meta = null;
                                        if (rep instanceof MetaData) {
@@ -188,7 +256,12 @@ public class RemoteLibrary extends BasicLibrary {
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (Exception e) {
@@ -201,6 +274,7 @@ public class RemoteLibrary extends BasicLibrary {
        @Override
        public synchronized Story save(final Story story, final String luid,
                        Progress pg) throws IOException {
+
                final String[] luidSaved = new String[1];
                Progress pgSave = new Progress();
                Progress pgRefresh = new Progress();
@@ -222,7 +296,7 @@ public class RemoteLibrary extends BasicLibrary {
                                        pg.setMinMax(0, (int) story.getMeta().getWords());
                                }
 
-                               sendCmd(this, new Object[] { "SAVE_STORY", luid });
+                               send(new Object[] { subkey, "SAVE_STORY", luid });
 
                                List<Object> list = RemoteLibraryServer.breakStory(story);
                                for (Object obj : list) {
@@ -237,7 +311,12 @@ public class RemoteLibrary extends BasicLibrary {
 
                        @Override
                        protected void onError(Exception e) {
-                               Instance.getTraceHandler().error(e);
+                               if (e instanceof SSLException) {
+                                       Instance.getTraceHandler().error(
+                                                       "Connection refused (bad key)");
+                               } else {
+                                       Instance.getTraceHandler().error(e);
+                               }
                        }
                }.connect();
 
@@ -262,12 +341,17 @@ public class RemoteLibrary extends BasicLibrary {
                new ConnectActionClientObject(host, port, key) {
                        @Override
                        public void action(Version serverVersion) throws Exception {
-                               sendCmd(this, new Object[] { "DELETE_STORY", luid });
+                               send(new Object[] { subkey, "DELETE_STORY", luid });
                        }
 
                        @Override
                        protected void onError(Exception e) {
-                               Instance.getTraceHandler().error(e);
+                               if (e instanceof SSLException) {
+                                       Instance.getTraceHandler().error(
+                                                       "Connection refused (bad key)");
+                               } else {
+                                       Instance.getTraceHandler().error(e);
+                               }
                        }
                }.connect();
        }
@@ -289,13 +373,17 @@ public class RemoteLibrary extends BasicLibrary {
                        new ConnectActionClientObject(host, port, key) {
                                @Override
                                public void action(Version serverVersion) throws Exception {
-                                       sendCmd(this,
-                                                       new Object[] { "SET_COVER", type, value, luid });
+                                       send(new Object[] { subkey, "SET_COVER", type, value, luid });
                                }
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (IOException e) {
@@ -332,8 +420,8 @@ public class RemoteLibrary extends BasicLibrary {
                                public void action(Version serverVersion) throws Exception {
                                        Progress pg = pgF;
 
-                                       Object rep = sendCmd(this,
-                                                       new Object[] { "IMPORT", url.toString() });
+                                       Object rep = send(new Object[] { subkey, "IMPORT",
+                                                       url.toString() });
 
                                        while (true) {
                                                if (!RemoteLibraryServer.updateProgress(pg, rep)) {
@@ -349,7 +437,12 @@ public class RemoteLibrary extends BasicLibrary {
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (IOException e) {
@@ -372,6 +465,7 @@ public class RemoteLibrary extends BasicLibrary {
        protected synchronized void changeSTA(final String luid,
                        final String newSource, final String newTitle,
                        final String newAuthor, Progress pg) throws IOException {
+
                final Progress pgF = pg == null ? new Progress() : pg;
 
                try {
@@ -380,7 +474,7 @@ public class RemoteLibrary extends BasicLibrary {
                                public void action(Version serverVersion) throws Exception {
                                        Progress pg = pgF;
 
-                                       Object rep = sendCmd(this, new Object[] { "CHANGE_STA",
+                                       Object rep = send(new Object[] { subkey, "CHANGE_STA",
                                                        luid, newSource, newTitle, newAuthor });
                                        while (true) {
                                                if (!RemoteLibraryServer.updateProgress(pg, rep)) {
@@ -393,7 +487,12 @@ public class RemoteLibrary extends BasicLibrary {
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (IOException e) {
@@ -415,12 +514,17 @@ public class RemoteLibrary extends BasicLibrary {
                        new ConnectActionClientObject(host, port, key) {
                                @Override
                                public void action(Version serverVersion) throws Exception {
-                                       sendCmd(this, new Object[] { "EXIT" });
+                                       send(new Object[] { subkey, "EXIT" });
                                }
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (IOException e) {
@@ -499,7 +603,7 @@ public class RemoteLibrary extends BasicLibrary {
                                                pg = new Progress();
                                        }
 
-                                       Object rep = sendCmd(this, new Object[] { "GET_METADATA",
+                                       Object rep = send(new Object[] { subkey, "GET_METADATA",
                                                        luid });
 
                                        while (true) {
@@ -521,7 +625,12 @@ public class RemoteLibrary extends BasicLibrary {
 
                                @Override
                                protected void onError(Exception e) {
-                                       Instance.getTraceHandler().error(e);
+                                       if (e instanceof SSLException) {
+                                               Instance.getTraceHandler().error(
+                                                               "Connection refused (bad key)");
+                                       } else {
+                                               Instance.getTraceHandler().error(e);
+                                       }
                                }
                        }.connect();
                } catch (Exception e) {
@@ -530,30 +639,4 @@ public class RemoteLibrary extends BasicLibrary {
 
                return metas;
        }
-
-       // IllegalArgumentException if key is bad
-       private Object sendCmd(ConnectActionClientObject action, Object[] params)
-                       throws IOException, NoSuchFieldException, NoSuchMethodException,
-                       ClassNotFoundException {
-               Object rep = action.send(params);
-
-               String hash = hashKey(key, "" + rep);
-               return action.send(hash);
-       }
-
-       /**
-        * Return a hash that corresponds to the given key and the given random
-        * value.
-        * 
-        * @param key
-        *            the key (the secret)
-        * 
-        * @param random
-        *            the random value
-        * 
-        * @return a hash that was computed using both
-        */
-       static String hashKey(String key, String random) {
-               return StringUtils.getMd5Hash(key + " <==> " + random);
-       }
 }