X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;ds=inline;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FInstance.java;h=f48d05b7d4cd84994eeb7e5e238018e99317afbd;hb=5a90a6ca7261f4c17407131fef58d5bcc793e2ce;hp=c265861aefb3f2b8c3e7e324c216ded7cad1682d;hpb=9f705f1afe91f215836e405c2a09cbbf926298cd;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java index c265861..f48d05b 100644 --- a/src/be/nikiroo/fanfix/Instance.java +++ b/src/be/nikiroo/fanfix/Instance.java @@ -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; @@ -25,20 +29,87 @@ import be.nikiroo.utils.resources.Bundles; * @author niki */ public class Instance { - private static ConfigBundle config; - private static UiConfigBundle uiconfig; - private static StringIdBundle trans; - 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 { + static private Instance instance; + static private Object instancelock = new Object(); + + private ConfigBundle config; + private UiConfigBundle uiconfig; + private StringIdBundle trans; + private DataLoader cache; + private StringIdGuiBundle transGui; + private BasicLibrary lib; + private File coverDir; + private File readerTmp; + private File remoteDir; + private String configDir; + private TraceHandler tracer; + private TempFiles tempFiles; + + /** + * Initialise the instance -- if already initialised, nothing will happen. + *
+ * 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 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) { + synchronized (instancelock) { + if (instance == null || force) { + instance = new Instance(); + } + } + + } + + /** + * Force-initialise the {@link Instance} to a known value. + *
+ * Usually for DEBUG/Test purposes. + * + * @param instance the actual Instance to use + */ + static public void init(Instance instance) { + Instance.instance = instance; + } + + /** + * The (mostly unique) instance of this {@link Instance}. + * + * @return the (mostly unique) instance + */ + public static Instance getInstance() { + return instance; + } + + /** + * Actually initialise the instance. + *
+ * Before calling this method, you may call {@link Bundles#setDirectory(String)} + * if wanted. + */ + protected Instance() { // 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(); @@ -47,17 +118,15 @@ public class Instance { } // Most of the rest is dependent upon this: - createConfigs(configDir, true); + createConfigs(configDir, false); + + // Proxy support + Proxy.use(config.getString(Config.NETWORK_PROXY)); // update tracer: - boolean debug = Instance.getConfig() - .getBoolean(Config.DEBUG_ERR, false); - boolean trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, - false); - - if (checkEnv("DEBUG")) { - debug = true; - trace = true; + if (debug == null) { + debug = config.getBoolean(Config.DEBUG_ERR, false); + trace = config.getBoolean(Config.DEBUG_TRACE, false); } tracer = new TraceHandler(true, debug, trace); @@ -66,38 +135,35 @@ 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( - "Cannot create cache (will continue without cache)", 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"); - } + 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)); } } @@ -108,22 +174,21 @@ public class Instance { * * @return the traces handler (never NULL) */ - public static TraceHandler getTraceHandler() { + public TraceHandler getTraceHandler() { return tracer; } /** * The traces handler for this {@link Cache}. * - * @param tracer - * the new traces handler or NULL + * @param tracer the new traces handler or NULL */ - public static void setTraceHandler(TraceHandler tracer) { + public void setTraceHandler(TraceHandler tracer) { if (tracer == null) { tracer = new TraceHandler(false, false, false); } - Instance.tracer = tracer; + this.tracer = tracer; cache.setTraceHandler(tracer); } @@ -132,7 +197,7 @@ public class Instance { * * @return the configuration service */ - public static ConfigBundle getConfig() { + public ConfigBundle getConfig() { return config; } @@ -141,17 +206,16 @@ public class Instance { * * @return the configuration service */ - public static UiConfigBundle getUiConfig() { + public UiConfigBundle getUiConfig() { return uiconfig; } /** * Reset the configuration. * - * @param resetTrans - * also reset the translation files + * @param resetTrans also reset the translation files */ - public static void resetConfig(boolean resetTrans) { + public void resetConfig(boolean resetTrans) { String dir = Bundles.getDirectory(); Bundles.setDirectory(null); try { @@ -186,25 +250,38 @@ public class Instance { * * @return the {@link DataLoader} */ - public static DataLoader getCache() { + public DataLoader getCache() { return cache; } /** * Get the (unique) {link StringIdBundle} for the program. + *
+ * This is used for the translations of the core parts of Fanfix. * * @return the {link StringIdBundle} */ - public static StringIdBundle getTrans() { + public StringIdBundle getTrans() { 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 StringIdGuiBundle getTransGui() { + return transGui; + } + /** * Get the (unique) {@link LocalLibrary} for the program. * * @return the {@link LocalLibrary} */ - public static BasicLibrary getLibrary() { + public BasicLibrary getLibrary() { if (lib == null) { throw new NullPointerException("We don't have a library to return"); } @@ -217,7 +294,7 @@ public class Instance { * * @return the default covers directory */ - public static File getCoverDir() { + public File getCoverDir() { return coverDir; } @@ -226,7 +303,7 @@ public class Instance { * * @return the directory */ - public static File getReaderDir() { + public File getReaderDir() { return readerTmp; } @@ -234,12 +311,11 @@ public class Instance { * Return the directory where to store temporary files for the remote * {@link LocalLibrary}. * - * @param host - * the remote for this host + * @param host the remote for this host * * @return the directory */ - public static File getRemoteDir(String host) { + public File getRemoteDir(String host) { return getRemoteDir(remoteDir, host); } @@ -247,14 +323,12 @@ public class Instance { * 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 + * @param remoteDir the base remote directory + * @param host the remote for this host * * @return the directory */ - private static File getRemoteDir(File remoteDir, String host) { + private File getRemoteDir(File remoteDir, String host) { remoteDir.mkdirs(); if (host != null) { @@ -269,15 +343,12 @@ public class Instance { * * @return TRUE if we need to */ - public static boolean isVersionCheckNeeded() { + public boolean isVersionCheckNeeded() { try { - long wait = config.getInteger(Config.UPDATE_INTERVAL, 1) * 24 * 60 - * 60 * 1000; + long wait = config.getInteger(Config.NETWORK_UPDATE_INTERVAL, 0) * 24 * 60 * 60 * 1000; if (wait >= 0) { - String lastUpString = IOUtils.readSmallFile(new File(configDir, - "LAST_UPDATE")); - long delay = new Date().getTime() - - Long.parseLong(lastUpString); + String lastUpString = IOUtils.readSmallFile(new File(configDir, "LAST_UPDATE")); + long delay = new Date().getTime() - Long.parseLong(lastUpString); if (delay > wait) { return true; } @@ -295,28 +366,34 @@ public class Instance { /** * Notify that we checked for a new version of Fanfix. */ - public static void setVersionChecked() { + public void setVersionChecked() { try { - IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE", - Long.toString(new Date().getTime())); + IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE", Long.toString(new Date().getTime())); } catch (IOException e) { tracer.error(e); } } /** - * The configuration directory (will check, in order of preference, - * {@link Bundles#getDirectory()}, the system properties, the environment - * and then defaults to $HOME/.fanfix). + * The facility to use temporary files in this program. + *
+ * MUST be closed at end of program. * - * @return the config directory + * @return the facility */ - private static String getConfigDir() { - String configDir = Bundles.getDirectory(); + public TempFiles getTempFiles() { + return tempFiles; + } - if (configDir == null) { - configDir = System.getProperty("CONFIG_DIR"); - } + /** + * The configuration directory (will check, in order of preference, the system + * properties, the environment and then defaults to + * {@link Instance#getHome()}/.fanfix). + * + * @return the config directory + */ + private String getConfigDir() { + String configDir = System.getProperty("CONFIG_DIR"); if (configDir == null) { configDir = System.getenv("CONFIG_DIR"); @@ -331,15 +408,14 @@ 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 - * @param refresh - * TRUE to refresh the configuration files from the default - * included ones + * @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) { + private void createConfigs(String configDir, boolean refresh) { if (!refresh) { Bundles.setDirectory(configDir); } @@ -361,6 +437,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 +445,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); @@ -378,53 +457,41 @@ public class Instance { /** * Create the default library as specified by the config. * - * @param remoteDir - * the base remote directory if needed + * @param remoteDir the base remote directory if needed * * @return the default {@link BasicLibrary} */ - private static BasicLibrary createDefaultLibrary(File remoteDir) { + private 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()) { - config.getString(Config.LIBRARY_DIR); - } + boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED, false); + + if (useRemote) { + String host = null; + int port = -1; try { - lib = new LocalLibrary(getFile(libDir)); + host = config.getString(Config.REMOTE_LIBRARY_HOST); + port = config.getInteger(Config.REMOTE_LIBRARY_PORT, -1); + String key = config.getString(Config.REMOTE_LIBRARY_KEY); + + tracer.trace("Selecting remote library " + host + ":" + port); + lib = new RemoteLibrary(key, host, port); + lib = new CacheLibrary(getRemoteDir(remoteDir, host), lib, uiconfig); } catch (Exception e) { - tracer.error(new IOException( - "Cannot create library for directory: " - + getFile(libDir), e)); + tracer.error(new IOException("Cannot create remote library for: " + host + ":" + port, 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) { - } + String libDir = System.getenv("BOOKS_DIR"); + if (libDir == null || libDir.isEmpty()) { + libDir = config.getString(Config.LIBRARY_DIR, "$HOME/Books"); + if (!getFile(libDir).isAbsolute()) { + libDir = new File(configDir, libDir).getPath(); } } - - if (lib == null) { - tracer.error(new IOException( - "Cannot create remote library for: " + remoteLib)); + try { + lib = new LocalLibrary(getFile(libDir), config); + } catch (Exception e) { + tracer.error(new IOException("Cannot create library for directory: " + getFile(libDir), e)); } } @@ -434,27 +501,34 @@ public class Instance { /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param id the key for the path, which may contain "$HOME" + * @param def the default value if none + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(Config id) { - return getFile(config.getString(id)); + protected File getFile(Config id, File def) { + String path = config.getString(id, def.getPath()); + return getFile(path); } /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param id the key for the path, which may contain "$HOME" + * @param def the default value if none + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(UiConfig id) { - return getFile(uiconfig.getString(id)); + protected File getFile(UiConfig id, File def) { + String path = uiconfig.getString(id, def.getPath()); + return getFile(path); } /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param path the path, which may contain "$HOME" + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(String path) { + protected File getFile(String path) { File file = null; if (path != null && !path.isEmpty()) { path = path.replace('/', File.separatorChar); @@ -469,16 +543,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. + *
+ * 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"); + protected String getHome() { + 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()) { @@ -505,11 +591,13 @@ public class Instance { * * @return the language */ - private static String getLang() { + protected 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()) { @@ -522,22 +610,22 @@ public class Instance { /** * Check that the given environment variable is "enabled". * - * @param key - * the variable to check + * @param key the variable to check * * @return TRUE if it is */ - private static boolean checkEnv(String key) { + protected 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) + if ("yes".equals(value) || "true".equals(value) || "on".equals(value) || "1".equals(value) || "y".equals(value)) { return true; } + + return false; } - return false; + return null; } }