Merge branch 'subtree'
[fanfix.git] / src / be / nikiroo / fanfix / library / RemoteLibraryServer.java
CommitLineData
e42573a0 1package be.nikiroo.fanfix.library;
b0e88ebd 2
b0e88ebd 3import java.io.IOException;
edf79e5e 4import java.net.URL;
74a40dfb 5import java.util.ArrayList;
9b863b20 6import java.util.Date;
9b558341 7import java.util.HashMap;
68e2c6d2 8import java.util.List;
9b558341 9import java.util.Map;
b0e88ebd 10
7e51d91c
NR
11import javax.net.ssl.SSLException;
12
e42573a0 13import be.nikiroo.fanfix.Instance;
fb25273c 14import be.nikiroo.fanfix.bundles.Config;
74a40dfb 15import be.nikiroo.fanfix.data.Chapter;
b0e88ebd 16import be.nikiroo.fanfix.data.MetaData;
74a40dfb 17import be.nikiroo.fanfix.data.Paragraph;
085a2f9a 18import be.nikiroo.fanfix.data.Story;
b9ce9cad
NR
19import be.nikiroo.utils.Progress;
20import be.nikiroo.utils.Progress.ProgressListener;
416c54f8 21import be.nikiroo.utils.StringUtils;
fb25273c 22import be.nikiroo.utils.Version;
62c63b07
NR
23import be.nikiroo.utils.serial.server.ConnectActionServerObject;
24import be.nikiroo.utils.serial.server.ServerObject;
b0e88ebd 25
a85e8077 26/**
ea734ab4 27 * Create a new remote server that will listen for orders on the given port.
a85e8077 28 * <p>
ea734ab4
N
29 * The available commands are given as arrays of objects (first item is the
30 * command, the rest are the arguments).
2a25f781 31 * <p>
fb25273c
NR
32 * All the commands are always prefixed by the subkey (which can be EMPTY if
33 * none).
34 * <p>
a85e8077 35 * <ul>
fb25273c
NR
36 * <li>PING: will return the mode if the key is accepted (mode can be: "r/o" or
37 * "r/w")</li>
ea734ab4
N
38 * <li>GET_METADATA *: will return the metadata of all the stories in the
39 * library (array)</li> *
37abe20c 40 * <li>GET_METADATA [luid]: will return the metadata of the story of LUID luid</li>
ea734ab4
N
41 * <li>GET_STORY [luid]: will return the given story if it exists (or NULL if
42 * not)</li>
43 * <li>SAVE_STORY [luid]: save the story (that must be sent just after the
0fa0fe95 44 * command) with the given LUID, then return the LUID</li>
37abe20c
NR
45 * <li>IMPORT [url]: save the story found at the given URL, then return the LUID
46 * </li>
ea734ab4
N
47 * <li>DELETE_STORY [luid]: delete the story of LUID luid</li>
48 * <li>GET_COVER [luid]: return the cover of the story</li>
49 * <li>GET_CUSTOM_COVER ["SOURCE"|"AUTHOR"] [source]: return the cover for this
50 * source/author</li>
51 * <li>SET_COVER ["SOURCE"|"AUTHOR"] [value] [luid]: set the default cover for
52 * the given source/author to the cover of the story denoted by luid</li>
53 * <li>CHANGE_SOURCE [luid] [new source]: change the source of the story of LUID
54 * luid</li>
55 * <li>EXIT: stop the server</li>
a85e8077
NR
56 * </ul>
57 *
58 * @author niki
59 */
62c63b07 60public class RemoteLibraryServer extends ServerObject {
9b558341
NR
61 private Map<Long, String> commands = new HashMap<Long, String>();
62 private Map<Long, Long> times = new HashMap<Long, Long>();
fb25273c
NR
63 private Map<Long, Boolean> wls = new HashMap<Long, Boolean>();
64 private Map<Long, Boolean> rws = new HashMap<Long, Boolean>();
9b558341 65
a85e8077
NR
66 /**
67 * Create a new remote server (will not be active until
68 * {@link RemoteLibraryServer#start()} is called).
fb25273c
NR
69 * <p>
70 * Note: the key we use here is the encryption key (it must not contain a
71 * subkey).
a85e8077 72 *
2070ced5
NR
73 * @param key
74 * the key that will restrict access to this server
a85e8077
NR
75 * @param port
76 * the port to listen on
77 *
78 * @throws IOException
79 * in case of I/O error
80 */
2070ced5 81 public RemoteLibraryServer(String key, int port) throws IOException {
3040c4f0 82 super("Fanfix remote library", port, key);
d66deb8d 83 setTraceHandler(Instance.getInstance().getTraceHandler());
b0e88ebd
NR
84 }
85
86 @Override
fb25273c
NR
87 protected Object onRequest(ConnectActionServerObject action,
88 Version clientVersion, Object data, long id) throws Exception {
ea734ab4
N
89 long start = new Date().getTime();
90
fb25273c
NR
91 // defaults are positive (as previous versions without the feature)
92 boolean rw = true;
93 boolean wl = true;
94
95 String subkey = "";
085a2f9a
NR
96 String command = "";
97 Object[] args = new Object[0];
98 if (data instanceof Object[]) {
2070ced5 99 Object[] dataArray = (Object[]) data;
27eba894 100 if (dataArray.length > 0) {
fb25273c
NR
101 subkey = "" + dataArray[0];
102 }
103 if (dataArray.length > 1) {
104 command = "" + dataArray[1];
105
106 args = new Object[dataArray.length - 2];
107 for (int i = 2; i < dataArray.length; i++) {
108 args[i - 2] = dataArray[i];
109 }
110 }
111 }
112
d66deb8d 113 List<String> whitelist = Instance.getInstance().getConfig().getList(Config.SERVER_WHITELIST);
fb25273c
NR
114 if (whitelist == null) {
115 whitelist = new ArrayList<String>();
116 }
117
118 if (whitelist.isEmpty()) {
119 wl = false;
120 }
edf79e5e 121
d66deb8d 122 rw = Instance.getInstance().getConfig().getBoolean(Config.SERVER_RW, rw);
fb25273c 123 if (!subkey.isEmpty()) {
d66deb8d 124 List<String> allowed = Instance.getInstance().getConfig().getList(Config.SERVER_ALLOWED_SUBKEYS);
fb25273c
NR
125 if (allowed.contains(subkey)) {
126 if ((subkey + "|").contains("|rw|")) {
127 rw = true;
128 }
129 if ((subkey + "|").contains("|wl|")) {
130 wl = false; // |wl| = bypass whitelist
651072f3 131 whitelist = new ArrayList<String>();
2070ced5 132 }
b0e88ebd
NR
133 }
134 }
135
fb25273c
NR
136 String mode = display(wl, rw);
137
138 String trace = mode + "[ " + command + "] ";
085a2f9a 139 for (Object arg : args) {
b9ce9cad 140 trace += arg + " ";
085a2f9a 141 }
c1bb921e
NR
142 long now = System.currentTimeMillis();
143 System.out.println(StringUtils.fromTime(now) + ": " + trace);
b0e88ebd 144
c1b31971 145 Object rep = null;
c1b31971
NR
146 try {
147 rep = doRequest(action, command, args, rw, whitelist);
5db598bc 148 } catch (IOException e) {
533dc2b8 149 rep = new RemoteLibraryException(e, true);
c1b31971 150 }
9f51d8ab 151
9b558341 152 commands.put(id, command);
fb25273c
NR
153 wls.put(id, wl);
154 rws.put(id, rw);
9b558341 155 times.put(id, (new Date().getTime() - start));
9f51d8ab
NR
156
157 return rep;
158 }
159
fb25273c
NR
160 private String display(boolean whitelist, boolean rw) {
161 String mode = "";
162 if (!rw) {
163 mode += "RO: ";
164 }
165 if (whitelist) {
166 mode += "WL: ";
167 }
168
169 return mode;
170 }
171
9b558341
NR
172 @Override
173 protected void onRequestDone(long id, long bytesReceived, long bytesSent) {
fb25273c
NR
174 boolean whitelist = wls.get(id);
175 boolean rw = rws.get(id);
176 wls.remove(id);
177 rws.remove(id);
178
9b558341
NR
179 String rec = StringUtils.formatNumber(bytesReceived) + "b";
180 String sent = StringUtils.formatNumber(bytesSent) + "b";
c1bb921e
NR
181 long now = System.currentTimeMillis();
182 System.out.println(StringUtils.fromTime(now)
183 + ": "
184 + String.format("%s[>%s]: (%s sent, %s rec) in %d ms",
185 display(whitelist, rw), commands.get(id), sent, rec,
186 times.get(id)));
fb25273c 187
9b558341
NR
188 commands.remove(id);
189 times.remove(id);
190 }
191
9f51d8ab 192 private Object doRequest(ConnectActionServerObject action, String command,
fb25273c
NR
193 Object[] args, boolean rw, List<String> whitelist)
194 throws NoSuchFieldException, NoSuchMethodException,
9f51d8ab 195 ClassNotFoundException, IOException {
3bbc86a5 196 if ("PING".equals(command)) {
fb25273c 197 return rw ? "r/w" : "r/o";
3bbc86a5 198 } else if ("GET_METADATA".equals(command)) {
651072f3
NR
199 List<MetaData> metas = new ArrayList<MetaData>();
200
7efece85 201 if ("*".equals(args[0])) {
9b863b20 202 Progress pg = createPgForwarder(action);
9f51d8ab 203
d66deb8d 204 for (MetaData meta : Instance.getInstance().getLibrary().getMetas(pg)) {
9f51d8ab
NR
205 MetaData light;
206 if (meta.getCover() == null) {
207 light = meta;
208 } else {
209 light = meta.clone();
210 light.setCover(null);
211 }
212
213 metas.add(light);
214 }
215
9b863b20 216 forcePgDoneSent(pg);
651072f3 217 } else {
d66deb8d 218 MetaData meta = Instance.getInstance().getLibrary().getInfo((String) args[0]);
210465c3
NR
219 MetaData light;
220 if (meta.getCover() == null) {
221 light = meta;
222 } else {
223 light = meta.clone();
224 light.setCover(null);
225 }
226
227 metas.add(light);
651072f3
NR
228 }
229
230 if (!whitelist.isEmpty()) {
231 for (int i = 0; i < metas.size(); i++) {
232 if (!whitelist.contains(metas.get(i).getSource())) {
233 metas.remove(i);
234 i--;
235 }
236 }
a85e8077 237 }
e272f05f 238
651072f3 239 return metas.toArray(new MetaData[0]);
a85e8077 240 } else if ("GET_STORY".equals(command)) {
d66deb8d 241 MetaData meta = Instance.getInstance().getLibrary().getInfo((String) args[0]);
651072f3
NR
242 if (meta == null) {
243 return null;
244 }
245
246 if (!whitelist.isEmpty()) {
247 if (!whitelist.contains(meta.getSource())) {
248 return null;
249 }
250 }
251
b9ce9cad
NR
252 meta = meta.clone();
253 meta.setCover(null);
254
255 action.send(meta);
256 action.rec();
257
d66deb8d 258 Story story = Instance.getInstance().getLibrary().getStory((String) args[0], null);
b9ce9cad
NR
259 for (Object obj : breakStory(story)) {
260 action.send(obj);
261 action.rec();
262 }
085a2f9a 263 } else if ("SAVE_STORY".equals(command)) {
651072f3 264 if (!rw) {
533dc2b8
NR
265 throw new RemoteLibraryException("Read-Only remote library: "
266 + args[0], false);
651072f3
NR
267 }
268
b9ce9cad
NR
269 List<Object> list = new ArrayList<Object>();
270
271 action.send(null);
272 Object obj = action.rec();
273 while (obj != null) {
274 list.add(obj);
275 action.send(null);
276 obj = action.rec();
277 }
278
279 Story story = rebuildStory(list);
d66deb8d 280 Instance.getInstance().getLibrary().save(story, (String) args[0], null);
0fa0fe95 281 return story.getMeta().getLuid();
edf79e5e 282 } else if ("IMPORT".equals(command)) {
651072f3 283 if (!rw) {
533dc2b8
NR
284 throw new RemoteLibraryException("Read-Only remote library: "
285 + args[0], false);
651072f3
NR
286 }
287
9b863b20 288 Progress pg = createPgForwarder(action);
d66deb8d 289 MetaData meta = Instance.getInstance().getLibrary().imprt(new URL((String) args[0]), pg);
9b863b20 290 forcePgDoneSent(pg);
b6b65795 291 return meta.getLuid();
085a2f9a 292 } else if ("DELETE_STORY".equals(command)) {
651072f3 293 if (!rw) {
533dc2b8
NR
294 throw new RemoteLibraryException("Read-Only remote library: "
295 + args[0], false);
651072f3
NR
296 }
297
d66deb8d 298 Instance.getInstance().getLibrary().delete((String) args[0]);
e604986c 299 } else if ("GET_COVER".equals(command)) {
d66deb8d 300 return Instance.getInstance().getLibrary().getCover((String) args[0]);
3989dfc5
NR
301 } else if ("GET_CUSTOM_COVER".equals(command)) {
302 if ("SOURCE".equals(args[0])) {
d66deb8d 303 return Instance.getInstance().getLibrary().getCustomSourceCover((String) args[1]);
3989dfc5 304 } else if ("AUTHOR".equals(args[0])) {
d66deb8d 305 return Instance.getInstance().getLibrary().getCustomAuthorCover((String) args[1]);
3989dfc5
NR
306 } else {
307 return null;
308 }
309 } else if ("SET_COVER".equals(command)) {
651072f3 310 if (!rw) {
533dc2b8
NR
311 throw new RemoteLibraryException("Read-Only remote library: "
312 + args[0] + ", " + args[1], false);
651072f3
NR
313 }
314
3989dfc5 315 if ("SOURCE".equals(args[0])) {
d66deb8d 316 Instance.getInstance().getLibrary().setSourceCover((String) args[1], (String) args[2]);
3989dfc5 317 } else if ("AUTHOR".equals(args[0])) {
d66deb8d 318 Instance.getInstance().getLibrary().setAuthorCover((String) args[1], (String) args[2]);
3989dfc5 319 }
c8d48938 320 } else if ("CHANGE_STA".equals(command)) {
651072f3 321 if (!rw) {
d66deb8d 322 throw new RemoteLibraryException("Read-Only remote library: " + args[0] + ", " + args[1], false);
651072f3
NR
323 }
324
9b863b20 325 Progress pg = createPgForwarder(action);
d66deb8d
NR
326 Instance.getInstance().getLibrary().changeSTA((String) args[0], (String) args[1], (String) args[2],
327 (String) args[3], pg);
9b863b20 328 forcePgDoneSent(pg);
5e848e6a 329 } else if ("EXIT".equals(command)) {
651072f3 330 if (!rw) {
533dc2b8
NR
331 throw new RemoteLibraryException(
332 "Read-Only remote library: EXIT", false);
651072f3
NR
333 }
334
c08c6ca1 335 stop(10000, false);
b0e88ebd
NR
336 }
337
338 return null;
339 }
74a40dfb 340
b9ce9cad
NR
341 @Override
342 protected void onError(Exception e) {
7e51d91c 343 if (e instanceof SSLException) {
c1bb921e
NR
344 long now = System.currentTimeMillis();
345 System.out.println(StringUtils.fromTime(now) + ": "
346 + "[Client connection refused (bad key)]");
7e51d91c
NR
347 } else {
348 getTraceHandler().error(e);
349 }
b9ce9cad 350 }
74a40dfb 351
b9ce9cad
NR
352 /**
353 * Break a story in multiple {@link Object}s for easier serialisation.
354 *
355 * @param story
356 * the {@link Story} to break
357 *
358 * @return the list of {@link Object}s
359 */
360 static List<Object> breakStory(Story story) {
361 List<Object> list = new ArrayList<Object>();
74a40dfb
NR
362
363 story = story.clone();
b9ce9cad 364 list.add(story);
74a40dfb 365
b9ce9cad
NR
366 if (story.getMeta().isImageDocument()) {
367 for (Chapter chap : story) {
368 list.add(chap);
369 list.addAll(chap.getParagraphs());
370 chap.setParagraphs(new ArrayList<Paragraph>());
74a40dfb 371 }
b9ce9cad 372 story.setChapters(new ArrayList<Chapter>());
74a40dfb 373 }
74a40dfb 374
b9ce9cad
NR
375 return list;
376 }
74a40dfb 377
b9ce9cad
NR
378 /**
379 * Rebuild a story from a list of broke up {@link Story} parts.
380 *
381 * @param list
382 * the list of {@link Story} parts
383 *
384 * @return the reconstructed {@link Story}
385 */
386 static Story rebuildStory(List<Object> list) {
74a40dfb 387 Story story = null;
b9ce9cad 388 Chapter chap = null;
74a40dfb 389
b9ce9cad
NR
390 for (Object obj : list) {
391 if (obj instanceof Story) {
392 story = (Story) obj;
393 } else if (obj instanceof Chapter) {
394 chap = (Chapter) obj;
395 story.getChapters().add(chap);
396 } else if (obj instanceof Paragraph) {
397 chap.getParagraphs().add((Paragraph) obj);
74a40dfb
NR
398 }
399 }
400
401 return story;
402 }
403
b9ce9cad
NR
404 /**
405 * Update the {@link Progress} with the adequate {@link Object} received
406 * from the network via {@link RemoteLibraryServer}.
407 *
408 * @param pg
409 * the {@link Progress} to update
410 * @param rep
411 * the object received from the network
412 *
413 * @return TRUE if it was a progress event, FALSE if not
414 */
415 static boolean updateProgress(Progress pg, Object rep) {
416 if (rep instanceof Integer[]) {
417 Integer[] a = (Integer[]) rep;
418 if (a.length == 3) {
419 int min = a[0];
420 int max = a[1];
421 int progress = a[2];
422
423 if (min >= 0 && min <= max) {
424 pg.setMinMax(min, max);
425 pg.setProgress(progress);
426
427 return true;
428 }
429 }
74a40dfb 430 }
b9ce9cad
NR
431
432 return false;
74a40dfb
NR
433 }
434
b9ce9cad
NR
435 /**
436 * Create a {@link Progress} that will forward its progress over the
437 * network.
438 *
439 * @param action
440 * the {@link ConnectActionServerObject} to use to forward it
441 *
442 * @return the {@link Progress}
443 */
49f3dec5 444 private Progress createPgForwarder(final ConnectActionServerObject action) {
9b863b20
NR
445 final Boolean[] isDoneForwarded = new Boolean[] { false };
446 final Progress pg = new Progress() {
447 @Override
448 public boolean isDone() {
449 return isDoneForwarded[0];
450 }
451 };
452
b9ce9cad 453 final Integer[] p = new Integer[] { -1, -1, -1 };
9b863b20 454 final Long[] lastTime = new Long[] { new Date().getTime() };
b9ce9cad
NR
455 pg.addProgressListener(new ProgressListener() {
456 @Override
457 public void progress(Progress progress, String name) {
458 int min = pg.getMin();
459 int max = pg.getMax();
37abe20c
NR
460 int relativeProgress = min
461 + (int) Math.round(pg.getRelativeProgress()
462 * (max - min));
b9ce9cad 463
9b863b20
NR
464 // Do not re-send the same value twice over the wire,
465 // unless more than 2 seconds have elapsed (to maintain the
466 // connection)
467 if ((p[0] != min || p[1] != max || p[2] != relativeProgress)
468 || (new Date().getTime() - lastTime[0] > 2000)) {
b9ce9cad
NR
469 p[0] = min;
470 p[1] = max;
471 p[2] = relativeProgress;
472
473 try {
37abe20c 474 action.send(new Integer[] { min, max, relativeProgress });
b9ce9cad
NR
475 action.rec();
476 } catch (Exception e) {
49f3dec5 477 getTraceHandler().error(e);
b9ce9cad 478 }
9b863b20 479
9b863b20 480 lastTime[0] = new Date().getTime();
b9ce9cad 481 }
652fd9b0
NR
482
483 isDoneForwarded[0] = (pg.getProgress() >= pg.getMax());
b9ce9cad
NR
484 }
485 });
486
487 return pg;
74a40dfb 488 }
9b863b20
NR
489
490 // with 30 seconds timeout
49f3dec5 491 private void forcePgDoneSent(Progress pg) {
9b863b20
NR
492 long start = new Date().getTime();
493 pg.done();
494 while (!pg.isDone() && new Date().getTime() - start < 30000) {
495 try {
496 Thread.sleep(100);
497 } catch (InterruptedException e) {
49f3dec5 498 getTraceHandler().error(e);
9b863b20
NR
499 }
500 }
501 }
b0e88ebd 502}