README update
[nikiroo-utils.git] / src / be / nikiroo / fanfix / Instance.java
index 7ed5e25940ad94954c4d8abe9a906667fc4900d7..ece87186b7021a11118d8c42ed324c51a8374333 100644 (file)
@@ -11,10 +11,12 @@ 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.TempFiles;
 import be.nikiroo.utils.TraceHandler;
 import be.nikiroo.utils.resources.Bundles;
 
@@ -34,123 +36,65 @@ public class Instance {
        private static File remoteDir;
        private static String configDir;
        private static TraceHandler tracer;
+       private static TempFiles tempFiles;
 
        static {
                // Before we can configure it:
-               tracer = new TraceHandler(true, checkEnv("DEBUG"), false);
-
-               // Most of the rest is dependent upon this:
-               config = new ConfigBundle();
-
-               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();
-               }
+               tracer = new TraceHandler(true, checkEnv("DEBUG"), checkEnv("DEBUG"));
 
+               // config dir:
+               configDir = getConfigDir();
                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());
-
-               // 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());
+               // Most of the rest is dependent upon this:
+               createConfigs(configDir, false);
 
+               // update tracer:
                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 (checkEnv("NOUTF")) {
-                       trans.setUnicode(false);
-               }
 
                if (checkEnv("DEBUG")) {
                        debug = true;
+                       trace = true;
                }
 
                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("Contacting remote library " + host + ":"
-                                                               + port);
-                                               lib = new RemoteLibrary(key, host,
-                                                               Integer.parseInt(port));
-                                       } catch (Exception e) {
-                                       }
-                               }
-                       }
-
-                       if (lib == null) {
-                               tracer.error(new IOException(
-                                               "Cannot create remote library for: "
-                                                               + getFile(Config.DEFAULT_LIBRARY)));
-                       }
-               }
+               // default Library
+               remoteDir = new File(configDir, "remote");
+               lib = createDefaultLibrary(remoteDir);
 
-               // Could have used: System.getProperty("java.io.tmpdir")
+               // create cache
+               File tmp = getFile(Config.CACHE_DIR);
                if (tmp == null) {
+                       // Could have used: System.getProperty("java.io.tmpdir")
                        tmp = new File(configDir, "tmp");
                }
+               String ua = config.getString(Config.USER_AGENT);
+               try {
+                       int hours = config.getInteger(Config.CACHE_MAX_TIME_CHANGING, -1);
+                       int hoursLarge = config
+                                       .getInteger(Config.CACHE_MAX_TIME_STABLE, -1);
+                       cache = new DataLoader(tmp, ua, hours, hoursLarge);
+               } catch (IOException e) {
+                       tracer.error(new IOException(
+                                       "Cannot create cache (will continue without cache)", e));
+                       cache = new DataLoader(ua);
+               }
+
+               cache.setTraceHandler(tracer);
+
+               // readerTmp / coverDir
+               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER);
                if (readerTmp == null) {
                        readerTmp = new File(configDir, "tmp-reader");
                }
-               //
 
+               coverDir = getFile(Config.DEFAULT_COVERS_DIR);
                if (coverDir != null && !coverDir.exists()) {
                        tracer.error(new IOException(
                                        "The 'default covers' directory does not exists: "
@@ -159,15 +103,9 @@ public class Instance {
                }
 
                try {
-                       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);
-
-                       cache = new DataLoader(tmp, ua, hours, hoursLarge);
+                       tempFiles = new TempFiles("fanfix");
                } catch (IOException e) {
-                       tracer.error(new IOException(
-                                       "Cannot create cache (will continue without cache)", e));
+                       tracer.error(new IOException("Cannot create temporary directory", e));
                }
        }
 
@@ -194,6 +132,7 @@ public class Instance {
                }
 
                Instance.tracer = tracer;
+               cache.setTraceHandler(tracer);
        }
 
        /**
@@ -214,6 +153,42 @@ public class Instance {
                return uiconfig;
        }
 
+       /**
+        * Reset the configuration.
+        * 
+        * @param resetTrans
+        *            also reset the translation files
+        */
+       public static void resetConfig(boolean resetTrans) {
+               String dir = Bundles.getDirectory();
+               Bundles.setDirectory(null);
+               try {
+                       try {
+                               ConfigBundle config = new ConfigBundle();
+                               config.updateFile(configDir);
+                       } catch (IOException e) {
+                               tracer.error(e);
+                       }
+                       try {
+                               UiConfigBundle uiconfig = new UiConfigBundle();
+                               uiconfig.updateFile(configDir);
+                       } catch (IOException e) {
+                               tracer.error(e);
+                       }
+
+                       if (resetTrans) {
+                               try {
+                                       StringIdBundle trans = new StringIdBundle(null);
+                                       trans.updateFile(configDir);
+                               } catch (IOException e) {
+                                       tracer.error(e);
+                               }
+                       }
+               } finally {
+                       Bundles.setDirectory(dir);
+               }
+       }
+
        /**
         * Get the (unique) {@link DataLoader} for the program.
         * 
@@ -273,6 +248,21 @@ public class Instance {
         * @return the directory
         */
        public static File getRemoteDir(String host) {
+               return getRemoteDir(remoteDir, host);
+       }
+
+       /**
+        * Return the directory where to store temporary files for the remote
+        * {@link LocalLibrary}.
+        * 
+        * @param remoteDir
+        *            the base remote directory
+        * @param host
+        *            the remote for this host
+        * 
+        * @return the directory
+        */
+       private static File getRemoteDir(File remoteDir, String host) {
                remoteDir.mkdirs();
 
                if (host != null) {
@@ -322,6 +312,144 @@ public class Instance {
                }
        }
 
+       /**
+        * The facility to use temporary files in this program.
+        * <p>
+        * <b>MUST</b> be closed at end of program.
+        * 
+        * @return the facility
+        */
+       public static TempFiles getTempFiles() {
+               return tempFiles;
+       }
+
+       /**
+        * The configuration directory (will check, in order of preference,
+        * {@link Bundles#getDirectory()}, the system properties, the environment
+        * and then defaults to $HOME/.fanfix).
+        * 
+        * @return the config directory
+        */
+       private static String getConfigDir() {
+               String configDir = Bundles.getDirectory();
+
+               if (configDir == null) {
+                       configDir = System.getProperty("CONFIG_DIR");
+               }
+
+               if (configDir == null) {
+                       configDir = System.getenv("CONFIG_DIR");
+               }
+
+               if (configDir == null) {
+                       configDir = new File(getHome(), ".fanfix").getPath();
+               }
+
+               return configDir;
+       }
+
+       /**
+        * Create the config variables ({@link Instance#config},
+        * {@link Instance#uiconfig} and {@link Instance#trans}).
+        * 
+        * @param configDir
+        *            the directory where to find the configuration files
+        * @param refresh
+        *            TRUE to reset the configuration files from the default
+        *            included ones
+        */
+       private static void createConfigs(String configDir, boolean refresh) {
+               if (!refresh) {
+                       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());
+
+               // Fix an old bug (we used to store custom translation files by
+               // default):
+               if (trans.getString(StringId.INPUT_DESC_CBZ) == null) {
+                       trans.deleteFile(configDir);
+               }
+
+               if (checkEnv("NOUTF")) {
+                       trans.setUnicode(false);
+               }
+
+               Bundles.setDirectory(configDir);
+       }
+
+       /**
+        * Create the default library as specified by the config.
+        * 
+        * @param remoteDir
+        *            the base remote directory if needed
+        * 
+        * @return the default {@link BasicLibrary}
+        */
+       private static BasicLibrary createDefaultLibrary(File remoteDir) {
+               BasicLibrary lib = null;
+
+               String remoteLib = config.getString(Config.DEFAULT_LIBRARY);
+               if (remoteLib == null || remoteLib.trim().isEmpty()) {
+                       String libDir = System.getProperty("fanfix.libdir");
+                       if (libDir == null || libDir.isEmpty()) {
+                               libDir = config.getString(Config.LIBRARY_DIR);
+                       }
+                       try {
+                               lib = new LocalLibrary(getFile(libDir));
+                       } catch (Exception e) {
+                               tracer.error(new IOException(
+                                               "Cannot create library for directory: "
+                                                               + getFile(libDir), 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(remoteDir, host),
+                                                               lib);
+
+                                       } catch (Exception e) {
+                                       }
+                               }
+                       }
+
+                       if (lib == null) {
+                               tracer.error(new IOException(
+                                               "Cannot create remote library for: " + remoteLib));
+                       }
+               }
+
+               return lib;
+       }
+
        /**
         * Return a path, but support the special $HOME variable.
         * 
@@ -350,8 +478,7 @@ public class Instance {
                if (path != null && !path.isEmpty()) {
                        path = path.replace('/', File.separatorChar);
                        if (path.contains("$HOME")) {
-                               path = path.replace("$HOME",
-                                               "" + System.getProperty("user.home"));
+                               path = path.replace("$HOME", getHome());
                        }
 
                        file = new File(path);
@@ -360,6 +487,38 @@ public class Instance {
                return file;
        }
 
+       /**
+        * Return the home directory from the system properties.
+        * 
+        * @return the home
+        */
+       private static String getHome() {
+               String home = System.getProperty("fanfix.home");
+               if (home != null && new File(home).isFile()) {
+                       home = null;
+               }
+
+               if (home == null || home.trim().isEmpty()) {
+                       home = System.getProperty("user.home");
+                       if (!new File(home).isDirectory()) {
+                               home = null;
+                       }
+               }
+
+               if (home == null || home.trim().isEmpty()) {
+                       home = System.getProperty("java.io.tmpdir");
+                       if (!new File(home).isDirectory()) {
+                               home = null;
+                       }
+               }
+
+               if (home == null) {
+                       home = "";
+               }
+
+               return home;
+       }
+
        /**
         * The language to use for the application (NULL = default system language).
         *