1 package be
.nikiroo
.fanfix
.library
;
4 import java
.io
.IOException
;
6 import java
.net
.UnknownHostException
;
7 import java
.util
.ArrayList
;
10 import javax
.net
.ssl
.SSLException
;
12 import be
.nikiroo
.fanfix
.Instance
;
13 import be
.nikiroo
.fanfix
.data
.MetaData
;
14 import be
.nikiroo
.fanfix
.data
.Story
;
15 import be
.nikiroo
.utils
.Image
;
16 import be
.nikiroo
.utils
.Progress
;
17 import be
.nikiroo
.utils
.Version
;
18 import be
.nikiroo
.utils
.serial
.server
.ConnectActionClientObject
;
21 * This {@link BasicLibrary} will access a remote server to list the available
22 * stories, and download the ones you try to load to the local directory
23 * specified in the configuration.
27 public class RemoteLibrary
extends BasicLibrary
{
28 interface RemoteAction
{
29 public void action(ConnectActionClientObject action
) throws Exception
;
32 class RemoteConnectAction
extends ConnectActionClientObject
{
33 public RemoteConnectAction() throws IOException
{
34 super(host
, port
, key
);
38 public Object
send(Object data
) throws IOException
,
39 NoSuchFieldException
, NoSuchMethodException
,
40 ClassNotFoundException
{
41 Object rep
= super.send(data
);
42 if (rep
instanceof RemoteLibraryException
) {
43 RemoteLibraryException remoteEx
= (RemoteLibraryException
) rep
;
44 IOException cause
= remoteEx
.getCause();
46 cause
= new IOException("IOException");
58 private final String key
;
59 private final String subkey
;
61 // informative only (server will make the actual checks)
64 // TODO: error handling is not up to par!
67 * Create a {@link RemoteLibrary} linked to the given server.
69 * Note that the key is structured:
70 * <tt><b><i>xxx</i></b>(|<b><i>yyy</i></b>|<b>wl</b>)(|<b>rw</b>)</tt>
72 * Note that anything before the first pipe (<tt>|</tt>) character is
73 * considered to be the encryption key, anything after that character is
74 * called the subkey (including the other pipe characters and flags!).
76 * This is important because the subkey (including the pipe characters and
77 * flags) must be present as-is in the server configuration file to be
80 * <li><b><i>xxx</i></b>: the encryption key used to communicate with the
82 * <li><b><i>yyy</i></b>: the secondary key</li>
83 * <li><b>rw</b>: flag to allow read and write access if it is not the
84 * default on this server</li>
85 * <li><b>wl</b>: flag to allow access to all the stories (bypassing the
86 * whitelist if it exists)</li>
91 * <li><b>my_key</b>: normal connection, will take the default server
93 * <li><b>my_key|agzyzz|wl</b>: will ask to bypass the white list (if it
95 * <li><b>my_key|agzyzz|rw</b>: will ask read-write access (if the default
97 * <li><b>my_key|agzyzz|wl|rw</b>: will ask both read-write access and white
102 * the key that will allow us to exchange information with the
105 * the host to contact or NULL for localhost
107 * the port to contact it on
109 public RemoteLibrary(String key
, String host
, int port
) {
112 index
= key
.indexOf('|');
116 this.key
= key
.substring(0, index
);
117 this.subkey
= key
.substring(index
+ 1);
128 public String
getLibraryName() {
129 return host
+ ":" + port
;
133 public Status
getStatus() {
134 Instance
.getTraceHandler().trace("Getting remote lib status...");
135 Status status
= getStatusDo();
136 Instance
.getTraceHandler().trace("Remote lib status: " + status
);
140 private Status
getStatusDo() {
141 final Status
[] result
= new Status
[1];
143 result
[0] = Status
.INVALID
;
146 new RemoteConnectAction() {
148 public void action(Version serverVersion
) throws Exception
{
149 Object rep
= send(new Object
[] { subkey
, "PING" });
151 if ("r/w".equals(rep
)) {
153 result
[0] = Status
.READY
;
154 } else if ("r/o".equals(rep
)) {
156 result
[0] = Status
.READY
;
158 result
[0] = Status
.UNAUTHORIZED
;
163 protected void onError(Exception e
) {
164 if (e
instanceof SSLException
) {
165 result
[0] = Status
.UNAUTHORIZED
;
167 result
[0] = Status
.UNAVAILABLE
;
171 } catch (UnknownHostException e
) {
172 result
[0] = Status
.INVALID
;
173 } catch (IllegalArgumentException e
) {
174 result
[0] = Status
.INVALID
;
175 } catch (Exception e
) {
176 result
[0] = Status
.UNAVAILABLE
;
183 public Image
getCover(final String luid
) {
184 final Image
[] result
= new Image
[1];
186 connectRemoteAction(new RemoteAction() {
188 public void action(ConnectActionClientObject action
)
190 Object rep
= action
.send(new Object
[] { subkey
, "GET_COVER",
192 result
[0] = (Image
) rep
;
200 public Image
getCustomSourceCover(final String source
) {
201 return getCustomCover(source
, "SOURCE");
205 public Image
getCustomAuthorCover(final String author
) {
206 return getCustomCover(author
, "AUTHOR");
209 // type: "SOURCE" or "AUTHOR"
210 private Image
getCustomCover(final String source
, final String type
) {
211 final Image
[] result
= new Image
[1];
213 connectRemoteAction(new RemoteAction() {
215 public void action(ConnectActionClientObject action
)
217 Object rep
= action
.send(new Object
[] { subkey
,
218 "GET_CUSTOM_COVER", type
, source
});
219 result
[0] = (Image
) rep
;
227 public synchronized Story
getStory(final String luid
, Progress pg
) {
228 final Progress pgF
= pg
;
229 final Story
[] result
= new Story
[1];
231 connectRemoteAction(new RemoteAction() {
233 public void action(ConnectActionClientObject action
)
240 Object rep
= action
.send(new Object
[] { subkey
, "GET_STORY",
243 MetaData meta
= null;
244 if (rep
instanceof MetaData
) {
245 meta
= (MetaData
) rep
;
246 if (meta
.getWords() <= Integer
.MAX_VALUE
) {
247 pg
.setMinMax(0, (int) meta
.getWords());
251 List
<Object
> list
= new ArrayList
<Object
>();
252 for (Object obj
= action
.send(null); obj
!= null; obj
= action
258 result
[0] = RemoteLibraryServer
.rebuildStory(list
);
267 public synchronized Story
save(final Story story
, final String luid
,
268 Progress pg
) throws IOException
{
270 final String
[] luidSaved
= new String
[1];
271 Progress pgSave
= new Progress();
272 Progress pgRefresh
= new Progress();
278 pg
.addProgress(pgSave
, 9);
279 pg
.addProgress(pgRefresh
, 1);
281 final Progress pgF
= pgSave
;
283 connectRemoteAction(new RemoteAction() {
285 public void action(ConnectActionClientObject action
)
288 if (story
.getMeta().getWords() <= Integer
.MAX_VALUE
) {
289 pg
.setMinMax(0, (int) story
.getMeta().getWords());
292 action
.send(new Object
[] { subkey
, "SAVE_STORY", luid
});
294 List
<Object
> list
= RemoteLibraryServer
.breakStory(story
);
295 for (Object obj
: list
) {
300 luidSaved
[0] = (String
) action
.send(null);
306 // because the meta changed:
307 MetaData meta
= getInfo(luidSaved
[0]);
308 if (story
.getMeta().getClass() != null) {
309 // If already available locally:
310 meta
.setCover(story
.getMeta().getCover());
313 meta
.setCover(getCover(meta
.getLuid()));
323 public synchronized void delete(final String luid
) throws IOException
{
324 connectRemoteAction(new RemoteAction() {
326 public void action(ConnectActionClientObject action
)
328 action
.send(new Object
[] { subkey
, "DELETE_STORY", luid
});
334 public void setSourceCover(final String source
, final String luid
) {
335 setCover(source
, luid
, "SOURCE");
339 public void setAuthorCover(final String author
, final String luid
) {
340 setCover(author
, luid
, "AUTHOR");
343 // type = "SOURCE" | "AUTHOR"
344 private void setCover(final String value
, final String luid
,
346 connectRemoteAction(new RemoteAction() {
348 public void action(ConnectActionClientObject action
)
350 action
.send(new Object
[] { subkey
, "SET_COVER", type
, value
,
357 // Could work (more slowly) without it
358 public Story
imprt(final URL url
, Progress pg
) throws IOException
{
359 // Import the file locally if it is actually a file
360 if (url
== null || url
.getProtocol().equalsIgnoreCase("file")) {
361 return super.imprt(url
, pg
);
364 // Import it remotely if it is an URL
371 Progress pgImprt
= new Progress();
372 Progress pgGet
= new Progress();
373 pg
.addProgress(pgImprt
, 1);
374 pg
.addProgress(pgGet
, 1);
376 final Progress pgF
= pgImprt
;
377 final String
[] luid
= new String
[1];
379 connectRemoteAction(new RemoteAction() {
381 public void action(ConnectActionClientObject action
)
385 Object rep
= action
.send(new Object
[] { subkey
, "IMPORT",
389 if (!RemoteLibraryServer
.updateProgress(pg
, rep
)) {
393 rep
= action
.send(null);
397 luid
[0] = (String
) rep
;
401 if (luid
[0] == null) {
402 throw new IOException("Remote failure");
405 Story story
= getStory(luid
[0], pgGet
);
413 // Could work (more slowly) without it
414 protected synchronized void changeSTA(final String luid
,
415 final String newSource
, final String newTitle
,
416 final String newAuthor
, Progress pg
) throws IOException
{
418 final Progress pgF
= pg
== null ?
new Progress() : pg
;
420 connectRemoteAction(new RemoteAction() {
422 public void action(ConnectActionClientObject action
)
426 Object rep
= action
.send(new Object
[] { subkey
, "CHANGE_STA",
427 luid
, newSource
, newTitle
, newAuthor
});
429 if (!RemoteLibraryServer
.updateProgress(pg
, rep
)) {
433 rep
= action
.send(null);
440 public synchronized File
getFile(final String luid
, Progress pg
) {
441 throw new java
.lang
.InternalError(
442 "Operation not supportorted on remote Libraries");
449 connectRemoteAction(new RemoteAction() {
451 public void action(ConnectActionClientObject action
)
453 action
.send(new Object
[] { subkey
, "EXIT" });
459 public synchronized MetaData
getInfo(String luid
) {
460 List
<MetaData
> metas
= getMetasList(luid
, null);
461 if (!metas
.isEmpty()) {
469 protected List
<MetaData
> getMetas(Progress pg
) {
470 return getMetasList("*", pg
);
474 protected void updateInfo(MetaData meta
) {
475 // Will be taken care of directly server side
479 protected void invalidateInfo(String luid
) {
480 // Will be taken care of directly server side
483 // The following methods are only used by Save and Delete in BasicLibrary:
486 protected int getNextId() {
487 throw new java
.lang
.InternalError("Should not have been called");
491 protected void doDelete(String luid
) throws IOException
{
492 throw new java
.lang
.InternalError("Should not have been called");
496 protected Story
doSave(Story story
, Progress pg
) throws IOException
{
497 throw new java
.lang
.InternalError("Should not have been called");
503 * Return the meta of the given story or a list of all known metas if the
506 * Will not get the covers.
509 * the luid of the story or *
511 * the optional progress
516 private List
<MetaData
> getMetasList(final String luid
, Progress pg
) {
517 final Progress pgF
= pg
;
518 final List
<MetaData
> metas
= new ArrayList
<MetaData
>();
520 connectRemoteAction(new RemoteAction() {
522 public void action(ConnectActionClientObject action
)
529 Object rep
= action
.send(new Object
[] { subkey
, "GET_METADATA",
533 if (!RemoteLibraryServer
.updateProgress(pg
, rep
)) {
537 rep
= action
.send(null);
540 if (rep
instanceof MetaData
[]) {
541 for (MetaData meta
: (MetaData
[]) rep
) {
544 } else if (rep
!= null) {
545 metas
.add((MetaData
) rep
);
553 private void connectRemoteAction(final RemoteAction runAction
) {
555 final RemoteConnectAction
[] array
= new RemoteConnectAction
[1];
556 RemoteConnectAction ra
= new RemoteConnectAction() {
558 public void action(Version serverVersion
) throws Exception
{
559 runAction
.action(array
[0]);
563 protected void onError(Exception e
) {
564 if (e
instanceof SSLException
) {
565 Instance
.getTraceHandler().error(
566 "Connection refused (bad key)");
568 Instance
.getTraceHandler().error(e
);
574 } catch (Exception e
) {
575 Instance
.getTraceHandler().error(e
);