code cleanup / jdoc
[nikiroo-utils.git] / src / be / nikiroo / fanfix / library / CacheLibrary.java
index 9432b33f5a0fb0b46fa360e3ca882fe3386bb87e..e184c1bd6555e7d79547ab61ab774d92e5b608ff 100644 (file)
@@ -3,12 +3,16 @@ package be.nikiroo.fanfix.library;
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
+import java.util.ArrayList;
 import java.util.List;
+import java.util.TreeSet;
 
 import be.nikiroo.fanfix.Instance;
 import be.nikiroo.fanfix.bundles.UiConfig;
+import be.nikiroo.fanfix.bundles.UiConfigBundle;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.fanfix.output.BasicOutput.OutputType;
 import be.nikiroo.utils.Image;
 import be.nikiroo.utils.Progress;
 
@@ -18,7 +22,10 @@ import be.nikiroo.utils.Progress;
  * @author niki
  */
 public class CacheLibrary extends BasicLibrary {
-       private List<MetaData> metas;
+       private List<MetaData> metasReal;
+       private List<MetaData> metasMixed;
+       private Object metasLock = new Object();
+
        private BasicLibrary lib;
        private LocalLibrary cacheLib;
 
@@ -32,12 +39,15 @@ public class CacheLibrary extends BasicLibrary {
         *            the cache directory where to save the files to disk
         * @param lib
         *            the original library to wrap
+        * @param config
+        *            the configuration used to know which kind of default
+        *            {@link OutputType} to use for images and non-images stories
         */
-       public CacheLibrary(File cacheDir, BasicLibrary lib) {
-               this.cacheLib = new LocalLibrary(cacheDir, Instance.getUiConfig()
-                               .getString(UiConfig.GUI_NON_IMAGES_DOCUMENT_TYPE), Instance
-                               .getUiConfig().getString(UiConfig.GUI_IMAGES_DOCUMENT_TYPE),
-                               true);
+       public CacheLibrary(File cacheDir, BasicLibrary lib,
+                       UiConfigBundle config) {
+               this.cacheLib = new LocalLibrary(cacheDir, //
+                               config.getString(UiConfig.GUI_NON_IMAGES_DOCUMENT_TYPE),
+                               config.getString(UiConfig.GUI_IMAGES_DOCUMENT_TYPE), true);
                this.lib = lib;
        }
 
@@ -52,47 +62,92 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       protected List<MetaData> getMetas(Progress pg) {
+       protected List<MetaData> getMetas(Progress pg) throws IOException {
                if (pg == null) {
                        pg = new Progress();
                }
 
-               if (metas == null) {
-                       metas = lib.getMetas(pg);
+               List<MetaData> copy;
+               synchronized (metasLock) {
+                       // We make sure that cached metas have precedence
+                       if (metasMixed == null) {
+                               if (metasReal == null) {
+                                       metasReal = lib.getMetas(pg);
+                               }
+
+                               metasMixed = new ArrayList<MetaData>();
+                               TreeSet<String> cachedLuids = new TreeSet<String>();
+                               for (MetaData cachedMeta : cacheLib.getMetas(null)) {
+                                       metasMixed.add(cachedMeta);
+                                       cachedLuids.add(cachedMeta.getLuid());
+                               }
+                               for (MetaData realMeta : metasReal) {
+                                       if (!cachedLuids.contains(realMeta.getLuid())) {
+                                               metasMixed.add(realMeta);
+                                       }
+                               }
+                       }
+
+                       copy = new ArrayList<MetaData>(metasMixed);
                }
 
                pg.done();
-               return metas;
+               return copy;
        }
 
        @Override
-       public synchronized File getFile(final String luid, Progress pg) {
+       public synchronized Story getStory(String luid, MetaData meta, Progress pg)
+                       throws IOException {
                if (pg == null) {
                        pg = new Progress();
                }
 
                Progress pgImport = new Progress();
                Progress pgGet = new Progress();
-               Progress pgRecall = new Progress();
 
-               pg.setMinMax(0, 5);
+               pg.setMinMax(0, 4);
                pg.addProgress(pgImport, 3);
                pg.addProgress(pgGet, 1);
-               pg.addProgress(pgRecall, 1);
 
                if (!isCached(luid)) {
                        try {
                                cacheLib.imprt(lib, luid, pgImport);
-                               updateInfo(cacheLib.getInfo(luid));
+                               updateMetaCache(metasMixed, cacheLib.getInfo(luid));
                                pgImport.done();
                        } catch (IOException e) {
-                               Instance.getTraceHandler().error(e);
+                               Instance.getInstance().getTraceHandler().error(e);
                        }
 
                        pgImport.done();
                        pgGet.done();
                }
 
+               String type = cacheLib.getOutputType(meta.isImageDocument());
+               MetaData cachedMeta = meta.clone();
+               cachedMeta.setType(type);
+
+               return cacheLib.getStory(luid, cachedMeta, pg);
+       }
+
+       @Override
+       public synchronized File getFile(final String luid, Progress pg)
+                       throws IOException {
+               if (pg == null) {
+                       pg = new Progress();
+               }
+
+               Progress pgGet = new Progress();
+               Progress pgRecall = new Progress();
+
+               pg.setMinMax(0, 5);
+               pg.addProgress(pgGet, 4);
+               pg.addProgress(pgRecall, 1);
+
+               if (!isCached(luid)) {
+                       getStory(luid, pgGet);
+                       pgGet.done();
+               }
+
                File file = cacheLib.getFile(luid, pgRecall);
                pgRecall.done();
 
@@ -101,7 +156,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Image getCover(final String luid) {
+       public Image getCover(final String luid) throws IOException {
                if (isCached(luid)) {
                        return cacheLib.getCover(luid);
                }
@@ -111,7 +166,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Image getSourceCover(String source) {
+       public Image getSourceCover(String source) throws IOException {
                Image custom = getCustomSourceCover(source);
                if (custom != null) {
                        return custom;
@@ -126,7 +181,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Image getAuthorCover(String author) {
+       public Image getAuthorCover(String author) throws IOException {
                Image custom = getCustomAuthorCover(author);
                if (custom != null) {
                        return custom;
@@ -141,7 +196,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Image getCustomSourceCover(String source) {
+       public Image getCustomSourceCover(String source) throws IOException {
                Image custom = cacheLib.getCustomSourceCover(source);
                if (custom == null) {
                        custom = lib.getCustomSourceCover(source);
@@ -154,7 +209,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Image getCustomAuthorCover(String author) {
+       public Image getCustomAuthorCover(String author) throws IOException {
                Image custom = cacheLib.getCustomAuthorCover(author);
                if (custom == null) {
                        custom = lib.getCustomAuthorCover(author);
@@ -167,47 +222,89 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public void setSourceCover(String source, String luid) {
+       public void setSourceCover(String source, String luid) throws IOException {
                lib.setSourceCover(source, luid);
                cacheLib.setSourceCover(source, getCover(luid));
        }
 
        @Override
-       public void setAuthorCover(String author, String luid) {
+       public void setAuthorCover(String author, String luid) throws IOException {
                lib.setAuthorCover(author, luid);
                cacheLib.setAuthorCover(author, getCover(luid));
        }
 
+       /**
+        * Invalidate the {@link Story} cache (when the content has changed, but we
+        * already have it) with the new given meta.
+        * <p>
+        * <b>Make sure to always use {@link MetaData} from the cached library in
+        * priority, here.</b>
+        * 
+        * @param meta
+        *            the {@link Story} to clear from the cache
+        * 
+        * @throws IOException
+        *             in case of IOException
+        */
        @Override
-       protected void updateInfo(MetaData meta) {
+       @Deprecated
+       protected void updateInfo(MetaData meta) throws IOException {
+               throw new IOException(
+                               "This method is not supported in a CacheLibrary, please use updateMetaCache");
+       }
+
+       // relplace the meta in Metas by Meta, add it if needed
+       // return TRUE = added
+       private boolean updateMetaCache(List<MetaData> metas, MetaData meta) {
                if (meta != null && metas != null) {
-                       for (int i = 0; i < metas.size(); i++) {
-                               if (metas.get(i).getLuid().equals(meta.getLuid())) {
-                                       metas.set(i, meta);
+                       synchronized (metasLock) {
+                               boolean changed = false;
+                               for (int i = 0; i < metas.size(); i++) {
+                                       if (metas.get(i).getLuid().equals(meta.getLuid())) {
+                                               metas.set(i, meta);
+                                               changed = true;
+                                       }
+                               }
+
+                               if (!changed) {
+                                       metas.add(meta);
+                                       return true;
                                }
                        }
                }
 
-               cacheLib.updateInfo(meta);
-               lib.updateInfo(meta);
+               return false;
        }
 
        @Override
        protected void invalidateInfo(String luid) {
                if (luid == null) {
-                       metas = null;
-               } else if (metas != null) {
-                       for (int i = 0; i < metas.size(); i++) {
-                               if (metas.get(i).getLuid().equals(luid)) {
-                                       metas.remove(i--);
-                               }
+                       synchronized (metasLock) {
+                               metasReal = null;
+                               metasMixed = null;
                        }
+               } else {
+                       invalidateInfo(metasReal, luid);
+                       invalidateInfo(metasMixed, luid);
                }
 
                cacheLib.invalidateInfo(luid);
                lib.invalidateInfo(luid);
        }
 
+       // luid cannot be null
+       private void invalidateInfo(List<MetaData> metas, String luid) {
+               if (metas != null) {
+                       synchronized (metasLock) {
+                               for (int i = 0; i < metas.size(); i++) {
+                                       if (metas.get(i).getLuid().equals(luid)) {
+                                               metas.remove(i--);
+                                       }
+                               }
+                       }
+               }
+       }
+
        @Override
        public synchronized Story save(Story story, String luid, Progress pg)
                        throws IOException {
@@ -223,9 +320,10 @@ public class CacheLibrary extends BasicLibrary {
                pg.addProgress(pgCacheLib, 1);
 
                story = lib.save(story, luid, pgLib);
-               story = cacheLib.save(story, story.getMeta().getLuid(), pgCacheLib);
+               updateMetaCache(metasReal, story.getMeta());
 
-               updateInfo(story.getMeta());
+               story = cacheLib.save(story, story.getMeta().getLuid(), pgCacheLib);
+               updateMetaCache(metasMixed, story.getMeta());
 
                return story;
        }
@@ -237,10 +335,7 @@ public class CacheLibrary extends BasicLibrary {
                }
                lib.delete(luid);
 
-               MetaData meta = getInfo(luid);
-               if (meta != null) {
-                       metas.remove(meta);
-               }
+               invalidateInfo(luid);
        }
 
        @Override
@@ -273,33 +368,25 @@ public class CacheLibrary extends BasicLibrary {
                meta.setTitle(newTitle);
                meta.setAuthor(newAuthor);
                pg.done();
+
+               if (isCached(luid)) {
+                       updateMetaCache(metasMixed, meta);
+                       updateMetaCache(metasReal, lib.getInfo(luid));
+               } else {
+                       updateMetaCache(metasReal, meta);
+               }
        }
 
-       /**
-        * Check if the {@link Story} denoted by this Library UID is present in the
-        * cache.
-        * 
-        * @param luid
-        *            the Library UID
-        * 
-        * @return TRUE if it is
-        */
+       @Override
        public boolean isCached(String luid) {
-               return cacheLib.getInfo(luid) != null;
+               try {
+                       return cacheLib.getInfo(luid) != null;
+               } catch (IOException e) {
+                       return false;
+               }
        }
 
-       /**
-        * Clear the {@link Story} from the cache.
-        * <p>
-        * The next time we try to retrieve the {@link Story}, it may be required to
-        * cache it again.
-        * 
-        * @param luid
-        *            the story to clear
-        * 
-        * @throws IOException
-        *             in case of I/O error
-        */
+       @Override
        public void clearFromCache(String luid) throws IOException {
                if (isCached(luid)) {
                        cacheLib.delete(luid);
@@ -307,7 +394,7 @@ public class CacheLibrary extends BasicLibrary {
        }
 
        @Override
-       public Story imprt(URL url, Progress pg) throws IOException {
+       public MetaData imprt(URL url, Progress pg) throws IOException {
                if (pg == null) {
                        pg = new Progress();
                }
@@ -318,20 +405,21 @@ public class CacheLibrary extends BasicLibrary {
                pg.addProgress(pgImprt, 7);
                pg.addProgress(pgCache, 3);
 
-               Story story = lib.imprt(url, pgImprt);
-               cacheLib.save(story, story.getMeta().getLuid(), pgCache);
+               MetaData meta = lib.imprt(url, pgImprt);
+               updateMetaCache(metasReal, meta);
+               metasMixed = null;
 
-               updateInfo(story.getMeta());
+               clearFromCache(meta.getLuid());
 
                pg.done();
-               return story;
+               return meta;
        }
 
        // All the following methods are only used by Save and Delete in
        // BasicLibrary:
 
        @Override
-       protected int getNextId() {
+       protected String getNextId() {
                throw new java.lang.InternalError("Should not have been called");
        }