Dependency fix + Local/Remote Library support
[fanfix.git] / src / be / nikiroo / fanfix / LocalLibrary.java
diff --git a/src/be/nikiroo/fanfix/LocalLibrary.java b/src/be/nikiroo/fanfix/LocalLibrary.java
new file mode 100644 (file)
index 0000000..35f13f0
--- /dev/null
@@ -0,0 +1,362 @@
+package be.nikiroo.fanfix;
+
+import java.awt.image.BufferedImage;
+import java.io.File;
+import java.io.FileFilter;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import be.nikiroo.fanfix.bundles.Config;
+import be.nikiroo.fanfix.data.MetaData;
+import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.fanfix.output.BasicOutput;
+import be.nikiroo.fanfix.output.BasicOutput.OutputType;
+import be.nikiroo.fanfix.output.InfoCover;
+import be.nikiroo.fanfix.supported.InfoReader;
+import be.nikiroo.utils.IOUtils;
+import be.nikiroo.utils.Progress;
+
+/**
+ * This {@link BasicLibrary} will store the stories locally on disk.
+ * 
+ * @author niki
+ */
+public class LocalLibrary extends BasicLibrary {
+       private int lastId;
+       private Map<MetaData, File[]> stories; // Files: [ infoFile, TargetFile ]
+
+       private File baseDir;
+       private OutputType text;
+       private OutputType image;
+
+       /**
+        * Create a new {@link LocalLibrary} with the given back-end directory.
+        * 
+        * @param baseDir
+        *            the directory where to find the {@link Story} objects
+        * @param text
+        *            the {@link OutputType} to save the text-focused stories into
+        * @param image
+        *            the {@link OutputType} to save the images-focused stories into
+        */
+       public LocalLibrary(File baseDir, OutputType text, OutputType image) {
+               this.baseDir = baseDir;
+               this.text = text;
+               this.image = image;
+
+               this.lastId = 0;
+               this.stories = null;
+
+               baseDir.mkdirs();
+       }
+
+       @Override
+       protected List<MetaData> getMetas(Progress pg) {
+               return new ArrayList<MetaData>(getStories(pg).keySet());
+       }
+
+       @Override
+       public File getFile(String luid) {
+               File[] files = getStories(null).get(getInfo(luid));
+               if (files != null) {
+                       return files[1];
+               }
+
+               return null;
+       }
+
+       @Override
+       public BufferedImage getCover(String luid) {
+               MetaData meta = getInfo(luid);
+               if (meta != null) {
+                       File[] files = getStories(null).get(meta);
+                       if (files != null) {
+                               File infoFile = files[0];
+
+                               try {
+                                       meta = InfoReader.readMeta(infoFile, true);
+                                       return meta.getCover();
+                               } catch (IOException e) {
+                                       Instance.syserr(e);
+                               }
+                       }
+               }
+
+               return null;
+       }
+
+       @Override
+       protected void clearCache() {
+               stories = null;
+       }
+
+       @Override
+       protected synchronized int getNextId() {
+               return ++lastId;
+       }
+
+       @Override
+       protected void doDelete(String luid) throws IOException {
+               for (File file : getRelatedFiles(luid)) {
+                       // TODO: throw an IOException if we cannot delete the files?
+                       IOUtils.deltree(file);
+               }
+       }
+
+       @Override
+       protected Story doSave(Story story, Progress pg) throws IOException {
+               MetaData meta = story.getMeta();
+
+               File expectedTarget = getExpectedFile(meta);
+               expectedTarget.getParentFile().mkdirs();
+
+               BasicOutput it = BasicOutput.getOutput(getOutputType(meta), true);
+               it.process(story, expectedTarget.getPath(), pg);
+
+               return story;
+       }
+
+       @Override
+       protected synchronized void saveMeta(MetaData meta, Progress pg)
+                       throws IOException {
+               File newDir = getExpectedDir(meta.getSource());
+               if (!newDir.exists()) {
+                       newDir.mkdir();
+               }
+
+               List<File> relatedFiles = getRelatedFiles(meta.getLuid());
+               for (File relatedFile : relatedFiles) {
+                       // TODO: this is not safe at all.
+                       // We should copy all the files THEN delete them
+                       // Maybe also adding some rollback cleanup if possible
+                       if (relatedFile.getName().endsWith(".info")) {
+                               try {
+                                       String name = relatedFile.getName().replaceFirst(
+                                                       "\\.info$", "");
+                                       InfoCover.writeInfo(newDir, name, meta);
+                                       relatedFile.delete();
+                               } catch (IOException e) {
+                                       Instance.syserr(e);
+                               }
+                       } else {
+                               relatedFile.renameTo(new File(newDir, relatedFile.getName()));
+                       }
+               }
+
+               clearCache();
+       }
+
+       /**
+        * Return the {@link OutputType} for this {@link Story}.
+        * 
+        * @param meta
+        *            the {@link Story} {@link MetaData}
+        * 
+        * @return the type
+        */
+       private OutputType getOutputType(MetaData meta) {
+               if (meta != null && meta.isImageDocument()) {
+                       return image;
+               } else {
+                       return text;
+               }
+       }
+
+       /**
+        * Get the target {@link File} related to the given <tt>.info</tt>
+        * {@link File} and {@link MetaData}.
+        * 
+        * @param meta
+        *            the meta
+        * @param infoFile
+        *            the <tt>.info</tt> {@link File}
+        * 
+        * @return the target {@link File}
+        */
+       private File getTargetFile(MetaData meta, File infoFile) {
+               // Replace .info with whatever is needed:
+               String path = infoFile.getPath();
+               path = path.substring(0, path.length() - ".info".length());
+               String newExt = getOutputType(meta).getDefaultExtension(true);
+
+               return new File(path + newExt);
+       }
+
+       /**
+        * The target (full path) where the {@link Story} related to this
+        * {@link MetaData} should be located on disk for a new {@link Story}.
+        * 
+        * @param key
+        *            the {@link Story} {@link MetaData}
+        * 
+        * @return the target
+        */
+       private File getExpectedFile(MetaData key) {
+               String title = key.getTitle();
+               if (title == null) {
+                       title = "";
+               }
+               title = title.replaceAll("[^a-zA-Z0-9._+-]", "_");
+               return new File(getExpectedDir(key.getSource()), key.getLuid() + "_"
+                               + title);
+       }
+
+       /**
+        * The directory (full path) where the new {@link Story} related to this
+        * {@link MetaData} should be located on disk.
+        * 
+        * @param type
+        *            the type (source)
+        * 
+        * @return the target directory
+        */
+       private File getExpectedDir(String type) {
+               String source = type.replaceAll("[^a-zA-Z0-9._+-]", "_");
+               return new File(baseDir, source);
+       }
+
+       /**
+        * Return the list of files/directories on disk for this {@link Story}.
+        * <p>
+        * If the {@link Story} is not found, and empty list is returned.
+        * 
+        * @param luid
+        *            the {@link Story} LUID
+        * 
+        * @return the list of {@link File}s
+        * 
+        * @throws IOException
+        *             if the {@link Story} was not found
+        */
+       private List<File> getRelatedFiles(String luid) throws IOException {
+               List<File> files = new ArrayList<File>();
+
+               MetaData meta = getInfo(luid);
+               if (meta == null) {
+                       throw new IOException("Story not found: " + luid);
+               } else {
+                       File infoFile = getStories(null).get(meta)[0];
+                       File targetFile = getStories(null).get(meta)[1];
+
+                       files.add(infoFile);
+                       files.add(targetFile);
+
+                       String readerExt = getOutputType(meta).getDefaultExtension(true);
+                       String fileExt = getOutputType(meta).getDefaultExtension(false);
+
+                       String path = targetFile.getAbsolutePath();
+                       if (readerExt != null && !readerExt.equals(fileExt)) {
+                               path = path.substring(0, path.length() - readerExt.length())
+                                               + fileExt;
+                               File relatedFile = new File(path);
+
+                               if (relatedFile.exists()) {
+                                       files.add(relatedFile);
+                               }
+                       }
+
+                       String coverExt = "."
+                                       + Instance.getConfig().getString(Config.IMAGE_FORMAT_COVER);
+                       File coverFile = new File(path + coverExt);
+                       if (!coverFile.exists()) {
+                               coverFile = new File(path.substring(0,
+                                               path.length() - fileExt.length())
+                                               + coverExt);
+                       }
+
+                       if (coverFile.exists()) {
+                               files.add(coverFile);
+                       }
+               }
+
+               return files;
+       }
+
+       /**
+        * Fill the list of stories by reading the content of the local directory
+        * {@link LocalLibrary#baseDir}.
+        * <p>
+        * Will use a cached list when possible (see
+        * {@link BasicLibrary#clearCache()}).
+        * 
+        * @param pg
+        *            the optional {@link Progress}
+        * 
+        * @return the list of stories
+        */
+       private synchronized Map<MetaData, File[]> getStories(Progress pg) {
+               if (pg == null) {
+                       pg = new Progress();
+               } else {
+                       pg.setMinMax(0, 100);
+               }
+
+               if (stories == null) {
+                       stories = new HashMap<MetaData, File[]>();
+
+                       lastId = 0;
+
+                       File[] dirs = baseDir.listFiles(new FileFilter() {
+                               public boolean accept(File file) {
+                                       return file != null && file.isDirectory();
+                               }
+                       });
+
+                       Progress pgDirs = new Progress(0, 100 * dirs.length);
+                       pg.addProgress(pgDirs, 100);
+
+                       for (File dir : dirs) {
+                               File[] infoFiles = dir.listFiles(new FileFilter() {
+                                       public boolean accept(File file) {
+                                               return file != null
+                                                               && file.getPath().toLowerCase()
+                                                                               .endsWith(".info");
+                                       }
+                               });
+
+                               Progress pgFiles = new Progress(0, infoFiles.length);
+                               pgDirs.addProgress(pgFiles, 100);
+                               pgDirs.setName("Loading from: " + dir.getName());
+
+                               for (File infoFile : infoFiles) {
+                                       pgFiles.setName(infoFile.getName());
+                                       try {
+                                               MetaData meta = InfoReader.readMeta(infoFile, false);
+                                               try {
+                                                       int id = Integer.parseInt(meta.getLuid());
+                                                       if (id > lastId) {
+                                                               lastId = id;
+                                                       }
+
+                                                       stories.put(meta, new File[] { infoFile,
+                                                                       getTargetFile(meta, infoFile) });
+                                               } catch (Exception e) {
+                                                       // not normal!!
+                                                       throw new IOException(
+                                                                       "Cannot understand the LUID of "
+                                                                                       + infoFile
+                                                                                       + ": "
+                                                                                       + (meta == null ? "[meta is NULL]"
+                                                                                                       : meta.getLuid()), e);
+                                               }
+                                       } catch (IOException e) {
+                                               // We should not have not-supported files in the
+                                               // library
+                                               Instance.syserr(new IOException(
+                                                               "Cannot load file from library: " + infoFile, e));
+                                       }
+                                       pgFiles.add(1);
+                               }
+
+                               pgFiles.setName(null);
+                       }
+
+                       pgDirs.setName("Loading directories");
+               }
+
+               return stories;
+       }
+}