Revert "fix some default paths"
[nikiroo-utils.git] / src / be / nikiroo / fanfix / Instance.java
index ed22f6217b13fd57bb28953f188c59f98f2321a4..74897491f7a0b93c60893b828fac0ec82ef5111a 100644 (file)
@@ -8,6 +8,7 @@ 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.StringIdGuiBundle;
 import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.bundles.UiConfigBundle;
 import be.nikiroo.fanfix.library.BasicLibrary;
@@ -16,6 +17,9 @@ 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.Image;
+import be.nikiroo.utils.Proxy;
+import be.nikiroo.utils.TempFiles;
 import be.nikiroo.utils.TraceHandler;
 import be.nikiroo.utils.resources.Bundles;
 
@@ -29,16 +33,55 @@ public class Instance {
        private static UiConfigBundle uiconfig;
        private static StringIdBundle trans;
        private static DataLoader cache;
+       private static StringIdGuiBundle transGui;
        private static BasicLibrary lib;
        private static File coverDir;
        private static File readerTmp;
        private static File remoteDir;
        private static String configDir;
        private static TraceHandler tracer;
+       private static TempFiles tempFiles;
+
+       private static boolean init;
+
+       /**
+        * Initialise the instance -- if already initialised, nothing will happen.
+        * <p>
+        * Before calling this method, you may call
+        * {@link Bundles#setDirectory(String)} if wanted.
+        */
+       static public void init() {
+               init(false);
+       }
+
+       /**
+        * Initialise the instance -- if already initialised, nothing will happen
+        * unless you pass TRUE to <tt>force</tt>.
+        * <p>
+        * Before calling this method, you may call
+        * {@link Bundles#setDirectory(String)} if wanted.
+        * <p>
+        * Note: forcing the initialisation can be dangerous, so make sure to only
+        * make it under controlled circumstances -- for instance, at the start of
+        * the program, you could call {@link Instance#init()}, change some settings
+        * because you want to force those settings (it will also forbid users to
+        * change them!) and then call {@link Instance#init(boolean)} with
+        * <tt>force</tt> set to TRUE.
+        * 
+        * @param force
+        *            force the initialisation even if already initialised
+        */
+       static public void init(boolean force) {
+               if (init && !force) {
+                       return;
+               }
+
+               init = true;
 
-       static {
                // Before we can configure it:
-               tracer = new TraceHandler(true, checkEnv("DEBUG"), checkEnv("DEBUG"));
+               Boolean debug = checkEnv("DEBUG");
+               boolean trace = debug != null && debug;
+               tracer = new TraceHandler(true, trace, trace);
 
                // config dir:
                configDir = getConfigDir();
@@ -49,15 +92,13 @@ public class Instance {
                // 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);
+               // Proxy support
+               Proxy.use(Instance.getConfig().getString(Config.NETWORK_PROXY));
 
-               if (checkEnv("DEBUG")) {
-                       debug = true;
-                       trace = true;
+               // update tracer:
+               if (debug == null) {
+                       debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
+                       trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, false);
                }
 
                tracer = new TraceHandler(true, debug, trace);
@@ -66,17 +107,17 @@ public class Instance {
                remoteDir = new File(configDir, "remote");
                lib = createDefaultLibrary(remoteDir);
 
-               // create cache
-               File tmp = getFile(Config.CACHE_DIR);
-               if (tmp == null) {
-                       // Could have used: System.getProperty("java.io.tmpdir")
-                       tmp = new File(configDir, "tmp");
+               // create cache and TMP
+               File tmp = getFile(Config.CACHE_DIR, new File(configDir, "tmp"));
+               if (!tmp.isAbsolute()) {
+                       tmp = new File(configDir, tmp.getPath());
                }
-               String ua = config.getString(Config.USER_AGENT);
+               Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images"));
+
+               String ua = config.getString(Config.NETWORK_USER_AGENT, "");
                try {
-                       int hours = config.getInteger(Config.CACHE_MAX_TIME_CHANGING, -1);
-                       int hoursLarge = config
-                                       .getInteger(Config.CACHE_MAX_TIME_STABLE, -1);
+                       int hours = config.getInteger(Config.CACHE_MAX_TIME_CHANGING, 0);
+                       int hoursLarge = config.getInteger(Config.CACHE_MAX_TIME_STABLE, 0);
                        cache = new DataLoader(tmp, ua, hours, hoursLarge);
                } catch (IOException e) {
                        tracer.error(new IOException(
@@ -87,17 +128,17 @@ public class Instance {
                cache.setTraceHandler(tracer);
 
                // readerTmp / coverDir
-               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER);
-               if (readerTmp == null) {
-                       readerTmp = new File(configDir, "tmp-reader");
-               }
+               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, 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: "
-                                                       + coverDir));
-                       coverDir = null;
+               coverDir = getFile(Config.DEFAULT_COVERS_DIR, new File(configDir,
+                               "covers"));
+               coverDir.mkdirs();
+
+               try {
+                       tempFiles = new TempFiles("fanfix");
+               } catch (IOException e) {
+                       tracer.error(new IOException("Cannot create temporary directory", e));
                }
        }
 
@@ -192,6 +233,8 @@ public class Instance {
 
        /**
         * Get the (unique) {link StringIdBundle} for the program.
+        * <p>
+        * This is used for the translations of the core parts of Fanfix.
         * 
         * @return the {link StringIdBundle}
         */
@@ -199,6 +242,17 @@ public class Instance {
                return trans;
        }
 
+       /**
+        * Get the (unique) {link StringIdGuiBundle} for the program.
+        * <p>
+        * This is used for the translations of the GUI parts of Fanfix.
+        * 
+        * @return the {link StringIdGuiBundle}
+        */
+       public static StringIdGuiBundle getTransGui() {
+               return transGui;
+       }
+
        /**
         * Get the (unique) {@link LocalLibrary} for the program.
         * 
@@ -271,7 +325,7 @@ public class Instance {
         */
        public static boolean isVersionCheckNeeded() {
                try {
-                       long wait = config.getInteger(Config.UPDATE_INTERVAL, 1) * 24 * 60
+                       long wait = config.getInteger(Config.NETWORK_UPDATE_INTERVAL, 0) * 24 * 60
                                        * 60 * 1000;
                        if (wait >= 0) {
                                String lastUpString = IOUtils.readSmallFile(new File(configDir,
@@ -304,6 +358,17 @@ 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
@@ -331,7 +396,8 @@ public class Instance {
 
        /**
         * Create the config variables ({@link Instance#config},
-        * {@link Instance#uiconfig} and {@link Instance#trans}).
+        * {@link Instance#uiconfig}, {@link Instance#trans} and
+        * {@link Instance#transGui}).
         * 
         * @param configDir
         *            the directory where to find the configuration files
@@ -361,6 +427,7 @@ public class Instance {
                // 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());
+               transGui = new StringIdGuiBundle(getLang());
 
                // Fix an old bug (we used to store custom translation files by
                // default):
@@ -368,8 +435,10 @@ public class Instance {
                        trans.deleteFile(configDir);
                }
 
-               if (checkEnv("NOUTF")) {
+               Boolean noutf = checkEnv("NOUTF");
+               if (noutf != null && noutf) {
                        trans.setUnicode(false);
+                       transGui.setUnicode(false);
                }
 
                Bundles.setDirectory(configDir);
@@ -388,9 +457,9 @@ public class Instance {
 
                String remoteLib = config.getString(Config.DEFAULT_LIBRARY);
                if (remoteLib == null || remoteLib.trim().isEmpty()) {
-                       String libDir = System.getProperty("fanfix.libdir");
+                       String libDir = System.getenv("BOOKS_DIR");
                        if (libDir == null || libDir.isEmpty()) {
-                               libDir = config.getString(Config.LIBRARY_DIR);
+                               libDir = config.getString(Config.LIBRARY_DIR, "$HOME/Books");
                        }
                        try {
                                lib = new LocalLibrary(getFile(libDir));
@@ -400,6 +469,7 @@ public class Instance {
                                                                + getFile(libDir), e));
                        }
                } else {
+                       Exception ex = null;
                        int pos = remoteLib.lastIndexOf(":");
                        if (pos >= 0) {
                                String port = remoteLib.substring(pos + 1).trim();
@@ -418,13 +488,14 @@ public class Instance {
                                                                lib);
 
                                        } catch (Exception e) {
+                                               ex = e;
                                        }
                                }
                        }
 
                        if (lib == null) {
                                tracer.error(new IOException(
-                                               "Cannot create remote library for: " + remoteLib));
+                                               "Cannot create remote library for: " + remoteLib, ex));
                        }
                }
 
@@ -436,8 +507,13 @@ public class Instance {
         * 
         * @return the path
         */
-       private static File getFile(Config id) {
-               return getFile(config.getString(id));
+       private static File getFile(Config id, File def) {
+               String path = config.getString(id);
+               if (path != null && path.isEmpty()) {
+                       path = def.getPath();
+               }
+
+               return getFile(path);
        }
 
        /**
@@ -445,8 +521,13 @@ public class Instance {
         * 
         * @return the path
         */
-       private static File getFile(UiConfig id) {
-               return getFile(uiconfig.getString(id));
+       private static File getFile(UiConfig id, File def) {
+               String path = uiconfig.getString(id);
+               if (path != null && path.isEmpty()) {
+                       path = def.getPath();
+               }
+
+               return getFile(path);
        }
 
        /**
@@ -469,16 +550,28 @@ public class Instance {
        }
 
        /**
-        * Return the home directory from the system properties.
+        * Return the home directory from the environment (FANFIX_DIR) or the system
+        * properties.
+        * <p>
+        * The environment variable is tested first. Then, the custom property
+        * "fanfix.home" is tried, followed by the usual "user.home" then
+        * "java.io.tmp" if nothing else is found.
         * 
         * @return the home
         */
        private static String getHome() {
-               String home = System.getProperty("fanfix.home");
+               String home = System.getenv("FANFIX_DIR");
                if (home != null && new File(home).isFile()) {
                        home = null;
                }
 
+               if (home == null || home.trim().isEmpty()) {
+                       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()) {
@@ -508,8 +601,11 @@ public class Instance {
        private static String getLang() {
                String lang = config.getString(Config.LANG);
 
-               if (System.getenv("LANG") != null && !System.getenv("LANG").isEmpty()) {
-                       lang = System.getenv("LANG");
+               if (lang == null || lang.isEmpty()) {
+                       if (System.getenv("LANG") != null
+                                       && !System.getenv("LANG").isEmpty()) {
+                               lang = System.getenv("LANG");
+                       }
                }
 
                if (lang != null && lang.isEmpty()) {
@@ -527,7 +623,7 @@ public class Instance {
         * 
         * @return TRUE if it is
         */
-       private static boolean checkEnv(String key) {
+       private static Boolean checkEnv(String key) {
                String value = System.getenv(key);
                if (value != null) {
                        value = value.trim().toLowerCase();
@@ -536,8 +632,10 @@ public class Instance {
                                        || "y".equals(value)) {
                                return true;
                        }
+
+                       return false;
                }
 
-               return false;
+               return null;
        }
 }