1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-09-18 18:30:10 +00:00

change config-base format to allow easier parsing

*note*: only GetConfig has been changed for now.
the config now has "order" and "sections", and each section now has
"meta", "order" and "settings". This allows for the use of a struct for
loading in Go and less janky web code. Also now appears in swagger.
This commit is contained in:
Harvey Tindall 2021-01-02 21:24:26 +00:00
parent 8b2f6fbb8a
commit d629cae71e
Signed by: hrfee
GPG Key ID: BBC65952848FB1A2
6 changed files with 761 additions and 703 deletions

49
api.go
View File

@ -1072,13 +1072,14 @@ func (app *appContext) ApplySettings(gc *gin.Context) {
// @Summary Get jfa-go configuration. // @Summary Get jfa-go configuration.
// @Produce json // @Produce json
// @Success 200 {object} configDTO "Uses the same format as config-base.json" // @Success 200 {object} settings "Uses the same format as config-base.json"
// @Router /config [get] // @Router /config [get]
// @Security Bearer // @Security Bearer
// @tags Configuration // @tags Configuration
func (app *appContext) GetConfig(gc *gin.Context) { func (app *appContext) GetConfig(gc *gin.Context) {
app.info.Println("Config requested") app.info.Println("Config requested")
resp := map[string]interface{}{} resp := app.configBase
// Load language options
langPath := filepath.Join(app.localPath, "lang", "form") langPath := filepath.Join(app.localPath, "lang", "form")
app.lang.langFiles, _ = ioutil.ReadDir(langPath) app.lang.langFiles, _ = ioutil.ReadDir(langPath)
app.lang.langOptions = make([]string, len(app.lang.langFiles)) app.lang.langOptions = make([]string, len(app.lang.langFiles))
@ -1095,37 +1096,25 @@ func (app *appContext) GetConfig(gc *gin.Context) {
app.lang.langOptions[i] = meta.(map[string]interface{})["name"].(string) app.lang.langOptions[i] = meta.(map[string]interface{})["name"].(string)
} }
} }
for section, settings := range app.configBase { s := resp.Sections["ui"].Settings["language"]
if section == "order" { s.Options = app.lang.langOptions
resp[section] = settings.([]interface{}) s.Value = app.lang.langOptions[app.lang.chosenIndex]
} else { resp.Sections["ui"].Settings["language"] = s
resp[section] = make(map[string]interface{}) for sectName, section := range resp.Sections {
for key, values := range settings.(map[string]interface{}) { for settingName, setting := range section.Settings {
if key == "order" { val := app.config.Section(sectName).Key(settingName)
resp[section].(map[string]interface{})[key] = values.([]interface{}) s := resp.Sections[sectName].Settings[settingName]
} else { switch setting.Type {
resp[section].(map[string]interface{})[key] = values.(map[string]interface{}) case "text", "email", "select":
if key != "meta" { s.Value = val.MustString("")
dataType := resp[section].(map[string]interface{})[key].(map[string]interface{})["type"].(string) case "number":
configKey := app.config.Section(section).Key(key) s.Value = val.MustInt(0)
if dataType == "number" { case "bool":
if val, err := configKey.Int(); err == nil { s.Value = val.MustBool(false)
resp[section].(map[string]interface{})[key].(map[string]interface{})["value"] = val
}
} else if dataType == "bool" {
resp[section].(map[string]interface{})[key].(map[string]interface{})["value"] = configKey.MustBool(false)
} else if dataType == "select" && key == "language" {
resp[section].(map[string]interface{})[key].(map[string]interface{})["options"] = app.lang.langOptions
resp[section].(map[string]interface{})[key].(map[string]interface{})["value"] = app.lang.langOptions[app.lang.chosenIndex]
} else {
resp[section].(map[string]interface{})[key].(map[string]interface{})["value"] = configKey.String()
}
}
}
} }
resp.Sections[sectName].Settings[settingName] = s
} }
} }
// resp["jellyfin"].(map[string]interface{})["language"].(map[string]interface{})["options"].([]string)
gc.JSON(200, resp) gc.JSON(200, resp)
} }

File diff suppressed because it is too large Load Diff

View File

@ -9,17 +9,17 @@ args = parser.parse_args()
with open(args.input, 'r') as f: with open(args.input, 'r') as f:
config = json.load(f) config = json.load(f)
newconfig = {"order": []} newconfig = {"sections": {}, "order": []}
for sect in config: for sect in config["sections"]:
newconfig["order"].append(sect) newconfig["order"].append(sect)
newconfig[sect] = {} newconfig["sections"][sect] = {}
newconfig[sect]["order"] = [] newconfig["sections"][sect]["order"] = []
newconfig[sect]["meta"] = config[sect]["meta"] newconfig["sections"][sect]["meta"] = config["sections"][sect]["meta"]
for setting in config[sect]: newconfig["sections"][sect]["settings"] = {}
if setting != "meta": for setting in config["sections"][sect]["settings"]:
newconfig[sect]["order"].append(setting) newconfig["sections"][sect]["order"].append(setting)
newconfig[sect][setting] = config[sect][setting] newconfig["sections"][sect]["settings"][setting] = config["sections"][sect]["settings"][setting]
with open(args.output, 'w') as f: with open(args.output, 'w') as f:
f.write(json.dumps(newconfig, indent=4)) f.write(json.dumps(newconfig, indent=4))

View File

@ -14,18 +14,19 @@ def generate_ini(base_file, ini_file):
ini = configparser.RawConfigParser(allow_no_value=True) ini = configparser.RawConfigParser(allow_no_value=True)
for section in config_base: for section in config_base["sections"]:
ini.add_section(section) ini.add_section(section)
for entry in config_base[section]: if "meta" in config_base["sections"][section]:
if "description" in config_base[section][entry]: ini.set(section, "; " + config_base["sections"][section]["meta"]["description"])
ini.set(section, "; " + config_base[section][entry]["description"]) for entry in config_base["sections"][section]["settings"]:
if entry != "meta": if "description" in config_base["sections"][section]["settings"][entry]:
value = config_base[section][entry]["value"] ini.set(section, "; " + config_base["sections"][section]["settings"][entry]["description"])
if isinstance(value, bool): value = config_base["sections"][section]["settings"][entry]["value"]
value = str(value).lower() if isinstance(value, bool):
else: value = str(value).lower()
value = str(value) else:
ini.set(section, entry, value) value = str(value)
ini.set(section, entry, value)
with open(Path(ini_file), "w") as config_file: with open(Path(ini_file), "w") as config_file:
ini.write(config_file) ini.write(config_file)

View File

@ -48,7 +48,7 @@ type appContext struct {
config *ini.File config *ini.File
configPath string configPath string
configBasePath string configBasePath string
configBase map[string]interface{} configBase settings
dataPath string dataPath string
localPath string localPath string
cssFile string cssFile string

View File

@ -127,3 +127,32 @@ type errorListDTO map[string]map[string]string
type configDTO map[string]interface{} type configDTO map[string]interface{}
// Below are for sending config
type meta struct {
Name string `json:"name"`
Description string `json:"description"`
}
type setting struct {
Name string `json:"name"`
Description string `json:"description"`
Required bool `json:"required"`
RequiresRestart bool `json:"requires_restart"`
Type string `json:"type"` // Type (string, number, bool, etc.)
Value interface{} `json:"value"`
Options []string `json:"options,omitempty"`
DependsTrue string `json:"depends_true,omitempty"` // If specified, this field is enabled when the specified bool setting is enabled.
DependsFalse string `json:"depends_false,omitempty"` // If specified, opposite behaviour of DependsTrue.
}
type section struct {
Meta meta `json:"meta"`
Order []string `json:"order"`
Settings map[string]setting `json:"settings"`
}
type settings struct {
Order []string `json:"order"`
Sections map[string]section `json:"sections"`
}