tui: fix meta/story use
[fanfix.git] / src / be / nikiroo / fanfix / reader / BasicReader.java
index eeb00af1c6ff2f5439af6c4bdfbe9bd8669142e4..778b6338b108f847bea745fbe8fe04c77a0454ec 100644 (file)
 package be.nikiroo.fanfix.reader;
 
+import java.io.File;
 import java.io.IOException;
+import java.net.MalformedURLException;
 import java.net.URL;
 
 import be.nikiroo.fanfix.Instance;
-import be.nikiroo.fanfix.Library;
+import be.nikiroo.fanfix.bundles.Config;
+import be.nikiroo.fanfix.bundles.UiConfig;
+import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.fanfix.library.BasicLibrary;
+import be.nikiroo.fanfix.library.LocalLibrary;
 import be.nikiroo.fanfix.supported.BasicSupport;
-import be.nikiroo.fanfix.supported.BasicSupport.SupportType;
+import be.nikiroo.utils.Progress;
+import be.nikiroo.utils.serial.SerialUtils;
 
 /**
- * Command line {@link Story} reader.
+ * The class that handles the different {@link Story} readers you can use.
  * <p>
- * Will output stories to the console.
+ * All the readers should be accessed via {@link BasicReader#getReader()}.
  * 
  * @author niki
  */
-public abstract class BasicReader {
-       public enum ReaderType {
-               /** Simple reader that outputs everything on the console */
-               CLI,
-               /** Reader that starts local programs to handle the stories */
-               LOCAL
-       }
+public abstract class BasicReader implements Reader {
+       private static BasicLibrary defaultLibrary = Instance.getLibrary();
+       private static ReaderType defaultType = ReaderType.GUI;
 
-       private static ReaderType defaultType;
+       private BasicLibrary lib;
+       private MetaData meta;
        private Story story;
-       private ReaderType type;
+       private int chapter;
 
+       /**
+        * Take the default reader type configuration from the config file.
+        */
        static {
-               // TODO: default type from config
+               String typeString = Instance.getConfig().getString(Config.READER_TYPE);
+               if (typeString != null && !typeString.isEmpty()) {
+                       try {
+                               ReaderType type = ReaderType.valueOf(typeString.toUpperCase());
+                               defaultType = type;
+                       } catch (IllegalArgumentException e) {
+                               // Do nothing
+                       }
+               }
        }
 
-       /**
-        * The type of this reader.
-        * 
-        * @return the type
-        */
-       public ReaderType getType() {
-               return type;
+       @Override
+       public synchronized Story getStory(Progress pg) {
+               if (story == null) {
+                       story = getLibrary().getStory(meta.getLuid(), pg);
+               }
+
+               return story;
        }
 
-       /**
-        * The type of this reader.
-        * 
-        * @param type
-        *            the new type
-        */
-       protected BasicReader setType(ReaderType type) {
-               this.type = type;
-               return this;
+       @Override
+       public BasicLibrary getLibrary() {
+               if (lib == null) {
+                       lib = defaultLibrary;
+               }
+
+               return lib;
        }
 
-       /**
-        * Return the current {@link Story}.
-        * 
-        * @return the {@link Story}
-        */
-       public Story getStory() {
-               return story;
+       @Override
+       public void setLibrary(BasicLibrary lib) {
+               this.lib = lib;
        }
 
-       /**
-        * Create a new {@link BasicReader} for a {@link Story} in the
-        * {@link Library} .
-        * 
-        * @param luid
-        *            the {@link Story} ID
-        * @throws IOException
-        *             in case of I/O error
-        */
-       public void setStory(String luid) throws IOException {
-               story = Instance.getLibrary().getStory(luid);
-               if (story == null) {
+       @Override
+       public synchronized MetaData getMeta() {
+               return meta;
+       }
+
+       @Override
+       public synchronized void setMeta(MetaData meta) throws IOException {
+               setMeta(meta == null ? null : meta.getLuid()); // must check the library
+       }
+
+       @Override
+       public synchronized void setMeta(String luid) throws IOException {
+               story = null;
+               meta = getLibrary().getInfo(luid);
+
+               if (meta == null) {
                        throw new IOException("Cannot retrieve story from library: " + luid);
                }
        }
 
-       /**
-        * Create a new {@link BasicReader} for an external {@link Story}.
-        * 
-        * @param source
-        *            the {@link Story} {@link URL}
-        * @throws IOException
-        *             in case of I/O error
-        */
-       public void setStory(URL source) throws IOException {
-               BasicSupport support = BasicSupport.getSupport(source);
+       @Override
+       public synchronized void setMeta(URL url, Progress pg)
+                       throws IOException {
+               BasicSupport support = BasicSupport.getSupport(url);
                if (support == null) {
-                       throw new IOException("URL not supported: " + source.toString());
+                       throw new IOException("URL not supported: " + url.toString());
                }
 
-               story = support.process(source);
+               story = support.process(pg);
                if (story == null) {
                        throw new IOException(
                                        "Cannot retrieve story from external source: "
-                                                       + source.toString());
+                                                       + url.toString());
+               }
+
+               meta = story.getMeta();
+       }
+
+       @Override
+       public int getChapter() {
+               return chapter;
+       }
+
+       @Override
+       public void setChapter(int chapter) {
+               this.chapter = chapter;
+       }
 
+       /**
+        * Return a new {@link BasicReader} ready for use if one is configured.
+        * <p>
+        * Can return NULL if none are configured.
+        * 
+        * @return a {@link BasicReader}, or NULL if none configured
+        */
+       public static Reader getReader() {
+               try {
+                       if (defaultType != null) {
+                               return (Reader) SerialUtils.createObject(defaultType
+                                               .getTypeName());
+                       }
+               } catch (Exception e) {
+                       Instance.getTraceHandler().error(
+                                       new Exception("Cannot create a reader of type: "
+                                                       + defaultType + " (Not compiled in?)", e));
                }
+
+               return null;
        }
 
        /**
-        * Start the {@link Story} Reading.
+        * The default {@link Reader.ReaderType} used when calling
+        * {@link BasicReader#getReader()}.
         * 
-        * @throws IOException
-        *             in case of I/O error or if the {@link Story} was not
-        *             previously set
+        * @return the default type
         */
-       public abstract void read() throws IOException;
+       public static ReaderType getDefaultReaderType() {
+               return defaultType;
+       }
 
        /**
-        * Read the selected chapter (starting at 1).
+        * The default {@link Reader.ReaderType} used when calling
+        * {@link BasicReader#getReader()}.
         * 
-        * @param chapter
-        *            the chapter
+        * @param defaultType
+        *            the new default type
         */
-       public abstract void read(int chapter);
+       public static void setDefaultReaderType(ReaderType defaultType) {
+               BasicReader.defaultType = defaultType;
+       }
 
        /**
-        * Start the reader in browse mode for the given type (or pass NULL for all
-        * types).
+        * Change the default {@link LocalLibrary} to open with the
+        * {@link BasicReader}s.
         * 
-        * @param type
-        *            the type of {@link Story} to take into account, or NULL for
-        *            all
+        * @param lib
+        *            the new {@link LocalLibrary}
         */
-       public abstract void start(SupportType type);
+       public static void setDefaultLibrary(BasicLibrary lib) {
+               BasicReader.defaultLibrary = lib;
+       }
 
        /**
-        * Return a new {@link BasicReader} ready for use.
+        * Return an {@link URL} from this {@link String}, be it a file path or an
+        * actual {@link URL}.
+        * 
+        * @param sourceString
+        *            the source
+        * 
+        * @return the corresponding {@link URL}
         * 
-        * @return a {@link BasicReader}
+        * @throws MalformedURLException
+        *             if this is neither a file nor a conventional {@link URL}
         */
-       public static BasicReader getReader() {
-               switch (defaultType) {
-               // case LOCAL:
-               // return new LocalReader().setType(ReaderType.LOCAL);
-               case CLI:
-                       return new CliReader().setType(ReaderType.CLI);
+       public static URL getUrl(String sourceString) throws MalformedURLException {
+               if (sourceString == null || sourceString.isEmpty()) {
+                       throw new MalformedURLException("Empty url");
                }
 
-               return null;
+               URL source = null;
+               try {
+                       source = new URL(sourceString);
+               } catch (MalformedURLException e) {
+                       File sourceFile = new File(sourceString);
+                       source = sourceFile.toURI().toURL();
+               }
+
+               return source;
        }
 
        /**
-        * The default {@link ReaderType} used when calling
-        * {@link BasicReader#getReader()}.
+        * Open the {@link Story} with an external reader (the program will be
+        * passed the main file associated with this {@link Story}).
         * 
-        * @return the default type
+        * @param lib
+        *            the {@link BasicLibrary} to select the {@link Story} from
+        * @param luid
+        *            the {@link Story} LUID
+        * 
+        * @throws IOException
+        *             in case of I/O error
         */
-       public static ReaderType getDefaultReaderType() {
-               return defaultType;
+       @Override
+       public void openExternal(BasicLibrary lib, String luid) throws IOException {
+               MetaData meta = lib.getInfo(luid);
+               File target = lib.getFile(luid, null);
+
+               openExternal(meta, target);
        }
 
        /**
-        * The default {@link ReaderType} used when calling
-        * {@link BasicReader#getReader()}.
+        * Open the {@link Story} with an external reader (the program will be
+        * passed the given target file).
         * 
-        * @param defaultType
-        *            the new default type
+        * @param meta
+        *            the {@link Story} to load
+        * @param target
+        *            the target {@link File}
+        * 
+        * @throws IOException
+        *             in case of I/O error
         */
-       public static void setDefaultReaderType(ReaderType defaultType) {
-               BasicReader.defaultType = defaultType;
+       protected void openExternal(MetaData meta, File target) throws IOException {
+               String program = null;
+               if (meta.isImageDocument()) {
+                       program = Instance.getUiConfig().getString(
+                                       UiConfig.IMAGES_DOCUMENT_READER);
+               } else {
+                       program = Instance.getUiConfig().getString(
+                                       UiConfig.NON_IMAGES_DOCUMENT_READER);
+               }
+
+               if (program != null && program.trim().isEmpty()) {
+                       program = null;
+               }
+
+               start(target, program);
+       }
+
+       /**
+        * Start a file and open it with the given program if given or the first
+        * default system starter we can find.
+        * 
+        * @param target
+        *            the target to open
+        * @param program
+        *            the program to use or NULL for the default system starter
+        * 
+        * @throws IOException
+        *             in case of I/O error
+        */
+       protected void start(File target, String program) throws IOException {
+               if (program == null) {
+                       boolean ok = false;
+                       for (String starter : new String[] { "xdg-open", "open", "see",
+                                       "start", "run" }) {
+                               try {
+                                       Instance.getTraceHandler().trace(
+                                                       "starting external program");
+                                       Runtime.getRuntime().exec(
+                                                       new String[] { starter, target.getAbsolutePath() });
+                                       ok = true;
+                                       break;
+                               } catch (IOException e) {
+                               }
+                       }
+                       if (!ok) {
+                               throw new IOException("Cannot find a program to start the file");
+                       }
+               } else {
+                       Instance.getTraceHandler().trace("starting external program");
+                       Runtime.getRuntime().exec(
+                                       new String[] { program, target.getAbsolutePath() });
+               }
        }
 }