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.

api.go

@@ -1072,13 +1072,14 @@ func (app *appContext) ApplySettings(gc *gin.Context) {
 
 // @Summary Get jfa-go configuration.
 // @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]
 // @Security Bearer
 // @tags Configuration
 func (app *appContext) GetConfig(gc *gin.Context) {
 	app.info.Println("Config requested")
-	resp := map[string]interface{}{}
+	resp := app.configBase
+	// Load language options
 	langPath := filepath.Join(app.localPath, "lang", "form")
 	app.lang.langFiles, _ = ioutil.ReadDir(langPath)
 	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)
 		}
 	}
-	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.Sections[sectName].Settings[settingName] = s
-							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["jellyfin"].(map[string]interface{})["language"].(map[string]interface{})["options"].([]string)
 	gc.JSON(200, resp)
 }
 

config/config-base.json

@@ -1,9 +1,13 @@
 {
+    "order": [],
+    "sections": {
         "jellyfin": {
+            "order": [],
             "meta": {
                 "name": "Jellyfin",
                 "description": "Settings for connecting to Jellyfin"
             },
+            "settings": {
                 "username": {
                     "name": "Jellyfin Username",
                     "required": true,
@@ -51,12 +55,15 @@
                     "value": 30,
                     "description": "Timeout of user cache in minutes. Set to 0 to disable."
                 }
+            }
         },
         "ui": {
+            "order": [],
             "meta": {
                 "name": "General",
                 "description": "Settings related to the UI and program functionality."
             },
+            "settings": {
                 "language": {
                     "name": "Language",
                     "required": false,
@@ -188,12 +195,15 @@
                     "value": "",
                     "description": "URL base for when running jfa-go with a reverse proxy in a subfolder."
                 }
+            }
         },
         "password_validation": {
+            "order": [],
             "meta": {
                 "name": "Password Validation",
                 "description": "Password validation (minimum length, etc.)"
             },
+            "settings": {
                 "enabled": {
                     "name": "Enabled",
                     "required": false,
@@ -236,12 +246,15 @@
                     "type": "text",
                     "value": "0"
                 }
+            }
         },
         "email": {
+            "order": [],
             "meta": {
                 "name": "Email",
                 "description": "General email settings. Ignore if not using email features."
             },
+            "settings": {
                 "no_username": {
                     "name": "Use email addresses as username",
                     "required": false,
@@ -307,12 +320,15 @@
                     "value": "Jellyfin",
                     "description": "The name of the sender"
                 }
+            }
         },
         "password_resets": {
+            "order": [],
             "meta": {
                 "name": "Password Resets",
                 "description": "Settings for the password reset handler."
             },
+            "settings": {
                 "enabled": {
                     "name": "Enabled",
                     "required": false,
@@ -357,12 +373,15 @@
                     "value": "Password Reset - Jellyfin",
                     "description": "Subject of password reset emails."
                 }
+            }
         },
         "invite_emails": {
+            "order": [],
             "meta": {
                 "name": "Invite emails",
                 "description": "Settings for sending invites directly to users."
             },
+            "settings": {
                 "enabled": {
                     "name": "Enabled",
                     "required": false,
@@ -406,12 +425,15 @@
                     "value": "http://accounts.jellyf.in:8056/invite",
                     "description": "Base URL for jfa-go. This is necessary because using a reverse proxy means the program has no way of knowing the URL itself."
                 }
+            }
         },
         "notifications": {
+            "order": [],
             "meta": {
                 "name": "Notifications",
                 "description": "Notification related settings."
             },
+            "settings": {
                 "enabled": {
                     "name": "Enabled",
                     "required": "false",
@@ -456,12 +478,15 @@
                     "value": "",
                     "description": "Path to user creation notification email in plaintext."
                 }
+            }
         },
         "mailgun": {
+            "order": [],
             "meta": {
                 "name": "Mailgun (Email)",
                 "description": "Mailgun API connection settings"
             },
+            "settings": {
                 "api_url": {
                     "name": "API URL",
                     "required": false,
@@ -476,12 +501,15 @@
                     "type": "text",
                     "value": "your api key"
                 }
+            }
         },
         "smtp": {
+            "order": [],
             "meta": {
                 "name": "SMTP (Email)",
                 "description": "SMTP Server connection settings."
             },
+            "settings": {
                 "username": {
                     "name": "Username",
                     "required": false,
@@ -524,12 +552,15 @@
                     "type": "password",
                     "value": "smtp password"
                 }
+            }
         },
         "ombi": {
+            "order": [],
             "meta": {
                 "name": "Ombi Integration",
                 "description": "Connect to Ombi to automatically create both Ombi and Jellyfin accounts for new users. You'll need to create a user template for this to work. Once enabled, refresh to see an option in settings for this."
             },
+            "settings": {
                 "enabled": {
                     "name": "Enabled",
                     "required": false,
@@ -556,12 +587,15 @@
                     "depends_true": "enabled",
                     "description": "API Key. Get this from the first tab in Ombi settings."
                 }
+            }
         },
         "deletion": {
+            "order": [],
             "meta": {
                 "name": "Account Deletion",
                 "description": "Subject/email files for account deletion emails."
             },
+            "settings": {
                 "subject": {
                     "name": "Email subject",
                     "required": false,
@@ -586,12 +620,15 @@
                     "value": "",
                     "description": "Path to custom email in plain text"
                 }
+            }
         },
         "files": {
+            "order": [],
             "meta": {
                 "name": "File Storage",
                 "description": "Optional settings for changing storage locations."
             },
+            "settings": {
                 "invites": {
                     "name": "Invite Storage",
                     "required": false,
@@ -666,3 +703,5 @@
                 }
             }
         }
+    }
+}

config/fixconfig.py

@@ -9,17 +9,17 @@ args = parser.parse_args()
 with open(args.input, 'r') as f:
     config = json.load(f)
 
-newconfig = {"order": []}
+newconfig = {"sections": {}, "order": []}
 
-for sect in config:
+for sect in config["sections"]:
     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:
     f.write(json.dumps(newconfig, indent=4))

config/generate_ini.py

@@ -14,13 +14,14 @@ def generate_ini(base_file, ini_file):
 
     ini = configparser.RawConfigParser(allow_no_value=True)
 
-    for section in config_base:
+    for section in config_base["sections"]:
         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"])
+            value = config_base["sections"][section]["settings"][entry]["value"]
             if isinstance(value, bool):
                 value = str(value).lower()
             else:

main.go

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

models.go

@@ -127,3 +127,32 @@ type errorListDTO map[string]map[string]string
 
 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"`
+}