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