+++ /dev/null
-package be.nikiroo.fanfix.library;
-
-import java.io.File;
-import java.io.IOException;
-import java.net.URL;
-import java.net.UnknownHostException;
-import java.util.ArrayList;
-import java.util.List;
-
-import javax.net.ssl.SSLException;
-
-import be.nikiroo.fanfix.Instance;
-import be.nikiroo.fanfix.data.MetaData;
-import be.nikiroo.fanfix.data.Story;
-import be.nikiroo.utils.Image;
-import be.nikiroo.utils.Progress;
-import be.nikiroo.utils.Version;
-import be.nikiroo.utils.serial.server.ConnectActionClientObject;
-
-/**
- * This {@link BasicLibrary} will access a remote server to list the available
- * stories, and download the ones you try to load to the local directory
- * specified in the configuration.
- *
- * @author niki
- */
-public class RemoteLibrary extends BasicLibrary {
- private String host;
- private int port;
- private final String key;
- private final String subkey;
-
- // informative only (server will make the actual checks)
- private boolean rw;
-
- // TODO: error handling is not up to par!
-
- /**
- * Create a {@link RemoteLibrary} linked to the given server.
- * <p>
- * Note that the key is structured:
- * <tt><b><i>xxx</i></b>(|<b><i>yyy</i></b>|<b>wl</b>)(|<b>rw</b>)</tt>
- * <p>
- * Note that anything before the first pipe (<tt>|</tt>) character is
- * considered to be the encryption key, anything after that character is
- * called the subkey (including the other pipe characters and flags!).
- * <p>
- * This is important because the subkey (including the pipe characters and
- * flags) must be present as-is in the server configuration file to be
- * allowed.
- * <ul>
- * <li><b><i>xxx</i></b>: the encryption key used to communicate with the
- * server</li>
- * <li><b><i>yyy</i></b>: the secondary key</li>
- * <li><b>rw</b>: flag to allow read and write access if it is not the
- * default on this server</li>
- * <li><b>wl</b>: flag to allow access to all the stories (bypassing the
- * whitelist if it exists)</li>
- * </ul>
- *
- * Some examples:
- * <ul>
- * <li><b>my_key</b>: normal connection, will take the default server
- * options</li>
- * <li><b>my_key|agzyzz|wl</b>: will ask to bypass the white list (if it
- * exists)</li>
- * <li><b>my_key|agzyzz|rw</b>: will ask read-write access (if the default
- * is read-only)</li>
- * <li><b>my_key|agzyzz|wl|rw</b>: will ask both read-write access and white
- * list bypass</li>
- * </ul>
- *
- * @param key
- * the key that will allow us to exchange information with the
- * server
- * @param host
- * the host to contact or NULL for localhost
- * @param port
- * the port to contact it on
- */
- public RemoteLibrary(String key, String host, int port) {
- int index = -1;
- if (key != null) {
- index = key.indexOf('|');
- }
-
- if (index >= 0) {
- this.key = key.substring(0, index);
- this.subkey = key.substring(index + 1);
- } else {
- this.key = key;
- this.subkey = "";
- }
-
- this.host = host;
- this.port = port;
- }
-
- @Override
- public String getLibraryName() {
- return host + ":" + port;
- }
-
- @Override
- public Status getStatus() {
- Instance.getTraceHandler().trace("Getting remote lib status...");
- Status status = getStatusDo();
- Instance.getTraceHandler().trace("Remote lib status: " + status);
- return status;
- }
-
- private boolean check() {
- Status status = getStatusDo();
- if (status != Status.READY) {
- Instance.getTraceHandler().error("Remote lib not ready: " + status);
- return false;
- }
-
- return true;
- }
-
- private Status getStatusDo() {
- final Status[] result = new Status[1];
-
- result[0] = Status.INVALID;
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Object rep = send(new Object[] { subkey, "PING" });
-
- if ("r/w".equals(rep)) {
- rw = true;
- result[0] = Status.READY;
- } else if ("r/o".equals(rep)) {
- rw = false;
- result[0] = Status.READY;
- } else {
- result[0] = Status.UNAUTHORIZED;
- }
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- result[0] = Status.UNAUTHORIZED;
- } else {
- result[0] = Status.UNAVAILABLE;
- }
- }
- }.connect();
- } catch (UnknownHostException e) {
- result[0] = Status.INVALID;
- } catch (IllegalArgumentException e) {
- result[0] = Status.INVALID;
- } catch (Exception e) {
- result[0] = Status.UNAVAILABLE;
- }
-
- return result[0];
- }
-
- @Override
- public Image getCover(final String luid) {
- if (!check()) {
- return null;
- }
-
- final Image[] result = new Image[1];
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Object rep = send(new Object[] { subkey, "GET_COVER", luid });
- result[0] = (Image) rep;
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (Exception e) {
- Instance.getTraceHandler().error(e);
- }
-
- return result[0];
- }
-
- @Override
- public Image getCustomSourceCover(final String source) {
- if (!check()) {
- return null;
- }
-
- return getCustomCover(source, "SOURCE");
- }
-
- @Override
- public Image getCustomAuthorCover(final String author) {
- if (!check()) {
- return null;
- }
-
- return getCustomCover(author, "AUTHOR");
- }
-
- // type: "SOURCE" or "AUTHOR"
- private Image getCustomCover(final String source, final String type) {
- if (!check()) {
- return null;
- }
-
- final Image[] result = new Image[1];
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Object rep = send(new Object[] { subkey,
- "GET_CUSTOM_COVER", type, source });
- result[0] = (Image) rep;
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (Exception e) {
- Instance.getTraceHandler().error(e);
- }
-
- return result[0];
- }
-
- @Override
- public synchronized Story getStory(final String luid, Progress pg) {
- if (!check()) {
- return null;
- }
-
- final Progress pgF = pg;
- final Story[] result = new Story[1];
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Progress pg = pgF;
- if (pg == null) {
- pg = new Progress();
- }
-
- Object rep = send(new Object[] { subkey, "GET_STORY", luid });
-
- MetaData meta = null;
- if (rep instanceof MetaData) {
- meta = (MetaData) rep;
- if (meta.getWords() <= Integer.MAX_VALUE) {
- pg.setMinMax(0, (int) meta.getWords());
- }
- }
-
- List<Object> list = new ArrayList<Object>();
- for (Object obj = send(null); obj != null; obj = send(null)) {
- list.add(obj);
- pg.add(1);
- }
-
- result[0] = RemoteLibraryServer.rebuildStory(list);
- pg.done();
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (Exception e) {
- Instance.getTraceHandler().error(e);
- }
-
- return result[0];
- }
-
- @Override
- public synchronized Story save(final Story story, final String luid,
- Progress pg) throws IOException {
- if (!check()) {
- return null;
- }
-
- final String[] luidSaved = new String[1];
- Progress pgSave = new Progress();
- Progress pgRefresh = new Progress();
- if (pg == null) {
- pg = new Progress();
- }
-
- pg.setMinMax(0, 10);
- pg.addProgress(pgSave, 9);
- pg.addProgress(pgRefresh, 1);
-
- final Progress pgF = pgSave;
-
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Progress pg = pgF;
- if (story.getMeta().getWords() <= Integer.MAX_VALUE) {
- pg.setMinMax(0, (int) story.getMeta().getWords());
- }
-
- send(new Object[] { subkey, "SAVE_STORY", luid });
-
- List<Object> list = RemoteLibraryServer.breakStory(story);
- for (Object obj : list) {
- send(obj);
- pg.add(1);
- }
-
- luidSaved[0] = (String) send(null);
-
- pg.done();
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
-
- // because the meta changed:
- MetaData meta = getInfo(luidSaved[0]);
- if (story.getMeta().getClass() != null) {
- // If already available locally:
- meta.setCover(story.getMeta().getCover());
- } else {
- // If required:
- meta.setCover(getCover(meta.getLuid()));
- }
- story.setMeta(meta);
-
- pg.done();
-
- return story;
- }
-
- @Override
- public synchronized void delete(final String luid) throws IOException {
- if (!check()) {
- throw new IOException("Library not ready");
- }
-
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- send(new Object[] { subkey, "DELETE_STORY", luid });
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- }
-
- @Override
- public void setSourceCover(final String source, final String luid) {
- if (!check()) {
- return;
- }
-
- setCover(source, luid, "SOURCE");
- }
-
- @Override
- public void setAuthorCover(final String author, final String luid) {
- if (!check()) {
- return;
- }
-
- setCover(author, luid, "AUTHOR");
- }
-
- // type = "SOURCE" | "AUTHOR"
- private void setCover(final String value, final String luid,
- final String type) {
- if (!check()) {
- return;
- }
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- send(new Object[] { subkey, "SET_COVER", type, value, luid });
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (IOException e) {
- Instance.getTraceHandler().error(e);
- }
- }
-
- @Override
- // Could work (more slowly) without it
- public Story imprt(final URL url, Progress pg) throws IOException {
- if (!check()) {
- return null;
- }
-
- // Import the file locally if it is actually a file
- if (url == null || url.getProtocol().equalsIgnoreCase("file")) {
- return super.imprt(url, pg);
- }
-
- // Import it remotely if it is an URL
-
- if (pg == null) {
- pg = new Progress();
- }
-
- pg.setMinMax(0, 2);
- Progress pgImprt = new Progress();
- Progress pgGet = new Progress();
- pg.addProgress(pgImprt, 1);
- pg.addProgress(pgGet, 1);
-
- final Progress pgF = pgImprt;
- final String[] luid = new String[1];
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Progress pg = pgF;
-
- Object rep = send(new Object[] { subkey, "IMPORT",
- url.toString() });
-
- while (true) {
- if (!RemoteLibraryServer.updateProgress(pg, rep)) {
- break;
- }
-
- rep = send(null);
- }
-
- pg.done();
- luid[0] = (String) rep;
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (IOException e) {
- Instance.getTraceHandler().error(e);
- }
-
- if (luid[0] == null) {
- throw new IOException("Remote failure");
- }
-
- Story story = getStory(luid[0], pgGet);
- pgGet.done();
-
- pg.done();
- return story;
- }
-
- @Override
- // Could work (more slowly) without it
- protected synchronized void changeSTA(final String luid,
- final String newSource, final String newTitle,
- final String newAuthor, Progress pg) throws IOException {
- if (!check()) {
- return;
- }
-
- final Progress pgF = pg == null ? new Progress() : pg;
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Progress pg = pgF;
-
- Object rep = send(new Object[] { subkey, "CHANGE_STA",
- luid, newSource, newTitle, newAuthor });
- while (true) {
- if (!RemoteLibraryServer.updateProgress(pg, rep)) {
- break;
- }
-
- rep = send(null);
- }
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (IOException e) {
- Instance.getTraceHandler().error(e);
- }
- }
-
- @Override
- public synchronized File getFile(final String luid, Progress pg) {
- throw new java.lang.InternalError(
- "Operation not supportorted on remote Libraries");
- }
-
- /**
- * Stop the server.
- */
- public void exit() {
- if (!check()) {
- return;
- }
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- send(new Object[] { subkey, "EXIT" });
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (IOException e) {
- Instance.getTraceHandler().error(e);
- }
- }
-
- @Override
- public synchronized MetaData getInfo(String luid) {
- if (!check()) {
- return null;
- }
-
- List<MetaData> metas = getMetasList(luid, null);
- if (!metas.isEmpty()) {
- return metas.get(0);
- }
-
- return null;
- }
-
- @Override
- protected List<MetaData> getMetas(Progress pg) {
- return getMetasList("*", pg);
- }
-
- @Override
- protected void updateInfo(MetaData meta) {
- // Will be taken care of directly server side
- }
-
- @Override
- protected void invalidateInfo(String luid) {
- // Will be taken care of directly server side
- }
-
- // The following methods are only used by Save and Delete in BasicLibrary:
-
- @Override
- protected int getNextId() {
- throw new java.lang.InternalError("Should not have been called");
- }
-
- @Override
- protected void doDelete(String luid) throws IOException {
- throw new java.lang.InternalError("Should not have been called");
- }
-
- @Override
- protected Story doSave(Story story, Progress pg) throws IOException {
- throw new java.lang.InternalError("Should not have been called");
- }
-
- //
-
- /**
- * Return the meta of the given story or a list of all known metas if the
- * luid is "*".
- * <p>
- * Will not get the covers.
- *
- * @param luid
- * the luid of the story or *
- * @param pg
- * the optional progress
- *
- *
- * @return the metas
- */
- private List<MetaData> getMetasList(final String luid, Progress pg) {
- if (!check()) {
- return null;
- }
-
- final Progress pgF = pg;
- final List<MetaData> metas = new ArrayList<MetaData>();
-
- try {
- new ConnectActionClientObject(host, port, key) {
- @Override
- public void action(Version serverVersion) throws Exception {
- Progress pg = pgF;
- if (pg == null) {
- pg = new Progress();
- }
-
- Object rep = send(new Object[] { subkey, "GET_METADATA",
- luid });
-
- while (true) {
- if (!RemoteLibraryServer.updateProgress(pg, rep)) {
- break;
- }
-
- rep = send(null);
- }
-
- if (rep instanceof MetaData[]) {
- for (MetaData meta : (MetaData[]) rep) {
- metas.add(meta);
- }
- } else if (rep != null) {
- metas.add((MetaData) rep);
- }
- }
-
- @Override
- protected void onError(Exception e) {
- if (e instanceof SSLException) {
- Instance.getTraceHandler().error(
- "Connection refused (bad key)");
- } else {
- Instance.getTraceHandler().error(e);
- }
- }
- }.connect();
- } catch (Exception e) {
- Instance.getTraceHandler().error(e);
- }
-
- return metas;
- }
-}
git://git.nikiroo.be / fanfix.git / blobdiff