library/WebLibrary.java

   1 package be.nikiroo.fanfix.library;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.io.InputStream;
   6 import java.net.URL;
   7 import java.util.ArrayList;
   8 import java.util.HashMap;
   9 import java.util.List;
  10 import java.util.Map;
  11
  12 import org.json.JSONArray;
  13 import org.json.JSONObject;
  14
  15 import be.nikiroo.fanfix.Instance;
  16 import be.nikiroo.fanfix.data.Chapter;
  17 import be.nikiroo.fanfix.data.JsonIO;
  18 import be.nikiroo.fanfix.data.MetaData;
  19 import be.nikiroo.fanfix.data.Paragraph;
  20 import be.nikiroo.fanfix.data.Paragraph.ParagraphType;
  21 import be.nikiroo.fanfix.data.Story;
  22 import be.nikiroo.utils.IOUtils;
  23 import be.nikiroo.utils.Image;
  24 import be.nikiroo.utils.Progress;
  25 import be.nikiroo.utils.Version;
  26
  27 /**
  28  * This {@link BasicLibrary} will access a remote server to list the available
  29  * stories, and download the ones you try to load to the local directory
  30  * specified in the configuration.
  31  * <p>
  32  * This remote library uses http:// or https://.
  33  *
  34  * @author niki
  35  */
  36 public class WebLibrary extends BasicLibrary {
  37         private String host;
  38         private int port;
  39         private final String key;
  40         private final String subkey;
  41
  42         // informative only (server will make the actual checks)
  43         private boolean rw;
  44
  45         /**
  46          * Create a {@link RemoteLibrary} linked to the given server.
  47          * <p>
  48          * Note that the key is structured:
  49          * <tt><b><i>xxx</i></b>(|<b><i>yyy</i></b>|<b>wl</b>)(|<b>rw</b>)</tt>
  50          * <p>
  51          * Note that anything before the first pipe (<tt>|</tt>) character is
  52          * considered to be the encryption key, anything after that character is
  53          * called the subkey (including the other pipe characters and flags!).
  54          * <p>
  55          * This is important because the subkey (including the pipe characters and
  56          * flags) must be present as-is in the server configuration file to be
  57          * allowed.
  58          * <ul>
  59          * <li><b><i>xxx</i></b>: the encryption key used to communicate with the
  60          * server</li>
  61          * <li><b><i>yyy</i></b>: the secondary key</li>
  62          * <li><b>rw</b>: flag to allow read and write access if it is not the
  63          * default on this server</li>
  64          * <li><b>wl</b>: flag to allow access to all the stories (bypassing the
  65          * whitelist if it exists)</li>
  66          * </ul>
  67          * <p>
  68          * Some examples:
  69          * <ul>
  70          * <li><b>my_key</b>: normal connection, will take the default server
  71          * options</li>
  72          * <li><b>my_key|agzyzz|wl</b>: will ask to bypass the white list (if it
  73          * exists)</li>
  74          * <li><b>my_key|agzyzz|rw</b>: will ask read-write access (if the default
  75          * is read-only)</li>
  76          * <li><b>my_key|agzyzz|wl|rw</b>: will ask both read-write access and white
  77          * list bypass</li>
  78          * </ul>
  79          *
  80          * @param key
  81          *            the key that will allow us to exchange information with the
  82          *            server
  83          * @param host
  84          *            the host to contact or NULL for localhost
  85          * @param port
  86          *            the port to contact it on
  87          */
  88         public WebLibrary(String key, String host, int port) {
  89                 int index = -1;
  90                 if (key != null) {
  91                         index = key.indexOf('|');
  92                 }
  93
  94                 if (index >= 0) {
  95                         this.key = key.substring(0, index);
  96                         this.subkey = key.substring(index + 1);
  97                 } else {
  98                         this.key = key;
  99                         this.subkey = "";
 100                 }
 101
 102                 this.rw = subkey.contains("|rw");
 103
 104                 this.host = host;
 105                 this.port = port;
 106         }
 107
 108         /**
 109          * Return the version of the program running server-side.
 110          * <p>
 111          * Never returns NULL.
 112          *
 113          * @return the version or an empty {@link Version} if not known
 114          */
 115         public Version getVersion() {
 116                 try {
 117                         InputStream in = post(WebLibraryUrls.VERSION_URL);
 118                         try {
 119                                 return new Version(IOUtils.readSmallStream(in));
 120                         } finally {
 121                                 in.close();
 122                         }
 123                 } catch (IOException e) {
 124                 }
 125
 126                 return new Version();
 127         }
 128
 129         @Override
 130         public Status getStatus() {
 131                 try {
 132                         post(WebLibraryUrls.INDEX_URL).close();
 133                 } catch (IOException e) {
 134                         try {
 135                                 post("/style.css").close();
 136                                 return Status.UNAUTHORIZED;
 137                         } catch (IOException ioe) {
 138                                 return Status.UNAVAILABLE;
 139                         }
 140                 }
 141
 142                 return rw ? Status.READ_WRITE : Status.READ_ONLY;
 143         }
 144
 145         @Override
 146         public String getLibraryName() {
 147                 return (rw ? "[READ-ONLY] " : "") + host + ":" + port + " ("
 148                                 + getVersion() + ")";
 149         }
 150
 151         @Override
 152         public Image getCover(String luid) throws IOException {
 153                 InputStream in = post(WebLibraryUrls.getStoryUrlCover(luid));
 154                 try {
 155                         Image img = new Image(in);
 156                         if (img.getSize() > 0) {
 157                                 return img;
 158                         }
 159
 160                         return null;
 161                 } finally {
 162                         in.close();
 163                 }
 164         }
 165
 166         @Override
 167         public Image getCustomSourceCover(String source) throws IOException {
 168                 InputStream in = post(WebLibraryUrls.getCoverUrlSource(source));
 169                 try {
 170                         Image img = new Image(in);
 171                         if (img.getSize() > 0) {
 172                                 return img;
 173                         }
 174
 175                         return null;
 176                 } finally {
 177                         in.close();
 178                 }
 179         }
 180
 181         @Override
 182         public Image getCustomAuthorCover(String author) throws IOException {
 183                 InputStream in = post(WebLibraryUrls.getCoverUrlAuthor(author));
 184                 try {
 185                         Image img = new Image(in);
 186                         if (img.getSize() > 0) {
 187                                 return img;
 188                         }
 189
 190                         return null;
 191                 } finally {
 192                         in.close();
 193                 }
 194         }
 195
 196         @Override
 197         public void setSourceCover(String source, String luid) throws IOException {
 198                 Map<String, String> post = new HashMap<String, String>();
 199                 post.put("luid", luid);
 200                 post(WebLibraryUrls.getCoverUrlSource(source), post).close();
 201         }
 202
 203         @Override
 204         public void setAuthorCover(String author, String luid) throws IOException {
 205                 Map<String, String> post = new HashMap<String, String>();
 206                 post.put("luid", luid);
 207                 post(WebLibraryUrls.getCoverUrlAuthor(author), post).close();
 208         }
 209
 210         @Override
 211         public synchronized Story getStory(final String luid, Progress pg)
 212                         throws IOException {
 213                 if (pg == null) {
 214                         pg = new Progress();
 215                 }
 216
 217                 Story story;
 218                 InputStream in = post(WebLibraryUrls.getStoryUrlJson(luid));
 219                 try {
 220                         JSONObject json = new JSONObject(IOUtils.readSmallStream(in));
 221                         story = JsonIO.toStory(json);
 222                 } finally {
 223                         in.close();
 224                 }
 225
 226                 int max = 0;
 227                 for (Chapter chap : story) {
 228                         max += chap.getParagraphs().size();
 229                 }
 230                 pg.setMinMax(0, max);
 231
 232                 story.getMeta().setCover(getCover(luid));
 233                 int chapNum = 1;
 234                 for (Chapter chap : story) {
 235                         int number = 1;
 236                         for (Paragraph para : chap) {
 237                                 if (para.getType() == ParagraphType.IMAGE) {
 238                                         InputStream subin = post(
 239                                                         WebLibraryUrls.getStoryUrl(luid, chapNum, number));
 240                                         try {
 241                                                 Image img = new Image(subin);
 242                                                 if (img.getSize() > 0) {
 243                                                         para.setContentImage(img);
 244                                                 }
 245                                         } finally {
 246                                                 subin.close();
 247                                         }
 248                                 }
 249
 250                                 pg.add(1);
 251                                 number++;
 252                         }
 253
 254                         chapNum++;
 255                 }
 256
 257                 pg.done();
 258                 return story;
 259         }
 260
 261         @Override
 262         protected List<MetaData> getMetas(Progress pg) throws IOException {
 263                 List<MetaData> metas = new ArrayList<MetaData>();
 264                 InputStream in = post(WebLibraryUrls.LIST_URL_METADATA);
 265                 JSONArray jsonArr = new JSONArray(IOUtils.readSmallStream(in));
 266                 for (int i = 0; i < jsonArr.length(); i++) {
 267                         JSONObject json = jsonArr.getJSONObject(i);
 268                         metas.add(JsonIO.toMetaData(json));
 269                 }
 270
 271                 return metas;
 272         }
 273
 274         @Override
 275         // Could work (more slowly) without it
 276         public MetaData imprt(final URL url, Progress pg) throws IOException {
 277                 if (pg == null) {
 278                         pg = new Progress();
 279                 }
 280
 281                 // Import the file locally if it is actually a file
 282
 283                 if (url == null || url.getProtocol().equalsIgnoreCase("file")) {
 284                         return super.imprt(url, pg);
 285                 }
 286
 287                 // Import it remotely if it is an URL
 288
 289                 try {
 290                         String luid = null;
 291
 292                         Map<String, String> post = new HashMap<String, String>();
 293                         post.put("url", url.toString());
 294                         InputStream in = post(WebLibraryUrls.IMPRT_URL_IMPORT, post);
 295                         try {
 296                                 luid = IOUtils.readSmallStream(in);
 297                         } finally {
 298                                 in.close();
 299                         }
 300
 301                         Progress subPg = null;
 302                         do {
 303                                 try {
 304                                         Thread.sleep(2000);
 305                                 } catch (InterruptedException e) {
 306                                 }
 307
 308                                 in = post(WebLibraryUrls.getImprtProgressUrl(luid));
 309                                 try {
 310                                         subPg = JsonIO.toProgress(
 311                                                         new JSONObject(IOUtils.readSmallStream(in)));
 312                                 } catch (Exception e) {
 313                                         subPg = null;
 314                                 } finally {
 315                                         in.close();
 316                                 }
 317                         } while (subPg != null);
 318
 319                         in = post(WebLibraryUrls.getStoryUrlMetadata(luid));
 320                         try {
 321                                 return JsonIO.toMetaData(
 322                                                 new JSONObject(IOUtils.readSmallStream(in)));
 323                         } finally {
 324                                 in.close();
 325                         }
 326                 } finally {
 327                         pg.done();
 328                 }
 329         }
 330
 331         @Override
 332         // Could work (more slowly) without it
 333         protected synchronized void changeSTA(final String luid,
 334                         final String newSource, final String newTitle,
 335                         final String newAuthor, Progress pg) throws IOException {
 336                 MetaData meta = getInfo(luid);
 337                 if (meta != null) {
 338                         if (!meta.getSource().equals(newSource)) {
 339                                 Map<String, String> post = new HashMap<String, String>();
 340                                 post.put("value", newSource);
 341                                 post(WebLibraryUrls.getStoryUrlSource(luid), post).close();
 342                         }
 343                         if (!meta.getTitle().equals(newTitle)) {
 344                                 Map<String, String> post = new HashMap<String, String>();
 345                                 post.put("value", newTitle);
 346                                 post(WebLibraryUrls.getStoryUrlTitle(luid), post).close();
 347                         }
 348                         if (!meta.getAuthor().equals(newAuthor)) {
 349                                 Map<String, String> post = new HashMap<String, String>();
 350                                 post.put("value", newAuthor);
 351                                 post(WebLibraryUrls.getStoryUrlAuthor(luid), post).close();
 352                         }
 353                 }
 354         }
 355
 356         @Override
 357         public synchronized void delete(String luid) throws IOException {
 358                 post(WebLibraryUrls.getDeleteUrlStory(luid), null).close();
 359         }
 360
 361         @Override
 362         protected void updateInfo(MetaData meta) {
 363                 // Will be taken care of directly server side
 364         }
 365
 366         @Override
 367         protected void invalidateInfo(String luid) {
 368                 // Will be taken care of directly server side
 369         }
 370
 371         // The following methods are only used by Save and Delete in BasicLibrary:
 372
 373         @Override
 374         protected String getNextId() {
 375                 throw new java.lang.InternalError("Should not have been called");
 376         }
 377
 378         @Override
 379         protected void doDelete(String luid) throws IOException {
 380                 throw new java.lang.InternalError("Should not have been called");
 381         }
 382
 383         @Override
 384         protected Story doSave(Story story, Progress pg) throws IOException {
 385                 throw new java.lang.InternalError("Should not have been called");
 386         }
 387
 388         //
 389
 390         @Override
 391         public File getFile(final String luid, Progress pg) {
 392                 throw new java.lang.InternalError(
 393                                 "Operation not supportorted on remote Libraries");
 394         }
 395
 396         // starts with "/", never NULL
 397         private InputStream post(String path) throws IOException {
 398                 return post(path, null);
 399         }
 400
 401         // starts with "/", never NULL
 402         private InputStream post(String path, Map<String, String> post)
 403                         throws IOException {
 404                 URL url = new URL(host + ":" + port + path);
 405
 406                 if (post == null) {
 407                         post = new HashMap<String, String>();
 408                 }
 409                 post.put("login", subkey);
 410                 post.put("password", key);
 411
 412                 return Instance.getInstance().getCache().openNoCache(url, null, post,
 413                                 null, null);
 414         }
 415 }