| 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 | // TODO: not supported yet |
| 108 | this.rw = false; |
| 109 | } |
| 110 | |
| 111 | public Version getVersion() { |
| 112 | try { |
| 113 | InputStream in = download(WebLibraryUrls.VERSION_URL); |
| 114 | try { |
| 115 | return new Version(IOUtils.readSmallStream(in)); |
| 116 | } finally { |
| 117 | in.close(); |
| 118 | } |
| 119 | } catch (IOException e) { |
| 120 | } |
| 121 | |
| 122 | return new Version(); |
| 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public Status getStatus() { |
| 127 | try { |
| 128 | download(WebLibraryUrls.INDEX_URL).close(); |
| 129 | } catch (IOException e) { |
| 130 | try { |
| 131 | download(WebLibraryUrls.VERSION_URL).close(); |
| 132 | return Status.UNAUTHORIZED; |
| 133 | } catch (IOException ioe) { |
| 134 | return Status.UNAVAILABLE; |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | return rw ? Status.READ_WRITE : Status.READ_ONLY; |
| 139 | } |
| 140 | |
| 141 | @Override |
| 142 | public String getLibraryName() { |
| 143 | return (rw ? "[READ-ONLY] " : "") + host + ":" + port + " (" |
| 144 | + getVersion() + ")"; |
| 145 | } |
| 146 | |
| 147 | @Override |
| 148 | public Image getCover(String luid) throws IOException { |
| 149 | InputStream in = download(WebLibraryUrls.getStoryUrlCover(luid)); |
| 150 | try { |
| 151 | return new Image(in); |
| 152 | } finally { |
| 153 | in.close(); |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public Image getCustomSourceCover(final String source) throws IOException { |
| 159 | // TODO maybe global system in BasicLib ? |
| 160 | return null; |
| 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public Image getCustomAuthorCover(final String author) throws IOException { |
| 165 | // TODO maybe global system in BasicLib ? |
| 166 | return null; |
| 167 | } |
| 168 | |
| 169 | @Override |
| 170 | public void setSourceCover(String source, String luid) throws IOException { |
| 171 | // TODO Auto-generated method stub |
| 172 | throw new IOException("Not implemented yet"); |
| 173 | } |
| 174 | |
| 175 | @Override |
| 176 | public void setAuthorCover(String author, String luid) throws IOException { |
| 177 | // TODO Auto-generated method stub |
| 178 | throw new IOException("Not implemented yet"); |
| 179 | } |
| 180 | |
| 181 | @Override |
| 182 | public synchronized Story getStory(final String luid, Progress pg) |
| 183 | throws IOException { |
| 184 | |
| 185 | // TODO: pg |
| 186 | |
| 187 | Story story; |
| 188 | InputStream in = download(WebLibraryUrls.getStoryUrlJson(luid)); |
| 189 | try { |
| 190 | JSONObject json = new JSONObject(IOUtils.readSmallStream(in)); |
| 191 | story = JsonIO.toStory(json); |
| 192 | } finally { |
| 193 | in.close(); |
| 194 | } |
| 195 | |
| 196 | story.getMeta().setCover(getCover(luid)); |
| 197 | int chapNum = 1; |
| 198 | for (Chapter chap : story) { |
| 199 | int number = 1; |
| 200 | for (Paragraph para : chap) { |
| 201 | if (para.getType() == ParagraphType.IMAGE) { |
| 202 | InputStream subin = download( |
| 203 | WebLibraryUrls.getStoryUrl(luid, chapNum, number)); |
| 204 | try { |
| 205 | para.setContentImage(new Image(subin)); |
| 206 | } finally { |
| 207 | subin.close(); |
| 208 | } |
| 209 | } |
| 210 | |
| 211 | number++; |
| 212 | } |
| 213 | |
| 214 | chapNum++; |
| 215 | } |
| 216 | |
| 217 | return story; |
| 218 | } |
| 219 | |
| 220 | @Override |
| 221 | protected List<MetaData> getMetas(Progress pg) throws IOException { |
| 222 | List<MetaData> metas = new ArrayList<MetaData>(); |
| 223 | InputStream in = download(WebLibraryUrls.LIST_URL_METADATA); |
| 224 | JSONArray jsonArr = new JSONArray(IOUtils.readSmallStream(in)); |
| 225 | for (int i = 0; i < jsonArr.length(); i++) { |
| 226 | JSONObject json = jsonArr.getJSONObject(i); |
| 227 | metas.add(JsonIO.toMetaData(json)); |
| 228 | } |
| 229 | |
| 230 | return metas; |
| 231 | } |
| 232 | |
| 233 | @Override |
| 234 | // Could work (more slowly) without it |
| 235 | public MetaData imprt(final URL url, Progress pg) throws IOException { |
| 236 | if (true) |
| 237 | throw new IOException("Not implemented yet"); |
| 238 | |
| 239 | // Import the file locally if it is actually a file |
| 240 | |
| 241 | if (url == null || url.getProtocol().equalsIgnoreCase("file")) { |
| 242 | return super.imprt(url, pg); |
| 243 | } |
| 244 | |
| 245 | // Import it remotely if it is an URL |
| 246 | |
| 247 | // TODO |
| 248 | return super.imprt(url, pg); |
| 249 | } |
| 250 | |
| 251 | @Override |
| 252 | // Could work (more slowly) without it |
| 253 | protected synchronized void changeSTA(final String luid, |
| 254 | final String newSource, final String newTitle, |
| 255 | final String newAuthor, Progress pg) throws IOException { |
| 256 | // TODO |
| 257 | super.changeSTA(luid, newSource, newTitle, newAuthor, pg); |
| 258 | } |
| 259 | |
| 260 | @Override |
| 261 | protected void updateInfo(MetaData meta) { |
| 262 | // Will be taken care of directly server side |
| 263 | } |
| 264 | |
| 265 | @Override |
| 266 | protected void invalidateInfo(String luid) { |
| 267 | // Will be taken care of directly server side |
| 268 | } |
| 269 | |
| 270 | // The following methods are only used by Save and Delete in BasicLibrary: |
| 271 | |
| 272 | @Override |
| 273 | protected int getNextId() { |
| 274 | throw new java.lang.InternalError("Should not have been called"); |
| 275 | } |
| 276 | |
| 277 | @Override |
| 278 | protected void doDelete(String luid) throws IOException { |
| 279 | throw new java.lang.InternalError("Should not have been called"); |
| 280 | } |
| 281 | |
| 282 | @Override |
| 283 | protected Story doSave(Story story, Progress pg) throws IOException { |
| 284 | throw new java.lang.InternalError("Should not have been called"); |
| 285 | } |
| 286 | |
| 287 | // |
| 288 | |
| 289 | @Override |
| 290 | public File getFile(final String luid, Progress pg) { |
| 291 | throw new java.lang.InternalError( |
| 292 | "Operation not supportorted on remote Libraries"); |
| 293 | } |
| 294 | |
| 295 | // starts with "/", never NULL |
| 296 | private InputStream download(String path) throws IOException { |
| 297 | URL url = new URL(host + ":" + port + path); |
| 298 | |
| 299 | Map<String, String> post = new HashMap<String, String>(); |
| 300 | post.put("login", subkey); |
| 301 | post.put("password", key); |
| 302 | |
| 303 | return Instance.getInstance().getCache().openNoCache(url, null, post, |
| 304 | null, null); |
| 305 | } |
| 306 | } |