Merge branch 'master' into subtree

[nikiroo-utils.git] / Instance.java

diff --git a/Instance.java b/Instance.java
index 561e2f685218442c05f98187df6738afc779ced2..e0a072714a08a35b87f4342a0b4046c0abe0894c 100644 (file)
--- a/Instance.java
+++ b/Instance.java
@@ -15,6 +15,7 @@ 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.fanfix.library.CacheLibrary;
 import be.nikiroo.fanfix.library.LocalLibrary;
 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.Cache;
 import be.nikiroo.utils.IOUtils;
 import be.nikiroo.utils.Image;


@@ -29,26 +30,38 @@ import be.nikiroo.utils.resources.Bundles;
  * @author niki
  */
 public class Instance {
  * @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.
 
        /**
         * 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);
         */
        static public void init() {
                init(false);


@@ -72,12 +85,42 @@ public class Instance {
         *            force the initialisation even if already initialised
         */
        static public void init(boolean 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;
                // Before we can configure it:
                Boolean debug = checkEnv("DEBUG");
                boolean trace = debug != null && debug;


@@ -93,12 +136,12 @@ public class Instance {
                createConfigs(configDir, false);
 
                // Proxy support
                createConfigs(configDir, false);
 
                // Proxy support

-               Proxy.use(Instance.getConfig().getString(Config.NETWORK_PROXY));
+               Proxy.use(config.getString(Config.NETWORK_PROXY));

 
                // update tracer:
                if (debug == null) {
 
                // 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);
                }
 
                tracer = new TraceHandler(true, debug, trace);


@@ -108,10 +151,7 @@ public class Instance {
                lib = createDefaultLibrary(remoteDir);
 
                // create cache and TMP
                lib = createDefaultLibrary(remoteDir);
 
                // create cache and TMP

-               File tmp = getFile(Config.CACHE_DIR, new File(configDir, "tmp"));
-               if (!tmp.isAbsolute()) {
-                       tmp = new File(configDir, tmp.getPath());
-               }
+               File tmp = getFile(Config.CACHE_DIR, configDir, "tmp");

                Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images"));
 
                String ua = config.getString(Config.NETWORK_USER_AGENT, "");
                Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images"));
 
                String ua = config.getString(Config.NETWORK_USER_AGENT, "");


@@ -128,17 +168,16 @@ public class Instance {
                cache.setTraceHandler(tracer);
 
                // readerTmp / coverDir
                cache.setTraceHandler(tracer);
 
                // readerTmp / coverDir

-               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, new File(
-                               configDir, "tmp-reader"));
-
-               coverDir = getFile(Config.DEFAULT_COVERS_DIR, new File(configDir,
-                               "covers"));
+               readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, configDir,
+                               "tmp-reader");
+               coverDir = getFile(Config.DEFAULT_COVERS_DIR, configDir, "covers");

                coverDir.mkdirs();
 
                try {
                        tempFiles = new TempFiles("fanfix");
                } catch (IOException e) {
                coverDir.mkdirs();
 
                try {
                        tempFiles = new TempFiles("fanfix");
                } catch (IOException e) {

-                       tracer.error(new IOException("Cannot create temporary directory", e));
+                       tracer.error(
+                                       new IOException("Cannot create temporary directory", e));

                }
        }
 
                }
        }
 


@@ -149,7 +188,7 @@ public class Instance {
         * 
         * @return the traces handler (never NULL)
         */
         * 
         * @return the traces handler (never NULL)
         */

-       public static TraceHandler getTraceHandler() {
+       public TraceHandler getTraceHandler() {

                return tracer;
        }
 
                return tracer;
        }
 


@@ -159,12 +198,12 @@ public class Instance {
         * @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);
                }
 
                if (tracer == null) {
                        tracer = new TraceHandler(false, false, false);
                }
 

-               Instance.tracer = tracer;
+               this.tracer = tracer;

                cache.setTraceHandler(tracer);
        }
 
                cache.setTraceHandler(tracer);
        }
 


@@ -173,7 +212,7 @@ public class Instance {
         * 
         * @return the configuration service
         */
         * 
         * @return the configuration service
         */

-       public static ConfigBundle getConfig() {
+       public ConfigBundle getConfig() {

                return config;
        }
 
                return config;
        }
 


@@ -182,7 +221,7 @@ public class Instance {
         * 
         * @return the configuration service
         */
         * 
         * @return the configuration service
         */

-       public static UiConfigBundle getUiConfig() {
+       public UiConfigBundle getUiConfig() {

                return uiconfig;
        }
 
                return uiconfig;
        }
 


@@ -192,7 +231,7 @@ public class Instance {
         * @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 {
                String dir = Bundles.getDirectory();
                Bundles.setDirectory(null);
                try {


@@ -227,7 +266,7 @@ public class Instance {
         * 
         * @return the {@link DataLoader}
         */
         * 
         * @return the {@link DataLoader}
         */

-       public static DataLoader getCache() {
+       public DataLoader getCache() {

                return cache;
        }
 
                return cache;
        }
 


@@ -238,7 +277,7 @@ public class Instance {
         * 
         * @return the {link StringIdBundle}
         */
         * 
         * @return the {link StringIdBundle}
         */

-       public static StringIdBundle getTrans() {
+       public StringIdBundle getTrans() {

                return trans;
        }
 
                return trans;
        }
 


@@ -249,16 +288,16 @@ public class Instance {
         * 
         * @return the {link StringIdGuiBundle}
         */
         * 
         * @return the {link StringIdGuiBundle}
         */

-       public static StringIdGuiBundle getTransGui() {
+       public StringIdGuiBundle getTransGui() {

                return transGui;
        }
 
        /**
                return transGui;
        }
 
        /**

-        * Get the (unique) {@link LocalLibrary} for the program.
+        * 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");
                }
                if (lib == null) {
                        throw new NullPointerException("We don't have a library to return");
                }


@@ -266,12 +305,24 @@ public class Instance {
                return lib;
        }
 
                return lib;
        }
 

+       /**
+        * Change the default {@link BasicLibrary} for this program.
+        * <p>
+        * 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
         */
        /**
         * Return the directory where to look for default cover pages.
         * 
         * @return the default covers directory
         */

-       public static File getCoverDir() {
+       public File getCoverDir() {

                return coverDir;
        }
 
                return coverDir;
        }
 


@@ -280,7 +331,7 @@ public class Instance {
         * 
         * @return the directory
         */
         * 
         * @return the directory
         */

-       public static File getReaderDir() {
+       public File getReaderDir() {

                return readerTmp;
        }
 
                return readerTmp;
        }
 


@@ -293,7 +344,7 @@ public class Instance {
         * 
         * @return the directory
         */
         * 
         * @return the directory
         */

-       public static File getRemoteDir(String host) {
+       public File getRemoteDir(String host) {

                return getRemoteDir(remoteDir, host);
        }
 
                return getRemoteDir(remoteDir, host);
        }
 


@@ -308,10 +359,15 @@ public class Instance {
         * 
         * @return the directory
         */
         * 
         * @return the directory
         */

-       private static File getRemoteDir(File remoteDir, String host) {
+       private File getRemoteDir(File remoteDir, String host) {

                remoteDir.mkdirs();
 
                if (host != null) {
                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);
                }
 
                        return new File(remoteDir, host);
                }
 


@@ -323,13 +379,13 @@ public class Instance {
         * 
         * @return TRUE if we need to
         */
         * 
         * @return TRUE if we need to
         */

-       public static boolean isVersionCheckNeeded() {
+       public boolean isVersionCheckNeeded() {

                try {
                        long wait = config.getInteger(Config.NETWORK_UPDATE_INTERVAL, 0)
                                        * 24 * 60 * 60 * 1000;
                        if (wait >= 0) {
                try {
                        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) {
                                long delay = new Date().getTime()
                                                - Long.parseLong(lastUpString);
                                if (delay > wait) {


@@ -349,7 +405,7 @@ public class Instance {
        /**
         * Notify that we checked for a new version of Fanfix.
         */
        /**
         * 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()));
                try {
                        IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE",
                                        Long.toString(new Date().getTime()));


@@ -365,7 +421,7 @@ public class Instance {
         * 
         * @return the facility
         */
         * 
         * @return the facility
         */

-       public static TempFiles getTempFiles() {
+       public TempFiles getTempFiles() {

                return tempFiles;
        }
 
                return tempFiles;
        }
 


@@ -376,7 +432,7 @@ public class Instance {
         * 
         * @return the config directory
         */
         * 
         * @return the config directory
         */

-       private static String getConfigDir() {
+       private String getConfigDir() {

                String configDir = System.getProperty("CONFIG_DIR");
 
                if (configDir == null) {
                String configDir = System.getProperty("CONFIG_DIR");
 
                if (configDir == null) {


@@ -401,7 +457,7 @@ public class Instance {
         *            TRUE to reset the configuration files from the default
         *            included ones
         */
         *            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);
                }
                if (!refresh) {
                        Bundles.setDirectory(configDir);
                }


@@ -448,42 +504,51 @@ public class Instance {
         * 
         * @return the default {@link BasicLibrary}
         */
         * 
         * @return the default {@link BasicLibrary}
         */

-       private static BasicLibrary createDefaultLibrary(File remoteDir) {
+       private BasicLibrary createDefaultLibrary(File remoteDir) {

                BasicLibrary lib = null;
 
                boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED,
                                false);
                BasicLibrary lib = null;
 
                boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED,
                                false);

-

                if (useRemote) {
                        String host = null;
                        int port = -1;
                        try {
                if (useRemote) {
                        String host = null;
                        int port = -1;
                        try {

-                               host = config.getString(Config.REMOTE_LIBRARY_HOST);
+                               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);
 
                                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);
                                tracer.trace("Selecting remote library " + host + ":" + port);

-                               lib = new RemoteLibrary(key, host, port);
-                               lib = new CacheLibrary(getRemoteDir(remoteDir, host), lib);
+
+                               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) {
                        } catch (Exception e) {

-                               tracer.error(new IOException(
-                                               "Cannot create remote library for: " + host + ":"
-                                                               + port, 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()) {
                        }
                } 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();
-                               }
+                               libDir = getFile(Config.LIBRARY_DIR, configDir, "$HOME/Books")
+                                               .getPath();

                        }
                        try {
                        }
                        try {

-                               lib = new LocalLibrary(getFile(libDir));
+                               lib = new LocalLibrary(new File(libDir), config);

                        } catch (Exception e) {
                                tracer.error(new IOException(
                        } catch (Exception e) {
                                tracer.error(new IOException(

-                                               "Cannot create library for directory: "
-                                                               + getFile(libDir), e));
+                                               "Cannot create library for directory: " + libDir, e));

                        }
                }
 
                        }
                }
 


@@ -493,34 +558,52 @@ public class Instance {
        /**
         * Return a path, but support the special $HOME variable.
         * 
        /**
         * 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, File def) {
-               String path = config.getString(id, def.getPath());
-               return getFile(path);
+       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 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, File def) {
-               String path = uiconfig.getString(id, def.getPath());
-               return getFile(path);
+       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 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", getHome());
                File file = null;
                if (path != null && !path.isEmpty()) {
                        path = path.replace('/', File.separatorChar);
                        if (path.contains("$HOME")) {
                                path = path.replace("$HOME", getHome());

+                       } else if (!path.startsWith("/")) {
+                               path = new File(configDir, path).getPath();

                        }
 
                        file = new File(path);
                        }
 
                        file = new File(path);


@@ -539,7 +622,7 @@ public class Instance {
         * 
         * @return the home
         */
         * 
         * @return the home
         */

-       private static String getHome() {
+       protected String getHome() {

                String home = System.getenv("FANFIX_DIR");
                if (home != null && new File(home).isFile()) {
                        home = null;
                String home = System.getenv("FANFIX_DIR");
                if (home != null && new File(home).isFile()) {
                        home = null;


@@ -578,7 +661,7 @@ public class Instance {
         * 
         * @return the language
         */
         * 
         * @return the language
         */

-       private static String getLang() {
+       protected String getLang() {

                String lang = config.getString(Config.LANG);
 
                if (lang == null || lang.isEmpty()) {
                String lang = config.getString(Config.LANG);
 
                if (lang == null || lang.isEmpty()) {


@@ -603,7 +686,7 @@ public class Instance {
         * 
         * @return TRUE if it is
         */
         * 
         * @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();
                String value = System.getenv(key);
                if (value != null) {
                        value = value.trim().toLowerCase();