1 package be
.nikiroo
.fanfix
.library
;
4 import java
.io
.FileFilter
;
5 import java
.io
.FileInputStream
;
6 import java
.io
.FileNotFoundException
;
7 import java
.io
.IOException
;
8 import java
.io
.InputStream
;
9 import java
.util
.ArrayList
;
10 import java
.util
.HashMap
;
11 import java
.util
.List
;
14 import be
.nikiroo
.fanfix
.Instance
;
15 import be
.nikiroo
.fanfix
.bundles
.Config
;
16 import be
.nikiroo
.fanfix
.data
.MetaData
;
17 import be
.nikiroo
.fanfix
.data
.Story
;
18 import be
.nikiroo
.fanfix
.output
.BasicOutput
;
19 import be
.nikiroo
.fanfix
.output
.BasicOutput
.OutputType
;
20 import be
.nikiroo
.fanfix
.output
.InfoCover
;
21 import be
.nikiroo
.fanfix
.supported
.InfoReader
;
22 import be
.nikiroo
.utils
.IOUtils
;
23 import be
.nikiroo
.utils
.Image
;
24 import be
.nikiroo
.utils
.Progress
;
27 * This {@link BasicLibrary} will store the stories locally on disk.
31 public class LocalLibrary
extends BasicLibrary
{
33 private Map
<MetaData
, File
[]> stories
; // Files: [ infoFile, TargetFile ]
34 private Map
<String
, Image
> sourceCovers
;
37 private OutputType text
;
38 private OutputType image
;
41 * Create a new {@link LocalLibrary} with the given back-end directory.
44 * the directory where to find the {@link Story} objects
46 public LocalLibrary(File baseDir
) {
47 this(baseDir
, Instance
.getConfig().getString(
48 Config
.NON_IMAGES_DOCUMENT_TYPE
), Instance
.getConfig()
49 .getString(Config
.IMAGES_DOCUMENT_TYPE
), false);
53 * Create a new {@link LocalLibrary} with the given back-end directory.
56 * the directory where to find the {@link Story} objects
58 * the {@link OutputType} to use for non-image documents
60 * the {@link OutputType} to use for image documents
61 * @param defaultIsHtml
62 * if the given text or image is invalid, use HTML by default (if
63 * not, it will be INFO_TEXT/CBZ by default)
65 public LocalLibrary(File baseDir
, String text
, String image
,
66 boolean defaultIsHtml
) {
67 this(baseDir
, OutputType
.valueOfAllOkUC(text
,
68 defaultIsHtml ? OutputType
.HTML
: OutputType
.INFO_TEXT
),
69 OutputType
.valueOfAllOkUC(image
,
70 defaultIsHtml ? OutputType
.HTML
: OutputType
.CBZ
));
74 * Create a new {@link LocalLibrary} with the given back-end directory.
77 * the directory where to find the {@link Story} objects
79 * the {@link OutputType} to use for non-image documents
81 * the {@link OutputType} to use for image documents
83 public LocalLibrary(File baseDir
, OutputType text
, OutputType image
) {
84 this.baseDir
= baseDir
;
90 this.sourceCovers
= null;
96 protected List
<MetaData
> getMetas(Progress pg
) {
97 return new ArrayList
<MetaData
>(getStories(pg
).keySet());
101 public File
getFile(String luid
, Progress pg
) {
102 Instance
.getTraceHandler().trace(
103 this.getClass().getSimpleName() + ": get file for " + luid
);
106 String mess
= "no file found for ";
108 MetaData meta
= getInfo(luid
);
109 File
[] files
= getStories(pg
).get(meta
);
111 mess
= "file retrieved for ";
115 Instance
.getTraceHandler().trace(
116 this.getClass().getSimpleName() + ": " + mess
+ luid
+ " ("
117 + meta
.getTitle() + ")");
123 public Image
getCover(String luid
) {
124 MetaData meta
= getInfo(luid
);
126 if (meta
.getCover() != null) {
127 return meta
.getCover();
130 File
[] files
= getStories(null).get(meta
);
132 File infoFile
= files
[0];
135 meta
= InfoReader
.readMeta(infoFile
, true);
136 return meta
.getCover();
137 } catch (IOException e
) {
138 Instance
.getTraceHandler().error(e
);
147 protected synchronized void updateInfo(MetaData meta
) {
152 protected void deleteInfo(String luid
) {
158 protected synchronized int getNextId() {
159 getStories(null); // make sure lastId is set
164 protected void doDelete(String luid
) throws IOException
{
165 for (File file
: getRelatedFiles(luid
)) {
166 // TODO: throw an IOException if we cannot delete the files?
167 IOUtils
.deltree(file
);
168 file
.getParentFile().delete();
173 protected Story
doSave(Story story
, Progress pg
) throws IOException
{
174 MetaData meta
= story
.getMeta();
176 File expectedTarget
= getExpectedFile(meta
);
177 expectedTarget
.getParentFile().mkdirs();
179 BasicOutput it
= BasicOutput
.getOutput(getOutputType(meta
), true, true);
180 it
.process(story
, expectedTarget
.getPath(), pg
);
186 protected synchronized void saveMeta(MetaData meta
, Progress pg
)
188 File newDir
= getExpectedDir(meta
.getSource());
189 if (!newDir
.exists()) {
193 List
<File
> relatedFiles
= getRelatedFiles(meta
.getLuid());
194 for (File relatedFile
: relatedFiles
) {
195 // TODO: this is not safe at all.
196 // We should copy all the files THEN delete them
197 // Maybe also adding some rollback cleanup if possible
198 if (relatedFile
.getName().endsWith(".info")) {
200 String name
= relatedFile
.getName().replaceFirst(
202 InfoCover
.writeInfo(newDir
, name
, meta
);
203 relatedFile
.delete();
204 relatedFile
.getParentFile().delete();
205 } catch (IOException e
) {
206 Instance
.getTraceHandler().error(e
);
209 relatedFile
.renameTo(new File(newDir
, relatedFile
.getName()));
210 relatedFile
.getParentFile().delete();
218 public synchronized Image
getCustomSourceCover(String source
) {
219 if (sourceCovers
== null) {
220 sourceCovers
= new HashMap
<String
, Image
>();
223 Image img
= sourceCovers
.get(source
);
228 File coverDir
= new File(baseDir
, source
);
229 if (coverDir
.isDirectory()) {
230 File cover
= new File(coverDir
, ".cover.png");
231 if (cover
.exists()) {
234 in
= new FileInputStream(cover
);
236 sourceCovers
.put(source
, new Image(in
));
240 } catch (FileNotFoundException e
) {
242 } catch (IOException e
) {
243 Instance
.getTraceHandler().error(
245 "Cannot load the existing custom source cover: "
251 return sourceCovers
.get(source
);
255 public void setSourceCover(String source
, String luid
) {
256 setSourceCover(source
, getCover(luid
));
260 * Fix the source cover to the given story cover.
263 * the source to change
267 synchronized void setSourceCover(String source
, Image coverImage
) {
268 File dir
= getExpectedDir(source
);
270 File cover
= new File(dir
, ".cover");
272 Instance
.getCache().saveAsImage(coverImage
, cover
, true);
273 if (sourceCovers
!= null) {
274 sourceCovers
.put(source
, coverImage
);
276 } catch (IOException e
) {
277 Instance
.getTraceHandler().error(e
);
282 public void imprt(BasicLibrary other
, String luid
, Progress pg
)
288 // Check if we can simply copy the files instead of the whole process
289 if (other
instanceof LocalLibrary
) {
290 LocalLibrary otherLocalLibrary
= (LocalLibrary
) other
;
292 MetaData meta
= otherLocalLibrary
.getInfo(luid
);
293 String expectedType
= ""
294 + (meta
!= null && meta
.isImageDocument() ? image
: text
);
295 if (meta
!= null && meta
.getType().equals(expectedType
)) {
296 File from
= otherLocalLibrary
.getExpectedDir(meta
.getSource());
297 File to
= this.getExpectedDir(meta
.getSource());
298 List
<File
> sources
= otherLocalLibrary
.getRelatedFiles(luid
);
299 if (!sources
.isEmpty()) {
300 pg
.setMinMax(0, sources
.size());
303 for (File source
: sources
) {
304 File target
= new File(source
.getAbsolutePath().replace(
305 from
.getAbsolutePath(), to
.getAbsolutePath()));
306 if (!source
.equals(target
)) {
307 target
.getParentFile().mkdirs();
308 InputStream in
= null;
310 in
= new FileInputStream(source
);
311 IOUtils
.write(in
, target
);
312 } catch (IOException e
) {
316 } catch (Exception ee
) {
334 super.imprt(other
, luid
, pg
);
338 * Return the {@link OutputType} for this {@link Story}.
341 * the {@link Story} {@link MetaData}
345 private OutputType
getOutputType(MetaData meta
) {
346 if (meta
!= null && meta
.isImageDocument()) {
354 * Get the target {@link File} related to the given <tt>.info</tt>
355 * {@link File} and {@link MetaData}.
360 * the <tt>.info</tt> {@link File}
362 * @return the target {@link File}
364 private File
getTargetFile(MetaData meta
, File infoFile
) {
365 // Replace .info with whatever is needed:
366 String path
= infoFile
.getPath();
367 path
= path
.substring(0, path
.length() - ".info".length());
368 String newExt
= getOutputType(meta
).getDefaultExtension(true);
370 return new File(path
+ newExt
);
374 * The target (full path) where the {@link Story} related to this
375 * {@link MetaData} should be located on disk for a new {@link Story}.
378 * the {@link Story} {@link MetaData}
382 private File
getExpectedFile(MetaData key
) {
383 String title
= key
.getTitle();
387 title
= title
.replaceAll("[^a-zA-Z0-9._+-]", "_");
388 return new File(getExpectedDir(key
.getSource()), key
.getLuid() + "_"
393 * The directory (full path) where the new {@link Story} related to this
394 * {@link MetaData} should be located on disk.
399 * @return the target directory
401 private File
getExpectedDir(String source
) {
402 String sanitizedSource
= source
.replaceAll("[^a-zA-Z0-9._+-]", "_");
403 return new File(baseDir
, sanitizedSource
);
407 * Return the list of files/directories on disk for this {@link Story}.
409 * If the {@link Story} is not found, and empty list is returned.
412 * the {@link Story} LUID
414 * @return the list of {@link File}s
416 * @throws IOException
417 * if the {@link Story} was not found
419 private List
<File
> getRelatedFiles(String luid
) throws IOException
{
420 List
<File
> files
= new ArrayList
<File
>();
422 MetaData meta
= getInfo(luid
);
424 throw new IOException("Story not found: " + luid
);
427 File infoFile
= getStories(null).get(meta
)[0];
428 File targetFile
= getStories(null).get(meta
)[1];
431 files
.add(targetFile
);
433 String readerExt
= getOutputType(meta
).getDefaultExtension(true);
434 String fileExt
= getOutputType(meta
).getDefaultExtension(false);
436 String path
= targetFile
.getAbsolutePath();
437 if (readerExt
!= null && !readerExt
.equals(fileExt
)) {
438 path
= path
.substring(0, path
.length() - readerExt
.length())
440 File relatedFile
= new File(path
);
442 if (relatedFile
.exists()) {
443 files
.add(relatedFile
);
447 String coverExt
= "."
448 + Instance
.getConfig().getString(Config
.IMAGE_FORMAT_COVER
)
450 File coverFile
= new File(path
+ coverExt
);
451 if (!coverFile
.exists()) {
452 coverFile
= new File(path
.substring(0,
453 path
.length() - fileExt
.length())
457 if (coverFile
.exists()) {
458 files
.add(coverFile
);
465 * Fill the list of stories by reading the content of the local directory
466 * {@link LocalLibrary#baseDir}.
468 * Will use a cached list when possible (see
469 * {@link BasicLibrary#deleteInfo()}).
472 * the optional {@link Progress}
474 * @return the list of stories (for each item, the first {@link File} is the
475 * info file, the second file is the target {@link File})
477 private synchronized Map
<MetaData
, File
[]> getStories(Progress pg
) {
481 pg
.setMinMax(0, 100);
484 if (stories
== null) {
485 stories
= new HashMap
<MetaData
, File
[]>();
489 File
[] dirs
= baseDir
.listFiles(new FileFilter() {
491 public boolean accept(File file
) {
492 return file
!= null && file
.isDirectory();
497 Progress pgDirs
= new Progress(0, 100 * dirs
.length
);
498 pg
.addProgress(pgDirs
, 100);
500 for (File dir
: dirs
) {
501 File
[] infoFiles
= dir
.listFiles(new FileFilter() {
503 public boolean accept(File file
) {
505 && file
.getPath().toLowerCase()
510 Progress pgFiles
= new Progress(0, infoFiles
.length
);
511 pgDirs
.addProgress(pgFiles
, 100);
512 pgDirs
.setName("Loading from: " + dir
.getName());
514 for (File infoFile
: infoFiles
) {
515 pgFiles
.setName(infoFile
.getName());
517 MetaData meta
= InfoReader
518 .readMeta(infoFile
, false);
520 int id
= Integer
.parseInt(meta
.getLuid());
525 stories
.put(meta
, new File
[] { infoFile
,
526 getTargetFile(meta
, infoFile
) });
527 } catch (Exception e
) {
529 throw new IOException(
530 "Cannot understand the LUID of "
532 + meta
.getLuid(), e
);
534 } catch (IOException e
) {
535 // We should not have not-supported files in the
537 Instance
.getTraceHandler().error(
539 "Cannot load file from library: "
545 pgFiles
.setName(null);
548 pgDirs
.setName("Loading directories");