API: + GetPluginsForCategory, cleanup, linting, log fixes

Author: Jeffrey Buchbinder

TODO.md

@@ -17,7 +17,7 @@ This "TODO" list covers migration from the 0.5.x J2EE backend for implementation
 - [X] getOutputMonths
 - [X] getOutputYears
 - [x] getPlugins
-- [ ] getPluginOptions
+- [X] getPluginOptions
 - [X] getProtocolVersion
 - [x] getStatus
 - [x] insertPayload

api/api.go

@@ -3,6 +3,8 @@ package api
 import (
 	"net/http"
 
+	"slices"
+
 	"github.com/freemed/remitt-server/common"
 	"github.com/gin-gonic/gin"
 )
@@ -37,10 +39,8 @@ func (a Api) aclRequireRole(c *gin.Context, role string) {
 		c.AbortWithStatus(http.StatusNetworkAuthenticationRequired)
 	}
 
-	for _, x := range r.([]string) {
-		if x == role {
-			return
-		}
+	if slices.Contains(r.([]string), role) {
+		return
 	}
 	c.AbortWithStatus(http.StatusNetworkAuthenticationRequired)
 }
@@ -51,10 +51,5 @@ func (a Api) isAdmin(c *gin.Context) bool {
 		return false
 	}
 
-	for _, role := range r.([]string) {
-		if role == "admin" {
-			return true
-		}
-	}
-	return false
+	return slices.Contains(r.([]string), "admin")
 }

api/config.go

@@ -19,7 +19,7 @@ func init() {
 
 func (a Api) ConfigGetAll(c *gin.Context) {
 	user := c.MustGet(gin.AuthUserKey).(string)
-	tag := fmt.Sprintf("ConfigGetAll(%s): ", user)
+	tag := fmt.Sprintf("api.ConfigGetAll(%s): ", user)
 	o, err := model.GetConfigValues(user)
 	if err != nil {
 		log.Print(tag + err.Error())
@@ -36,7 +36,7 @@ func (a Api) ConfigSetValue(c *gin.Context) {
 	option := c.Param("option")
 	value := c.Param("value")
 
-	tag := fmt.Sprintf("ConfigSetValue(%s,%s,%s) [%s]: ", namespace, option, value, user)
+	tag := fmt.Sprintf("api.ConfigSetValue(%s,%s,%s) [%s]: ", namespace, option, value, user)
 
 	err := model.SetConfigValue(user, namespace, option, []byte(value))
 	if err != nil {

api/file.go

@@ -26,7 +26,7 @@ func (a Api) GetFile(c *gin.Context) {
 	category := c.Param("category")
 	filename := c.Param("filename")
 
-	tag := fmt.Sprintf("apiGetFile(%s,%s) [%s]: ", category, filename, user)
+	tag := fmt.Sprintf("api.GetFile(%s,%s) [%s]: ", category, filename, user)
 
 	if category == "" || filename == "" {
 		log.Print(tag + "Missing category or filename")
@@ -71,7 +71,7 @@ func (a Api) GetFileList(c *gin.Context) {
 	criteria := c.Param("criteria")
 	value := c.Param("value")
 
-	tag := fmt.Sprintf("apiGetFileList(%s,%s,%s) [%s]: ", category, criteria, value, user)
+	tag := fmt.Sprintf("api.GetFileList(%s,%s,%s) [%s]: ", category, criteria, value, user)
 
 	if category == "" || criteria == "" || value == "" {
 		log.Print(tag + "Missing category or criteria or value")
@@ -116,7 +116,7 @@ func (a Api) GetOutputMonths(c *gin.Context) {
 
 	year := c.Param("year")
 
-	tag := fmt.Sprintf("apiGetOutputMonths(%s) [%s]: ", year, user)
+	tag := fmt.Sprintf("api.GetOutputMonths(%s) [%s]: ", year, user)
 
 	if year == "" {
 		log.Print(tag + "Missing year")
@@ -143,7 +143,7 @@ func (a Api) GetOutputMonths(c *gin.Context) {
 func (a Api) GetOutputYears(c *gin.Context) {
 	user := c.MustGet(gin.AuthUserKey).(string)
 
-	tag := fmt.Sprintf("apiGetOutputYears() [%s]: ", user)
+	tag := fmt.Sprintf("api.GetOutputYears() [%s]: ", user)
 
 	query := "SELECT " +
 		"  DISTINCT(YEAR(stamp)) AS year " +

api/payload.go

@@ -29,7 +29,7 @@ func (a Api) PayloadInsert(c *gin.Context) {
 		TransportOption string           `json:"transport_option"`
 	}
 
-	tag := fmt.Sprintf("apiPayloadInsert() [%s]: ", user)
+	tag := fmt.Sprintf("api.PayloadInsert() [%s]: ", user)
 
 	var raw inputPayload
 	if c.BindJSON(&raw) != nil {
@@ -59,7 +59,7 @@ func (a Api) PayloadInsert(c *gin.Context) {
 func (a Api) PayloadResubmit(c *gin.Context) {
 	user := c.MustGet(gin.AuthUserKey).(string)
 
-	tag := fmt.Sprintf("apiPayloadResubmit() [%s]: ", user)
+	tag := fmt.Sprintf("api.PayloadResubmit() [%s]: ", user)
 
 	id, err := common.ParamInt(c, "id")
 	if err != nil {

api/plugins.go

@@ -12,15 +12,16 @@ import (
 
 func init() {
 	common.ApiMap["plugins"] = func(r *gin.RouterGroup) {
-		r.GET("/:category", a.PluginsGetAll)
+		r.GET("/get/:category", a.PluginsGetAll)
+		r.GET("/options/:plugin", a.PluginGetOptions)
 	}
 }
 
 func (a Api) PluginsGetAll(c *gin.Context) {
 	user := c.MustGet(gin.AuthUserKey).(string)
 	cat := c.Param("category")
 
-	tag := fmt.Sprintf("apiPluginsGetAll(%s) [%s]: ", cat, user)
+	tag := fmt.Sprintf("api.PluginsGetAll(%s) [%s]: ", cat, user)
 
 	switch cat {
 	case "validation":
@@ -44,3 +45,18 @@ func (a Api) PluginsGetAll(c *gin.Context) {
 	}
 	c.JSON(http.StatusOK, o)
 }
+
+func (a Api) PluginGetOptions(c *gin.Context) {
+	user := c.MustGet(gin.AuthUserKey).(string)
+	p := c.Param("plugin")
+
+	tag := fmt.Sprintf("api.PluginGetOptions(%s) [%s]: ", p, user)
+
+	o, err := model.GetPluginOptions(p)
+	if err != nil {
+		log.Print(tag + err.Error())
+		c.AbortWithError(http.StatusInternalServerError, err)
+		return
+	}
+	c.JSON(http.StatusOK, o)
+}

api/status.go

@@ -27,7 +27,7 @@ func (a Api) GetStatus(c *gin.Context) {
 
 	payloadID, err := common.ParamInt(c, "id")
 
-	tag := fmt.Sprintf("apiGetStatus(%d) [%s]: ", payloadID, user)
+	tag := fmt.Sprintf("api.GetStatus(%d) [%s]: ", payloadID, user)
 
 	if err != nil {
 		log.Print(tag + err.Error())
@@ -48,7 +48,7 @@ func (a Api) GetStatus(c *gin.Context) {
 func (a Api) GetBulkStatus(c *gin.Context) {
 	user := c.MustGet(gin.AuthUserKey).(string)
 
-	tag := fmt.Sprintf("apiGetBulkStatus() [%s]: ", user)
+	tag := fmt.Sprintf("api.GetBulkStatus() [%s]: ", user)
 
 	var ids []int64
 	err := c.BindJSON(&ids)

model/pluginoptions.go

@@ -1,7 +1,5 @@
 package model
 
-import ()
-
 const (
 	TABLE_PLUGIN_OPTIONS = "tPluginOptions"
 )
@@ -20,3 +18,9 @@ type PluginOptionsModel struct {
 func init() {
 	DbTables = append(DbTables, DbTable{TableName: TABLE_PLUGIN_OPTIONS, Obj: PluginOptionsModel{}, Key: ""})
 }
+
+func GetPluginOptions(plugin string) ([]PluginOptionsModel, error) {
+	var o []PluginOptionsModel
+	_, err := DbMap.Select(&o, "SELECT * FROM "+TABLE_PLUGIN_OPTIONS+" WHERE plugin = ?", plugin)
+	return o, err
+}