import java.io.IOException;
import java.security.InvalidParameterException;
+import java.util.ArrayList;
import java.util.List;
import be.nikiroo.fanfix.Instance;
+import be.nikiroo.fanfix.data.Chapter;
import be.nikiroo.fanfix.data.MetaData;
+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.Version;
import be.nikiroo.utils.serial.server.ConnectActionServerObject;
import be.nikiroo.utils.serial.server.ServerObject;
* The key is always a String, the commands are also Strings; the parameters
* vary depending upon the command.
* <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 [story] [luid]: save the story with the given LUID</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>
* in case of I/O error
*/
public RemoteLibraryServer(String key, int port) throws IOException {
- super(port, true);
+ super("Fanfix remote library", port, true);
this.key = key;
+
+ setTraceHandler(Instance.getTraceHandler());
}
@Override
}
}
- System.out.print("[" + command + "] ");
+ String trace = "[" + command + "] ";
for (Object arg : args) {
- System.out.print(arg + " ");
+ trace += arg + " ";
}
- System.out.println("");
+ getTraceHandler().trace(trace);
if (!key.equals(this.key)) {
- System.out.println("Key rejected.");
- throw new SecurityException("Invalid key");
+ getTraceHandler().trace("Key rejected.");
+ return null;
}
- // TODO: progress (+send name + %age info back to client)
-
- if ("GET_METADATA".equals(command)) {
+ if ("PING".equals(command)) {
+ return "PONG";
+ } else if ("GET_METADATA".equals(command)) {
if (args[0].equals("*")) {
- List<MetaData> metas = Instance.getLibrary().getMetas(null);
+ List<MetaData> metas = Instance.getLibrary().getMetas(
+ createPgForwarder(action));
return metas.toArray(new MetaData[] {});
}
throw new InvalidParameterException(
"only * is valid here, but you passed: " + args[0]);
} else if ("GET_STORY".equals(command)) {
- return Instance.getLibrary().getStory("" + args[0], null);
+ MetaData meta = Instance.getLibrary().getInfo("" + args[0]);
+ meta = meta.clone();
+ meta.setCover(null);
+
+ action.send(meta);
+ action.rec();
+
+ Story story = Instance.getLibrary().getStory("" + args[0], null);
+ for (Object obj : breakStory(story)) {
+ action.send(obj);
+ action.rec();
+ }
} else if ("SAVE_STORY".equals(command)) {
- Instance.getLibrary().save((Story) args[0], "" + args[1], null);
+ List<Object> list = new ArrayList<Object>();
+
+ action.send(null);
+ Object obj = action.rec();
+ while (obj != null) {
+ list.add(obj);
+ action.send(null);
+ obj = action.rec();
+ }
+
+ Story story = rebuildStory(list);
+ Instance.getLibrary().save(story, "" + args[1], null);
} else if ("DELETE_STORY".equals(command)) {
Instance.getLibrary().delete("" + args[0]);
} else if ("GET_COVER".equals(command)) {
return null;
}
+
+ @Override
+ protected void onError(Exception e) {
+ getTraceHandler().error(e);
+ }
+
+ /**
+ * Break a story in multiple {@link Object}s for easier serialisation.
+ *
+ * @param story
+ * the {@link Story} to break
+ *
+ * @return the list of {@link Object}s
+ */
+ static List<Object> breakStory(Story story) {
+ List<Object> list = new ArrayList<Object>();
+
+ story = story.clone();
+ list.add(story);
+
+ if (story.getMeta().isImageDocument()) {
+ for (Chapter chap : story) {
+ list.add(chap);
+ list.addAll(chap.getParagraphs());
+ chap.setParagraphs(new ArrayList<Paragraph>());
+ }
+ story.setChapters(new ArrayList<Chapter>());
+ }
+
+ return list;
+ }
+
+ /**
+ * Rebuild a story from a list of broke up {@link Story} parts.
+ *
+ * @param list
+ * the list of {@link Story} parts
+ *
+ * @return the reconstructed {@link Story}
+ */
+ static Story rebuildStory(List<Object> list) {
+ Story story = null;
+ Chapter chap = null;
+
+ for (Object obj : list) {
+ if (obj instanceof Story) {
+ story = (Story) obj;
+ } else if (obj instanceof Chapter) {
+ chap = (Chapter) obj;
+ story.getChapters().add(chap);
+ } else if (obj instanceof Paragraph) {
+ chap.getParagraphs().add((Paragraph) obj);
+ }
+ }
+
+ return story;
+ }
+
+ /**
+ * Update the {@link Progress} with the adequate {@link Object} received
+ * from the network via {@link RemoteLibraryServer}.
+ *
+ * @param pg
+ * the {@link Progress} to update
+ * @param rep
+ * the object received from the network
+ *
+ * @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;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Create a {@link Progress} that will forward its progress over the
+ * network.
+ *
+ * @param action
+ * the {@link ConnectActionServerObject} to use to forward it
+ *
+ * @return the {@link Progress}
+ */
+ private static Progress createPgForwarder(
+ final ConnectActionServerObject action) {
+ final Progress pg = new Progress();
+ final Integer[] p = new Integer[] { -1, -1, -1 };
+ 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));
+
+ // Do not re-send the same value twice over the wire
+ if (p[0] != min || p[1] != max || p[2] != relativeProgress) {
+ p[0] = min;
+ p[1] = max;
+ p[2] = relativeProgress;
+
+ try {
+ action.send(new Integer[] { min, max, relativeProgress });
+ action.rec();
+ } catch (Exception e) {
+ Instance.getTraceHandler().error(e);
+ }
+ }
+ }
+ });
+
+ return pg;
+ }
}