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
;
25 import be
.nikiroo
.utils
.StringUtils
;
28 * This {@link BasicLibrary} will store the stories locally on disk.
32 public class LocalLibrary
extends BasicLibrary
{
34 private Map
<MetaData
, File
[]> stories
; // Files: [ infoFile, TargetFile ]
35 private Map
<String
, Image
> sourceCovers
;
36 private Map
<String
, Image
> authorCovers
;
39 private OutputType text
;
40 private OutputType image
;
43 * Create a new {@link LocalLibrary} with the given back-end directory.
46 * the directory where to find the {@link Story} objects
48 public LocalLibrary(File baseDir
) {
49 this(baseDir
, Instance
.getConfig().getString(
50 Config
.NON_IMAGES_DOCUMENT_TYPE
), Instance
.getConfig()
51 .getString(Config
.IMAGES_DOCUMENT_TYPE
), false);
55 * Create a new {@link LocalLibrary} with the given back-end directory.
58 * the directory where to find the {@link Story} objects
60 * the {@link OutputType} to use for non-image documents
62 * the {@link OutputType} to use for image documents
63 * @param defaultIsHtml
64 * if the given text or image is invalid, use HTML by default (if
65 * not, it will be INFO_TEXT/CBZ by default)
67 public LocalLibrary(File baseDir
, String text
, String image
,
68 boolean defaultIsHtml
) {
69 this(baseDir
, OutputType
.valueOfAllOkUC(text
,
70 defaultIsHtml ? OutputType
.HTML
: OutputType
.INFO_TEXT
),
71 OutputType
.valueOfAllOkUC(image
,
72 defaultIsHtml ? OutputType
.HTML
: OutputType
.CBZ
));
76 * Create a new {@link LocalLibrary} with the given back-end directory.
79 * the directory where to find the {@link Story} objects
81 * the {@link OutputType} to use for non-image documents
83 * the {@link OutputType} to use for image documents
85 public LocalLibrary(File baseDir
, OutputType text
, OutputType image
) {
86 this.baseDir
= baseDir
;
92 this.sourceCovers
= null;
98 protected List
<MetaData
> getMetas(Progress pg
) {
99 return new ArrayList
<MetaData
>(getStories(pg
).keySet());
103 public File
getFile(String luid
, Progress pg
) {
104 Instance
.getTraceHandler().trace(
105 this.getClass().getSimpleName() + ": get file for " + luid
);
108 String mess
= "no file found for ";
110 MetaData meta
= getInfo(luid
);
111 File
[] files
= getStories(pg
).get(meta
);
113 mess
= "file retrieved for ";
117 Instance
.getTraceHandler().trace(
118 this.getClass().getSimpleName() + ": " + mess
+ luid
+ " ("
119 + meta
.getTitle() + ")");
125 public Image
getCover(String luid
) {
126 MetaData meta
= getInfo(luid
);
128 if (meta
.getCover() != null) {
129 return meta
.getCover();
132 File
[] files
= getStories(null).get(meta
);
134 File infoFile
= files
[0];
137 meta
= InfoReader
.readMeta(infoFile
, true);
138 return meta
.getCover();
139 } catch (IOException e
) {
140 Instance
.getTraceHandler().error(e
);
149 protected synchronized void updateInfo(MetaData meta
) {
154 protected void invalidateInfo(String luid
) {
160 protected synchronized int getNextId() {
161 getStories(null); // make sure lastId is set
166 protected void doDelete(String luid
) throws IOException
{
167 for (File file
: getRelatedFiles(luid
)) {
168 // TODO: throw an IOException if we cannot delete the files?
169 IOUtils
.deltree(file
);
170 file
.getParentFile().delete();
175 protected Story
doSave(Story story
, Progress pg
) throws IOException
{
176 MetaData meta
= story
.getMeta();
178 File expectedTarget
= getExpectedFile(meta
);
179 expectedTarget
.getParentFile().mkdirs();
181 BasicOutput it
= BasicOutput
.getOutput(getOutputType(meta
), true, true);
182 it
.process(story
, expectedTarget
.getPath(), pg
);
188 protected synchronized void saveMeta(MetaData meta
, Progress pg
)
190 File newDir
= getExpectedDir(meta
.getSource());
191 if (!newDir
.exists()) {
195 List
<File
> relatedFiles
= getRelatedFiles(meta
.getLuid());
196 for (File relatedFile
: relatedFiles
) {
197 // TODO: this is not safe at all.
198 // We should copy all the files THEN delete them
199 // Maybe also adding some rollback cleanup if possible
200 if (relatedFile
.getName().endsWith(".info")) {
202 String name
= relatedFile
.getName().replaceFirst(
204 relatedFile
.delete();
205 InfoCover
.writeInfo(newDir
, name
, meta
);
206 relatedFile
.getParentFile().delete();
207 } catch (IOException e
) {
208 Instance
.getTraceHandler().error(e
);
211 relatedFile
.renameTo(new File(newDir
, relatedFile
.getName()));
212 relatedFile
.getParentFile().delete();
220 public synchronized Image
getCustomSourceCover(String source
) {
221 if (sourceCovers
== null) {
222 sourceCovers
= new HashMap
<String
, Image
>();
225 Image img
= sourceCovers
.get(source
);
230 File coverDir
= getExpectedDir(source
);
231 if (coverDir
.isDirectory()) {
232 File cover
= new File(coverDir
, ".cover.png");
233 if (cover
.exists()) {
236 in
= new FileInputStream(cover
);
238 sourceCovers
.put(source
, new Image(in
));
242 } catch (FileNotFoundException e
) {
244 } catch (IOException e
) {
245 Instance
.getTraceHandler().error(
247 "Cannot load the existing custom source cover: "
253 return sourceCovers
.get(source
);
257 public synchronized Image
getCustomAuthorCover(String author
) {
258 File cover
= getAuthorCoverFile(author
);
259 if (cover
.exists()) {
262 in
= new FileInputStream(cover
);
264 authorCovers
.put(author
, new Image(in
));
268 } catch (FileNotFoundException e
) {
270 } catch (IOException e
) {
271 Instance
.getTraceHandler().error(
273 "Cannot load the existing custom author cover: "
278 return authorCovers
.get(author
);
282 public void setSourceCover(String source
, String luid
) {
283 setSourceCover(source
, getCover(luid
));
287 public void setAuthorCover(String author
, String luid
) {
288 setAuthorCover(author
, getCover(luid
));
292 * Set the source cover to the given story cover.
295 * the source to change
299 synchronized void setSourceCover(String source
, Image coverImage
) {
300 File dir
= getExpectedDir(source
);
302 File cover
= new File(dir
, ".cover");
304 Instance
.getCache().saveAsImage(coverImage
, cover
, true);
305 if (sourceCovers
!= null) {
306 sourceCovers
.put(source
, coverImage
);
308 } catch (IOException e
) {
309 Instance
.getTraceHandler().error(e
);
314 * Set the author cover to the given story cover.
317 * the author to change
321 synchronized void setAuthorCover(String author
, Image coverImage
) {
322 File cover
= getAuthorCoverFile(author
);
323 cover
.getParentFile().mkdirs();
325 Instance
.getCache().saveAsImage(coverImage
, cover
, true);
326 if (authorCovers
!= null) {
327 authorCovers
.put(author
, coverImage
);
329 } catch (IOException e
) {
330 Instance
.getTraceHandler().error(e
);
335 public void imprt(BasicLibrary other
, String luid
, Progress pg
)
341 // Check if we can simply copy the files instead of the whole process
342 if (other
instanceof LocalLibrary
) {
343 LocalLibrary otherLocalLibrary
= (LocalLibrary
) other
;
345 MetaData meta
= otherLocalLibrary
.getInfo(luid
);
346 String expectedType
= ""
347 + (meta
!= null && meta
.isImageDocument() ? image
: text
);
348 if (meta
!= null && meta
.getType().equals(expectedType
)) {
349 File from
= otherLocalLibrary
.getExpectedDir(meta
.getSource());
350 File to
= this.getExpectedDir(meta
.getSource());
351 List
<File
> relatedFiles
= otherLocalLibrary
352 .getRelatedFiles(luid
);
353 if (!relatedFiles
.isEmpty()) {
354 pg
.setMinMax(0, relatedFiles
.size());
357 for (File relatedFile
: relatedFiles
) {
358 File target
= new File(relatedFile
.getAbsolutePath()
359 .replace(from
.getAbsolutePath(),
360 to
.getAbsolutePath()));
361 if (!relatedFile
.equals(target
)) {
362 target
.getParentFile().mkdirs();
363 InputStream in
= null;
365 in
= new FileInputStream(relatedFile
);
366 IOUtils
.write(in
, target
);
367 } catch (IOException e
) {
371 } catch (Exception ee
) {
389 super.imprt(other
, luid
, pg
);
393 * Return the {@link OutputType} for this {@link Story}.
396 * the {@link Story} {@link MetaData}
400 private OutputType
getOutputType(MetaData meta
) {
401 if (meta
!= null && meta
.isImageDocument()) {
409 * Get the target {@link File} related to the given <tt>.info</tt>
410 * {@link File} and {@link MetaData}.
415 * the <tt>.info</tt> {@link File}
417 * @return the target {@link File}
419 private File
getTargetFile(MetaData meta
, File infoFile
) {
420 // Replace .info with whatever is needed:
421 String path
= infoFile
.getPath();
422 path
= path
.substring(0, path
.length() - ".info".length());
423 String newExt
= getOutputType(meta
).getDefaultExtension(true);
425 return new File(path
+ newExt
);
429 * The target (full path) where the {@link Story} related to this
430 * {@link MetaData} should be located on disk for a new {@link Story}.
433 * the {@link Story} {@link MetaData}
437 private File
getExpectedFile(MetaData key
) {
438 String title
= key
.getTitle();
442 title
= title
.replaceAll("[^a-zA-Z0-9._+-]", "_");
443 if (title
.length() > 40) {
444 title
= title
.substring(0, 40);
446 return new File(getExpectedDir(key
.getSource()), key
.getLuid() + "_"
451 * The directory (full path) where the new {@link Story} related to this
452 * {@link MetaData} should be located on disk.
457 * @return the target directory
459 private File
getExpectedDir(String source
) {
460 String sanitizedSource
= source
.replaceAll("[^a-zA-Z0-9._+/-]", "_");
462 while (sanitizedSource
.startsWith("/")
463 || sanitizedSource
.startsWith("_")) {
464 if (sanitizedSource
.length() > 1) {
465 sanitizedSource
= sanitizedSource
.substring(1);
467 sanitizedSource
= "";
471 sanitizedSource
= sanitizedSource
.replace("/", File
.separator
);
473 if (sanitizedSource
.isEmpty()) {
474 sanitizedSource
= "_EMPTY";
477 return new File(baseDir
, sanitizedSource
);
481 * Return the full path to the file to use for the custom cover of this
484 * One or more of the parent directories <b>MAY</b> not exist.
489 * @return the custom cover file
491 private File
getAuthorCoverFile(String author
) {
492 File aDir
= new File(baseDir
, "_AUTHORS");
493 String hash
= StringUtils
.getMd5Hash(author
);
494 String ext
= Instance
.getConfig().getString(Config
.IMAGE_FORMAT_COVER
);
495 return new File(aDir
, hash
+ "." + ext
.toLowerCase());
499 * Return the list of files/directories on disk for this {@link Story}.
501 * If the {@link Story} is not found, and empty list is returned.
504 * the {@link Story} LUID
506 * @return the list of {@link File}s
508 * @throws IOException
509 * if the {@link Story} was not found
511 private List
<File
> getRelatedFiles(String luid
) throws IOException
{
512 List
<File
> files
= new ArrayList
<File
>();
514 MetaData meta
= getInfo(luid
);
516 throw new IOException("Story not found: " + luid
);
519 File infoFile
= getStories(null).get(meta
)[0];
520 File targetFile
= getStories(null).get(meta
)[1];
523 files
.add(targetFile
);
525 String readerExt
= getOutputType(meta
).getDefaultExtension(true);
526 String fileExt
= getOutputType(meta
).getDefaultExtension(false);
528 String path
= targetFile
.getAbsolutePath();
529 if (readerExt
!= null && !readerExt
.equals(fileExt
)) {
530 path
= path
.substring(0, path
.length() - readerExt
.length())
532 File relatedFile
= new File(path
);
534 if (relatedFile
.exists()) {
535 files
.add(relatedFile
);
539 String coverExt
= "."
540 + Instance
.getConfig().getString(Config
.IMAGE_FORMAT_COVER
)
542 File coverFile
= new File(path
+ coverExt
);
543 if (!coverFile
.exists()) {
544 coverFile
= new File(path
.substring(0,
545 path
.length() - fileExt
.length())
549 if (coverFile
.exists()) {
550 files
.add(coverFile
);
557 * Fill the list of stories by reading the content of the local directory
558 * {@link LocalLibrary#baseDir}.
560 * Will use a cached list when possible (see
561 * {@link BasicLibrary#invalidateInfo()}).
564 * the optional {@link Progress}
566 * @return the list of stories (for each item, the first {@link File} is the
567 * info file, the second file is the target {@link File})
569 private synchronized Map
<MetaData
, File
[]> getStories(Progress pg
) {
573 pg
.setMinMax(0, 100);
576 if (stories
== null) {
577 stories
= new HashMap
<MetaData
, File
[]>();
581 File
[] dirs
= baseDir
.listFiles(new FileFilter() {
583 public boolean accept(File file
) {
584 return file
!= null && file
.isDirectory();
589 Progress pgDirs
= new Progress(0, 100 * dirs
.length
);
590 pg
.addProgress(pgDirs
, 100);
592 for (File dir
: dirs
) {
593 Progress pgFiles
= new Progress();
594 pgDirs
.addProgress(pgFiles
, 100);
595 pgDirs
.setName("Loading from: " + dir
.getName());
597 addToStories(pgFiles
, dir
);
599 pgFiles
.setName(null);
602 pgDirs
.setName("Loading directories");
610 private void addToStories(Progress pgFiles
, File dir
) {
611 File
[] infoFilesAndSubdirs
= dir
.listFiles(new FileFilter() {
613 public boolean accept(File file
) {
614 boolean info
= file
!= null && file
.isFile()
615 && file
.getPath().toLowerCase().endsWith(".info");
616 boolean dir
= file
!= null && file
.isDirectory();
621 if (pgFiles
!= null) {
622 pgFiles
.setMinMax(0, infoFilesAndSubdirs
.length
);
625 for (File infoFileOrSubdir
: infoFilesAndSubdirs
) {
626 if (pgFiles
!= null) {
627 pgFiles
.setName(infoFileOrSubdir
.getName());
630 if (infoFileOrSubdir
.isDirectory()) {
631 addToStories(null, infoFileOrSubdir
);
634 MetaData meta
= InfoReader
635 .readMeta(infoFileOrSubdir
, false);
637 int id
= Integer
.parseInt(meta
.getLuid());
642 stories
.put(meta
, new File
[] { infoFileOrSubdir
,
643 getTargetFile(meta
, infoFileOrSubdir
) });
644 } catch (Exception e
) {
646 throw new IOException("Cannot understand the LUID of "
647 + infoFileOrSubdir
+ ": " + meta
.getLuid(), e
);
649 } catch (IOException e
) {
650 // We should not have not-supported files in the
652 Instance
.getTraceHandler().error(
653 new IOException("Cannot load file from library: "
654 + infoFileOrSubdir
, e
));
658 if (pgFiles
!= null) {