1 package be
.nikiroo
.fanfix
.library
;
4 import java
.io
.IOException
;
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
;
16 * This library will cache another pre-existing {@link BasicLibrary}.
20 public class CacheLibrary
extends BasicLibrary
{
21 private List
<MetaData
> metas
;
22 private BasicLibrary lib
;
23 private LocalLibrary cacheLib
;
26 * Create a cache library around the given one.
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.
32 * the cache directory where to save the files to disk
34 * the original library to wrap
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
),
45 public String
getLibraryName() {
46 return lib
.getLibraryName();
50 public Status
getStatus() {
51 return lib
.getStatus();
55 protected List
<MetaData
> getMetas(Progress pg
) {
61 metas
= lib
.getMetas(pg
);
69 public synchronized File
getFile(final String luid
, Progress pg
) {
74 Progress pgImport
= new Progress();
75 Progress pgGet
= new Progress();
76 Progress pgRecall
= new Progress();
79 pg
.addProgress(pgImport
, 3);
80 pg
.addProgress(pgGet
, 1);
81 pg
.addProgress(pgRecall
, 1);
83 if (!isCached(luid
)) {
85 cacheLib
.imprt(lib
, luid
, pgImport
);
86 updateInfo(cacheLib
.getInfo(luid
));
88 } catch (IOException e
) {
89 Instance
.getTraceHandler().error(e
);
96 File file
= cacheLib
.getFile(luid
, pgRecall
);
104 public Image
getCover(final String luid
) {
105 if (isCached(luid
)) {
106 return cacheLib
.getCover(luid
);
109 // We could update the cache here, but it's not easy
110 return lib
.getCover(luid
);
114 public Image
getSourceCover(String source
) {
115 Image custom
= getCustomSourceCover(source
);
116 if (custom
!= null) {
120 Image cached
= cacheLib
.getSourceCover(source
);
121 if (cached
!= null) {
125 return lib
.getSourceCover(source
);
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
);
142 public void setSourceCover(String source
, String luid
) {
143 lib
.setSourceCover(source
, luid
);
144 cacheLib
.setSourceCover(source
, getCover(luid
));
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())) {
157 cacheLib
.updateInfo(meta
);
158 lib
.updateInfo(meta
);
162 protected void invalidateInfo(String luid
) {
165 } else if (metas
!= null) {
166 for (int i
= 0; i
< metas
.size(); i
++) {
167 if (metas
.get(i
).getLuid().equals(luid
)) {
173 cacheLib
.invalidateInfo(luid
);
174 lib
.invalidateInfo(luid
);
178 public synchronized Story
save(Story story
, String luid
, Progress pg
)
180 Progress pgLib
= new Progress();
181 Progress pgCacheLib
= new Progress();
188 pg
.addProgress(pgLib
, 1);
189 pg
.addProgress(pgCacheLib
, 1);
191 story
= lib
.save(story
, luid
, pgLib
);
192 story
= cacheLib
.save(story
, story
.getMeta().getLuid(), pgCacheLib
);
194 updateInfo(story
.getMeta());
200 public synchronized void delete(String luid
) throws IOException
{
201 if (isCached(luid
)) {
202 cacheLib
.delete(luid
);
206 MetaData meta
= getInfo(luid
);
213 protected synchronized void changeSTA(String luid
, String newSource
,
214 String newTitle
, String newAuthor
, Progress pg
) throws IOException
{
219 Progress pgCache
= new Progress();
220 Progress pgOrig
= new Progress();
222 pg
.addProgress(pgCache
, 1);
223 pg
.addProgress(pgOrig
, 1);
225 MetaData meta
= getInfo(luid
);
227 throw new IOException("Story not found: " + luid
);
230 if (isCached(luid
)) {
231 cacheLib
.changeSTA(luid
, newSource
, newTitle
, newAuthor
, pgCache
);
235 lib
.changeSTA(luid
, newSource
, newTitle
, newAuthor
, pgOrig
);
238 meta
.setSource(newSource
);
239 meta
.setTitle(newTitle
);
240 meta
.setAuthor(newAuthor
);
245 * Check if the {@link Story} denoted by this Library UID is present in the
251 * @return TRUE if it is
253 public boolean isCached(String luid
) {
254 return cacheLib
.getInfo(luid
) != null;
258 * Clear the {@link Story} from the cache.
260 * The next time we try to retrieve the {@link Story}, it may be required to
266 * @throws IOException
267 * in case of I/O error
269 public void clearFromCache(String luid
) throws IOException
{
270 if (isCached(luid
)) {
271 cacheLib
.delete(luid
);
276 public Story
imprt(URL url
, Progress pg
) throws IOException
{
281 Progress pgImprt
= new Progress();
282 Progress pgCache
= new Progress();
284 pg
.addProgress(pgImprt
, 7);
285 pg
.addProgress(pgCache
, 3);
287 Story story
= lib
.imprt(url
, pgImprt
);
288 cacheLib
.save(story
, story
.getMeta().getLuid(), pgCache
);
290 updateInfo(story
.getMeta());
296 // All the following methods are only used by Save and Delete in
300 protected int getNextId() {
301 throw new java
.lang
.InternalError("Should not have been called");
305 protected void doDelete(String luid
) throws IOException
{
306 throw new java
.lang
.InternalError("Should not have been called");
310 protected Story
doSave(Story story
, Progress pg
) throws IOException
{
311 throw new java
.lang
.InternalError("Should not have been called");