X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FInstance.java;h=e0a072714a08a35b87f4342a0b4046c0abe0894c;hp=a06c975420419c00d2998214438e3356101ab397;hb=d11fb35b34e44744c8b1f9226321f133af4eb151;hpb=99ccbdf63b539f1f40e070f5833f2d15fcf79830 diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java index a06c975..e0a0727 100644 --- a/src/be/nikiroo/fanfix/Instance.java +++ b/src/be/nikiroo/fanfix/Instance.java @@ -8,12 +8,20 @@ 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; +import be.nikiroo.fanfix.library.CacheLibrary; import be.nikiroo.fanfix.library.LocalLibrary; -import be.nikiroo.fanfix.output.BasicOutput.OutputType; +import be.nikiroo.fanfix.library.RemoteLibrary; +import be.nikiroo.fanfix.library.WebLibrary; +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; /** @@ -22,155 +30,181 @@ import be.nikiroo.utils.resources.Bundles; * @author niki */ public class Instance { + 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; + /** - * A handler when a recoverable exception was caught by the program. - * - * @author niki + * Initialise the instance -- if already initialised, nothing will happen. + *

+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + *

+ * Note that this method will honour some environment variables, the 3 most + * important ones probably being: + *

*/ - public interface SyserrHandler { - /** - * An exception happened, log it. - * - * @param e - * the exception - * @param showDetails - * show more details (usually equivalent to the value of - * DEBUG) - */ - public void notify(Exception e, boolean showDetails); + static public void init() { + init(false); } /** - * A handler when a trace message is sent. + * 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. * - * @author niki + * @param force + * force the initialisation even if already initialised */ - public interface TraceHandler { - /** - * A trace happened, show it. - *

- * Will only be called if TRACE is true. - * - * @param message - * the trace message - */ - public void trace(String message); - } - - private static ConfigBundle config; - private static UiConfigBundle uiconfig; - private static StringIdBundle trans; - private static DataLoader cache; - private static LocalLibrary lib; - private static boolean debug; - private static boolean trace; - private static File coverDir; - private static File readerTmp; - private static File remoteDir; - private static String configDir; - - private static SyserrHandler syserrHandler; - - private static TraceHandler traceHandler; + static public void init(boolean force) { + synchronized (instancelock) { + if (instance == null || force) { + instance = new Instance(); + } + } - static { - // Most of the rest is dependent upon this: - config = new ConfigBundle(); + } - configDir = System.getProperty("CONFIG_DIR"); - if (configDir == null) { - configDir = System.getenv("CONFIG_DIR"); - } + /** + * 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; + } - if (configDir == null) { - configDir = new File(System.getProperty("user.home"), ".fanfix") - .getPath(); - } + /** + * 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: + 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) { - syserr(e); - } - try { - uiconfig = new UiConfigBundle(); - uiconfig.updateFile(configDir); - } catch (IOException e) { - syserr(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(config.getString(Config.NETWORK_PROXY)); - // 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); + // update tracer: + if (debug == null) { + debug = config.getBoolean(Config.DEBUG_ERR, false); + trace = config.getBoolean(Config.DEBUG_TRACE, false); } - Bundles.setDirectory(configDir); + tracer = new TraceHandler(true, debug, trace); - uiconfig = new UiConfigBundle(); - trans = new StringIdBundle(getLang()); - try { - lib = new LocalLibrary(getFile(Config.LIBRARY_DIR), - OutputType.INFO_TEXT, OutputType.CBZ); - } catch (Exception e) { - syserr(new IOException("Cannot create library for directory: " - + getFile(Config.LIBRARY_DIR), e)); - } + // default Library + remoteDir = new File(configDir, "remote"); + lib = createDefaultLibrary(remoteDir); - debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false); - 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(getFile(Config.LIBRARY_DIR), "remote"); + // create cache and TMP + File tmp = getFile(Config.CACHE_DIR, configDir, "tmp"); + Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images")); - if (checkEnv("NOUTF")) { - trans.setUnicode(false); + String ua = config.getString(Config.NETWORK_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); } - if (checkEnv("DEBUG")) { - debug = true; - } + cache.setTraceHandler(tracer); - // 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"); - } - // + // readerTmp / coverDir + readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, configDir, + "tmp-reader"); + coverDir = getFile(Config.DEFAULT_COVERS_DIR, configDir, "covers"); + coverDir.mkdirs(); - if (coverDir != null && !coverDir.exists()) { - syserr(new IOException( - "The 'default covers' directory does not exists: " - + coverDir)); - coverDir = null; + try { + tempFiles = new TempFiles("fanfix"); + } catch (IOException e) { + tracer.error( + new IOException("Cannot create temporary directory", e)); } + } - 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); + /** + * The traces handler for this {@link Cache}. + *

+ * It is never NULL. + * + * @return the traces handler (never NULL) + */ + public TraceHandler getTraceHandler() { + return tracer; + } - cache = new DataLoader(tmp, ua, hours, hoursLarge); - } catch (IOException e) { - syserr(new IOException( - "Cannot create cache (will continue without cache)", e)); + /** + * The traces handler for this {@link Cache}. + * + * @param tracer + * the new traces handler or NULL + */ + public void setTraceHandler(TraceHandler tracer) { + if (tracer == null) { + tracer = new TraceHandler(false, false, false); } + + this.tracer = tracer; + cache.setTraceHandler(tracer); } /** @@ -178,7 +212,7 @@ public class Instance { * * @return the configuration service */ - public static ConfigBundle getConfig() { + public ConfigBundle getConfig() { return config; } @@ -187,43 +221,108 @@ 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 + */ + public 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. * * @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 LocalLibrary} for the program. + * 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 BasicLibrary} for the program. * - * @return the {@link LocalLibrary} + * @return the {@link BasicLibrary} */ - public static BasicLibrary getLibrary() { + public BasicLibrary getLibrary() { + if (lib == null) { + throw new NullPointerException("We don't have a library to return"); + } + return lib; } + /** + * Change the default {@link BasicLibrary} for this program. + *

+ * Be careful. + * + * @param lib + * the new {@link BasicLibrary} + */ + public void setLibrary(BasicLibrary lib) { + this.lib = lib; + } + /** * Return the directory where to look for default cover pages. * * @return the default covers directory */ - public static File getCoverDir() { + public File getCoverDir() { return coverDir; } @@ -232,7 +331,7 @@ public class Instance { * * @return the directory */ - public static File getReaderDir() { + public File getReaderDir() { return readerTmp; } @@ -245,10 +344,30 @@ public class Instance { * * @return the directory */ - public static File getRemoteDir(String host) { + public 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 File getRemoteDir(File remoteDir, String host) { remoteDir.mkdirs(); if (host != null) { + host = host.replace("fanfix://", ""); + host = host.replace("http://", ""); + host = host.replace("https://", ""); + host = host.replaceAll("[^a-zA-Z0-9=+.-]", "_"); + return new File(remoteDir, host); } @@ -260,13 +379,13 @@ 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")); + String lastUpString = IOUtils + .readSmallFile(new File(configDir, "LAST_UPDATE")); long delay = new Date().getTime() - Long.parseLong(lastUpString); if (delay > wait) { @@ -286,99 +405,205 @@ 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())); } catch (IOException e) { - syserr(e); + tracer.error(e); } } /** - * Replace the global syserr handler. + * The facility to use temporary files in this program. + *

+ * MUST be closed at end of program. * - * @param syserrHandler - * the new syserr handler + * @return the facility */ - public static void setSyserrHandler(SyserrHandler syserrHandler) { - Instance.syserrHandler = syserrHandler; + public TempFiles getTempFiles() { + return tempFiles; } /** - * Replace the global trace handler. + * The configuration directory (will check, in order of preference, the + * system properties, the environment and then defaults to + * {@link Instance#getHome()}/.fanfix). * - * @param traceHandler - * the new trace handler + * @return the config directory */ - public static void setTraceHandler(TraceHandler traceHandler) { - Instance.traceHandler = traceHandler; + private String getConfigDir() { + String configDir = System.getProperty("CONFIG_DIR"); + + if (configDir == null) { + configDir = System.getenv("CONFIG_DIR"); + } + + if (configDir == null) { + configDir = new File(getHome(), ".fanfix").getPath(); + } + + return configDir; } /** - * Report an error to the user + * Create the config variables ({@link Instance#config}, + * {@link Instance#uiconfig}, {@link Instance#trans} and + * {@link Instance#transGui}). * - * @param e - * the {@link Exception} to report + * @param configDir + * the directory where to find the configuration files + * @param refresh + * TRUE to reset the configuration files from the default + * included ones */ - public static void syserr(Exception e) { - if (syserrHandler != null) { - syserrHandler.notify(e, debug); - } else { - if (debug) { - e.printStackTrace(); - } else { - System.err.println(e.getMessage()); - } + private 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); } /** - * Notify of a debug message. + * Create the default library as specified by the config. * - * @param message - * the message + * @param remoteDir + * the base remote directory if needed + * + * @return the default {@link BasicLibrary} */ - public static void trace(String message) { - if (trace) { - if (traceHandler != null) { - traceHandler.trace(message); - } else { - System.out.println(message); + private BasicLibrary createDefaultLibrary(File remoteDir) { + BasicLibrary lib = null; + + boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED, + false); + if (useRemote) { + String host = null; + int port = -1; + try { + host = config.getString(Config.REMOTE_LIBRARY_HOST, + "fanfix://localhost"); + port = config.getInteger(Config.REMOTE_LIBRARY_PORT, -1); + String key = config.getString(Config.REMOTE_LIBRARY_KEY); + + if (!host.startsWith("http://") && !host.startsWith("https://") + && !host.startsWith("fanfix://")) { + host = "fanfix://" + host; + } + + tracer.trace("Selecting remote library " + host + ":" + port); + + if (host.startsWith("fanfix://")) { + lib = new RemoteLibrary(key, host, port); + } else { + lib = new WebLibrary(key, host, port); + } + + lib = new CacheLibrary(getRemoteDir(remoteDir, host), lib, + uiconfig); + } catch (Exception e) { + tracer.error( + new IOException("Cannot create remote library for: " + + host + ":" + port, e)); + } + } else { + String libDir = System.getenv("BOOKS_DIR"); + if (libDir == null || libDir.isEmpty()) { + libDir = getFile(Config.LIBRARY_DIR, configDir, "$HOME/Books") + .getPath(); + } + try { + lib = new LocalLibrary(new File(libDir), config); + } catch (Exception e) { + tracer.error(new IOException( + "Cannot create library for directory: " + libDir, e)); } } + + return lib; } /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param id + * the key for the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @param def + * the default value if none (will be configDir-rooted if needed) + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(Config id) { - return getFile(config.getString(id)); + protected File getFile(Config id, String configDir, String def) { + String path = config.getString(id, def); + return getFile(path, configDir); } /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param id + * the key for the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @param def + * the default value if none (will be configDir-rooted if needed) + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(UiConfig id) { - return getFile(uiconfig.getString(id)); + protected File getFile(UiConfig id, String configDir, String def) { + String path = uiconfig.getString(id, def); + return getFile(path, configDir); } /** * Return a path, but support the special $HOME variable. * - * @return the path + * @param path + * the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @return the path, with expanded "$HOME" if needed */ - private static File getFile(String path) { + protected File getFile(String path, String configDir) { File file = null; 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()); + } else if (!path.startsWith("/")) { + path = new File(configDir, path).getPath(); } file = new File(path); @@ -387,16 +612,63 @@ public class Instance { return file; } + /** + * 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 + */ + 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()) { + 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). * * @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()) { @@ -414,7 +686,7 @@ public class Instance { * * @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(); @@ -423,8 +695,10 @@ public class Instance { || "y".equals(value)) { return true; } + + return false; } - return false; + return null; } }