From 13fdb89adc017452a7a72f552b933f8e7b869413 Mon Sep 17 00:00:00 2001 From: Niki Roo Date: Wed, 22 May 2019 10:04:24 +0200 Subject: [PATCH] change config names --- src/be/nikiroo/fanfix/DataLoader.java | 4 +- src/be/nikiroo/fanfix/Instance.java | 6 +- src/be/nikiroo/fanfix/bundles/Config.java | 99 ++++++++++++------- .../nikiroo/fanfix/library/LocalLibrary.java | 8 +- src/be/nikiroo/fanfix/output/Epub.java | 4 +- src/be/nikiroo/fanfix/output/Html.java | 2 +- src/be/nikiroo/fanfix/output/InfoCover.java | 2 +- src/be/nikiroo/fanfix/output/LaTeX.java | 2 +- .../fanfix/supported/BasicSupportHelper.java | 2 +- .../fanfix/supported/BasicSupportPara.java | 4 +- .../supported/BasicSupport_Deprecated.java | 4 +- .../nikiroo/fanfix/supported/Fanfiction.java | 4 +- .../nikiroo/fanfix/supported/InfoReader.java | 2 +- src/be/nikiroo/fanfix/supported/Text.java | 4 +- 14 files changed, 89 insertions(+), 58 deletions(-) diff --git a/src/be/nikiroo/fanfix/DataLoader.java b/src/be/nikiroo/fanfix/DataLoader.java index abc9585..0abb323 100644 --- a/src/be/nikiroo/fanfix/DataLoader.java +++ b/src/be/nikiroo/fanfix/DataLoader.java @@ -278,11 +278,11 @@ public class DataLoader { throws IOException { String format; if (cover) { - format = Instance.getConfig().getString(Config.IMAGE_FORMAT_COVER) + format = Instance.getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER) .toLowerCase(); } else { format = Instance.getConfig() - .getString(Config.IMAGE_FORMAT_CONTENT).toLowerCase(); + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_CONTENT).toLowerCase(); } saveAsImage(img, new File(target.toString() + "." + format), format); } diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java index b7a284c..7489749 100644 --- a/src/be/nikiroo/fanfix/Instance.java +++ b/src/be/nikiroo/fanfix/Instance.java @@ -93,7 +93,7 @@ public class Instance { createConfigs(configDir, false); // Proxy support - Proxy.use(Instance.getConfig().getString(Config.USE_PROXY)); + Proxy.use(Instance.getConfig().getString(Config.NETWORK_PROXY)); // update tracer: if (debug == null) { @@ -114,7 +114,7 @@ public class Instance { } Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images")); - String ua = config.getString(Config.USER_AGENT, ""); + 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); @@ -325,7 +325,7 @@ public class Instance { */ public static boolean isVersionCheckNeeded() { try { - long wait = config.getInteger(Config.UPDATE_INTERVAL, 0) * 24 * 60 + long wait = config.getInteger(Config.NETWORK_UPDATE_INTERVAL, 0) * 24 * 60 * 60 * 1000; if (wait >= 0) { String lastUpString = IOUtils.readSmallFile(new File(configDir, diff --git a/src/be/nikiroo/fanfix/bundles/Config.java b/src/be/nikiroo/fanfix/bundles/Config.java index 028f965..e62a524 100644 --- a/src/be/nikiroo/fanfix/bundles/Config.java +++ b/src/be/nikiroo/fanfix/bundles/Config.java @@ -10,18 +10,32 @@ import be.nikiroo.utils.resources.Meta.Format; */ @SuppressWarnings("javadoc") public enum Config { - @Meta(description = "The language (example: en-GB, fr-BE...) or nothing for default system language (can be overwritten with the variable $LANG)",// + @Meta(description = "The language to use for in the program (example: en-GB, fr-BE...) or nothing for default system language (can be overwritten with the variable $LANG)",// format = Format.LOCALE) LANG, // @Meta(description = "The default reader type to use to read stories:\nCLI = simple output to console\nTUI = a Text User Interface with menus and windows, based upon Jexer\nGUI = a GUI with locally stored files, based upon Swing", // format = Format.FIXED_LIST, list = { "CLI", "GUI", "TUI" }, def = "GUI") READER_TYPE, // - @Meta(description = "The type of output for the Local Reader for non-images documents",// + + @Meta(description = "File format options",// + group = true) + FILE_FORMAT, // + @Meta(description = "How to save non-images documents in the library",// format = Format.FIXED_LIST, list = { "INFO_TEXT", "EPUB", "HTML", "TEXT" }, def = "INFO_TEXT") - NON_IMAGES_DOCUMENT_TYPE, // - @Meta(description = "The type of output for the Local Reader for non-images documents",// + FILE_FORMAT_NON_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "How to save images documents in the library",// format = Format.FIXED_LIST, list = { "CBZ", "HTML" }, def = "CBZ") - IMAGES_DOCUMENT_TYPE, // + FILE_FORMAT_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "How to save cover images",// + format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "PNG") + FILE_FORMAT_IMAGE_FORMAT_COVER, // + @Meta(description = "How to save content images",// + format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "JPG") + FILE_FORMAT_IMAGE_FORMAT_CONTENT, // + + @Meta(description = "Cache management",// + group = true) + CACHE, // @Meta(description = "The directory where to store temporary files; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// format = Format.DIRECTORY, def = "tmp/") CACHE_DIR, // @@ -31,15 +45,33 @@ public enum Config { @Meta(description = "The delay in hours after which a cached resource that is thought to change rarely is considered too old and triggers a refresh delay (or 0 for no cache, or -1 for infinite time)", // format = Format.INT, def = "720") CACHE_MAX_TIME_STABLE, // - @Meta(description = "The user-agent to use to download files",// - def = "Mozilla/5.0 (X11; Linux x86_64; rv:44.0) Gecko/20100101 Firefox/44.0 -- ELinks/0.9.3 (Linux 2.6.11 i686; 80x24) -- Fanfix (https://github.com/nikiroo/fanfix/)") - USER_AGENT, // + @Meta(description = "The directory where to get the default story covers; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// format = Format.DIRECTORY, def = "covers/") DEFAULT_COVERS_DIR, // + @Meta(description = "The directory where to store the library (can be overriden by the envvironment variable \"BOOKS_DIR\"; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// + format = Format.DIRECTORY, def = "$HOME/Books/") + LIBRARY_DIR, // @Meta(description = "The default library to use (KEY:SERVER:PORT), or empty for the local library",// format = Format.STRING, def = "") DEFAULT_LIBRARY, // + + @Meta(description = "Network configuration",// + group = true) + NETWORK, // + @Meta(description = "The user-agent to use to download files",// + def = "Mozilla/5.0 (X11; Linux x86_64; rv:44.0) Gecko/20100101 Firefox/44.0 -- ELinks/0.9.3 (Linux 2.6.11 i686; 80x24) -- Fanfix (https://github.com/nikiroo/fanfix/)") + NETWORK_USER_AGENT, // + @Meta(description = "The proxy server to use under the format 'user:pass@proxy:port', 'user@proxy:port', 'proxy:port' or ':' alone (system proxy); an empty String means no proxy",// + format = Format.STRING, def = "") + NETWORK_PROXY, // + @Meta(description = "If the last update check was done at least that many days ago, check for updates at startup (-1 for 'no checks')", // + format = Format.INT, def = "1") + NETWORK_UPDATE_INTERVAL, // + + @Meta(description = "Remote Server configuration\nNote that the key is structured: \"KEY|SUBKEY|wl|rw\"\n- \"KEY\" is the actual encryption key (it can actually be empty, which will still encrypt the messages but of course it will be easier to guess the key)\n- \"SUBKEY\" is the (optional) subkey to use to get additional privileges\n- \"wl\" is a special privilege that allows that subkey to ignore white lists\n- \"rw\" is a special privilege that allows that subkey to modify the library, even if it is not in RW (by default) mode\n\nSome examples:\n- \"super-secret\": a normal key, no special privileges\n- \"you-will-not-guess|azOpd8|wl\": a white-list ignoring key\n- \"new-password|subpass|rw\": a key that allows modifications on the library",// + group = true) + SERVER, // @Meta(description = "The port on which we can start the server (must be a valid port, from 1 to 65535)", // format = Format.INT, def = "58365") SERVER_PORT, // @@ -52,56 +84,55 @@ public enum Config { @Meta(description = "If not empty, only the EXACT listed sources will be available for clients without BL subkeys",// array = true, format = Format.STRING, def = "") SERVER_WHITELIST, // - @Meta(description = "The subkeys that the server will allow, including the modes", // + @Meta(description = "The subkeys that the server will allow, including the modes\nA subkey ", // array = true, format = Format.STRING, def = "") SERVER_ALLOWED_SUBKEYS, // - @Meta(description = "The directory where to store the library (can be overriden by the envvironment variable \"BOOKS_DIR\"; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// - format = Format.DIRECTORY, def = "$HOME/Books/") - LIBRARY_DIR, // + + @Meta(description = "DEBUG options",// + group = true) + DEBUG, // @Meta(description = "Show debug information on errors",// format = Format.BOOLEAN, def = "false") DEBUG_ERR, // @Meta(description = "Show debug trace information",// format = Format.BOOLEAN, def = "false") DEBUG_TRACE, // - @Meta(description = "Image format to use for cover images",// - format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "PNG") - IMAGE_FORMAT_COVER, // - @Meta(description = "Image format to use for content images",// - format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "jpg") - IMAGE_FORMAT_CONTENT, // - @Meta(group = true) - LATEX_LANG, // + + @Meta(description = "Internal configuration\nThose options are internal to the program and should probably not be changed",// + group = true) + CONF, // + @Meta(description = "LaTeX configuration",// + group = true) + CONF_LATEX_LANG, // @Meta(description = "LaTeX output language (full name) for \"English\"",// format = Format.STRING, def = "english") - LATEX_LANG_EN, // + CONF_LATEX_LANG_EN, // @Meta(description = "LaTeX output language (full name) for \"French\"",// format = Format.STRING, def = "french") - LATEX_LANG_FR, // + CONF_LATEX_LANG_FR, // @Meta(description = "other 'by' prefixes before author name, used to identify the author",// array = true, format = Format.STRING, def = "\"by\",\"par\",\"de\",\"©\",\"(c)\"") - BYS, // + CONF_BYS, // @Meta(description = "List of languages codes used for chapter identification (should not be changed)", // array = true, format = Format.STRING, def = "\"EN\",\"FR\"") - CHAPTER, // + CONF_CHAPTER, // @Meta(description = "Chapter identification string in English, used to identify a starting chapter in text mode",// format = Format.STRING, def = "Chapter") - CHAPTER_EN, // + CONF_CHAPTER_EN, // @Meta(description = "Chapter identification string in French, used to identify a starting chapter in text mode",// format = Format.STRING, def = "Chapitre") - CHAPTER_FR, // - @Meta(description = "Login for YiffStar to have access to all the stories (should not be necessary anymore, but can still be used)",// + CONF_CHAPTER_FR, // + + @Meta(description = "YiffStar/SoFurry credentials\nYou can give your YiffStar credentials here to have access to all the stories, though it should not be necessary anymore (some stories used to beblocked for anonymous viewers)",// + group = true) + LOGIN_YIFFSTAR, // + @Meta(description = "Your YiffStar/SoFurry login",// format = Format.STRING) LOGIN_YIFFSTAR_USER, // - @Meta(description = "Password for YiffStar to have access to all the stories (should not be necessary anymore, but can still be used)",// + @Meta(description = "Your YiffStar/SoFurry password",// format = Format.PASSWORD) LOGIN_YIFFSTAR_PASS, // - @Meta(description = "If the last update check was done at least that many days ago, check for updates at startup (-1 for 'no checks')", // - format = Format.INT, def = "1") - UPDATE_INTERVAL, // - @Meta(description = "The proxy server to use under the format 'user:pass@proxy:port', 'user@proxy:port', 'proxy:port' or ':' alone (system proxy); an empty String means no proxy",// - format = Format.STRING, def = "") - USE_PROXY, // + @Meta(description = "FimFiction APIKEY credentials\nFimFiction can be queried via an API, but requires an API key to do that. One has been created for this program, but if you have another API key you can set it here. You can also set a login and password instead, in that case, a new API key will be generated (and stored) if you still haven't set one.",// group = true) LOGIN_FIMFICTION_APIKEY, // diff --git a/src/be/nikiroo/fanfix/library/LocalLibrary.java b/src/be/nikiroo/fanfix/library/LocalLibrary.java index 3b0a848..ffcd8af 100644 --- a/src/be/nikiroo/fanfix/library/LocalLibrary.java +++ b/src/be/nikiroo/fanfix/library/LocalLibrary.java @@ -47,8 +47,8 @@ public class LocalLibrary extends BasicLibrary { */ public LocalLibrary(File baseDir) { this(baseDir, Instance.getConfig().getString( - Config.NON_IMAGES_DOCUMENT_TYPE), Instance.getConfig() - .getString(Config.IMAGES_DOCUMENT_TYPE), false); + Config.FILE_FORMAT_NON_IMAGES_DOCUMENT_TYPE), Instance.getConfig() + .getString(Config.FILE_FORMAT_IMAGES_DOCUMENT_TYPE), false); } /** @@ -516,7 +516,7 @@ public class LocalLibrary extends BasicLibrary { private File getAuthorCoverFile(String author) { File aDir = new File(baseDir, "_AUTHORS"); String hash = StringUtils.getMd5Hash(author); - String ext = Instance.getConfig().getString(Config.IMAGE_FORMAT_COVER); + String ext = Instance.getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER); return new File(aDir, hash + "." + ext.toLowerCase()); } @@ -562,7 +562,7 @@ public class LocalLibrary extends BasicLibrary { } String coverExt = "." - + Instance.getConfig().getString(Config.IMAGE_FORMAT_COVER) + + Instance.getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER) .toLowerCase(); File coverFile = new File(path + coverExt); if (!coverFile.exists()) { diff --git a/src/be/nikiroo/fanfix/output/Epub.java b/src/be/nikiroo/fanfix/output/Epub.java index b56cc33..e3280d1 100644 --- a/src/be/nikiroo/fanfix/output/Epub.java +++ b/src/be/nikiroo/fanfix/output/Epub.java @@ -437,7 +437,7 @@ class Epub extends BasicOutput { if (story.getMeta() != null && story.getMeta().getCover() != null) { String format = Instance.getConfig() - .getString(Config.IMAGE_FORMAT_COVER).toLowerCase(); + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); builder.append("\n "); } @@ -483,7 +483,7 @@ class Epub extends BasicOutput { } String format = Instance.getConfig() - .getString(Config.IMAGE_FORMAT_COVER).toLowerCase(); + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); builder.append(""); builder.append("\n"); diff --git a/src/be/nikiroo/fanfix/output/Html.java b/src/be/nikiroo/fanfix/output/Html.java index 756eb8d..ca802a5 100644 --- a/src/be/nikiroo/fanfix/output/Html.java +++ b/src/be/nikiroo/fanfix/output/Html.java @@ -92,7 +92,7 @@ class Html extends BasicOutput { } String format = Instance.getConfig() - .getString(Config.IMAGE_FORMAT_COVER).toLowerCase(); + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); InputStream inStyle = getClass().getResourceAsStream("html.style.css"); if (inStyle == null) { diff --git a/src/be/nikiroo/fanfix/output/InfoCover.java b/src/be/nikiroo/fanfix/output/InfoCover.java index 9227d3e..6bfa4dd 100644 --- a/src/be/nikiroo/fanfix/output/InfoCover.java +++ b/src/be/nikiroo/fanfix/output/InfoCover.java @@ -47,7 +47,7 @@ public class InfoCover { writeMeta(infoWriter, "TYPE", meta.getType()); if (meta.getCover() != null) { String format = Instance.getConfig() - .getString(Config.IMAGE_FORMAT_COVER).toLowerCase(); + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); writeMeta(infoWriter, "COVER", targetName + "." + format); } else { writeMeta(infoWriter, "COVER", ""); diff --git a/src/be/nikiroo/fanfix/output/LaTeX.java b/src/be/nikiroo/fanfix/output/LaTeX.java index d677f10..321556f 100644 --- a/src/be/nikiroo/fanfix/output/LaTeX.java +++ b/src/be/nikiroo/fanfix/output/LaTeX.java @@ -66,7 +66,7 @@ class LaTeX extends BasicOutput { author = "\\author{" + latexEncode(meta.getAuthor()) + "}"; lang = meta.getLang().toLowerCase(); if (lang != null && !lang.isEmpty()) { - lang = Instance.getConfig().getStringX(Config.LATEX_LANG, lang); + lang = Instance.getConfig().getStringX(Config.CONF_LATEX_LANG, lang); if (lang == null) { System.err.println(Instance.getTrans().getString( StringId.LATEX_LANG_UNKNOWN, lang)); diff --git a/src/be/nikiroo/fanfix/supported/BasicSupportHelper.java b/src/be/nikiroo/fanfix/supported/BasicSupportHelper.java index 6525067..c9c9f08 100644 --- a/src/be/nikiroo/fanfix/supported/BasicSupportHelper.java +++ b/src/be/nikiroo/fanfix/supported/BasicSupportHelper.java @@ -204,7 +204,7 @@ class BasicSupportHelper { public static String fixAuthor(String author) { if (author != null) { for (String suffix : new String[] { " ", ":" }) { - for (String byString : Instance.getConfig().getList(Config.BYS)) { + for (String byString : Instance.getConfig().getList(Config.CONF_BYS)) { byString += suffix; if (author.toUpperCase().startsWith(byString.toUpperCase())) { author = author.substring(byString.length()).trim(); diff --git a/src/be/nikiroo/fanfix/supported/BasicSupportPara.java b/src/be/nikiroo/fanfix/supported/BasicSupportPara.java index 9795cf6..b960348 100644 --- a/src/be/nikiroo/fanfix/supported/BasicSupportPara.java +++ b/src/be/nikiroo/fanfix/supported/BasicSupportPara.java @@ -68,9 +68,9 @@ class BasicSupportPara { // "Chapter 5: - Fun!" after the ": " was automatically added) String chapterName = BasicSupportPara.processPara(name, false) .getContent().trim(); - for (String lang : Instance.getConfig().getList(Config.CHAPTER)) { + for (String lang : Instance.getConfig().getList(Config.CONF_CHAPTER)) { String chapterWord = Instance.getConfig().getStringX( - Config.CHAPTER, lang); + Config.CONF_CHAPTER, lang); if (chapterName.startsWith(chapterWord)) { chapterName = chapterName.substring(chapterWord.length()) .trim(); diff --git a/src/be/nikiroo/fanfix/supported/BasicSupport_Deprecated.java b/src/be/nikiroo/fanfix/supported/BasicSupport_Deprecated.java index 7a652a4..1faac03 100644 --- a/src/be/nikiroo/fanfix/supported/BasicSupport_Deprecated.java +++ b/src/be/nikiroo/fanfix/supported/BasicSupport_Deprecated.java @@ -391,9 +391,9 @@ public abstract class BasicSupport_Deprecated extends BasicSupport { // redundant "Chapter x: " in front of it, or "-" (as in // "Chapter 5: - Fun!" after the ": " was automatically added) String chapterName = processPara(name).getContent().trim(); - for (String lang : Instance.getConfig().getList(Config.CHAPTER)) { + for (String lang : Instance.getConfig().getList(Config.CONF_CHAPTER)) { String chapterWord = Instance.getConfig().getStringX( - Config.CHAPTER, lang); + Config.CONF_CHAPTER, lang); if (chapterName.startsWith(chapterWord)) { chapterName = chapterName.substring(chapterWord.length()) .trim(); diff --git a/src/be/nikiroo/fanfix/supported/Fanfiction.java b/src/be/nikiroo/fanfix/supported/Fanfiction.java index 10c82fc..33c1721 100644 --- a/src/be/nikiroo/fanfix/supported/Fanfiction.java +++ b/src/be/nikiroo/fanfix/supported/Fanfiction.java @@ -305,9 +305,9 @@ class Fanfiction extends BasicSupport_Deprecated { if (pos >= 0) { boolean chaptered = false; for (String lang : Instance.getConfig().getList( - Config.CHAPTER)) { + Config.CONF_CHAPTER)) { String chapterWord = Instance.getConfig() - .getStringX(Config.CHAPTER, lang); + .getStringX(Config.CONF_CHAPTER, lang); int posChap = line.indexOf(chapterWord + " "); if (posChap < pos) { chaptered = true; diff --git a/src/be/nikiroo/fanfix/supported/InfoReader.java b/src/be/nikiroo/fanfix/supported/InfoReader.java index 57f021f..3d09a55 100644 --- a/src/be/nikiroo/fanfix/supported/InfoReader.java +++ b/src/be/nikiroo/fanfix/supported/InfoReader.java @@ -95,7 +95,7 @@ public class InfoReader { File basefile = new File(sourceInfoFile.getFile()); String ext = "." - + Instance.getConfig().getString(Config.IMAGE_FORMAT_COVER) + + Instance.getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER) .toLowerCase(); // Without removing ext diff --git a/src/be/nikiroo/fanfix/supported/Text.java b/src/be/nikiroo/fanfix/supported/Text.java index 34f180e..1e5977a 100644 --- a/src/be/nikiroo/fanfix/supported/Text.java +++ b/src/be/nikiroo/fanfix/supported/Text.java @@ -331,8 +331,8 @@ class Text extends BasicSupport { */ static private String detectChapter(String line, int number) { line = line.toUpperCase(); - for (String lang : Instance.getConfig().getList(Config.CHAPTER)) { - String chapter = Instance.getConfig().getStringX(Config.CHAPTER, + for (String lang : Instance.getConfig().getList(Config.CONF_CHAPTER)) { + String chapter = Instance.getConfig().getStringX(Config.CONF_CHAPTER, lang); if (chapter != null && !chapter.isEmpty()) { chapter = chapter.toUpperCase() + " "; -- 2.27.0