Fix bug when moving an unopened book in GUI
[fanfix.git] / src / be / nikiroo / fanfix / Cache.java
index 8e8392aa12d61795b53ce03d320e591f11b20712..383fa7c87a8cdd3f40b1041c9ac49e5d091e0189 100644 (file)
@@ -3,6 +3,7 @@ package be.nikiroo.fanfix;
 import java.io.BufferedOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -13,7 +14,6 @@ import java.net.CookiePolicy;
 import java.net.CookieStore;
 import java.net.HttpCookie;
 import java.net.HttpURLConnection;
-import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLEncoder;
@@ -26,6 +26,7 @@ import javax.imageio.ImageIO;
 import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.supported.BasicSupport;
 import be.nikiroo.utils.IOUtils;
+import be.nikiroo.utils.ImageUtils;
 import be.nikiroo.utils.MarkableFileInputStream;
 
 /**
@@ -140,7 +141,11 @@ public class Cache {
                // MUST NOT return null
                try {
                        InputStream in = load(originalUrl, false, stable);
+                       Instance.trace("Cache " + (in != null ? "hit" : "miss") + ": "
+                                       + url);
+
                        if (in == null) {
+
                                try {
                                        save(url, support, originalUrl);
                                } catch (IOException e) {
@@ -175,7 +180,7 @@ public class Cache {
         */
        public InputStream openNoCache(URL url, BasicSupport support)
                        throws IOException {
-               return openNoCache(url, support, url, null);
+               return openNoCache(url, support, url, null, null, null);
        }
 
        /**
@@ -188,6 +193,10 @@ public class Cache {
         *            the {@link BasicSupport} used for the cookies
         * @param postParams
         *            the POST parameters
+        * @param getParams
+        *            the GET parameters (priority over POST)
+        * @param oauth
+        *            OAuth authorization (aka, "bearer XXXXXXX")
         * 
         * @return the {@link InputStream} of the opened page
         * 
@@ -195,8 +204,9 @@ public class Cache {
         *             in case of I/O error
         */
        public InputStream openNoCache(URL url, BasicSupport support,
-                       Map<String, String> postParams) throws IOException {
-               return openNoCache(url, support, url, postParams);
+                       Map<String, String> postParams, Map<String, String> getParams,
+                       String oauth) throws IOException {
+               return openNoCache(url, support, url, postParams, getParams, oauth);
        }
 
        /**
@@ -211,36 +221,73 @@ public class Cache {
         *            the original {@link URL} before any redirection occurs
         * @param postParams
         *            the POST parameters
-        * 
+        * @param getParams
+        *            the GET parameters (priority over POST)
+        * @param oauth
+        *            OAuth authorisation (aka, "bearer XXXXXXX")
         * @return the {@link InputStream} of the opened page
         * 
         * @throws IOException
         *             in case of I/O error
         */
        private InputStream openNoCache(URL url, BasicSupport support,
-                       final URL originalUrl, Map<String, String> postParams)
-                       throws IOException {
+                       final URL originalUrl, Map<String, String> postParams,
+                       Map<String, String> getParams, String oauth) throws IOException {
+
+               Instance.trace("Open no cache: " + url);
 
                URLConnection conn = openConnectionWithCookies(url, support);
-               if (postParams != null) {
-                       StringBuilder postData = new StringBuilder();
-                       for (Map.Entry<String, String> param : postParams.entrySet()) {
-                               if (postData.length() != 0)
-                                       postData.append('&');
-                               postData.append(URLEncoder.encode(param.getKey(), "UTF-8"));
-                               postData.append('=');
-                               postData.append(URLEncoder.encode(
-                                               String.valueOf(param.getValue()), "UTF-8"));
+               if (support != null) {
+                       // priority: arguments
+                       if (oauth == null) {
+                               oauth = support.getOAuth();
+                       }
+               }
+
+               // Priority: GET over POST
+               Map<String, String> params = getParams;
+               if (getParams == null) {
+                       params = postParams;
+               }
+
+               if ((params != null || oauth != null)
+                               && conn instanceof HttpURLConnection) {
+                       StringBuilder requestData = null;
+                       if (params != null) {
+                               requestData = new StringBuilder();
+                               for (Map.Entry<String, String> param : params.entrySet()) {
+                                       if (requestData.length() != 0)
+                                               requestData.append('&');
+                                       requestData.append(URLEncoder.encode(param.getKey(),
+                                                       "UTF-8"));
+                                       requestData.append('=');
+                                       requestData.append(URLEncoder.encode(
+                                                       String.valueOf(param.getValue()), "UTF-8"));
+                               }
+
+                               conn.setDoOutput(true);
+
+                               if (getParams == null && postParams != null) {
+                                       ((HttpURLConnection) conn).setRequestMethod("POST");
+                               }
+
+                               conn.setRequestProperty("Content-Type",
+                                               "application/x-www-form-urlencoded");
+                               conn.setRequestProperty("charset", "utf-8");
                        }
 
-                       conn.setDoOutput(true);
+                       if (oauth != null) {
+                               conn.setRequestProperty("Authorization", oauth);
+                       }
 
-                       OutputStreamWriter writer = new OutputStreamWriter(
-                                       conn.getOutputStream());
+                       if (requestData != null) {
+                               OutputStreamWriter writer = new OutputStreamWriter(
+                                               conn.getOutputStream());
 
-                       writer.write(postData.toString());
-                       writer.flush();
-                       writer.close();
+                               writer.write(requestData.toString());
+                               writer.flush();
+                               writer.close();
+                       }
                }
 
                conn.connect();
@@ -250,7 +297,7 @@ public class Cache {
                                && ((HttpURLConnection) conn).getResponseCode() / 100 == 3) {
                        String newUrl = conn.getHeaderField("Location");
                        return openNoCache(new URL(newUrl), support, originalUrl,
-                                       postParams);
+                                       postParams, getParams, oauth);
                }
 
                InputStream in = conn.getInputStream();
@@ -298,17 +345,13 @@ public class Cache {
        }
 
        /**
-        * Open a resource (will load it from the cache if possible, or save it into
-        * the cache after downloading if not) as an Image, then save it where
-        * requested.
-        * <p>
-        * This version will not always work properly if the original file was not
-        * downloaded before.
+        * Save the given resource as an image on disk using the default image
+        * format for content.
         * 
         * @param url
-        *            the resource to open
-        * 
-        * @return the opened resource image
+        *            the resource
+        * @param target
+        *            the target file
         * 
         * @throws IOException
         *             in case of I/O error
@@ -319,7 +362,7 @@ public class Cache {
 
                if (!cached.exists() || isOld(cached, true)) {
                        InputStream imageIn = open(url, null, true);
-                       ImageIO.write(IOUtils.toImage(imageIn), Instance.getConfig()
+                       ImageIO.write(ImageUtils.fromStream(imageIn), Instance.getConfig()
                                        .getString(Config.IMAGE_FORMAT_CONTENT).toLowerCase(),
                                        cached);
                }
@@ -341,11 +384,37 @@ public class Cache {
         *             in case of I/O error
         */
        public File addToCache(InputStream in, String uniqueID) throws IOException {
-               File file = getCached(new File(uniqueID).toURI().toURL());
+               File file = getCached(uniqueID);
+               File subdir = new File(file.getParentFile(), "_");
+               file = new File(subdir, file.getName());
+               subdir.mkdir();
                IOUtils.write(in, file);
                return file;
        }
 
+       /**
+        * Return the {@link InputStream} corresponding to the given unique ID, or
+        * NULL if none found.
+        * 
+        * @param uniqueID
+        *            the unique ID
+        * 
+        * @return the content or NULL
+        */
+       public InputStream getFromCache(String uniqueID) {
+               File file = getCached(uniqueID);
+               File subdir = new File(file.getParentFile(), "_");
+               file = new File(subdir, file.getName());
+               if (file.exists()) {
+                       try {
+                               return new MarkableFileInputStream(new FileInputStream(file));
+                       } catch (FileNotFoundException e) {
+                       }
+               }
+
+               return null;
+       }
+
        /**
         * Clean the cache (delete the cached items).
         * 
@@ -355,17 +424,36 @@ public class Cache {
         * @return the number of cleaned items
         */
        public int cleanCache(boolean onlyOld) {
+               return cleanCache(onlyOld, dir);
+       }
+
+       /**
+        * Clean the cache (delete the cached items) in the given cache directory.
+        * 
+        * @param onlyOld
+        *            only clean the files that are considered too old
+        * @param cacheDir
+        *            the cache directory to clean
+        * 
+        * @return the number of cleaned items
+        */
+       private int cleanCache(boolean onlyOld, File cacheDir) {
                int num = 0;
-               for (File file : dir.listFiles()) {
-                       if (!onlyOld || isOld(file, true)) {
-                               if (file.delete()) {
-                                       num++;
-                               } else {
-                                       System.err.println("Cannot delete temporary file: "
-                                                       + file.getAbsolutePath());
+               for (File file : cacheDir.listFiles()) {
+                       if (file.isDirectory()) {
+                               num += cleanCache(onlyOld, file);
+                       } else {
+                               if (!onlyOld || isOld(file, true)) {
+                                       if (file.delete()) {
+                                               num++;
+                                       } else {
+                                               System.err.println("Cannot delete temporary file: "
+                                                               + file.getAbsolutePath());
+                                       }
                                }
                        }
                }
+
                return num;
        }
 
@@ -374,16 +462,21 @@ public class Cache {
         * 
         * @param url
         *            the resource to open
+        * @param allowTooOld
+        *            allow files even if they are considered too old
+        * @param stable
+        *            a stable file (that dones't change too often) -- parameter
+        *            used to check if the file is too old to keep or not
         * 
         * @return the opened resource if found, NULL i not
         * 
         * @throws IOException
         *             in case of I/O error
         */
-       private InputStream load(URL url, boolean allowOld, boolean stable)
+       private InputStream load(URL url, boolean allowTooOld, boolean stable)
                        throws IOException {
                File cached = getCached(url);
-               if (cached.exists() && !isOld(cached, stable)) {
+               if (cached.exists() && (allowTooOld || !isOld(cached, stable))) {
                        return new MarkableFileInputStream(new FileInputStream(cached));
                }
 
@@ -402,11 +495,11 @@ public class Cache {
         * 
         * @throws IOException
         *             in case of I/O error
-        * @throws URISyntaxException
         */
        private void save(URL url, BasicSupport support, URL originalUrl)
                        throws IOException {
-               InputStream in = openNoCache(url, support, originalUrl, null);
+               InputStream in = openNoCache(url, support, originalUrl, null, null,
+                               null);
                try {
                        File cached = getCached(originalUrl);
                        BufferedOutputStream out = new BufferedOutputStream(
@@ -487,24 +580,59 @@ public class Cache {
        }
 
        /**
-        * Get the cache resource from the cache if it is present for this
-        * {@link URL}.
+        * Return the associated cache {@link File} from this {@link URL}.
         * 
         * @param url
         *            the url
-        * @return the cached version if present, NULL if not
+        * 
+        * @return the cached {@link File} version of this {@link URL}
         */
        private File getCached(URL url) {
+               File subdir = null;
+
                String name = url.getHost();
-               if (name == null || name.length() == 0) {
+               if (name == null || name.isEmpty()) {
                        name = url.getFile();
                } else {
-                       name = url.toString();
+                       File cacheDir = getCached(".").getParentFile();
+                       File subsubDir = new File(cacheDir, allowedChars(url.getHost()));
+                       subdir = new File(subsubDir, "_" + allowedChars(url.getPath()));
+                       name = allowedChars("_" + url.getQuery());
+               }
+
+               File cacheFile = getCached(name);
+               if (subdir != null) {
+                       cacheFile = new File(subdir, cacheFile.getName());
+                       subdir.mkdirs();
                }
 
-               name = name.replace('/', '_').replace(':', '_');
+               return cacheFile;
+       }
 
-               return new File(dir, name);
+       /**
+        * Get the basic cache resource file corresponding to this unique ID.
+        * <p>
+        * Note that you may need to add a sub-directory in some cases.
+        * 
+        * @param uniqueID
+        *            the id
+        * 
+        * @return the cached version if present, NULL if not
+        */
+       private File getCached(String uniqueID) {
+               return new File(dir, allowedChars(uniqueID));
+       }
+
+       /**
+        * Replace not allowed chars (in a {@link File}) by "_".
+        * 
+        * @param raw
+        *            the raw {@link String}
+        * 
+        * @return the sanitised {@link String}
+        */
+       private String allowedChars(String raw) {
+               return raw.replace('/', '_').replace(':', '_').replace("\\", "_");
        }
 
        /**
@@ -525,18 +653,14 @@ public class Cache {
                }
 
                if (support != null) {
-                       try {
-                               for (Map.Entry<String, String> set : support.getCookies()
-                                               .entrySet()) {
-                                       if (builder.length() > 0) {
-                                               builder.append(';');
-                                       }
-                                       builder.append(set.getKey());
-                                       builder.append('=');
-                                       builder.append(set.getValue());
+                       for (Map.Entry<String, String> set : support.getCookies()
+                                       .entrySet()) {
+                               if (builder.length() > 0) {
+                                       builder.append(';');
                                }
-                       } catch (IOException e) {
-                               Instance.syserr(e);
+                               builder.append(set.getKey());
+                               builder.append('=');
+                               builder.append(set.getValue());
                        }
                }