[fanfix.git] / src / be / nikiroo / fanfix / bundles / Config.java

package be.nikiroo.fanfix.bundles;

import be.nikiroo.utils.resources.Meta;
import be.nikiroo.utils.resources.Meta.Format;

/**
 * The configuration options.
 * 
 * @author niki
 */
@SuppressWarnings("javadoc")
public enum Config {
	@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 = "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")
	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")
	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, //
	@Meta(description = "The delay in hours after which a cached resource that is thought to change ~often is considered too old and triggers a refresh delay (or 0 for no cache, or -1 for infinite time)", //
	format = Format.INT, def = "24")
	CACHE_MAX_TIME_CHANGING, //
	@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 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, //
	@Meta(description = "The encryption key for the server (NOT including a subkey), it cannot contain the pipe character \"|\" but can be empty (it is *still* encrypted, but with an empty, easy to guess key)",//
	format = Format.PASSWORD, def = "")
	SERVER_KEY, //
	@Meta(description = "Allow write access to the clients (download story, move story...) without RW subkeys", //
	format = Format.BOOLEAN, def = "true")
	SERVER_RW, //
	@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\nA subkey ", //
	array = true, format = Format.STRING, def = "")
	SERVER_ALLOWED_SUBKEYS, //

	@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 = "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")
	CONF_LATEX_LANG_EN, //
	@Meta(description = "LaTeX output language (full name) for \"French\"",//
	format = Format.STRING, def = "french")
	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)\"")
	CONF_BYS, //
	@Meta(description = "List of languages codes used for chapter identification (should not be changed)", //
	array = true, format = Format.STRING, def = "\"EN\",\"FR\"")
	CONF_CHAPTER, //
	@Meta(description = "Chapter identification string in English, used to identify a starting chapter in text mode",//
	format = Format.STRING, def = "Chapter")
	CONF_CHAPTER_EN, //
	@Meta(description = "Chapter identification string in French, used to identify a starting chapter in text mode",//
	format = Format.STRING, def = "Chapitre")
	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 = "Your YiffStar/SoFurry password",//
	format = Format.PASSWORD)
	LOGIN_YIFFSTAR_PASS, //

	@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, //
	@Meta(description = "The login of the API key used to create a new token from FimFiction", //
	format = Format.STRING)
	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
	@Meta(description = "The password of the API key used to create a new token from FimFiction", //
	format = Format.PASSWORD)
	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
	@Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping",//
	format = Format.BOOLEAN, def = "false")
	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
	@Meta(description = "The token required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_* if you want to generate a new one from your own API key)", //
	format = Format.PASSWORD, def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D")
	LOGIN_FIMFICTION_APIKEY_TOKEN, //
}
Commit	Line	Data
08fe2e33 NR	1	package be.nikiroo.fanfix.bundles;
	2
	3	import be.nikiroo.utils.resources.Meta;
ce788468	4	import be.nikiroo.utils.resources.Meta.Format;
08fe2e33 NR	5
	6	/**
	7	* The configuration options.
	8	*
	9	* @author niki
	10	*/
ce788468	11	@SuppressWarnings("javadoc")
08fe2e33	12	public enum Config {
13fdb89a	13	@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)",//
b7cd9db8	14	format = Format.LOCALE)
08fe2e33	15	LANG, //
b7cd9db8 NR	16	@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", //
b7cd9db8 NR	17	format = Format.FIXED_LIST, list = { "CLI", "GUI", "TUI" }, def = "GUI")
3727aae2	18	READER_TYPE, //
13fdb89a NR	19
	20	@Meta(description = "File format options",//
	21	group = true)
	22	FILE_FORMAT, //
	23	@Meta(description = "How to save non-images documents in the library",//
b7cd9db8	24	format = Format.FIXED_LIST, list = { "INFO_TEXT", "EPUB", "HTML", "TEXT" }, def = "INFO_TEXT")
13fdb89a NR	25	FILE_FORMAT_NON_IMAGES_DOCUMENT_TYPE, //
13fdb89a NR	26	@Meta(description = "How to save images documents in the library",//
b7cd9db8	27	format = Format.FIXED_LIST, list = { "CBZ", "HTML" }, def = "CBZ")
13fdb89a NR	28	FILE_FORMAT_IMAGES_DOCUMENT_TYPE, //
	29	@Meta(description = "How to save cover images",//
	30	format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "PNG")
	31	FILE_FORMAT_IMAGE_FORMAT_COVER, //
	32	@Meta(description = "How to save content images",//
	33	format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "JPG")
	34	FILE_FORMAT_IMAGE_FORMAT_CONTENT, //
	35
	36	@Meta(description = "Cache management",//
	37	group = true)
	38	CACHE, //
7cd006eb NR	39	@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",//
7cd006eb NR	40	format = Format.DIRECTORY, def = "tmp/")
08fe2e33	41	CACHE_DIR, //
b7cd9db8 NR	42	@Meta(description = "The delay in hours after which a cached resource that is thought to change ~often is considered too old and triggers a refresh delay (or 0 for no cache, or -1 for infinite time)", //
b7cd9db8 NR	43	format = Format.INT, def = "24")
08fe2e33	44	CACHE_MAX_TIME_CHANGING, //
b7cd9db8 NR	45	@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)", //
b7cd9db8 NR	46	format = Format.INT, def = "720")
08fe2e33	47	CACHE_MAX_TIME_STABLE, //
13fdb89a	48
7cd006eb NR	49	@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",//
7cd006eb NR	50	format = Format.DIRECTORY, def = "covers/")
08fe2e33	51	DEFAULT_COVERS_DIR, //
13fdb89a NR	52	@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",//
	53	format = Format.DIRECTORY, def = "$HOME/Books/")
	54	LIBRARY_DIR, //
b7cd9db8 NR	55	@Meta(description = "The default library to use (KEY:SERVER:PORT), or empty for the local library",//
b7cd9db8 NR	56	format = Format.STRING, def = "")
e023483b	57	DEFAULT_LIBRARY, //
13fdb89a NR	58
	59	@Meta(description = "Network configuration",//
	60	group = true)
	61	NETWORK, //
	62	@Meta(description = "The user-agent to use to download files",//
	63	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/)")
	64	NETWORK_USER_AGENT, //
	65	@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",//
	66	format = Format.STRING, def = "")
	67	NETWORK_PROXY, //
	68	@Meta(description = "If the last update check was done at least that many days ago, check for updates at startup (-1 for 'no checks')", //
	69	format = Format.INT, def = "1")
	70	NETWORK_UPDATE_INTERVAL, //
	71
	72	@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",//
	73	group = true)
	74	SERVER, //
b7cd9db8 NR	75	@Meta(description = "The port on which we can start the server (must be a valid port, from 1 to 65535)", //
b7cd9db8 NR	76	format = Format.INT, def = "58365")
fb25273c	77	SERVER_PORT, //
b7cd9db8 NR	78	@Meta(description = "The encryption key for the server (NOT including a subkey), it cannot contain the pipe character \"\|\" but can be empty (it is still encrypted, but with an empty, easy to guess key)",//
b7cd9db8 NR	79	format = Format.PASSWORD, def = "")
fb25273c	80	SERVER_KEY, //
b7cd9db8 NR	81	@Meta(description = "Allow write access to the clients (download story, move story...) without RW subkeys", //
b7cd9db8 NR	82	format = Format.BOOLEAN, def = "true")
fb25273c	83	SERVER_RW, //
b7cd9db8 NR	84	@Meta(description = "If not empty, only the EXACT listed sources will be available for clients without BL subkeys",//
b7cd9db8 NR	85	array = true, format = Format.STRING, def = "")
fb25273c	86	SERVER_WHITELIST, //
13fdb89a	87	@Meta(description = "The subkeys that the server will allow, including the modes\nA subkey ", //
b7cd9db8	88	array = true, format = Format.STRING, def = "")
fb25273c	89	SERVER_ALLOWED_SUBKEYS, //
13fdb89a NR	90
	91	@Meta(description = "DEBUG options",//
	92	group = true)
	93	DEBUG, //
b7cd9db8 NR	94	@Meta(description = "Show debug information on errors",//
b7cd9db8 NR	95	format = Format.BOOLEAN, def = "false")
08fe2e33	96	DEBUG_ERR, //
b7cd9db8 NR	97	@Meta(description = "Show debug trace information",//
b7cd9db8 NR	98	format = Format.BOOLEAN, def = "false")
a8209dd0	99	DEBUG_TRACE, //
13fdb89a NR	100
	101	@Meta(description = "Internal configuration\nThose options are internal to the program and should probably not be changed",//
	102	group = true)
	103	CONF, //
	104	@Meta(description = "LaTeX configuration",//
	105	group = true)
	106	CONF_LATEX_LANG, //
b7cd9db8 NR	107	@Meta(description = "LaTeX output language (full name) for \"English\"",//
b7cd9db8 NR	108	format = Format.STRING, def = "english")
13fdb89a	109	CONF_LATEX_LANG_EN, //
b7cd9db8 NR	110	@Meta(description = "LaTeX output language (full name) for \"French\"",//
b7cd9db8 NR	111	format = Format.STRING, def = "french")
13fdb89a	112	CONF_LATEX_LANG_FR, //
b7cd9db8 NR	113	@Meta(description = "other 'by' prefixes before author name, used to identify the author",//
b7cd9db8 NR	114	array = true, format = Format.STRING, def = "\"by\",\"par\",\"de\",\"©\",\"(c)\"")
13fdb89a	115	CONF_BYS, //
b7cd9db8 NR	116	@Meta(description = "List of languages codes used for chapter identification (should not be changed)", //
b7cd9db8 NR	117	array = true, format = Format.STRING, def = "\"EN\",\"FR\"")
13fdb89a	118	CONF_CHAPTER, //
b7cd9db8 NR	119	@Meta(description = "Chapter identification string in English, used to identify a starting chapter in text mode",//
b7cd9db8 NR	120	format = Format.STRING, def = "Chapter")
13fdb89a	121	CONF_CHAPTER_EN, //
b7cd9db8 NR	122	@Meta(description = "Chapter identification string in French, used to identify a starting chapter in text mode",//
b7cd9db8 NR	123	format = Format.STRING, def = "Chapitre")
13fdb89a NR	124	CONF_CHAPTER_FR, //
	125
	126	@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)",//
	127	group = true)
	128	LOGIN_YIFFSTAR, //
	129	@Meta(description = "Your YiffStar/SoFurry login",//
b7cd9db8	130	format = Format.STRING)
6e06d2cc	131	LOGIN_YIFFSTAR_USER, //
13fdb89a	132	@Meta(description = "Your YiffStar/SoFurry password",//
b7cd9db8	133	format = Format.PASSWORD)
6e06d2cc	134	LOGIN_YIFFSTAR_PASS, //
13fdb89a	135
b7cd9db8 NR	136	@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.",//
b7cd9db8 NR	137	group = true)
f59eafef	138	LOGIN_FIMFICTION_APIKEY, //
b7cd9db8 NR	139	@Meta(description = "The login of the API key used to create a new token from FimFiction", //
b7cd9db8 NR	140	format = Format.STRING)
315f14ae	141	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
b7cd9db8 NR	142	@Meta(description = "The password of the API key used to create a new token from FimFiction", //
b7cd9db8 NR	143	format = Format.PASSWORD)
315f14ae	144	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
b7cd9db8 NR	145	@Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping",//
b7cd9db8 NR	146	format = Format.BOOLEAN, def = "false")
315f14ae	147	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
b7cd9db8 NR	148	@Meta(description = "The token required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_* if you want to generate a new one from your own API key)", //
b7cd9db8 NR	149	format = Format.PASSWORD, def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D")
315f14ae	150	LOGIN_FIMFICTION_APIKEY_TOKEN, //
08fe2e33	151	}