X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FInstance.java;h=f48d05b7d4cd84994eeb7e5e238018e99317afbd;hp=97e9868b8858ad2475b96cb7f51df3ae50d04683;hb=d66deb8d8b30cff6b54db352eef34a3508939f84;hpb=778d8d85f288c7b67c1a5156e5aedfc944997be0

diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java
index 97e9868..f48d05b 100644
--- a/src/be/nikiroo/fanfix/Instance.java
+++ b/src/be/nikiroo/fanfix/Instance.java
@@ -8,12 +8,18 @@ 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.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;
 
@@ -23,140 +29,167 @@ 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 LocalLibrary lib;
-	private static File coverDir;
-	private static File readerTmp;
-	private static File remoteDir;
-	private static String configDir;
-	private static TraceHandler tracer;
-
-	static {
-		// Most of the rest is dependent upon this:
-		config = new ConfigBundle();
+	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;
 
-		configDir = System.getProperty("CONFIG_DIR");
-		if (configDir == null) {
-			configDir = System.getenv("CONFIG_DIR");
-		}
+	/**
+	 * 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);
+	}
 
-		if (configDir == null) {
-			configDir = new File(System.getProperty("user.home"), ".fanfix")
-					.getPath();
+	/**
+	 * 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) {
+		synchronized (instancelock) {
+			if (instance == null || force) {
+				instance = new Instance();
+			}
 		}
 
+	}
+
+	/**
+	 * 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;
+		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);
-
-		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);
-		}
-
-		if (checkEnv("DEBUG")) {
-			debug = true;
+		// create cache and TMP
+		File tmp = getFile(Config.CACHE_DIR, new File(configDir, "tmp"));
+		if (!tmp.isAbsolute()) {
+			tmp = new File(configDir, tmp.getPath());
 		}
+		Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images"));
 
-		tracer = new TraceHandler();
-		tracer.setShowErrorDetails(debug);
-		tracer.setShowTraces(trace);
-
+		String ua = config.getString(Config.NETWORK_USER_AGENT, "");
 		try {
-			lib = new LocalLibrary(getFile(Config.LIBRARY_DIR));
-		} catch (Exception e) {
-			syserr(new IOException("Cannot create library for directory: "
-					+ getFile(Config.LIBRARY_DIR), e));
+			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);
 		}
 
-		// 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");
-		}
-		//
+		cache.setTraceHandler(tracer);
 
-		if (coverDir != null && !coverDir.exists()) {
-			syserr(new IOException(
-					"The 'default covers' directory does not exists: "
-							+ coverDir));
-			coverDir = null;
-		}
+		// readerTmp / coverDir
+		readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, new File(configDir, "tmp-reader"));
 
-		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);
+		coverDir = getFile(Config.DEFAULT_COVERS_DIR, new File(configDir, "covers"));
+		coverDir.mkdirs();
 
-			cache = new DataLoader(tmp, ua, hours, hoursLarge);
+		try {
+			tempFiles = new TempFiles("fanfix");
 		} catch (IOException e) {
-			syserr(new IOException(
-					"Cannot create cache (will continue without cache)", e));
+			tracer.error(new IOException("Cannot create temporary directory", e));
 		}
 	}
 
 	/**
 	 * The traces handler for this {@link Cache}.
+	 * <p>
+	 * It is never NULL.
 	 * 
-	 * @return the traces handler or NULL
+	 * @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) {
-		Instance.tracer = tracer;
+	public void setTraceHandler(TraceHandler tracer) {
+		if (tracer == null) {
+			tracer = new TraceHandler(false, false, false);
+		}
+
+		this.tracer = tracer;
+		cache.setTraceHandler(tracer);
 	}
 
 	/**
@@ -164,7 +197,7 @@ public class Instance {
 	 * 
 	 * @return the configuration service
 	 */
-	public static ConfigBundle getConfig() {
+	public ConfigBundle getConfig() {
 		return config;
 	}
 
@@ -173,34 +206,82 @@ 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.
+	 * <p>
+	 * 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.
+	 * <p>
+	 * 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");
 		}
@@ -213,7 +294,7 @@ public class Instance {
 	 * 
 	 * @return the default covers directory
 	 */
-	public static File getCoverDir() {
+	public File getCoverDir() {
 		return coverDir;
 	}
 
@@ -222,7 +303,7 @@ public class Instance {
 	 * 
 	 * @return the directory
 	 */
-	public static File getReaderDir() {
+	public File getReaderDir() {
 		return readerTmp;
 	}
 
@@ -230,12 +311,24 @@ 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);
+	}
+
+	/**
+	 * 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) {
@@ -250,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;
 				}
@@ -276,69 +366,174 @@ 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) {
-			syserr(e);
+			tracer.error(e);
 		}
 	}
 
 	/**
-	 * Report an error to the user
+	 * The facility to use temporary files in this program.
+	 * <p>
+	 * <b>MUST</b> be closed at end of program.
 	 * 
-	 * @param e
-	 *            the {@link Exception} to report
+	 * @return the facility
 	 */
-	public static void syserr(Exception e) {
-		if (tracer != null) {
+	public TempFiles getTempFiles() {
+		return tempFiles;
+	}
+
+	/**
+	 * 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");
+		}
+
+		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 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 remoteDir the base remote directory if needed
 	 * 
-	 * @param message
-	 *            the message
+	 * @return the default {@link BasicLibrary}
 	 */
-	public static void trace(String message) {
-		if (tracer != null) {
-			tracer.trace(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);
+				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 remote library for: " + host + ":" + port, e));
+			}
+		} else {
+			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();
+				}
+			}
+			try {
+				lib = new LocalLibrary(getFile(libDir), config);
+			} catch (Exception e) {
+				tracer.error(new IOException("Cannot create library for directory: " + getFile(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 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);
 			if (path.contains("$HOME")) {
-				path = path.replace("$HOME",
-						"" + System.getProperty("user.home"));
+				path = path.replace("$HOME", getHome());
 			}
 
 			file = new File(path);
@@ -347,16 +542,62 @@ public class Instance {
 		return file;
 	}
 
+	/**
+	 * 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
+	 */
+	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()) {
@@ -369,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;
 	}
 }