* @author niki
*/
public class Instance {
- private static ConfigBundle config;
- 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;
+ 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.
* <p>
* Before calling this method, you may call
* {@link Bundles#setDirectory(String)} if wanted.
+ * <p>
+ * Note that this method will honour some environment variables, the 3 most
+ * important ones probably being:
+ * <ul>
+ * <li><tt>DEBUG</tt>: will enable DEBUG output if set to 1 (or Y or TRUE or
+ * ON, case insensitive)</li>
+ * <li><tt>CONFIG_DIR</tt>: will use this directory as configuration
+ * directory (supports $HOME notation, defaults to $HOME/.fanfix</li>
+ * <li><tt>BOOKS_DIR</tt>: will use this directory as library directory
+ * (supports $HOME notation, defaults to $HOME/Books</li>
+ * </ul>
*/
static public void init() {
init(false);
}
/**
- * Initialise the instance -- if already initialised, nothing will happen
- * unless you pass TRUE to <tt>force</tt>.
+ * 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.
+ * 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.
+ * 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
+ * @param force force the initialisation even if already initialised
*/
static public void init(boolean force) {
- if (init && !force) {
- return;
+ synchronized (instancelock) {
+ if (instance == null || force) {
+ instance = new Instance();
+ }
}
- init = true;
+ }
+ /**
+ * Force-initialise the {@link Instance} to a known value.
+ * <p>
+ * 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.
+ * <p>
+ * 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;
createConfigs(configDir, false);
// Proxy support
- Proxy.use(Instance.getConfig().getString(Config.USE_PROXY));
+ Proxy.use(config.getString(Config.NETWORK_PROXY));
// update tracer:
if (debug == null) {
- debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
- trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, false);
+ debug = config.getBoolean(Config.DEBUG_ERR, false);
+ trace = config.getBoolean(Config.DEBUG_TRACE, false);
}
tracer = new TraceHandler(true, debug, trace);
lib = createDefaultLibrary(remoteDir);
// 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");
+ 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");
*
* @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);
}
*
* @return the configuration service
*/
- public static ConfigBundle getConfig() {
+ public ConfigBundle getConfig() {
return config;
}
*
* @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 {
*
* @return the {@link DataLoader}
*/
- public static DataLoader getCache() {
+ public DataLoader getCache() {
return cache;
}
*
* @return the {link StringIdBundle}
*/
- public static StringIdBundle getTrans() {
+ public StringIdBundle getTrans() {
return trans;
}
*
* @return the {link StringIdGuiBundle}
*/
- public static StringIdGuiBundle getTransGui() {
+ public StringIdGuiBundle getTransGui() {
return transGui;
}
*
* @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");
}
*
* @return the default covers directory
*/
- public static File getCoverDir() {
+ public File getCoverDir() {
return coverDir;
}
*
* @return the directory
*/
- public static File getReaderDir() {
+ public File getReaderDir() {
return readerTmp;
}
* 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);
}
* 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) {
*
* @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;
}
/**
* 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);
}
*
* @return the facility
*/
- public static TempFiles getTempFiles() {
+ public 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).
+ * 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 static String getConfigDir() {
- String configDir = Bundles.getDirectory();
-
- if (configDir == null) {
- configDir = System.getProperty("CONFIG_DIR");
- }
+ private String getConfigDir() {
+ String configDir = System.getProperty("CONFIG_DIR");
if (configDir == null) {
configDir = System.getenv("CONFIG_DIR");
* {@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
+ * @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);
}
/**
* 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()) {
- libDir = 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 {
- 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;
- }
+ 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, ex));
+ try {
+ lib = new LocalLibrary(getFile(libDir), config);
+ } catch (Exception e) {
+ tracer.error(new IOException("Cannot create library for directory: " + getFile(libDir), e));
}
}
/**
* 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);
}
/**
- * 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");
+ 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()) {
*
* @return the language
*/
- private static String getLang() {
+ protected String getLang() {
String lang = config.getString(Config.LANG);
if (lang == null || lang.isEmpty()) {
- if (System.getenv("LANG") != null
- && !System.getenv("LANG").isEmpty()) {
+ if (System.getenv("LANG") != null && !System.getenv("LANG").isEmpty()) {
lang = System.getenv("LANG");
}
}
/**
* 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;
}