+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + */ + static public void init() { + init(false); + } - configDir = System.getProperty("CONFIG_DIR"); - if (configDir == null) { - configDir = System.getenv("CONFIG_DIR"); + /** + * Initialise the instance -- if already initialised, nothing will happen + * unless you pass TRUE to force. + *
+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + *
+ * 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 + * force set to TRUE. + * + * @param force + * force the initialisation even if already initialised + */ + static public void init(boolean force) { + if (init && !force) { + return; } - if (configDir == null) { - configDir = new File(getHome(), ".fanfix").getPath(); - } + init = true; + + // Before we can configure it: + Boolean debug = checkEnv("DEBUG"); + boolean trace = debug != null && debug; + tracer = new TraceHandler(true, trace, trace); + // 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); - } + // Most of the rest is dependent upon this: + createConfigs(configDir, false); - // 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()); + // Proxy support + Proxy.use(Instance.getConfig().getString(Config.USE_PROXY)); - // Fix an old bug (we used to store custom translation files by - // default): - if (trans.getString(StringId.INPUT_DESC_CBZ) == null) { - trans.deleteFile(configDir); + // update tracer: + if (debug == null) { + debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false); + trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, false); } - Bundles.setDirectory(configDir); - - uiconfig = new UiConfigBundle(); - trans = new StringIdBundle(getLang()); + tracer = new TraceHandler(true, debug, trace); - 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); + // default Library remoteDir = new File(configDir, "remote"); + lib = createDefaultLibrary(remoteDir); - if (checkEnv("NOUTF")) { - trans.setUnicode(false); + // create cache and TMP + Image.setTemporaryFilesRoot(new File(configDir, "tmp.images")); + File tmp = getFile(Config.CACHE_DIR); + if (tmp == null) { + // Could have used: System.getProperty("java.io.tmpdir") + tmp = new File(configDir, "tmp"); } - - if (checkEnv("DEBUG")) { - debug = true; - trace = true; + String ua = config.getString(Config.USER_AGENT, ""); + try { + 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( + "Cannot create cache (will continue without cache)", e)); + cache = new DataLoader(ua); } - 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) { - } - } - } - - if (lib == null) { - tracer.error(new IOException( - "Cannot create remote library for: " + remoteLib)); - } - } + cache.setTraceHandler(tracer); - // Could have used: System.getProperty("java.io.tmpdir") - if (tmp == null) { - tmp = new File(configDir, "tmp"); - } + // 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,19 +141,11 @@ public class Instance { coverDir = null; } - 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); + tempFiles = new TempFiles("fanfix"); } catch (IOException e) { - tracer.error(new IOException( - "Cannot create cache (will continue without cache)", e)); - cache = new DataLoader(ua); + tracer.error(new IOException("Cannot create temporary directory", e)); } - - cache.setTraceHandler(tracer); } /** @@ -265,6 +239,8 @@ public class Instance { /** * Get the (unique) {link StringIdBundle} for the program. + *
+ * This is used for the translations of the core parts of Fanfix. * * @return the {link StringIdBundle} */ @@ -272,6 +248,17 @@ public class Instance { return trans; } + /** + * Get the (unique) {link StringIdGuiBundle} for the program. + *
+ * 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. * @@ -313,6 +300,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) { @@ -329,7 +331,7 @@ public class Instance { */ public static boolean isVersionCheckNeeded() { try { - long wait = config.getInteger(Config.UPDATE_INTERVAL, 1) * 24 * 60 + long wait = config.getInteger(Config.UPDATE_INTERVAL, 0) * 24 * 60 * 60 * 1000; if (wait >= 0) { String lastUpString = IOUtils.readSmallFile(new File(configDir, @@ -362,6 +364,150 @@ public class Instance { } } + /** + * The facility to use temporary files in this program. + *
+ * MUST 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}, {@link Instance#trans} and + * {@link Instance#transGui}). + * + * @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()); + transGui = new StringIdGuiBundle(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); + } + + Boolean noutf = checkEnv("NOUTF"); + if (noutf != null && noutf) { + trans.setUnicode(false); + transGui.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 { + Exception ex = null; + 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) { + ex = e; + } + } + } + + if (lib == null) { + tracer.error(new IOException( + "Cannot create remote library for: " + remoteLib, ex)); + } + } + + return lib; + } + /** * Return a path, but support the special $HOME variable. * @@ -405,9 +551,23 @@ public class Instance { * @return the home */ private static String getHome() { - String home = System.getProperty("user.home"); + 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) { @@ -425,8 +585,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()) { @@ -444,7 +607,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(); @@ -453,8 +616,10 @@ public class Instance { || "y".equals(value)) { return true; } + + return false; } - return false; + return null; } }