X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FInstance.java;h=74897491f7a0b93c60893b828fac0ec82ef5111a;hb=7d4c3830e2128253dbb0212d1afb737aa28e033b;hp=1266ac7e437f700564165dadec15521383f4083b;hpb=b42117f163c9c0dd96424d43730fb95fb088b4be;p=nikiroo-utils.git

diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java
index 1266ac7..7489749 100644
--- a/src/be/nikiroo/fanfix/Instance.java
+++ b/src/be/nikiroo/fanfix/Instance.java
@@ -6,11 +6,21 @@ import java.util.Date;
 
 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.output.BasicOutput.OutputType;
+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;
 
 /**
@@ -22,106 +32,142 @@ public class Instance {
 	private static ConfigBundle config;
 	private static UiConfigBundle uiconfig;
 	private static StringIdBundle trans;
-	private static Cache cache;
-	private static Library lib;
-	private static boolean debug;
+	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;
 
-	static {
-		// Most of the rest is dependent upon this:
-		config = new ConfigBundle();
+	private static boolean init;
 
-		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) {
+		if (init && !force) {
+			return;
 		}
 
+		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) {
-			syserr(e);
-		}
-		try {
-			uiconfig = new UiConfigBundle();
-			uiconfig.updateFile(configDir);
-		} catch (IOException e) {
-			syserr(e);
-		}
-		try {
-			trans = new StringIdBundle(getLang());
-			trans.updateFile(configDir);
-		} catch (IOException e) {
-			syserr(e);
-		}
+		// Most of the rest is dependent upon this:
+		createConfigs(configDir, false);
 
-		Bundles.setDirectory(configDir);
+		// Proxy support
+		Proxy.use(Instance.getConfig().getString(Config.NETWORK_PROXY));
 
-		uiconfig = new UiConfigBundle();
-		trans = new StringIdBundle(getLang());
-		try {
-			lib = new Library(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));
+		// update tracer:
+		if (debug == null) {
+			debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
+			trace = Instance.getConfig().getBoolean(Config.DEBUG_TRACE, false);
 		}
 
-		debug = Instance.getConfig().getBoolean(Config.DEBUG_ERR, false);
-		coverDir = getFile(Config.DEFAULT_COVERS_DIR);
-		File tmp = getFile(Config.CACHE_DIR);
-		readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER);
+		tracer = new TraceHandler(true, debug, trace);
 
-		if (checkEnv("NOUTF")) {
-			trans.setUnicode(false);
-		}
+		// default Library
+		remoteDir = new File(configDir, "remote");
+		lib = createDefaultLibrary(remoteDir);
 
-		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"));
 
-		// 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");
+		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 (coverDir != null && !coverDir.exists()) {
-			syserr(new IOException(
-					"The 'default covers' directory does not exists: "
-							+ coverDir));
-			coverDir = null;
-		}
+		cache.setTraceHandler(tracer);
 
-		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);
+		// readerTmp / coverDir
+		readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, new File(
+				configDir, "tmp-reader"));
+
+		coverDir = getFile(Config.DEFAULT_COVERS_DIR, new File(configDir,
+				"covers"));
+		coverDir.mkdirs();
 
-			cache = new Cache(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 (never NULL)
+	 */
+	public static TraceHandler getTraceHandler() {
+		return tracer;
+	}
+
+	/**
+	 * The traces handler for this {@link Cache}.
+	 * 
+	 * @param tracer
+	 *            the new traces handler or NULL
+	 */
+	public static void setTraceHandler(TraceHandler tracer) {
+		if (tracer == null) {
+			tracer = new TraceHandler(false, false, false);
+		}
+
+		Instance.tracer = tracer;
+		cache.setTraceHandler(tracer);
+	}
+
 	/**
 	 * Get the (unique) configuration service for the program.
 	 * 
@@ -141,16 +187,54 @@ public class Instance {
 	}
 
 	/**
-	 * Get the (unique) {@link Cache} for the program.
+	 * Reset the configuration.
+	 * 
+	 * @param resetTrans
+	 *            also reset the translation files
+	 */
+	public static 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 Cache}
+	 * @return the {@link DataLoader}
 	 */
-	public static Cache getCache() {
+	public static 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}
 	 */
@@ -159,11 +243,26 @@ public class Instance {
 	}
 
 	/**
-	 * Get the (unique) {@link Library} for the program.
+	 * Get the (unique) {link StringIdGuiBundle} for the program.
+	 * <p>
+	 * This is used for the translations of the GUI parts of Fanfix.
 	 * 
-	 * @return the {@link Library}
+	 * @return the {link StringIdGuiBundle}
 	 */
-	public static Library getLibrary() {
+	public static StringIdGuiBundle getTransGui() {
+		return transGui;
+	}
+
+	/**
+	 * Get the (unique) {@link LocalLibrary} for the program.
+	 * 
+	 * @return the {@link LocalLibrary}
+	 */
+	public static BasicLibrary getLibrary() {
+		if (lib == null) {
+			throw new NullPointerException("We don't have a library to return");
+		}
+
 		return lib;
 	}
 
@@ -185,6 +284,40 @@ public class Instance {
 		return readerTmp;
 	}
 
+	/**
+	 * Return the directory where to store temporary files for the remote
+	 * {@link LocalLibrary}.
+	 * 
+	 * @param host
+	 *            the remote for this host
+	 * 
+	 * @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) {
+			return new File(remoteDir, host);
+		}
+
+		return remoteDir;
+	}
+
 	/**
 	 * Check if we need to check that a new version of Fanfix is available.
 	 * 
@@ -192,7 +325,8 @@ public class Instance {
 	 */
 	public static boolean isVersionCheckNeeded() {
 		try {
-			long wait = config.getInteger(Config.UPDATE_INTERVAL, 1) * 24 * 60 * 60;
+			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"));
@@ -220,22 +354,152 @@ public class Instance {
 			IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE",
 					Long.toString(new Date().getTime()));
 		} catch (IOException e) {
-			syserr(e);
+			tracer.error(e);
+		}
+	}
+
+	/**
+	 * The facility to use temporary files in this program.
+	 * <p>
+	 * <b>MUST</b> 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;
 	}
 
 	/**
-	 * 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 (debug) {
-			e.printStackTrace();
+	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.getenv("BOOKS_DIR");
+			if (libDir == null || libDir.isEmpty()) {
+				libDir = config.getString(Config.LIBRARY_DIR, "$HOME/Books");
+			}
+			try {
+				lib = new LocalLibrary(getFile(libDir));
+			} catch (Exception e) {
+				tracer.error(new IOException(
+						"Cannot create library for directory: "
+								+ getFile(libDir), e));
+			}
 		} else {
-			System.err.println(e.getMessage());
+			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;
 	}
 
 	/**
@@ -243,8 +507,13 @@ public class Instance {
 	 * 
 	 * @return the path
 	 */
-	private static File getFile(Config id) {
-		return getFile(config.getString(id));
+	private static File getFile(Config id, File def) {
+		String path = config.getString(id);
+		if (path != null && path.isEmpty()) {
+			path = def.getPath();
+		}
+
+		return getFile(path);
 	}
 
 	/**
@@ -252,8 +521,13 @@ public class Instance {
 	 * 
 	 * @return the path
 	 */
-	private static File getFile(UiConfig id) {
-		return getFile(uiconfig.getString(id));
+	private static File getFile(UiConfig id, File def) {
+		String path = uiconfig.getString(id);
+		if (path != null && path.isEmpty()) {
+			path = def.getPath();
+		}
+
+		return getFile(path);
 	}
 
 	/**
@@ -266,8 +540,7 @@ public class Instance {
 		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);
@@ -276,6 +549,50 @@ 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
+	 */
+	private static 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).
 	 * 
@@ -284,8 +601,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()) {
@@ -303,7 +623,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();
@@ -312,8 +632,10 @@ public class Instance {
 					|| "y".equals(value)) {
 				return true;
 			}
+
+			return false;
 		}
 
-		return false;
+		return null;
 	}
 }