remote server -> plain text
[fanfix.git] / src / be / nikiroo / fanfix / library / RemoteLibraryServer.java
index b95c50f84f490134a12a8d8592b599a429b99d76..d62b41b0283e5b2fe49abe2a47059e98ce8e6bca 100644 (file)
@@ -1,8 +1,9 @@
 package be.nikiroo.fanfix.library;
 
 import java.io.IOException;
-import java.security.InvalidParameterException;
+import java.net.URL;
 import java.util.ArrayList;
+import java.util.Date;
 import java.util.List;
 
 import be.nikiroo.fanfix.Instance;
@@ -12,32 +13,47 @@ import be.nikiroo.fanfix.data.Paragraph;
 import be.nikiroo.fanfix.data.Story;
 import be.nikiroo.utils.Progress;
 import be.nikiroo.utils.Progress.ProgressListener;
+import be.nikiroo.utils.StringUtils;
 import be.nikiroo.utils.Version;
 import be.nikiroo.utils.serial.server.ConnectActionServerObject;
 import be.nikiroo.utils.serial.server.ServerObject;
 
 /**
- * Create a new remote server that will listen for order on the given port.
+ * Create a new remote server that will listen for orders on the given port.
  * <p>
- * The available commands are given as arrays of objects (first item is the key,
- * second is the command, the rest are the arguments).
+ * The available commands are given as arrays of objects (first item is the
+ * command, the rest are the arguments).
  * <p>
- * The key is always a String, the commands are also Strings; the parameters
- * vary depending upon the command.
+ * All commands, including PING, will first return a random value to you that
+ * you must hash with your key and return before processing the rest; if the
+ * value is OK, it will return "true", if not, it will return NULL and stop the
+ * connection.
+ * <p>
+ * BTW: this system <b>is by no means secure</b>. It is just slightly
+ * obfuscated, and operate on clear text (because Google decided not to support
+ * anonymous SSL exchanges on Android, and the main use case for this server is
+ * Android).
  * <ul>
- * <li>[key] PING: will return PONG if the key is accepted</li>
- * <li>[key] GET_METADATA *: will return the metadata of all the stories in the
- * library</li>
- * <li>[key] GET_STORY [luid]: will return the given story if it exists (or NULL
- * if not)</li>
- * <li>[key] SAVE_STORY [luid]: save the story (that must be sent just after the
- * command) with the given LUID</li>
- * <li>[key] DELETE_STORY [luid]: delete the story of LUID luid</li>
- * <li>[key] GET_COVER [luid]: return the cover of the story</li>
- * <li>[key] GET_SOURCE_COVER [source]: return the cover for this source</li>
- * <li>[key] SET_SOURCE_COVER [source], [luid]: set the default cover for the
- * given source to the cover of the story denoted by luid</li>
- * <li>[key] EXIT: stop the server</li>
+ * <li>PING: will return PONG if the key is accepted</li>
+ * <li>GET_METADATA *: will return the metadata of all the stories in the
+ * library (array)</li> *
+ * <li>GET_METADATA [luid]: will return the metadata of the story of LUID
+ * luid</li>
+ * <li>GET_STORY [luid]: will return the given story if it exists (or NULL if
+ * not)</li>
+ * <li>SAVE_STORY [luid]: save the story (that must be sent just after the
+ * command) with the given LUID, then return the LUID</li>
+ * <li>IMPORT [url]: save the story found at the given URL, then return the
+ * LUID</li>
+ * <li>DELETE_STORY [luid]: delete the story of LUID luid</li>
+ * <li>GET_COVER [luid]: return the cover of the story</li>
+ * <li>GET_CUSTOM_COVER ["SOURCE"|"AUTHOR"] [source]: return the cover for this
+ * source/author</li>
+ * <li>SET_COVER ["SOURCE"|"AUTHOR"] [value] [luid]: set the default cover for
+ * the given source/author to the cover of the story denoted by luid</li>
+ * <li>CHANGE_SOURCE [luid] [new source]: change the source of the story of LUID
+ * luid</li>
+ * <li>EXIT: stop the server</li>
  * </ul>
  * 
  * @author niki
@@ -58,7 +74,7 @@ public class RemoteLibraryServer extends ServerObject {
         *             in case of I/O error
         */
        public RemoteLibraryServer(String key, int port) throws IOException {
-               super("Fanfix remote library", port, true);
+               super("Fanfix remote library", port, false);
                this.key = key;
 
                setTraceHandler(Instance.getTraceHandler());
@@ -67,52 +83,92 @@ public class RemoteLibraryServer extends ServerObject {
        @Override
        protected Object onRequest(ConnectActionServerObject action,
                        Version clientVersion, Object data) throws Exception {
-               String key = "";
+               long start = new Date().getTime();
+
                String command = "";
                Object[] args = new Object[0];
                if (data instanceof Object[]) {
                        Object[] dataArray = (Object[]) data;
                        if (dataArray.length >= 2) {
-                               args = new Object[dataArray.length - 2];
-                               for (int i = 2; i < dataArray.length; i++) {
-                                       args[i - 2] = dataArray[i];
-                               }
+                               command = "" + dataArray[0];
 
-                               key = "" + dataArray[0];
-                               command = "" + dataArray[1];
+                               args = new Object[dataArray.length - 1];
+                               for (int i = 1; i < dataArray.length; i++) {
+                                       args[i - 1] = dataArray[i];
+                               }
                        }
                }
 
-               String trace = "[" + command + "] ";
+               String trace = "[ " + command + "] ";
                for (Object arg : args) {
                        trace += arg + " ";
                }
                getTraceHandler().trace(trace);
 
-               if (!key.equals(this.key)) {
+               // Authentication:
+               String random = StringUtils.getMd5Hash(Double.toString(Math.random()));
+               action.send(random);
+               String answer = "";
+               try {
+                       answer += action.rec();
+               } catch (NullPointerException e) {
+                       return null;
+               }
+
+               if (answer.equals(RemoteLibrary.hashKey(key, random))) {
+                       action.send(true);
+               } else {
                        getTraceHandler().trace("Key rejected.");
                        return null;
                }
 
+               Object rep = doRequest(action, command, args);
+
+               getTraceHandler().trace(String.format("[>%s]: %d ms", command,
+                               (new Date().getTime() - start)));
+
+               return rep;
+       }
+
+       private Object doRequest(ConnectActionServerObject action, String command,
+                       Object[] args) throws NoSuchFieldException, NoSuchMethodException,
+                       ClassNotFoundException, IOException {
                if ("PING".equals(command)) {
                        return "PONG";
                } else if ("GET_METADATA".equals(command)) {
-                       if (args[0].equals("*")) {
-                               List<MetaData> metas = Instance.getLibrary().getMetas(
-                                               createPgForwarder(action));
+                       if ("*".equals(args[0])) {
+                               Progress pg = createPgForwarder(action);
+
+                               List<MetaData> metas = new ArrayList<MetaData>();
+
+                               for (MetaData meta : Instance.getLibrary().getMetas(pg)) {
+                                       MetaData light;
+                                       if (meta.getCover() == null) {
+                                               light = meta;
+                                       } else {
+                                               light = meta.clone();
+                                               light.setCover(null);
+                                       }
+
+                                       metas.add(light);
+                               }
+
+                               forcePgDoneSent(pg);
                                return metas.toArray(new MetaData[] {});
                        }
-                       throw new InvalidParameterException(
-                                       "only * is valid here, but you passed: " + args[0]);
+
+                       return new MetaData[] {
+                                       Instance.getLibrary().getInfo((String) args[0]) };
                } else if ("GET_STORY".equals(command)) {
-                       MetaData meta = Instance.getLibrary().getInfo("" + args[0]);
+                       MetaData meta = Instance.getLibrary().getInfo((String) args[0]);
                        meta = meta.clone();
                        meta.setCover(null);
 
                        action.send(meta);
                        action.rec();
 
-                       Story story = Instance.getLibrary().getStory("" + args[0], null);
+                       Story story = Instance.getLibrary().getStory((String) args[0],
+                                       null);
                        for (Object obj : breakStory(story)) {
                                action.send(obj);
                                action.rec();
@@ -129,15 +185,41 @@ public class RemoteLibraryServer extends ServerObject {
                        }
 
                        Story story = rebuildStory(list);
-                       Instance.getLibrary().save(story, "" + args[1], null);
+                       Instance.getLibrary().save(story, (String) args[0], null);
+                       return story.getMeta().getLuid();
+               } else if ("IMPORT".equals(command)) {
+                       Progress pg = createPgForwarder(action);
+                       Story story = Instance.getLibrary().imprt(new URL((String) args[0]),
+                                       pg);
+                       forcePgDoneSent(pg);
+                       return story.getMeta().getLuid();
                } else if ("DELETE_STORY".equals(command)) {
-                       Instance.getLibrary().delete("" + args[0]);
+                       Instance.getLibrary().delete((String) args[0]);
                } else if ("GET_COVER".equals(command)) {
-                       return Instance.getLibrary().getCover("" + args[0]);
-               } else if ("GET_SOURCE_COVER".equals(command)) {
-                       return Instance.getLibrary().getSourceCover("" + args[0]);
-               } else if ("SET_SOURCE_COVER".equals(command)) {
-                       Instance.getLibrary().setSourceCover("" + args[0], "" + args[1]);
+                       return Instance.getLibrary().getCover((String) args[0]);
+               } else if ("GET_CUSTOM_COVER".equals(command)) {
+                       if ("SOURCE".equals(args[0])) {
+                               return Instance.getLibrary()
+                                               .getCustomSourceCover((String) args[1]);
+                       } else if ("AUTHOR".equals(args[0])) {
+                               return Instance.getLibrary()
+                                               .getCustomAuthorCover((String) args[1]);
+                       } else {
+                               return null;
+                       }
+               } else if ("SET_COVER".equals(command)) {
+                       if ("SOURCE".equals(args[0])) {
+                               Instance.getLibrary().setSourceCover((String) args[1],
+                                               (String) args[2]);
+                       } else if ("AUTHOR".equals(args[0])) {
+                               Instance.getLibrary().setAuthorCover((String) args[1],
+                                               (String) args[2]);
+                       }
+               } else if ("CHANGE_STA".equals(command)) {
+                       Progress pg = createPgForwarder(action);
+                       Instance.getLibrary().changeSTA((String) args[0], (String) args[1],
+                                       (String) args[2], (String) args[3], pg);
+                       forcePgDoneSent(pg);
                } else if ("EXIT".equals(command)) {
                        stop(0, false);
                }
@@ -244,33 +326,61 @@ public class RemoteLibraryServer extends ServerObject {
         */
        private static Progress createPgForwarder(
                        final ConnectActionServerObject action) {
-               final Progress pg = new Progress();
+               final Boolean[] isDoneForwarded = new Boolean[] { false };
+               final Progress pg = new Progress() {
+                       @Override
+                       public boolean isDone() {
+                               return isDoneForwarded[0];
+                       }
+               };
+
                final Integer[] p = new Integer[] { -1, -1, -1 };
+               final Long[] lastTime = new Long[] { new Date().getTime() };
                pg.addProgressListener(new ProgressListener() {
                        @Override
                        public void progress(Progress progress, String name) {
                                int min = pg.getMin();
                                int max = pg.getMax();
-                               int relativeProgress = min
-                                               + (int) Math.round(pg.getRelativeProgress()
-                                                               * (max - min));
+                               int relativeProgress = min + (int) Math
+                                               .round(pg.getRelativeProgress() * (max - min));
 
-                               // Do not re-send the same value twice over the wire
-                               if (p[0] != min || p[1] != max || p[2] != relativeProgress) {
+                               // Do not re-send the same value twice over the wire,
+                               // unless more than 2 seconds have elapsed (to maintain the
+                               // connection)
+                               if ((p[0] != min || p[1] != max || p[2] != relativeProgress)
+                                               || (new Date().getTime() - lastTime[0] > 2000)) {
                                        p[0] = min;
                                        p[1] = max;
                                        p[2] = relativeProgress;
 
                                        try {
-                                               action.send(new Integer[] { min, max, relativeProgress });
+                                               action.send(
+                                                               new Integer[] { min, max, relativeProgress });
                                                action.rec();
                                        } catch (Exception e) {
                                                Instance.getTraceHandler().error(e);
                                        }
+
+                                       lastTime[0] = new Date().getTime();
                                }
+
+                               isDoneForwarded[0] = (pg.getProgress() >= pg.getMax());
                        }
                });
 
                return pg;
        }
+
+       // with 30 seconds timeout
+       private static void forcePgDoneSent(Progress pg) {
+               long start = new Date().getTime();
+               pg.done();
+               while (!pg.isDone() && new Date().getTime() - start < 30000) {
+                       try {
+                               Thread.sleep(100);
+                       } catch (InterruptedException e) {
+                               Instance.getTraceHandler().error(e);
+                       }
+               }
+       }
 }