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> | |
44 | * <li>[md5] GET_SOURCE_COVER [source]: return the cover for this source</li> | |
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 | ||
b9ce9cad | 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 | ||
3bbc86a5 NR |
106 | if ("PING".equals(command)) { |
107 | return "PONG"; | |
108 | } else if ("GET_METADATA".equals(command)) { | |
7efece85 | 109 | if ("*".equals(args[0])) { |
9b863b20 NR |
110 | Progress pg = createPgForwarder(action); |
111 | List<MetaData> metas = Instance.getLibrary().getMetas(pg); | |
112 | forcePgDoneSent(pg); | |
a85e8077 NR |
113 | return metas.toArray(new MetaData[] {}); |
114 | } | |
e272f05f NR |
115 | |
116 | return new MetaData[] { Instance.getLibrary().getInfo( | |
117 | (String) args[0]) }; | |
a85e8077 | 118 | } else if ("GET_STORY".equals(command)) { |
7efece85 | 119 | MetaData meta = Instance.getLibrary().getInfo((String) args[0]); |
b9ce9cad NR |
120 | meta = meta.clone(); |
121 | meta.setCover(null); | |
122 | ||
123 | action.send(meta); | |
124 | action.rec(); | |
125 | ||
7efece85 NR |
126 | Story story = Instance.getLibrary() |
127 | .getStory((String) args[0], null); | |
b9ce9cad NR |
128 | for (Object obj : breakStory(story)) { |
129 | action.send(obj); | |
130 | action.rec(); | |
131 | } | |
085a2f9a | 132 | } else if ("SAVE_STORY".equals(command)) { |
b9ce9cad NR |
133 | List<Object> list = new ArrayList<Object>(); |
134 | ||
135 | action.send(null); | |
136 | Object obj = action.rec(); | |
137 | while (obj != null) { | |
138 | list.add(obj); | |
139 | action.send(null); | |
140 | obj = action.rec(); | |
141 | } | |
142 | ||
143 | Story story = rebuildStory(list); | |
7efece85 | 144 | Instance.getLibrary().save(story, (String) args[0], null); |
0fa0fe95 | 145 | return story.getMeta().getLuid(); |
edf79e5e | 146 | } else if ("IMPORT".equals(command)) { |
9b863b20 | 147 | Progress pg = createPgForwarder(action); |
edf79e5e | 148 | Story story = Instance.getLibrary().imprt( |
9b863b20 NR |
149 | new URL((String) args[0]), pg); |
150 | forcePgDoneSent(pg); | |
edf79e5e | 151 | return story.getMeta().getLuid(); |
085a2f9a | 152 | } else if ("DELETE_STORY".equals(command)) { |
7efece85 | 153 | Instance.getLibrary().delete((String) args[0]); |
e604986c | 154 | } else if ("GET_COVER".equals(command)) { |
7efece85 | 155 | return Instance.getLibrary().getCover((String) args[0]); |
085a2f9a | 156 | } else if ("GET_SOURCE_COVER".equals(command)) { |
7efece85 | 157 | return Instance.getLibrary().getSourceCover((String) args[0]); |
085a2f9a | 158 | } else if ("SET_SOURCE_COVER".equals(command)) { |
7efece85 NR |
159 | Instance.getLibrary().setSourceCover((String) args[0], |
160 | (String) args[1]); | |
edf79e5e | 161 | } else if ("CHANGE_SOURCE".equals(command)) { |
9b863b20 | 162 | Progress pg = createPgForwarder(action); |
edf79e5e | 163 | Instance.getLibrary().changeSource((String) args[0], |
9b863b20 NR |
164 | (String) args[1], pg); |
165 | forcePgDoneSent(pg); | |
5e848e6a NR |
166 | } else if ("EXIT".equals(command)) { |
167 | stop(0, false); | |
b0e88ebd NR |
168 | } |
169 | ||
170 | return null; | |
171 | } | |
74a40dfb | 172 | |
b9ce9cad NR |
173 | @Override |
174 | protected void onError(Exception e) { | |
175 | getTraceHandler().error(e); | |
176 | } | |
74a40dfb | 177 | |
b9ce9cad NR |
178 | /** |
179 | * Break a story in multiple {@link Object}s for easier serialisation. | |
180 | * | |
181 | * @param story | |
182 | * the {@link Story} to break | |
183 | * | |
184 | * @return the list of {@link Object}s | |
185 | */ | |
186 | static List<Object> breakStory(Story story) { | |
187 | List<Object> list = new ArrayList<Object>(); | |
74a40dfb NR |
188 | |
189 | story = story.clone(); | |
b9ce9cad | 190 | list.add(story); |
74a40dfb | 191 | |
b9ce9cad NR |
192 | if (story.getMeta().isImageDocument()) { |
193 | for (Chapter chap : story) { | |
194 | list.add(chap); | |
195 | list.addAll(chap.getParagraphs()); | |
196 | chap.setParagraphs(new ArrayList<Paragraph>()); | |
74a40dfb | 197 | } |
b9ce9cad | 198 | story.setChapters(new ArrayList<Chapter>()); |
74a40dfb | 199 | } |
74a40dfb | 200 | |
b9ce9cad NR |
201 | return list; |
202 | } | |
74a40dfb | 203 | |
b9ce9cad NR |
204 | /** |
205 | * Rebuild a story from a list of broke up {@link Story} parts. | |
206 | * | |
207 | * @param list | |
208 | * the list of {@link Story} parts | |
209 | * | |
210 | * @return the reconstructed {@link Story} | |
211 | */ | |
212 | static Story rebuildStory(List<Object> list) { | |
74a40dfb | 213 | Story story = null; |
b9ce9cad | 214 | Chapter chap = null; |
74a40dfb | 215 | |
b9ce9cad NR |
216 | for (Object obj : list) { |
217 | if (obj instanceof Story) { | |
218 | story = (Story) obj; | |
219 | } else if (obj instanceof Chapter) { | |
220 | chap = (Chapter) obj; | |
221 | story.getChapters().add(chap); | |
222 | } else if (obj instanceof Paragraph) { | |
223 | chap.getParagraphs().add((Paragraph) obj); | |
74a40dfb NR |
224 | } |
225 | } | |
226 | ||
227 | return story; | |
228 | } | |
229 | ||
b9ce9cad NR |
230 | /** |
231 | * Update the {@link Progress} with the adequate {@link Object} received | |
232 | * from the network via {@link RemoteLibraryServer}. | |
233 | * | |
234 | * @param pg | |
235 | * the {@link Progress} to update | |
236 | * @param rep | |
237 | * the object received from the network | |
238 | * | |
239 | * @return TRUE if it was a progress event, FALSE if not | |
240 | */ | |
241 | static boolean updateProgress(Progress pg, Object rep) { | |
242 | if (rep instanceof Integer[]) { | |
243 | Integer[] a = (Integer[]) rep; | |
244 | if (a.length == 3) { | |
245 | int min = a[0]; | |
246 | int max = a[1]; | |
247 | int progress = a[2]; | |
248 | ||
249 | if (min >= 0 && min <= max) { | |
250 | pg.setMinMax(min, max); | |
251 | pg.setProgress(progress); | |
252 | ||
253 | return true; | |
254 | } | |
255 | } | |
74a40dfb | 256 | } |
b9ce9cad NR |
257 | |
258 | return false; | |
74a40dfb NR |
259 | } |
260 | ||
b9ce9cad NR |
261 | /** |
262 | * Create a {@link Progress} that will forward its progress over the | |
263 | * network. | |
264 | * | |
265 | * @param action | |
266 | * the {@link ConnectActionServerObject} to use to forward it | |
267 | * | |
268 | * @return the {@link Progress} | |
269 | */ | |
270 | private static Progress createPgForwarder( | |
271 | final ConnectActionServerObject action) { | |
9b863b20 NR |
272 | final Boolean[] isDoneForwarded = new Boolean[] { false }; |
273 | final Progress pg = new Progress() { | |
274 | @Override | |
275 | public boolean isDone() { | |
276 | return isDoneForwarded[0]; | |
277 | } | |
278 | }; | |
279 | ||
b9ce9cad | 280 | final Integer[] p = new Integer[] { -1, -1, -1 }; |
9b863b20 | 281 | final Long[] lastTime = new Long[] { new Date().getTime() }; |
b9ce9cad NR |
282 | pg.addProgressListener(new ProgressListener() { |
283 | @Override | |
284 | public void progress(Progress progress, String name) { | |
285 | int min = pg.getMin(); | |
286 | int max = pg.getMax(); | |
287 | int relativeProgress = min | |
288 | + (int) Math.round(pg.getRelativeProgress() | |
289 | * (max - min)); | |
290 | ||
9b863b20 NR |
291 | // Do not re-send the same value twice over the wire, |
292 | // unless more than 2 seconds have elapsed (to maintain the | |
293 | // connection) | |
294 | if ((p[0] != min || p[1] != max || p[2] != relativeProgress) | |
295 | || (new Date().getTime() - lastTime[0] > 2000)) { | |
b9ce9cad NR |
296 | p[0] = min; |
297 | p[1] = max; | |
298 | p[2] = relativeProgress; | |
299 | ||
300 | try { | |
301 | action.send(new Integer[] { min, max, relativeProgress }); | |
302 | action.rec(); | |
303 | } catch (Exception e) { | |
304 | Instance.getTraceHandler().error(e); | |
305 | } | |
9b863b20 NR |
306 | |
307 | isDoneForwarded[0] = pg.isDone(); | |
308 | lastTime[0] = new Date().getTime(); | |
b9ce9cad NR |
309 | } |
310 | } | |
311 | }); | |
312 | ||
313 | return pg; | |
74a40dfb | 314 | } |
9b863b20 NR |
315 | |
316 | // with 30 seconds timeout | |
317 | private static void forcePgDoneSent(Progress pg) { | |
318 | long start = new Date().getTime(); | |
319 | pg.done(); | |
320 | while (!pg.isDone() && new Date().getTime() - start < 30000) { | |
321 | try { | |
322 | Thread.sleep(100); | |
323 | } catch (InterruptedException e) { | |
324 | Instance.getTraceHandler().error(e); | |
325 | } | |
326 | } | |
327 | } | |
b0e88ebd | 328 | } |