Remove or move java.awt dependencies
[nikiroo-utils.git] / src / be / nikiroo / fanfix / Instance.java
index 5c198ee73d9580f50773bfd3fcffe92c9751a3ab..4dde3fa642b8cfaae5265250e86606b494ec0328 100644 (file)
@@ -2,10 +2,21 @@ 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.StringId;
 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.CacheLibrary;
+import be.nikiroo.fanfix.library.LocalLibrary;
+import be.nikiroo.fanfix.library.RemoteLibrary;
+import be.nikiroo.utils.Cache;
+import be.nikiroo.utils.IOUtils;
+import be.nikiroo.utils.TraceHandler;
 import be.nikiroo.utils.resources.Bundles;
 
 /**
@@ -15,85 +26,179 @@ import be.nikiroo.utils.resources.Bundles;
  */
 public class Instance {
        private static ConfigBundle config;
+       private static UiConfigBundle uiconfig;
        private static StringIdBundle trans;
-       private static Cache cache;
-       private static Library lib;
-       private static boolean debug;
+       private static DataLoader cache;
+       private static BasicLibrary lib;
        private static File coverDir;
+       private static File readerTmp;
+       private static File remoteDir;
+       private static String configDir;
+       private static TraceHandler tracer;
 
        static {
+               // Before we can configure it:
+               tracer = new TraceHandler(true, checkEnv("DEBUG"), false);
+
+               // Most of the rest is dependent upon this:
                config = new ConfigBundle();
 
-               // config dependent:
+               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 (!new File(configDir).exists()) {
+                       new File(configDir).mkdirs();
+               } else {
+                       Bundles.setDirectory(configDir);
+               }
+
+               try {
+                       config = new ConfigBundle();
+                       config.updateFile(configDir);
+               } catch (IOException e) {
+                       tracer.error(e);
+               }
+               try {
+                       uiconfig = new UiConfigBundle();
+                       uiconfig.updateFile(configDir);
+               } catch (IOException e) {
+                       tracer.error(e);
+               }
+
+               // No updateFile for this one! (we do not want the user to have custom
+               // translations that won't accept updates from newer versions)
                trans = new StringIdBundle(getLang());
-               lib = new Library(getFile(Config.LIBRARY_DIR));
-               debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
+
+               // Fix an old bug (we used to store custom translation files by
+               // default):
+               if (trans.getString(StringId.INPUT_DESC_CBZ) == null) {
+                       // TODO: create the deleteFile method
+                       // trans.deleteFile(configDir);
+               }
+
+               Bundles.setDirectory(configDir);
+
+               uiconfig = new UiConfigBundle();
+               trans = new StringIdBundle(getLang());
+
+               boolean debug = Instance.getConfig()
+                               .getBoolean(Config.DEBUG_ERR, false);
+               boolean trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE,
+                               false);
                coverDir = getFile(Config.DEFAULT_COVERS_DIR);
+               File tmp = getFile(Config.CACHE_DIR);
+               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER);
+               remoteDir = new File(configDir, "remote");
 
-               if (coverDir != null && !coverDir.exists()) {
-                       syserr(new IOException(
-                                       "The 'default covers' directory does not exists: "
-                                                       + coverDir));
-                       coverDir = null;
+               if (checkEnv("NOUTF")) {
+                       trans.setUnicode(false);
                }
-               //
 
-               String noutf = System.getenv("NOUTF");
-               if (noutf != null) {
-                       noutf = noutf.trim().toLowerCase();
-                       if ("yes".equals(noutf) || "true".equals(noutf)
-                                       || "on".equals(noutf) || "1".equals(noutf)
-                                       || "y".equals(noutf)) {
-                               trans.setUnicode(false);
-                       }
+               if (checkEnv("DEBUG")) {
+                       debug = true;
                }
 
-               String configDir = System.getenv("CONFIG_DIR");
-               if (configDir != null) {
-                       if (new File(configDir).isDirectory()) {
-                               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);
+               tracer = new TraceHandler(true, debug, trace);
+
+               String remoteLib = config.getString(Config.DEFAULT_LIBRARY);
+               if (remoteLib == null || remoteLib.trim().isEmpty()) {
+                       try {
+                               lib = new LocalLibrary(getFile(Config.LIBRARY_DIR));
+                       } catch (Exception e) {
+                               tracer.error(new IOException(
+                                               "Cannot create library for directory: "
+                                                               + getFile(Config.LIBRARY_DIR), e));
+                       }
+               } else {
+                       int pos = remoteLib.lastIndexOf(":");
+                       if (pos >= 0) {
+                               String port = remoteLib.substring(pos + 1).trim();
+                               remoteLib = remoteLib.substring(0, pos);
+                               pos = remoteLib.lastIndexOf(":");
+                               if (pos >= 0) {
+                                       String host = remoteLib.substring(pos + 1).trim();
+                                       String key = remoteLib.substring(0, pos).trim();
+
+                                       try {
+                                               tracer.trace("Selecting remote library " + host + ":"
+                                                               + port);
+                                               lib = new RemoteLibrary(key, host,
+                                                               Integer.parseInt(port));
+                                               lib = new CacheLibrary(getRemoteDir(host), lib);
+
+                                       } catch (Exception e) {
+                                       }
                                }
-                       } else {
-                               syserr(new IOException("Configuration directory not found: "
-                                               + configDir));
                        }
+
+                       if (lib == null) {
+                               tracer.error(new IOException(
+                                               "Cannot create remote library for: "
+                                                               + getFile(Config.DEFAULT_LIBRARY)));
+                       }
+               }
+
+               // 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()) {
+                       tracer.error(new IOException(
+                                       "The 'default covers' directory does not exists: "
+                                                       + coverDir));
+                       coverDir = null;
                }
 
                try {
-                       File tmp = getFile(Config.CACHE_DIR);
                        String ua = config.getString(Config.USER_AGENT);
                        int hours = config.getInteger(Config.CACHE_MAX_TIME_CHANGING, -1);
                        int hoursLarge = config
                                        .getInteger(Config.CACHE_MAX_TIME_STABLE, -1);
 
-                       if (tmp == null) {
-                               String tmpDir = System.getProperty("java.io.tmpdir");
-                               if (tmpDir != null) {
-                                       tmp = new File(tmpDir, "fanfic-tmp");
-                               } else {
-                                       syserr(new IOException(
-                                                       "The system does not have a default temporary directory"));
-                               }
-                       }
-
-                       cache = new Cache(tmp, ua, hours, hoursLarge);
+                       cache = new DataLoader(tmp, ua, hours, hoursLarge);
                } catch (IOException e) {
-                       syserr(new IOException(
+                       tracer.error(new IOException(
                                        "Cannot create cache (will continue without cache)", e));
                }
        }
 
+       /**
+        * The traces handler for this {@link Cache}.
+        * <p>
+        * It is never NULL.
+        * 
+        * @return the traces handler (never NULL)
+        */
+       public static TraceHandler getTraceHandler() {
+               return tracer;
+       }
+
+       /**
+        * The traces handler for this {@link Cache}.
+        * 
+        * @param tracer
+        *            the new traces handler or NULL
+        */
+       public static void setTraceHandler(TraceHandler tracer) {
+               if (tracer == null) {
+                       tracer = new TraceHandler(false, false, false);
+               }
+
+               Instance.tracer = tracer;
+       }
+
        /**
         * Get the (unique) configuration service for the program.
         * 
@@ -104,17 +209,26 @@ public class Instance {
        }
 
        /**
-        * Get the (unique) {@link Cache} for the program.
+        * Get the (unique) UI configuration service for the program.
+        * 
+        * @return the configuration service
+        */
+       public static UiConfigBundle getUiConfig() {
+               return uiconfig;
+       }
+
+       /**
+        * Get the (unique) {@link DataLoader} for the program.
         * 
-        * @return the {@link Cache}
+        * @return the {@link DataLoader}
         */
-       public static Cache getCache() {
+       public static DataLoader getCache() {
                return cache;
        }
 
        /**
         * Get the (unique) {link StringIdBundle} for the program.
-        *
+        * 
         * @return the {link StringIdBundle}
         */
        public static StringIdBundle getTrans() {
@@ -122,11 +236,15 @@ 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() {
+               if (lib == null) {
+                       throw new NullPointerException("We don't have a library to return");
+               }
+
                return lib;
        }
 
@@ -140,16 +258,70 @@ public class Instance {
        }
 
        /**
-        * Report an error to the user
+        * Return the directory where to store temporary files for the local reader.
         * 
-        * @param e
-        *            the {@link Exception} to report
+        * @return the directory
         */
-       public static void syserr(Exception e) {
-               if (debug) {
-                       e.printStackTrace();
-               } else {
-                       System.err.println(e.getMessage());
+       public static File getReaderDir() {
+               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) {
+                       tracer.error(e);
                }
        }
 
@@ -159,8 +331,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")) {
@@ -192,4 +381,26 @@ public class Instance {
 
                return lang;
        }
+
+       /**
+        * Check that the given environment variable is "enabled".
+        * 
+        * @param key
+        *            the variable to check
+        * 
+        * @return TRUE if it is
+        */
+       private static boolean checkEnv(String key) {
+               String value = System.getenv(key);
+               if (value != null) {
+                       value = value.trim().toLowerCase();
+                       if ("yes".equals(value) || "true".equals(value)
+                                       || "on".equals(value) || "1".equals(value)
+                                       || "y".equals(value)) {
+                               return true;
+                       }
+               }
+
+               return false;
+       }
 }