src/be/nikiroo/fanfix/library/CacheLibrary.java

   1 package be.nikiroo.fanfix.library;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.net.URL;
   6 import java.util.List;
   7
   8 import be.nikiroo.fanfix.Instance;
   9 import be.nikiroo.fanfix.bundles.UiConfig;
  10 import be.nikiroo.fanfix.data.MetaData;
  11 import be.nikiroo.fanfix.data.Story;
  12 import be.nikiroo.utils.Image;
  13 import be.nikiroo.utils.Progress;
  14
  15 /**
  16  * This library will cache another pre-existing {@link BasicLibrary}.
  17  *
  18  * @author niki
  19  */
  20 public class CacheLibrary extends BasicLibrary {
  21         private List<MetaData> metas;
  22         private BasicLibrary lib;
  23         private LocalLibrary cacheLib;
  24
  25         /**
  26          * Create a cache library around the given one.
  27          * <p>
  28          * It will return the same result, but those will be saved to disk at the
  29          * same time to be fetched quicker the next time.
  30          *
  31          * @param cacheDir
  32          *            the cache directory where to save the files to disk
  33          * @param lib
  34          *            the original library to wrap
  35          */
  36         public CacheLibrary(File cacheDir, BasicLibrary lib) {
  37                 this.cacheLib = new LocalLibrary(cacheDir, Instance.getUiConfig()
  38                                 .getString(UiConfig.GUI_NON_IMAGES_DOCUMENT_TYPE), Instance
  39                                 .getUiConfig().getString(UiConfig.GUI_IMAGES_DOCUMENT_TYPE),
  40                                 true);
  41                 this.lib = lib;
  42         }
  43
  44         @Override
  45         public String getLibraryName() {
  46                 return lib.getLibraryName();
  47         }
  48
  49         @Override
  50         public Status getStatus() {
  51                 return lib.getStatus();
  52         }
  53
  54         @Override
  55         protected List<MetaData> getMetas(Progress pg) {
  56                 if (pg == null) {
  57                         pg = new Progress();
  58                 }
  59
  60                 if (metas == null) {
  61                         metas = lib.getMetas(pg);
  62                 }
  63
  64                 pg.done();
  65                 return metas;
  66         }
  67
  68         @Override
  69         public synchronized File getFile(final String luid, Progress pg) {
  70                 if (pg == null) {
  71                         pg = new Progress();
  72                 }
  73
  74                 Progress pgImport = new Progress();
  75                 Progress pgGet = new Progress();
  76                 Progress pgRecall = new Progress();
  77
  78                 pg.setMinMax(0, 5);
  79                 pg.addProgress(pgImport, 3);
  80                 pg.addProgress(pgGet, 1);
  81                 pg.addProgress(pgRecall, 1);
  82
  83                 if (!isCached(luid)) {
  84                         try {
  85                                 cacheLib.imprt(lib, luid, pgImport);
  86                                 updateInfo(cacheLib.getInfo(luid));
  87                                 pgImport.done();
  88                         } catch (IOException e) {
  89                                 Instance.getTraceHandler().error(e);
  90                         }
  91
  92                         pgImport.done();
  93                         pgGet.done();
  94                 }
  95
  96                 File file = cacheLib.getFile(luid, pgRecall);
  97                 pgRecall.done();
  98
  99                 pg.done();
 100                 return file;
 101         }
 102
 103         @Override
 104         public Image getCover(final String luid) {
 105                 if (isCached(luid)) {
 106                         return cacheLib.getCover(luid);
 107                 }
 108
 109                 // We could update the cache here, but it's not easy
 110                 return lib.getCover(luid);
 111         }
 112
 113         @Override
 114         public Image getSourceCover(String source) {
 115                 Image custom = getCustomSourceCover(source);
 116                 if (custom != null) {
 117                         return custom;
 118                 }
 119
 120                 Image cached = cacheLib.getSourceCover(source);
 121                 if (cached != null) {
 122                         return cached;
 123                 }
 124
 125                 return lib.getSourceCover(source);
 126         }
 127
 128         @Override
 129         public Image getCustomSourceCover(String source) {
 130                 Image custom = cacheLib.getCustomSourceCover(source);
 131                 if (custom == null) {
 132                         custom = lib.getCustomSourceCover(source);
 133                         if (custom != null) {
 134                                 cacheLib.setSourceCover(source, custom);
 135                         }
 136                 }
 137
 138                 return custom;
 139         }
 140
 141         @Override
 142         public void setSourceCover(String source, String luid) {
 143                 lib.setSourceCover(source, luid);
 144                 cacheLib.setSourceCover(source, getCover(luid));
 145         }
 146
 147         @Override
 148         protected void updateInfo(MetaData meta) {
 149                 if (meta != null && metas != null) {
 150                         for (int i = 0; i < metas.size(); i++) {
 151                                 if (metas.get(i).getLuid().equals(meta.getLuid())) {
 152                                         metas.set(i, meta);
 153                                 }
 154                         }
 155                 }
 156
 157                 cacheLib.updateInfo(meta);
 158                 lib.updateInfo(meta);
 159         }
 160
 161         @Override
 162         protected void deleteInfo(String luid) {
 163                 if (luid == null) {
 164                         metas = null;
 165                 } else if (metas != null) {
 166                         for (int i = 0; i < metas.size(); i++) {
 167                                 if (metas.get(i).getLuid().equals(luid)) {
 168                                         metas.remove(i--);
 169                                 }
 170                         }
 171                 }
 172
 173                 cacheLib.deleteInfo(luid);
 174                 lib.deleteInfo(luid);
 175         }
 176
 177         @Override
 178         public synchronized Story save(Story story, String luid, Progress pg)
 179                         throws IOException {
 180                 Progress pgLib = new Progress();
 181                 Progress pgCacheLib = new Progress();
 182
 183                 if (pg == null) {
 184                         pg = new Progress();
 185                 }
 186
 187                 pg.setMinMax(0, 2);
 188                 pg.addProgress(pgLib, 1);
 189                 pg.addProgress(pgCacheLib, 1);
 190
 191                 story = lib.save(story, luid, pgLib);
 192                 story = cacheLib.save(story, story.getMeta().getLuid(), pgCacheLib);
 193
 194                 updateInfo(story.getMeta());
 195
 196                 return story;
 197         }
 198
 199         @Override
 200         public synchronized void delete(String luid) throws IOException {
 201                 if (isCached(luid)) {
 202                         cacheLib.delete(luid);
 203                 }
 204                 lib.delete(luid);
 205
 206                 MetaData meta = getInfo(luid);
 207                 if (meta != null) {
 208                         metas.remove(meta);
 209                 }
 210         }
 211
 212         @Override
 213         public synchronized void changeSource(String luid, String newSource,
 214                         Progress pg) throws IOException {
 215                 if (pg == null) {
 216                         pg = new Progress();
 217                 }
 218
 219                 Progress pgCache = new Progress();
 220                 Progress pgOrig = new Progress();
 221                 pg.setMinMax(0, 2);
 222                 pg.addProgress(pgCache, 1);
 223                 pg.addProgress(pgOrig, 1);
 224
 225                 MetaData meta = getInfo(luid);
 226                 if (meta == null) {
 227                         throw new IOException("Story not found: " + luid);
 228                 }
 229
 230                 if (isCached(luid)) {
 231                         cacheLib.changeSource(luid, newSource, pgCache);
 232                 }
 233                 pgCache.done();
 234
 235                 lib.changeSource(luid, newSource, pgOrig);
 236                 pgOrig.done();
 237
 238                 meta.setSource(newSource);
 239                 pg.done();
 240         }
 241
 242         /**
 243          * Check if the {@link Story} denoted by this Library UID is present in the
 244          * cache.
 245          *
 246          * @param luid
 247          *            the Library UID
 248          *
 249          * @return TRUE if it is
 250          */
 251         public boolean isCached(String luid) {
 252                 return cacheLib.getInfo(luid) != null;
 253         }
 254
 255         /**
 256          * Clear the {@link Story} from the cache.
 257          * <p>
 258          * The next time we try to retrieve the {@link Story}, it may be required to
 259          * cache it again.
 260          *
 261          * @param luid
 262          *            the story to clear
 263          *
 264          * @throws IOException
 265          *             in case of I/O error
 266          */
 267         public void clearFromCache(String luid) throws IOException {
 268                 if (isCached(luid)) {
 269                         cacheLib.delete(luid);
 270                 }
 271         }
 272
 273         @Override
 274         public Story imprt(URL url, Progress pg) throws IOException {
 275                 if (pg == null) {
 276                         pg = new Progress();
 277                 }
 278
 279                 Progress pgImprt = new Progress();
 280                 Progress pgCache = new Progress();
 281                 pg.setMinMax(0, 10);
 282                 pg.addProgress(pgImprt, 7);
 283                 pg.addProgress(pgCache, 3);
 284
 285                 Story story = lib.imprt(url, pgImprt);
 286                 cacheLib.save(story, story.getMeta().getLuid(), pgCache);
 287
 288                 updateInfo(story.getMeta());
 289
 290                 pg.done();
 291                 return story;
 292         }
 293
 294         // All the following methods are only used by Save and Delete in
 295         // BasicLibrary:
 296
 297         @Override
 298         protected int getNextId() {
 299                 throw new java.lang.InternalError("Should not have been called");
 300         }
 301
 302         @Override
 303         protected void doDelete(String luid) throws IOException {
 304                 throw new java.lang.InternalError("Should not have been called");
 305         }
 306
 307         @Override
 308         protected Story doSave(Story story, Progress pg) throws IOException {
 309                 throw new java.lang.InternalError("Should not have been called");
 310         }
 311 }