Merge branch 'subtree'
[fanfix.git] / src / be / nikiroo / fanfix / library / RemoteLibraryServer.java
index 0893746239292297aeb1091aa51780351288b749..f92c37e8e2ecaf6a1b7604d6b0c914a56b03131a 100644 (file)
@@ -4,11 +4,14 @@ import java.io.IOException;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import javax.net.ssl.SSLException;
 
 import be.nikiroo.fanfix.Instance;
+import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.data.Chapter;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Paragraph;
@@ -16,6 +19,7 @@ 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;
 
@@ -25,8 +29,12 @@ import be.nikiroo.utils.serial.server.ServerObject;
  * The available commands are given as arrays of objects (first item is the
  * command, the rest are the arguments).
  * <p>
+ * All the commands are always prefixed by the subkey (which can be EMPTY if
+ * none).
+ * <p>
  * <ul>
- * <li>PING: will return PONG if the key is accepted</li>
+ * <li>PING: will return the mode if the key is accepted (mode can be: "r/o" or
+ * "r/w")</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>
@@ -50,9 +58,17 @@ import be.nikiroo.utils.serial.server.ServerObject;
  * @author niki
  */
 public class RemoteLibraryServer extends ServerObject {
+       private Map<Long, String> commands = new HashMap<Long, String>();
+       private Map<Long, Long> times = new HashMap<Long, Long>();
+       private Map<Long, Boolean> wls = new HashMap<Long, Boolean>();
+       private Map<Long, Boolean> rws = new HashMap<Long, Boolean>();
+
        /**
         * Create a new remote server (will not be active until
         * {@link RemoteLibraryServer#start()} is called).
+        * <p>
+        * Note: the key we use here is the encryption key (it must not contain a
+        * subkey).
         * 
         * @param key
         *            the key that will restrict access to this server
@@ -64,88 +80,184 @@ public class RemoteLibraryServer extends ServerObject {
         */
        public RemoteLibraryServer(String key, int port) throws IOException {
                super("Fanfix remote library", port, key);
-               setTraceHandler(Instance.getTraceHandler());
+               setTraceHandler(Instance.getInstance().getTraceHandler());
        }
 
        @Override
-       protected Object onRequest(ConnectActionServerObject action, Object data)
-                       throws Exception {
+       protected Object onRequest(ConnectActionServerObject action,
+                       Version clientVersion, Object data, long id) throws Exception {
                long start = new Date().getTime();
 
+               // defaults are positive (as previous versions without the feature)
+               boolean rw = true;
+               boolean wl = true;
+
+               String subkey = "";
                String command = "";
                Object[] args = new Object[0];
                if (data instanceof Object[]) {
                        Object[] dataArray = (Object[]) data;
                        if (dataArray.length > 0) {
-                               command = "" + dataArray[0];
+                               subkey = "" + dataArray[0];
+                       }
+                       if (dataArray.length > 1) {
+                               command = "" + dataArray[1];
 
-                               args = new Object[dataArray.length - 1];
-                               for (int i = 1; i < dataArray.length; i++) {
-                                       args[i - 1] = dataArray[i];
+                               args = new Object[dataArray.length - 2];
+                               for (int i = 2; i < dataArray.length; i++) {
+                                       args[i - 2] = dataArray[i];
                                }
                        }
                }
 
-               String trace = "[ " + command + "] ";
+               List<String> whitelist = Instance.getInstance().getConfig().getList(Config.SERVER_WHITELIST);
+               if (whitelist == null) {
+                       whitelist = new ArrayList<String>();
+               }
+
+               if (whitelist.isEmpty()) {
+                       wl = false;
+               }
+
+               rw = Instance.getInstance().getConfig().getBoolean(Config.SERVER_RW, rw);
+               if (!subkey.isEmpty()) {
+                       List<String> allowed = Instance.getInstance().getConfig().getList(Config.SERVER_ALLOWED_SUBKEYS);
+                       if (allowed.contains(subkey)) {
+                               if ((subkey + "|").contains("|rw|")) {
+                                       rw = true;
+                               }
+                               if ((subkey + "|").contains("|wl|")) {
+                                       wl = false; // |wl| = bypass whitelist
+                                       whitelist = new ArrayList<String>();
+                               }
+                       }
+               }
+
+               String mode = display(wl, rw);
+
+               String trace = mode + "[ " + command + "] ";
                for (Object arg : args) {
                        trace += arg + " ";
                }
-               System.out.println(trace);
-
-               Object rep = doRequest(action, command, args);
+               long now = System.currentTimeMillis();
+               System.out.println(StringUtils.fromTime(now) + ": " + trace);
+
+               Object rep = null;
+               try {
+                       rep = doRequest(action, command, args, rw, whitelist);
+               } catch (IOException e) {
+                       rep = new RemoteLibraryException(e, true);
+               }
 
-               String rec = StringUtils.formatNumber(action.getBytesReceived()) + "b";
-               String sent = StringUtils.formatNumber(action.getBytesSent()) + "b";
-               System.out.println(String.format("[>%s]: (%s sent, %s rec) in %d ms",
-                               command, sent, rec, (new Date().getTime() - start)));
+               commands.put(id, command);
+               wls.put(id, wl);
+               rws.put(id, rw);
+               times.put(id, (new Date().getTime() - start));
 
                return rep;
        }
 
+       private String display(boolean whitelist, boolean rw) {
+               String mode = "";
+               if (!rw) {
+                       mode += "RO: ";
+               }
+               if (whitelist) {
+                       mode += "WL: ";
+               }
+
+               return mode;
+       }
+
+       @Override
+       protected void onRequestDone(long id, long bytesReceived, long bytesSent) {
+               boolean whitelist = wls.get(id);
+               boolean rw = rws.get(id);
+               wls.remove(id);
+               rws.remove(id);
+
+               String rec = StringUtils.formatNumber(bytesReceived) + "b";
+               String sent = StringUtils.formatNumber(bytesSent) + "b";
+               long now = System.currentTimeMillis();
+               System.out.println(StringUtils.fromTime(now)
+                               + ": "
+                               + String.format("%s[>%s]: (%s sent, %s rec) in %d ms",
+                                               display(whitelist, rw), commands.get(id), sent, rec,
+                                               times.get(id)));
+
+               commands.remove(id);
+               times.remove(id);
+       }
+
        private Object doRequest(ConnectActionServerObject action, String command,
-                       Object[] args) throws NoSuchFieldException, NoSuchMethodException,
+                       Object[] args, boolean rw, List<String> whitelist)
+                       throws NoSuchFieldException, NoSuchMethodException,
                        ClassNotFoundException, IOException {
                if ("PING".equals(command)) {
-                       return "PONG";
+                       return rw ? "r/w" : "r/o";
                } else if ("GET_METADATA".equals(command)) {
+                       List<MetaData> metas = new ArrayList<MetaData>();
+
                        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);
+                               for (MetaData meta : Instance.getInstance().getLibrary().getMetas(pg)) {
+                                       metas.add(removeCover(meta));
                                }
 
                                forcePgDoneSent(pg);
-                               return metas.toArray(new MetaData[] {});
+                       } else {
+                               MetaData meta = Instance.getInstance().getLibrary().getInfo((String) args[0]);
+                               MetaData light;
+                               if (meta.getCover() == null) {
+                                       light = meta;
+                               } else {
+                                       light = meta.clone();
+                                       light.setCover(null);
+                               }
+
+                               metas.add(light);
                        }
 
-                       return new MetaData[] { Instance.getLibrary().getInfo(
-                                       (String) args[0]) };
+                       if (!whitelist.isEmpty()) {
+                               for (int i = 0; i < metas.size(); i++) {
+                                       if (!whitelist.contains(metas.get(i).getSource())) {
+                                               metas.remove(i);
+                                               i--;
+                                       }
+                               }
+                       }
+
+                       return metas.toArray(new MetaData[0]);
                } else if ("GET_STORY".equals(command)) {
-                       MetaData meta = Instance.getLibrary().getInfo((String) args[0]);
+                       MetaData meta = Instance.getInstance().getLibrary().getInfo((String) args[0]);
+                       if (meta == null) {
+                               return null;
+                       }
+
+                       if (!whitelist.isEmpty()) {
+                               if (!whitelist.contains(meta.getSource())) {
+                                       return null;
+                               }
+                       }
+
                        meta = meta.clone();
                        meta.setCover(null);
 
                        action.send(meta);
                        action.rec();
 
-                       Story story = Instance.getLibrary()
-                                       .getStory((String) args[0], null);
+                       Story story = Instance.getInstance().getLibrary().getStory((String) args[0], null);
                        for (Object obj : breakStory(story)) {
                                action.send(obj);
                                action.rec();
                        }
                } else if ("SAVE_STORY".equals(command)) {
+                       if (!rw) {
+                               throw new RemoteLibraryException("Read-Only remote library: "
+                                               + args[0], false);
+                       }
+
                        List<Object> list = new ArrayList<Object>();
 
                        action.send(null);
@@ -157,43 +269,62 @@ public class RemoteLibraryServer extends ServerObject {
                        }
 
                        Story story = rebuildStory(list);
-                       Instance.getLibrary().save(story, (String) args[0], null);
+                       Instance.getInstance().getLibrary().save(story, (String) args[0], null);
                        return story.getMeta().getLuid();
                } else if ("IMPORT".equals(command)) {
+                       if (!rw) {
+                               throw new RemoteLibraryException("Read-Only remote library: "
+                                               + args[0], false);
+                       }
+
                        Progress pg = createPgForwarder(action);
-                       Story story = Instance.getLibrary().imprt(
-                                       new URL((String) args[0]), pg);
+                       MetaData meta = Instance.getInstance().getLibrary().imprt(new URL((String) args[0]), pg);
                        forcePgDoneSent(pg);
-                       return story.getMeta().getLuid();
+                       return meta.getLuid();
                } else if ("DELETE_STORY".equals(command)) {
-                       Instance.getLibrary().delete((String) args[0]);
+                       if (!rw) {
+                               throw new RemoteLibraryException("Read-Only remote library: "
+                                               + args[0], false);
+                       }
+
+                       Instance.getInstance().getLibrary().delete((String) args[0]);
                } else if ("GET_COVER".equals(command)) {
-                       return Instance.getLibrary().getCover((String) args[0]);
+                       return Instance.getInstance().getLibrary().getCover((String) args[0]);
                } else if ("GET_CUSTOM_COVER".equals(command)) {
                        if ("SOURCE".equals(args[0])) {
-                               return Instance.getLibrary().getCustomSourceCover(
-                                               (String) args[1]);
+                               return Instance.getInstance().getLibrary().getCustomSourceCover((String) args[1]);
                        } else if ("AUTHOR".equals(args[0])) {
-                               return Instance.getLibrary().getCustomAuthorCover(
-                                               (String) args[1]);
+                               return Instance.getInstance().getLibrary().getCustomAuthorCover((String) args[1]);
                        } else {
                                return null;
                        }
                } else if ("SET_COVER".equals(command)) {
+                       if (!rw) {
+                               throw new RemoteLibraryException("Read-Only remote library: "
+                                               + args[0] + ", " + args[1], false);
+                       }
+
                        if ("SOURCE".equals(args[0])) {
-                               Instance.getLibrary().setSourceCover((String) args[1],
-                                               (String) args[2]);
+                               Instance.getInstance().getLibrary().setSourceCover((String) args[1], (String) args[2]);
                        } else if ("AUTHOR".equals(args[0])) {
-                               Instance.getLibrary().setAuthorCover((String) args[1],
-                                               (String) args[2]);
+                               Instance.getInstance().getLibrary().setAuthorCover((String) args[1], (String) args[2]);
                        }
                } else if ("CHANGE_STA".equals(command)) {
+                       if (!rw) {
+                               throw new RemoteLibraryException("Read-Only remote library: " + args[0] + ", " + args[1], false);
+                       }
+
                        Progress pg = createPgForwarder(action);
-                       Instance.getLibrary().changeSTA((String) args[0], (String) args[1],
-                                       (String) args[2], (String) args[3], pg);
+                       Instance.getInstance().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);
+                       if (!rw) {
+                               throw new RemoteLibraryException(
+                                               "Read-Only remote library: EXIT", false);
+                       }
+
+                       stop(10000, false);
                }
 
                return null;
@@ -202,7 +333,9 @@ public class RemoteLibraryServer extends ServerObject {
        @Override
        protected void onError(Exception e) {
                if (e instanceof SSLException) {
-                       System.out.println("[Client connection refused (bad key)]");
+                       long now = System.currentTimeMillis();
+                       System.out.println(StringUtils.fromTime(now) + ": "
+                                       + "[Client connection refused (bad key)]");
                } else {
                        getTraceHandler().error(e);
                }
@@ -272,19 +405,45 @@ public class RemoteLibraryServer extends ServerObject {
         * @return TRUE if it was a progress event, FALSE if not
         */
        static boolean updateProgress(Progress pg, Object rep) {
-               if (rep instanceof Integer[]) {
-                       Integer[] a = (Integer[]) rep;
-                       if (a.length == 3) {
-                               int min = a[0];
-                               int max = a[1];
-                               int progress = a[2];
-
-                               if (min >= 0 && min <= max) {
-                                       pg.setMinMax(min, max);
-                                       pg.setProgress(progress);
-
-                                       return true;
+               boolean updateProgress = false;
+               if (rep instanceof Integer[] && ((Integer[]) rep).length == 3)
+                       updateProgress = true;
+               if (rep instanceof Object[] && ((Object[]) rep).length >= 5
+                               && "UPDATE".equals(((Object[]) rep)[0]))
+                       updateProgress = true;
+
+               if (updateProgress) {
+                       Object[] a = (Object[]) rep;
+
+                       int offset = 0;
+                       if (a[0] instanceof String) {
+                               offset = 1;
+                       }
+
+                       int min = (Integer) a[0 + offset];
+                       int max = (Integer) a[1 + offset];
+                       int progress = (Integer) a[2 + offset];
+                       
+                       Object meta = null;
+                       if (a.length > (3 + offset)) {
+                               meta = a[3 + offset];
+                       }
+                       
+                       String name = null;
+                       if (a.length > (4 + offset)) {
+                               name = a[4 + offset] == null ? "" : a[4 + offset].toString();
+                       }
+                       
+
+                       if (min >= 0 && min <= max) {
+                               pg.setName(name);
+                               pg.setMinMax(min, max);
+                               pg.setProgress(progress);
+                               if (meta != null) {
+                                       pg.put("meta", meta);
                                }
+
+                               return true;
                        }
                }
 
@@ -310,27 +469,40 @@ public class RemoteLibraryServer extends ServerObject {
                };
 
                final Integer[] p = new Integer[] { -1, -1, -1 };
+               final Object[] pMeta = new MetaData[1];
+               final String[] pName = new String[1];
                final Long[] lastTime = new Long[] { new Date().getTime() };
                pg.addProgressListener(new ProgressListener() {
                        @Override
                        public void progress(Progress progress, String name) {
+                               Object meta = pg.get("meta");
+                               if (meta instanceof MetaData) {
+                                       meta = removeCover((MetaData)meta);
+                               }
+                               
                                int min = pg.getMin();
                                int max = pg.getMax();
-                               int relativeProgress = min
+                               int rel = min
                                                + (int) Math.round(pg.getRelativeProgress()
                                                                * (max - min));
-
+                               
+                               boolean samePg = p[0] == min && p[1] == max && p[2] == rel;
+                               
                                // 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)
+                               if (!samePg || !same(pMeta[0], meta)
+                                               || !same(pName[0], name) //
                                                || (new Date().getTime() - lastTime[0] > 2000)) {
                                        p[0] = min;
                                        p[1] = max;
-                                       p[2] = relativeProgress;
+                                       p[2] = rel;
+                                       pMeta[0] = meta;
+                                       pName[0] = name;
 
                                        try {
-                                               action.send(new Integer[] { min, max, relativeProgress });
+                                               action.send(new Object[] { "UPDATE", min, max, rel,
+                                                               meta, name });
                                                action.rec();
                                        } catch (Exception e) {
                                                getTraceHandler().error(e);
@@ -345,6 +517,13 @@ public class RemoteLibraryServer extends ServerObject {
 
                return pg;
        }
+       
+       private boolean same(Object obj1, Object obj2) {
+               if (obj1 == null || obj2 == null)
+                       return obj1 == null && obj2 == null;
+
+               return obj1.equals(obj2);
+       }
 
        // with 30 seconds timeout
        private void forcePgDoneSent(Progress pg) {
@@ -358,4 +537,18 @@ public class RemoteLibraryServer extends ServerObject {
                        }
                }
        }
+       
+       private MetaData removeCover(MetaData meta) {
+               MetaData light = null;
+               if (meta != null) {
+                       if (meta.getCover() == null) {
+                               light = meta;
+                       } else {
+                               light = meta.clone();
+                               light.setCover(null);
+                       }
+               }
+               
+               return light;
+       }
 }