Use Downloader/Cache from utils
[fanfix.git] / src / be / nikiroo / fanfix / Instance.java
index 9c20682fd8d6798da64eea8406ddfc86fa1c9dee..14977822bec55ca032a26e266ac35445ca96c570 100644 (file)
@@ -2,11 +2,17 @@ package be.nikiroo.fanfix;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Date;
 
 import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.bundles.ConfigBundle;
 import be.nikiroo.fanfix.bundles.StringIdBundle;
+import be.nikiroo.fanfix.bundles.UiConfig;
+import be.nikiroo.fanfix.bundles.UiConfigBundle;
+import be.nikiroo.fanfix.library.BasicLibrary;
+import be.nikiroo.fanfix.library.LocalLibrary;
 import be.nikiroo.fanfix.output.BasicOutput.OutputType;
+import be.nikiroo.utils.IOUtils;
 import be.nikiroo.utils.resources.Bundles;
 
 /**
@@ -15,49 +21,102 @@ import be.nikiroo.utils.resources.Bundles;
  * @author niki
  */
 public class Instance {
+       /**
+        * A handler when a recoverable exception was caught by the program.
+        * 
+        * @author niki
+        */
+       public interface SyserrHandler {
+               /**
+                * An exception happened, log it.
+                * 
+                * @param e
+                *            the exception
+                * @param showDetails
+                *            show more details (usually equivalent to the value of
+                *            DEBUG)
+                */
+               public void notify(Exception e, boolean showDetails);
+       }
+
+       /**
+        * A handler when a trace message is sent.
+        * 
+        * @author niki
+        */
+       public interface TraceHandler {
+               /**
+                * A trace happened, show it.
+                * <p>
+                * Will only be called if TRACE is true.
+                * 
+                * @param message
+                *            the trace message
+                */
+               public void trace(String message);
+       }
+
        private static ConfigBundle config;
+       private static UiConfigBundle uiconfig;
        private static StringIdBundle trans;
-       private static Cache cache;
-       private static Library lib;
+       private static DataLoader cache;
+       private static LocalLibrary lib;
        private static boolean debug;
+       private static boolean trace;
        private static File coverDir;
        private static File readerTmp;
+       private static File remoteDir;
+       private static String configDir;
+
+       private static SyserrHandler syserrHandler;
+
+       private static TraceHandler traceHandler;
 
        static {
                // Most of the rest is dependent upon this:
                config = new ConfigBundle();
 
-               String configDir = System.getenv("CONFIG_DIR");
+               configDir = System.getProperty("CONFIG_DIR");
+               if (configDir == null) {
+                       configDir = System.getenv("CONFIG_DIR");
+               }
+
                if (configDir == null) {
                        configDir = new File(System.getProperty("user.home"), ".fanfix")
                                        .getPath();
                }
-               if (configDir != null) {
-                       if (!new File(configDir).exists()) {
-                               new File(configDir).mkdirs();
-                       } else {
-                               Bundles.setDirectory(configDir);
-                       }
-
-                       try {
-                               config = new ConfigBundle();
-                               config.updateFile(configDir);
-                       } catch (IOException e) {
-                               syserr(e);
-                       }
-                       try {
-                               trans = new StringIdBundle(getLang());
-                               trans.updateFile(configDir);
-                       } catch (IOException e) {
-                               syserr(e);
-                       }
 
+               if (!new File(configDir).exists()) {
+                       new File(configDir).mkdirs();
+               } else {
                        Bundles.setDirectory(configDir);
                }
 
+               try {
+                       config = new ConfigBundle();
+                       config.updateFile(configDir);
+               } catch (IOException e) {
+                       syserr(e);
+               }
+               try {
+                       uiconfig = new UiConfigBundle();
+                       uiconfig.updateFile(configDir);
+               } catch (IOException e) {
+                       syserr(e);
+               }
+               try {
+                       trans = new StringIdBundle(getLang());
+                       trans.updateFile(configDir);
+               } catch (IOException e) {
+                       syserr(e);
+               }
+
+               Bundles.setDirectory(configDir);
+
+               uiconfig = new UiConfigBundle();
                trans = new StringIdBundle(getLang());
                try {
-                       lib = new Library(getFile(Config.LIBRARY_DIR),
+                       lib = new LocalLibrary(getFile(Config.LIBRARY_DIR),
                                        OutputType.INFO_TEXT, OutputType.CBZ);
                } catch (Exception e) {
                        syserr(new IOException("Cannot create library for directory: "
@@ -65,9 +124,11 @@ public class Instance {
                }
 
                debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
+               trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, false);
                coverDir = getFile(Config.DEFAULT_COVERS_DIR);
                File tmp = getFile(Config.CACHE_DIR);
-               readerTmp = getFile(Config.CACHE_DIR_LOCAL_READER);
+               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER);
+               remoteDir = new File(getFile(Config.LIBRARY_DIR), "remote");
 
                if (checkEnv("NOUTF")) {
                        trans.setUnicode(false);
@@ -77,20 +138,14 @@ public class Instance {
                        debug = true;
                }
 
-               if (tmp == null || readerTmp == null) {
-                       String tmpDir = System.getProperty("java.io.tmpdir");
-                       if (tmpDir != null) {
-                               if (tmp == null) {
-                                       tmp = new File(tmpDir, "fanfic-tmp");
-                               }
-                               if (readerTmp == null) {
-                                       readerTmp = new File(tmpDir, "fanfic-reader");
-                               }
-                       } else {
-                               syserr(new IOException(
-                                               "The system does not have a default temporary directory"));
-                       }
+               // Could have used: System.getProperty("java.io.tmpdir")
+               if (tmp == null) {
+                       tmp = new File(configDir, "tmp");
                }
+               if (readerTmp == null) {
+                       readerTmp = new File(configDir, "tmp-reader");
+               }
+               //
 
                if (coverDir != null && !coverDir.exists()) {
                        syserr(new IOException(
@@ -105,7 +160,7 @@ public class Instance {
                        int hoursLarge = config
                                        .getInteger(Config.CACHE_MAX_TIME_STABLE, -1);
 
-                       cache = new Cache(tmp, ua, hours, hoursLarge);
+                       cache = new DataLoader(tmp, ua, hours, hoursLarge);
                } catch (IOException e) {
                        syserr(new IOException(
                                        "Cannot create cache (will continue without cache)", e));
@@ -122,17 +177,26 @@ public class Instance {
        }
 
        /**
-        * Get the (unique) {@link Cache} for the program.
+        * Get the (unique) UI configuration service for the program.
         * 
-        * @return the {@link Cache}
+        * @return the configuration service
         */
-       public static Cache getCache() {
+       public static UiConfigBundle getUiConfig() {
+               return uiconfig;
+       }
+
+       /**
+        * Get the (unique) {@link DataLoader} for the program.
+        * 
+        * @return the {@link DataLoader}
+        */
+       public static DataLoader getCache() {
                return cache;
        }
 
        /**
         * Get the (unique) {link StringIdBundle} for the program.
-        *
+        * 
         * @return the {link StringIdBundle}
         */
        public static StringIdBundle getTrans() {
@@ -140,11 +204,11 @@ public class Instance {
        }
 
        /**
-        * Get the (unique) {@link Library} for the program.
+        * Get the (unique) {@link LocalLibrary} for the program.
         * 
-        * @return the {@link Library}
+        * @return the {@link LocalLibrary}
         */
-       public static Library getLibrary() {
+       public static BasicLibrary getLibrary() {
                return lib;
        }
 
@@ -166,6 +230,85 @@ public class Instance {
                return readerTmp;
        }
 
+       /**
+        * Return the directory where to store temporary files for the remote
+        * {@link LocalLibrary}.
+        * 
+        * @param host
+        *            the remote for this host
+        * 
+        * @return the directory
+        */
+       public static File getRemoteDir(String host) {
+               remoteDir.mkdirs();
+
+               if (host != null) {
+                       return new File(remoteDir, host);
+               }
+
+               return remoteDir;
+       }
+
+       /**
+        * Check if we need to check that a new version of Fanfix is available.
+        * 
+        * @return TRUE if we need to
+        */
+       public static boolean isVersionCheckNeeded() {
+               try {
+                       long wait = config.getInteger(Config.UPDATE_INTERVAL, 1) * 24 * 60
+                                       * 60 * 1000;
+                       if (wait >= 0) {
+                               String lastUpString = IOUtils.readSmallFile(new File(configDir,
+                                               "LAST_UPDATE"));
+                               long delay = new Date().getTime()
+                                               - Long.parseLong(lastUpString);
+                               if (delay > wait) {
+                                       return true;
+                               }
+                       } else {
+                               return false;
+                       }
+               } catch (Exception e) {
+                       // No file or bad file:
+                       return true;
+               }
+
+               return false;
+       }
+
+       /**
+        * Notify that we checked for a new version of Fanfix.
+        */
+       public static void setVersionChecked() {
+               try {
+                       IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE",
+                                       Long.toString(new Date().getTime()));
+               } catch (IOException e) {
+                       syserr(e);
+               }
+       }
+
+       /**
+        * Replace the global syserr handler.
+        * 
+        * @param syserrHandler
+        *            the new syserr handler
+        */
+       public static void setSyserrHandler(SyserrHandler syserrHandler) {
+               Instance.syserrHandler = syserrHandler;
+       }
+
+       /**
+        * Replace the global trace handler.
+        * 
+        * @param traceHandler
+        *            the new trace handler
+        */
+       public static void setTraceHandler(TraceHandler traceHandler) {
+               Instance.traceHandler = traceHandler;
+       }
+
        /**
         * Report an error to the user
         * 
@@ -173,10 +316,30 @@ public class Instance {
         *            the {@link Exception} to report
         */
        public static void syserr(Exception e) {
-               if (debug) {
-                       e.printStackTrace();
+               if (syserrHandler != null) {
+                       syserrHandler.notify(e, debug);
                } else {
-                       System.err.println(e.getMessage());
+                       if (debug) {
+                               e.printStackTrace();
+                       } else {
+                               System.err.println(e.getMessage());
+                       }
+               }
+       }
+
+       /**
+        * Notify of a debug message.
+        * 
+        * @param message
+        *            the message
+        */
+       public static void trace(String message) {
+               if (trace) {
+                       if (traceHandler != null) {
+                               traceHandler.trace(message);
+                       } else {
+                               System.out.println(message);
+                       }
                }
        }
 
@@ -186,8 +349,25 @@ public class Instance {
         * @return the path
         */
        private static File getFile(Config id) {
+               return getFile(config.getString(id));
+       }
+
+       /**
+        * Return a path, but support the special $HOME variable.
+        * 
+        * @return the path
+        */
+       private static File getFile(UiConfig id) {
+               return getFile(uiconfig.getString(id));
+       }
+
+       /**
+        * Return a path, but support the special $HOME variable.
+        * 
+        * @return the path
+        */
+       private static File getFile(String path) {
                File file = null;
-               String path = config.getString(id);
                if (path != null && !path.isEmpty()) {
                        path = path.replace('/', File.separatorChar);
                        if (path.contains("$HOME")) {