X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Flibrary%2FRemoteLibraryServer.java;h=c150a01b6f8a14f68279fc4bb7358f3374a85e10;hb=f433d15308b70e23280a65cef8c54002a7a971ce;hp=84d763fce51f5c4ad97cfd1fda07d41dee71845c;hpb=416c54f8bf5f60e2f8d7981e24fdd613fb9246f1;p=nikiroo-utils.git diff --git a/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java b/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java index 84d763f..c150a01 100644 --- a/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java +++ b/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java @@ -1,11 +1,17 @@ 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.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; @@ -18,107 +24,240 @@ 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. + *

+ * The available commands are given as arrays of objects (first item is the + * command, the rest are the arguments). *

- * The available commands are given as arrays of objects (first item is the key, - * second is the command, the rest are the arguments). + * All the commands are always prefixed by the subkey (which can be EMPTY if + * none). *

- * The md5 is always a String (the MD5 hash of the access key), the commands are - * also Strings; the parameters vary depending upon the command. *

* * @author niki */ public class RemoteLibraryServer extends ServerObject { - private final String md5; + private Map commands = new HashMap(); + private Map times = new HashMap(); + private Map wls = new HashMap(); + private Map rws = new HashMap(); /** * Create a new remote server (will not be active until * {@link RemoteLibraryServer#start()} is called). - * - * @param key - * the key that will restrict access to this server - * @param port - * the port to listen on + *

+ * Note: the key we use here is the encryption key (it must not contain a + * subkey). * * @throws IOException * in case of I/O error */ - public RemoteLibraryServer(String key, int port) throws IOException { - super("Fanfix remote library", port, true); - this.md5 = StringUtils.getMd5Hash(key); - - setTraceHandler(Instance.getTraceHandler()); + public RemoteLibraryServer() throws IOException { + super("Fanfix remote library", + Instance.getInstance().getConfig() + .getInteger(Config.SERVER_PORT), + Instance.getInstance().getConfig() + .getString(Config.SERVER_KEY)); + + setTraceHandler(Instance.getInstance().getTraceHandler()); } @Override protected Object onRequest(ConnectActionServerObject action, - Version clientVersion, Object data) throws Exception { - String md5 = ""; + 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 >= 2) { + if (dataArray.length > 0) { + subkey = "" + dataArray[0]; + } + if (dataArray.length > 1) { + command = "" + dataArray[1]; + args = new Object[dataArray.length - 2]; for (int i = 2; i < dataArray.length; i++) { args[i - 2] = dataArray[i]; } + } + } - md5 = "" + dataArray[0]; - command = "" + dataArray[1]; + List whitelist = Instance.getInstance().getConfig().getList(Config.SERVER_WHITELIST); + if (whitelist == null) { + whitelist = new ArrayList(); + } + + if (whitelist.isEmpty()) { + wl = false; + } + + rw = Instance.getInstance().getConfig().getBoolean(Config.SERVER_RW, rw); + if (!subkey.isEmpty()) { + List 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 trace = "[" + command + "] "; + String mode = display(wl, rw); + + String trace = mode + "[ " + command + "] "; for (Object arg : args) { trace += arg + " "; } - getTraceHandler().trace(trace); + 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); + } + + commands.put(id, command); + wls.put(id, wl); + rws.put(id, rw); + times.put(id, (new Date().getTime() - start)); - if (!md5.equals(this.md5)) { - getTraceHandler().trace("Key rejected."); - return null; + 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, boolean rw, List whitelist) + throws NoSuchFieldException, NoSuchMethodException, + ClassNotFoundException, IOException { if ("PING".equals(command)) { - return "PONG"; + return rw ? "r/w" : "r/o"; } else if ("GET_METADATA".equals(command)) { - if (args[0].equals("*")) { - List metas = Instance.getLibrary().getMetas( - createPgForwarder(action)); - return metas.toArray(new MetaData[] {}); + List metas = new ArrayList(); + + if ("*".equals(args[0])) { + Progress pg = createPgForwarder(action); + + for (MetaData meta : Instance.getInstance().getLibrary().getMetas(pg)) { + metas.add(removeCover(meta)); + } + + forcePgDoneSent(pg); + } 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); } - throw new InvalidParameterException( - "only * is valid here, but you passed: " + 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("" + 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("" + 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 list = new ArrayList(); action.send(null); @@ -130,17 +269,62 @@ public class RemoteLibraryServer extends ServerObject { } Story story = rebuildStory(list); - Instance.getLibrary().save(story, "" + args[1], 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); + MetaData meta = Instance.getInstance().getLibrary().imprt(new URL((String) args[0]), pg); + forcePgDoneSent(pg); + return meta.getLuid(); } else if ("DELETE_STORY".equals(command)) { - Instance.getLibrary().delete("" + 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("" + 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.getInstance().getLibrary().getCover((String) args[0]); + } else if ("GET_CUSTOM_COVER".equals(command)) { + if ("SOURCE".equals(args[0])) { + return Instance.getInstance().getLibrary().getCustomSourceCover((String) args[1]); + } else if ("AUTHOR".equals(args[0])) { + 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.getInstance().getLibrary().setSourceCover((String) args[1], (String) args[2]); + } else if ("AUTHOR".equals(args[0])) { + 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.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; @@ -148,7 +332,13 @@ public class RemoteLibraryServer extends ServerObject { @Override protected void onError(Exception e) { - getTraceHandler().error(e); + if (e instanceof SSLException) { + long now = System.currentTimeMillis(); + System.out.println(StringUtils.fromTime(now) + ": " + + "[Client connection refused (bad key)]"); + } else { + getTraceHandler().error(e); + } } /** @@ -215,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; } } @@ -243,35 +459,96 @@ public class RemoteLibraryServer extends ServerObject { * * @return the {@link Progress} */ - private static Progress createPgForwarder( - final ConnectActionServerObject action) { - final Progress pg = new Progress(); + private Progress createPgForwarder(final ConnectActionServerObject action) { + 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 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)); - - // Do not re-send the same value twice over the wire - if (p[0] != min || p[1] != max || p[2] != relativeProgress) { + + 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 (!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) { - Instance.getTraceHandler().error(e); + getTraceHandler().error(e); } + + lastTime[0] = new Date().getTime(); } + + isDoneForwarded[0] = (pg.getProgress() >= pg.getMax()); } }); 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) { + long start = new Date().getTime(); + pg.done(); + while (!pg.isDone() && new Date().getTime() - start < 30000) { + try { + Thread.sleep(100); + } catch (InterruptedException e) { + getTraceHandler().error(e); + } + } + } + + 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; + } }