Commit | Line | Data |
---|---|---|
e42573a0 | 1 | package be.nikiroo.fanfix.library; |
b0e88ebd | 2 | |
b0e88ebd | 3 | import java.io.IOException; |
edf79e5e | 4 | import java.net.URL; |
74a40dfb | 5 | import java.util.ArrayList; |
9b863b20 | 6 | import java.util.Date; |
68e2c6d2 | 7 | import java.util.List; |
b0e88ebd | 8 | |
e42573a0 | 9 | import be.nikiroo.fanfix.Instance; |
74a40dfb | 10 | import be.nikiroo.fanfix.data.Chapter; |
b0e88ebd | 11 | import be.nikiroo.fanfix.data.MetaData; |
74a40dfb | 12 | import be.nikiroo.fanfix.data.Paragraph; |
085a2f9a | 13 | import be.nikiroo.fanfix.data.Story; |
b9ce9cad NR |
14 | import be.nikiroo.utils.Progress; |
15 | import be.nikiroo.utils.Progress.ProgressListener; | |
416c54f8 | 16 | import be.nikiroo.utils.StringUtils; |
b0e88ebd | 17 | import be.nikiroo.utils.Version; |
62c63b07 NR |
18 | import be.nikiroo.utils.serial.server.ConnectActionServerObject; |
19 | import be.nikiroo.utils.serial.server.ServerObject; | |
b0e88ebd | 20 | |
a85e8077 NR |
21 | /** |
22 | * Create a new remote server that will listen for order on the given port. | |
23 | * <p> | |
2a25f781 NR |
24 | * The available commands are given as arrays of objects (first item is the key, |
25 | * second is the command, the rest are the arguments). | |
26 | * <p> | |
416c54f8 NR |
27 | * The md5 is always a String (the MD5 hash of the access key), the commands are |
28 | * also Strings; the parameters vary depending upon the command. | |
a85e8077 | 29 | * <ul> |
416c54f8 NR |
30 | * <li>[md5] PING: will return PONG if the key is accepted</li> |
31 | * <li>[md5] GET_METADATA *: will return the metadata of all the stories in the | |
e272f05f NR |
32 | * library (array)</li> |
33 | * * | |
34 | * <li>[md5] GET_METADATA [luid]: will return the metadata of the story of LUID | |
35 | * luid</li> | |
416c54f8 | 36 | * <li>[md5] GET_STORY [luid]: will return the given story if it exists (or NULL |
2070ced5 | 37 | * if not)</li> |
416c54f8 | 38 | * <li>[md5] SAVE_STORY [luid]: save the story (that must be sent just after the |
0fa0fe95 | 39 | * command) with the given LUID, then return the LUID</li> |
edf79e5e NR |
40 | * <li>[md5] IMPORT [url]: save the story found at the given URL, then return |
41 | * the LUID</li> | |
416c54f8 NR |
42 | * <li>[md5] DELETE_STORY [luid]: delete the story of LUID luid</li> |
43 | * <li>[md5] GET_COVER [luid]: return the cover of the story</li> | |
e1de8087 | 44 | * <li>[md5] GET_CUSTOM_SOURCE_COVER [source]: return the cover for this source</li> |
416c54f8 | 45 | * <li>[md5] SET_SOURCE_COVER [source], [luid]: set the default cover for the |
2070ced5 | 46 | * given source to the cover of the story denoted by luid</li> |
edf79e5e NR |
47 | * <li>[md5] CHANGE_SOURCE [luid] [new source]: change the source of the story |
48 | * of LUID luid</li> | |
416c54f8 | 49 | * <li>[md5] EXIT: stop the server</li> |
a85e8077 NR |
50 | * </ul> |
51 | * | |
52 | * @author niki | |
53 | */ | |
62c63b07 | 54 | public class RemoteLibraryServer extends ServerObject { |
416c54f8 | 55 | private final String md5; |
b0e88ebd | 56 | |
a85e8077 NR |
57 | /** |
58 | * Create a new remote server (will not be active until | |
59 | * {@link RemoteLibraryServer#start()} is called). | |
60 | * | |
2070ced5 NR |
61 | * @param key |
62 | * the key that will restrict access to this server | |
a85e8077 NR |
63 | * @param port |
64 | * the port to listen on | |
65 | * | |
66 | * @throws IOException | |
67 | * in case of I/O error | |
68 | */ | |
2070ced5 | 69 | public RemoteLibraryServer(String key, int port) throws IOException { |
22b2b942 | 70 | super("Fanfix remote library", port, true); |
416c54f8 | 71 | this.md5 = StringUtils.getMd5Hash(key); |
b9ce9cad NR |
72 | |
73 | setTraceHandler(Instance.getTraceHandler()); | |
b0e88ebd NR |
74 | } |
75 | ||
76 | @Override | |
62c63b07 | 77 | protected Object onRequest(ConnectActionServerObject action, |
b0e88ebd | 78 | Version clientVersion, Object data) throws Exception { |
416c54f8 | 79 | String md5 = ""; |
085a2f9a NR |
80 | String command = ""; |
81 | Object[] args = new Object[0]; | |
82 | if (data instanceof Object[]) { | |
2070ced5 NR |
83 | Object[] dataArray = (Object[]) data; |
84 | if (dataArray.length >= 2) { | |
edf79e5e NR |
85 | md5 = "" + dataArray[0]; |
86 | command = "" + dataArray[1]; | |
87 | ||
2070ced5 NR |
88 | args = new Object[dataArray.length - 2]; |
89 | for (int i = 2; i < dataArray.length; i++) { | |
f569d249 | 90 | args[i - 2] = dataArray[i]; |
2070ced5 | 91 | } |
b0e88ebd NR |
92 | } |
93 | } | |
94 | ||
652fd9b0 | 95 | String trace = "[ " + command + "] "; |
085a2f9a | 96 | for (Object arg : args) { |
b9ce9cad | 97 | trace += arg + " "; |
085a2f9a | 98 | } |
b9ce9cad | 99 | getTraceHandler().trace(trace); |
b0e88ebd | 100 | |
416c54f8 | 101 | if (!md5.equals(this.md5)) { |
b9ce9cad NR |
102 | getTraceHandler().trace("Key rejected."); |
103 | return null; | |
2070ced5 NR |
104 | } |
105 | ||
9f51d8ab NR |
106 | long start = new Date().getTime(); |
107 | Object rep = doRequest(action, command, args); | |
108 | ||
109 | getTraceHandler().trace( | |
652fd9b0 | 110 | String.format("[>%s]: %d ms", command, |
9f51d8ab NR |
111 | (new Date().getTime() - start))); |
112 | ||
113 | return rep; | |
114 | } | |
115 | ||
116 | private Object doRequest(ConnectActionServerObject action, String command, | |
117 | Object[] args) throws NoSuchFieldException, NoSuchMethodException, | |
118 | ClassNotFoundException, IOException { | |
3bbc86a5 NR |
119 | if ("PING".equals(command)) { |
120 | return "PONG"; | |
121 | } else if ("GET_METADATA".equals(command)) { | |
7efece85 | 122 | if ("*".equals(args[0])) { |
9b863b20 | 123 | Progress pg = createPgForwarder(action); |
9f51d8ab NR |
124 | |
125 | List<MetaData> metas = new ArrayList<MetaData>(); | |
652fd9b0 | 126 | |
9f51d8ab NR |
127 | for (MetaData meta : Instance.getLibrary().getMetas(pg)) { |
128 | MetaData light; | |
129 | if (meta.getCover() == null) { | |
130 | light = meta; | |
131 | } else { | |
132 | light = meta.clone(); | |
133 | light.setCover(null); | |
134 | } | |
135 | ||
136 | metas.add(light); | |
137 | } | |
138 | ||
9b863b20 | 139 | forcePgDoneSent(pg); |
a85e8077 NR |
140 | return metas.toArray(new MetaData[] {}); |
141 | } | |
e272f05f NR |
142 | |
143 | return new MetaData[] { Instance.getLibrary().getInfo( | |
144 | (String) args[0]) }; | |
a85e8077 | 145 | } else if ("GET_STORY".equals(command)) { |
7efece85 | 146 | MetaData meta = Instance.getLibrary().getInfo((String) args[0]); |
b9ce9cad NR |
147 | meta = meta.clone(); |
148 | meta.setCover(null); | |
149 | ||
150 | action.send(meta); | |
151 | action.rec(); | |
152 | ||
7efece85 NR |
153 | Story story = Instance.getLibrary() |
154 | .getStory((String) args[0], null); | |
b9ce9cad NR |
155 | for (Object obj : breakStory(story)) { |
156 | action.send(obj); | |
157 | action.rec(); | |
158 | } | |
085a2f9a | 159 | } else if ("SAVE_STORY".equals(command)) { |
b9ce9cad NR |
160 | List<Object> list = new ArrayList<Object>(); |
161 | ||
162 | action.send(null); | |
163 | Object obj = action.rec(); | |
164 | while (obj != null) { | |
165 | list.add(obj); | |
166 | action.send(null); | |
167 | obj = action.rec(); | |
168 | } | |
169 | ||
170 | Story story = rebuildStory(list); | |
7efece85 | 171 | Instance.getLibrary().save(story, (String) args[0], null); |
0fa0fe95 | 172 | return story.getMeta().getLuid(); |
edf79e5e | 173 | } else if ("IMPORT".equals(command)) { |
9b863b20 | 174 | Progress pg = createPgForwarder(action); |
edf79e5e | 175 | Story story = Instance.getLibrary().imprt( |
9b863b20 NR |
176 | new URL((String) args[0]), pg); |
177 | forcePgDoneSent(pg); | |
edf79e5e | 178 | return story.getMeta().getLuid(); |
085a2f9a | 179 | } else if ("DELETE_STORY".equals(command)) { |
7efece85 | 180 | Instance.getLibrary().delete((String) args[0]); |
e604986c | 181 | } else if ("GET_COVER".equals(command)) { |
7efece85 | 182 | return Instance.getLibrary().getCover((String) args[0]); |
e1de8087 NR |
183 | } else if ("GET_CUSTOM_SOURCE_COVER".equals(command)) { |
184 | return Instance.getLibrary().getCustomSourceCover((String) args[0]); | |
085a2f9a | 185 | } else if ("SET_SOURCE_COVER".equals(command)) { |
7efece85 NR |
186 | Instance.getLibrary().setSourceCover((String) args[0], |
187 | (String) args[1]); | |
edf79e5e | 188 | } else if ("CHANGE_SOURCE".equals(command)) { |
9b863b20 | 189 | Progress pg = createPgForwarder(action); |
edf79e5e | 190 | Instance.getLibrary().changeSource((String) args[0], |
9b863b20 NR |
191 | (String) args[1], pg); |
192 | forcePgDoneSent(pg); | |
5e848e6a NR |
193 | } else if ("EXIT".equals(command)) { |
194 | stop(0, false); | |
b0e88ebd NR |
195 | } |
196 | ||
197 | return null; | |
198 | } | |
74a40dfb | 199 | |
b9ce9cad NR |
200 | @Override |
201 | protected void onError(Exception e) { | |
202 | getTraceHandler().error(e); | |
203 | } | |
74a40dfb | 204 | |
b9ce9cad NR |
205 | /** |
206 | * Break a story in multiple {@link Object}s for easier serialisation. | |
207 | * | |
208 | * @param story | |
209 | * the {@link Story} to break | |
210 | * | |
211 | * @return the list of {@link Object}s | |
212 | */ | |
213 | static List<Object> breakStory(Story story) { | |
214 | List<Object> list = new ArrayList<Object>(); | |
74a40dfb NR |
215 | |
216 | story = story.clone(); | |
b9ce9cad | 217 | list.add(story); |
74a40dfb | 218 | |
b9ce9cad NR |
219 | if (story.getMeta().isImageDocument()) { |
220 | for (Chapter chap : story) { | |
221 | list.add(chap); | |
222 | list.addAll(chap.getParagraphs()); | |
223 | chap.setParagraphs(new ArrayList<Paragraph>()); | |
74a40dfb | 224 | } |
b9ce9cad | 225 | story.setChapters(new ArrayList<Chapter>()); |
74a40dfb | 226 | } |
74a40dfb | 227 | |
b9ce9cad NR |
228 | return list; |
229 | } | |
74a40dfb | 230 | |
b9ce9cad NR |
231 | /** |
232 | * Rebuild a story from a list of broke up {@link Story} parts. | |
233 | * | |
234 | * @param list | |
235 | * the list of {@link Story} parts | |
236 | * | |
237 | * @return the reconstructed {@link Story} | |
238 | */ | |
239 | static Story rebuildStory(List<Object> list) { | |
74a40dfb | 240 | Story story = null; |
b9ce9cad | 241 | Chapter chap = null; |
74a40dfb | 242 | |
b9ce9cad NR |
243 | for (Object obj : list) { |
244 | if (obj instanceof Story) { | |
245 | story = (Story) obj; | |
246 | } else if (obj instanceof Chapter) { | |
247 | chap = (Chapter) obj; | |
248 | story.getChapters().add(chap); | |
249 | } else if (obj instanceof Paragraph) { | |
250 | chap.getParagraphs().add((Paragraph) obj); | |
74a40dfb NR |
251 | } |
252 | } | |
253 | ||
254 | return story; | |
255 | } | |
256 | ||
b9ce9cad NR |
257 | /** |
258 | * Update the {@link Progress} with the adequate {@link Object} received | |
259 | * from the network via {@link RemoteLibraryServer}. | |
260 | * | |
261 | * @param pg | |
262 | * the {@link Progress} to update | |
263 | * @param rep | |
264 | * the object received from the network | |
265 | * | |
266 | * @return TRUE if it was a progress event, FALSE if not | |
267 | */ | |
268 | static boolean updateProgress(Progress pg, Object rep) { | |
269 | if (rep instanceof Integer[]) { | |
270 | Integer[] a = (Integer[]) rep; | |
271 | if (a.length == 3) { | |
272 | int min = a[0]; | |
273 | int max = a[1]; | |
274 | int progress = a[2]; | |
275 | ||
276 | if (min >= 0 && min <= max) { | |
277 | pg.setMinMax(min, max); | |
278 | pg.setProgress(progress); | |
279 | ||
280 | return true; | |
281 | } | |
282 | } | |
74a40dfb | 283 | } |
b9ce9cad NR |
284 | |
285 | return false; | |
74a40dfb NR |
286 | } |
287 | ||
b9ce9cad NR |
288 | /** |
289 | * Create a {@link Progress} that will forward its progress over the | |
290 | * network. | |
291 | * | |
292 | * @param action | |
293 | * the {@link ConnectActionServerObject} to use to forward it | |
294 | * | |
295 | * @return the {@link Progress} | |
296 | */ | |
297 | private static Progress createPgForwarder( | |
298 | final ConnectActionServerObject action) { | |
9b863b20 NR |
299 | final Boolean[] isDoneForwarded = new Boolean[] { false }; |
300 | final Progress pg = new Progress() { | |
301 | @Override | |
302 | public boolean isDone() { | |
303 | return isDoneForwarded[0]; | |
304 | } | |
305 | }; | |
306 | ||
b9ce9cad | 307 | final Integer[] p = new Integer[] { -1, -1, -1 }; |
9b863b20 | 308 | final Long[] lastTime = new Long[] { new Date().getTime() }; |
b9ce9cad NR |
309 | pg.addProgressListener(new ProgressListener() { |
310 | @Override | |
311 | public void progress(Progress progress, String name) { | |
312 | int min = pg.getMin(); | |
313 | int max = pg.getMax(); | |
314 | int relativeProgress = min | |
315 | + (int) Math.round(pg.getRelativeProgress() | |
316 | * (max - min)); | |
317 | ||
9b863b20 NR |
318 | // Do not re-send the same value twice over the wire, |
319 | // unless more than 2 seconds have elapsed (to maintain the | |
320 | // connection) | |
321 | if ((p[0] != min || p[1] != max || p[2] != relativeProgress) | |
322 | || (new Date().getTime() - lastTime[0] > 2000)) { | |
b9ce9cad NR |
323 | p[0] = min; |
324 | p[1] = max; | |
325 | p[2] = relativeProgress; | |
326 | ||
327 | try { | |
328 | action.send(new Integer[] { min, max, relativeProgress }); | |
329 | action.rec(); | |
330 | } catch (Exception e) { | |
331 | Instance.getTraceHandler().error(e); | |
332 | } | |
9b863b20 | 333 | |
9b863b20 | 334 | lastTime[0] = new Date().getTime(); |
b9ce9cad | 335 | } |
652fd9b0 NR |
336 | |
337 | isDoneForwarded[0] = (pg.getProgress() >= pg.getMax()); | |
b9ce9cad NR |
338 | } |
339 | }); | |
340 | ||
341 | return pg; | |
74a40dfb | 342 | } |
9b863b20 NR |
343 | |
344 | // with 30 seconds timeout | |
345 | private static void forcePgDoneSent(Progress pg) { | |
346 | long start = new Date().getTime(); | |
347 | pg.done(); | |
348 | while (!pg.isDone() && new Date().getTime() - start < 30000) { | |
349 | try { | |
350 | Thread.sleep(100); | |
351 | } catch (InterruptedException e) { | |
352 | Instance.getTraceHandler().error(e); | |
353 | } | |
354 | } | |
355 | } | |
b0e88ebd | 356 | } |