[nikiroo-utils.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 = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)")
	LANG, //
	@Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = {
			"CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories")
	READER_TYPE, //
	@Meta(def = "INFO_TEXT", format = Format.COMBO_LIST, list = { "INFO_TEXT",
			"EPUB", "HTML", "TEXT" }, info = "One of the known output type", description = "The type of output for the Local Reader for non-images documents")
	NON_IMAGES_DOCUMENT_TYPE, //
	@Meta(def = "CBZ", format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, description = "The type of output for the Local Reader for images documents")
	IMAGES_DOCUMENT_TYPE, //
	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
	CACHE_DIR, //
	@Meta(def = "24", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
	CACHE_MAX_TIME_CHANGING, //
	@Meta(def = "720", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
	CACHE_MAX_TIME_STABLE, //
	@Meta(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)", description = "string", info = "The user-agent to use to download files")
	USER_AGENT, //
	@Meta(def = "$HOME/.fanfix/covers/", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers")
	DEFAULT_COVERS_DIR, //
	@Meta(description = "string", info = "The default library to use (KEY:SERVER:PORT), or empty for the local library")
	DEFAULT_LIBRARY, //
	@Meta(def = "$HOME/Books", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
	LIBRARY_DIR, //
	@Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
	DEBUG_ERR, //
	@Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug trace information")
	DEBUG_TRACE, //
	@Meta(def = "PNG", description = "image format", format = Format.COMBO_LIST, list = {
			"PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
	IMAGE_FORMAT_COVER, //
	@Meta(def = "JPG", description = "image format", format = Format.COMBO_LIST, list = {
			"PNG", "JPG", "BMP" }, info = "Image format to use for content images")
	IMAGE_FORMAT_CONTENT, //
	@Meta(group = true)
	LATEX_LANG, //
	@Meta(def = "english", description = "LaTeX output language: English", info = "LaTeX full name")
	LATEX_LANG_EN, //
	@Meta(def = "french", description = "LaTeX output language: French", info = "LaTeX full name")
	LATEX_LANG_FR, //
	@Meta(def = "by,par,de,©,(c)", description = "other 'by' prefixes before author name, used to identify the author", array = true)
	BYS, //
	@Meta(def = "EN,FR", description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
	CHAPTER, //
	@Meta(def = "Chapter", description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
	CHAPTER_EN, //
	@Meta(def = "Chapitre", description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
	CHAPTER_FR, //
	@Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
	LOGIN_YIFFSTAR_USER, //
	@Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
	LOGIN_YIFFSTAR_PASS, //
	@Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT)
	UPDATE_INTERVAL, //
	@Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
	@Meta(description = "An API key required to create a 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 (default is false, use API if token or ID present)", format = Format.BOOLEAN)
	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
	@Meta(def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D", description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
	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 {
ce788468	13	@Meta(description = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)")
08fe2e33	14	LANG, //
c1873e56 NR	15	@Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = {
c1873e56 NR	16	"CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories")
3727aae2	17	READER_TYPE, //
ae78e517 NR	18	@Meta(def = "INFO_TEXT", format = Format.COMBO_LIST, list = { "INFO_TEXT",
ae78e517 NR	19	"EPUB", "HTML", "TEXT" }, info = "One of the known output type", description = "The type of output for the Local Reader for non-images documents")
e604986c	20	NON_IMAGES_DOCUMENT_TYPE, //
ae78e517	21	@Meta(def = "CBZ", format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, description = "The type of output for the Local Reader for images documents")
e604986c	22	IMAGES_DOCUMENT_TYPE, //
ce788468	23	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
08fe2e33	24	CACHE_DIR, //
ae78e517	25	@Meta(def = "24", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
08fe2e33	26	CACHE_MAX_TIME_CHANGING, //
ae78e517	27	@Meta(def = "720", description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
08fe2e33	28	CACHE_MAX_TIME_STABLE, //
ae78e517	29	@Meta(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)", description = "string", info = "The user-agent to use to download files")
08fe2e33	30	USER_AGENT, //
51c5d9a7	31	@Meta(def = "$HOME/.fanfix/covers/", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers")
08fe2e33	32	DEFAULT_COVERS_DIR, //
e023483b NR	33	@Meta(description = "string", info = "The default library to use (KEY:SERVER:PORT), or empty for the local library")
e023483b NR	34	DEFAULT_LIBRARY, //
ae78e517	35	@Meta(def = "$HOME/Books", description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
08fe2e33	36	LIBRARY_DIR, //
ae78e517	37	@Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
08fe2e33	38	DEBUG_ERR, //
ae78e517	39	@Meta(def = "false", description = "boolean", format = Format.BOOLEAN, info = "Show debug trace information")
a8209dd0	40	DEBUG_TRACE, //
ae78e517	41	@Meta(def = "PNG", description = "image format", format = Format.COMBO_LIST, list = {
ce788468	42	"PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
08fe2e33	43	IMAGE_FORMAT_COVER, //
ae78e517	44	@Meta(def = "JPG", description = "image format", format = Format.COMBO_LIST, list = {
ce788468	45	"PNG", "JPG", "BMP" }, info = "Image format to use for content images")
08fe2e33	46	IMAGE_FORMAT_CONTENT, //
ce788468	47	@Meta(group = true)
08fe2e33	48	LATEX_LANG, //
ae78e517	49	@Meta(def = "english", description = "LaTeX output language: English", info = "LaTeX full name")
08fe2e33	50	LATEX_LANG_EN, //
ae78e517	51	@Meta(def = "french", description = "LaTeX output language: French", info = "LaTeX full name")
08fe2e33	52	LATEX_LANG_FR, //
ae78e517	53	@Meta(def = "by,par,de,©,(c)", description = "other 'by' prefixes before author name, used to identify the author", array = true)
08fe2e33	54	BYS, //
ae78e517	55	@Meta(def = "EN,FR", description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
08fe2e33	56	CHAPTER, //
ae78e517	57	@Meta(def = "Chapter", description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
08fe2e33	58	CHAPTER_EN, //
ae78e517	59	@Meta(def = "Chapitre", description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
08fe2e33	60	CHAPTER_FR, //
ce788468	61	@Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
6e06d2cc	62	LOGIN_YIFFSTAR_USER, //
ce788468	63	@Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
6e06d2cc	64	LOGIN_YIFFSTAR_PASS, //
ce788468	65	@Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT)
315f14ae NR	66	UPDATE_INTERVAL, //
	67	@Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
	68	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
	69	@Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD)
	70	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
a8209dd0	71	@Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping (default is false, use API if token or ID present)", format = Format.BOOLEAN)
315f14ae	72	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
ae78e517	73	@Meta(def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D", description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
315f14ae	74	LOGIN_FIMFICTION_APIKEY_TOKEN, //
08fe2e33	75	}