fix changelog headers
[fanfix.git] / RemoteLibrary.java
... / ...
CommitLineData
1package be.nikiroo.fanfix.library;
2
3import java.io.File;
4import java.io.IOException;
5import java.net.URL;
6import java.net.UnknownHostException;
7import java.util.ArrayList;
8import java.util.List;
9
10import be.nikiroo.fanfix.Instance;
11import be.nikiroo.fanfix.data.MetaData;
12import be.nikiroo.fanfix.data.Story;
13import be.nikiroo.utils.Image;
14import be.nikiroo.utils.Progress;
15import be.nikiroo.utils.StringUtils;
16import be.nikiroo.utils.Version;
17import be.nikiroo.utils.serial.server.ConnectActionClientObject;
18
19/**
20 * This {@link BasicLibrary} will access a remote server to list the available
21 * stories, and download the ones you try to load to the local directory
22 * specified in the configuration.
23 *
24 * @author niki
25 */
26public class RemoteLibrary extends BasicLibrary {
27 private String host;
28 private int port;
29 private final String md5;
30
31 /**
32 * Create a {@link RemoteLibrary} linked to the given server.
33 *
34 * @param key
35 * the key that will allow us to exchange information with the
36 * server
37 * @param host
38 * the host to contact or NULL for localhost
39 * @param port
40 * the port to contact it on
41 */
42 public RemoteLibrary(String key, String host, int port) {
43 this.md5 = StringUtils.getMd5Hash(key);
44 this.host = host;
45 this.port = port;
46 }
47
48 @Override
49 public String getLibraryName() {
50 return host + ":" + port;
51 }
52
53 @Override
54 public Status getStatus() {
55 final Status[] result = new Status[1];
56
57 result[0] = Status.INVALID;
58
59 ConnectActionClientObject action = null;
60 try {
61 action = new ConnectActionClientObject(host, port, true) {
62 @Override
63 public void action(Version serverVersion) throws Exception {
64 Object rep = send(new Object[] { md5, "PING" });
65 if ("PONG".equals(rep)) {
66 result[0] = Status.READY;
67 } else {
68 result[0] = Status.UNAUTORIZED;
69 }
70 }
71
72 @Override
73 protected void onError(Exception e) {
74 result[0] = Status.UNAVAILABLE;
75 }
76 };
77
78 } catch (UnknownHostException e) {
79 result[0] = Status.INVALID;
80 } catch (IllegalArgumentException e) {
81 result[0] = Status.INVALID;
82 } catch (Exception e) {
83 result[0] = Status.UNAVAILABLE;
84 }
85
86 if (action != null) {
87 try {
88 action.connect();
89 } catch (Exception e) {
90 result[0] = Status.UNAVAILABLE;
91 }
92 }
93
94 return result[0];
95 }
96
97 @Override
98 public Image getCover(final String luid) {
99 final Image[] result = new Image[1];
100
101 try {
102 new ConnectActionClientObject(host, port, true) {
103 @Override
104 public void action(Version serverVersion) throws Exception {
105 Object rep = send(new Object[] { md5, "GET_COVER", luid });
106 result[0] = (Image) rep;
107 }
108
109 @Override
110 protected void onError(Exception e) {
111 Instance.getTraceHandler().error(e);
112 }
113 }.connect();
114 } catch (Exception e) {
115 Instance.getTraceHandler().error(e);
116 }
117
118 return result[0];
119 }
120
121 @Override
122 public Image getCustomSourceCover(final String source) {
123 final Image[] result = new Image[1];
124
125 try {
126 new ConnectActionClientObject(host, port, true) {
127 @Override
128 public void action(Version serverVersion) throws Exception {
129 Object rep = send(new Object[] { md5,
130 "GET_CUSTOM_SOURCE_COVER", source });
131 result[0] = (Image) rep;
132 }
133
134 @Override
135 protected void onError(Exception e) {
136 Instance.getTraceHandler().error(e);
137 }
138 }.connect();
139 } catch (Exception e) {
140 Instance.getTraceHandler().error(e);
141 }
142
143 return result[0];
144 }
145
146 @Override
147 public synchronized Story getStory(final String luid, Progress pg) {
148 final Progress pgF = pg;
149 final Story[] result = new Story[1];
150
151 try {
152 new ConnectActionClientObject(host, port, true) {
153 @Override
154 public void action(Version serverVersion) throws Exception {
155 Progress pg = pgF;
156 if (pg == null) {
157 pg = new Progress();
158 }
159
160 Object rep = send(new Object[] { md5, "GET_STORY", luid });
161
162 MetaData meta = null;
163 if (rep instanceof MetaData) {
164 meta = (MetaData) rep;
165 if (meta.getWords() <= Integer.MAX_VALUE) {
166 pg.setMinMax(0, (int) meta.getWords());
167 }
168 }
169
170 List<Object> list = new ArrayList<Object>();
171 for (Object obj = send(null); obj != null; obj = send(null)) {
172 list.add(obj);
173 pg.add(1);
174 }
175
176 result[0] = RemoteLibraryServer.rebuildStory(list);
177 pg.done();
178 }
179
180 @Override
181 protected void onError(Exception e) {
182 Instance.getTraceHandler().error(e);
183 }
184 }.connect();
185 } catch (Exception e) {
186 Instance.getTraceHandler().error(e);
187 }
188
189 return result[0];
190 }
191
192 @Override
193 public synchronized Story save(final Story story, final String luid,
194 Progress pg) throws IOException {
195 final String[] luidSaved = new String[1];
196 Progress pgSave = new Progress();
197 Progress pgRefresh = new Progress();
198 if (pg == null) {
199 pg = new Progress();
200 }
201
202 pg.setMinMax(0, 10);
203 pg.addProgress(pgSave, 9);
204 pg.addProgress(pgRefresh, 1);
205
206 final Progress pgF = pgSave;
207
208 new ConnectActionClientObject(host, port, true) {
209 @Override
210 public void action(Version serverVersion) throws Exception {
211 Progress pg = pgF;
212 if (story.getMeta().getWords() <= Integer.MAX_VALUE) {
213 pg.setMinMax(0, (int) story.getMeta().getWords());
214 }
215
216 send(new Object[] { md5, "SAVE_STORY", luid });
217
218 List<Object> list = RemoteLibraryServer.breakStory(story);
219 for (Object obj : list) {
220 send(obj);
221 pg.add(1);
222 }
223
224 luidSaved[0] = (String) send(null);
225
226 pg.done();
227 }
228
229 @Override
230 protected void onError(Exception e) {
231 Instance.getTraceHandler().error(e);
232 }
233 }.connect();
234
235 // because the meta changed:
236 MetaData meta = getInfo(luidSaved[0]);
237 if (story.getMeta().getClass() != null) {
238 // If already available locally:
239 meta.setCover(story.getMeta().getCover());
240 } else {
241 // If required:
242 meta.setCover(getCover(meta.getLuid()));
243 }
244 story.setMeta(meta);
245
246 pg.done();
247
248 return story;
249 }
250
251 @Override
252 public synchronized void delete(final String luid) throws IOException {
253 new ConnectActionClientObject(host, port, true) {
254 @Override
255 public void action(Version serverVersion) throws Exception {
256 send(new Object[] { md5, "DELETE_STORY", luid });
257 }
258
259 @Override
260 protected void onError(Exception e) {
261 Instance.getTraceHandler().error(e);
262 }
263 }.connect();
264 }
265
266 @Override
267 public void setSourceCover(final String source, final String luid) {
268 try {
269 new ConnectActionClientObject(host, port, true) {
270 @Override
271 public void action(Version serverVersion) throws Exception {
272 send(new Object[] { md5, "SET_SOURCE_COVER", source, luid });
273 }
274
275 @Override
276 protected void onError(Exception e) {
277 Instance.getTraceHandler().error(e);
278 }
279 }.connect();
280 } catch (IOException e) {
281 Instance.getTraceHandler().error(e);
282 }
283 }
284
285 @Override
286 // Could work (more slowly) without it
287 public Story imprt(final URL url, Progress pg) throws IOException {
288 if (pg == null) {
289 pg = new Progress();
290 }
291
292 pg.setMinMax(0, 2);
293 Progress pgImprt = new Progress();
294 Progress pgGet = new Progress();
295 pg.addProgress(pgImprt, 1);
296 pg.addProgress(pgGet, 1);
297
298 final Progress pgF = pgImprt;
299 final String[] luid = new String[1];
300
301 try {
302 new ConnectActionClientObject(host, port, true) {
303 @Override
304 public void action(Version serverVersion) throws Exception {
305 Progress pg = pgF;
306
307 Object rep = send(new Object[] { md5, "IMPORT",
308 url.toString() });
309
310 while (true) {
311 if (!RemoteLibraryServer.updateProgress(pg, rep)) {
312 break;
313 }
314
315 rep = send(null);
316 }
317
318 pg.done();
319 luid[0] = (String) rep;
320 }
321
322 @Override
323 protected void onError(Exception e) {
324 Instance.getTraceHandler().error(e);
325 }
326 }.connect();
327 } catch (IOException e) {
328 Instance.getTraceHandler().error(e);
329 }
330
331 if (luid[0] == null) {
332 throw new IOException("Remote failure");
333 }
334
335 Story story = getStory(luid[0], pgGet);
336 pgGet.done();
337
338 pg.done();
339 return story;
340 }
341
342 @Override
343 // Could work (more slowly) without it
344 public synchronized void changeSource(final String luid,
345 final String newSource, Progress pg) throws IOException {
346 final Progress pgF = pg == null ? new Progress() : pg;
347
348 try {
349 new ConnectActionClientObject(host, port, true) {
350 @Override
351 public void action(Version serverVersion) throws Exception {
352 Progress pg = pgF;
353
354 Object rep = send(new Object[] { md5, "CHANGE_SOURCE",
355 luid, newSource });
356 while (true) {
357 if (!RemoteLibraryServer.updateProgress(pg, rep)) {
358 break;
359 }
360
361 rep = send(null);
362 }
363 }
364
365 @Override
366 protected void onError(Exception e) {
367 Instance.getTraceHandler().error(e);
368 }
369 }.connect();
370 } catch (IOException e) {
371 Instance.getTraceHandler().error(e);
372 }
373 }
374
375 @Override
376 public synchronized File getFile(final String luid, Progress pg) {
377 throw new java.lang.InternalError(
378 "Operation not supportorted on remote Libraries");
379 }
380
381 /**
382 * Stop the server.
383 */
384 public void exit() {
385 try {
386 new ConnectActionClientObject(host, port, true) {
387 @Override
388 public void action(Version serverVersion) throws Exception {
389 send(new Object[] { md5, "EXIT" });
390 }
391
392 @Override
393 protected void onError(Exception e) {
394 Instance.getTraceHandler().error(e);
395 }
396 }.connect();
397 } catch (IOException e) {
398 Instance.getTraceHandler().error(e);
399 }
400 }
401
402 @Override
403 public synchronized MetaData getInfo(String luid) {
404 List<MetaData> metas = getMetasList(luid, null);
405 if (!metas.isEmpty()) {
406 return metas.get(0);
407 }
408
409 return null;
410 }
411
412 @Override
413 protected List<MetaData> getMetas(Progress pg) {
414 return getMetasList("*", pg);
415 }
416
417 @Override
418 protected void updateInfo(MetaData meta) {
419 // Will be taken care of directly server side
420 }
421
422 @Override
423 protected void deleteInfo(String luid) {
424 // Will be taken care of directly server side
425 }
426
427 // The following methods are only used by Save and Delete in BasicLibrary:
428
429 @Override
430 protected int getNextId() {
431 throw new java.lang.InternalError("Should not have been called");
432 }
433
434 @Override
435 protected void doDelete(String luid) throws IOException {
436 throw new java.lang.InternalError("Should not have been called");
437 }
438
439 @Override
440 protected Story doSave(Story story, Progress pg) throws IOException {
441 throw new java.lang.InternalError("Should not have been called");
442 }
443
444 //
445
446 /**
447 * Return the meta of the given story or a list of all known metas if the
448 * luid is "*".
449 * <p>
450 * Will not get the covers.
451 *
452 * @param luid
453 * the luid of the story or *
454 * @param pg
455 * the optional progress
456 *
457 *
458 * @return the metas
459 */
460 private List<MetaData> getMetasList(final String luid, Progress pg) {
461 final Progress pgF = pg;
462 final List<MetaData> metas = new ArrayList<MetaData>();
463
464 try {
465 new ConnectActionClientObject(host, port, true) {
466 @Override
467 public void action(Version serverVersion) throws Exception {
468 Progress pg = pgF;
469 if (pg == null) {
470 pg = new Progress();
471 }
472
473 Object rep = send(new Object[] { md5, "GET_METADATA", luid });
474
475 while (true) {
476 if (!RemoteLibraryServer.updateProgress(pg, rep)) {
477 break;
478 }
479
480 rep = send(null);
481 }
482
483 if (rep instanceof MetaData[]) {
484 for (MetaData meta : (MetaData[]) rep) {
485 metas.add(meta);
486 }
487 } else if (rep != null) {
488 metas.add((MetaData) rep);
489 }
490 }
491
492 @Override
493 protected void onError(Exception e) {
494 Instance.getTraceHandler().error(e);
495 }
496 }.connect();
497 } catch (Exception e) {
498 Instance.getTraceHandler().error(e);
499 }
500
501 return metas;
502 }
503}