From 026b644630d3b9823be59e0de2d337dc7071b0d5 Mon Sep 17 00:00:00 2001 From: Ralph Ocdol Date: Fri, 28 Feb 2025 08:48:07 +0800 Subject: [PATCH] feat: add parameters and array parameters support --- docs/configuration.md | 12 ++++++++ internal/glance/widget-custom-api.go | 42 +++++++++++++++++++++++----- 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 231c04c..3c5dcc4 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1294,6 +1294,7 @@ Examples: | headers | key (string) & value (string) | no | | | frameless | boolean | no | false | | template | string | yes | | +| parameters | key & value | no | | ##### `url` The URL to fetch the data from. It must be accessible from the server that Glance is running on. @@ -1313,6 +1314,17 @@ When set to `true`, removes the border and padding around the widget. ##### `template` The template that will be used to display the data. It relies on Go's `html/template` package so it's recommended to go through [its documentation](https://pkg.go.dev/text/template) to understand how to do basic things such as conditionals, loops, etc. In addition, it also uses [tidwall's gjson](https://github.com/tidwall/gjson) package to parse the JSON data so it's worth going through its documentation if you want to use more advanced JSON selectors. You can view additional examples with explanations and function definitions [here](custom-api.md). +##### `parameters` +A list of keys and values that will be sent to the custom-api as query paramters. + +```yaml +parameters: + param1: value1 + param2: + - item1 + - item2 +``` + ### Extension Display a widget provided by an external source (3rd party). If you want to learn more about developing extensions, checkout the [extensions documentation](extensions.md) (WIP). diff --git a/internal/glance/widget-custom-api.go b/internal/glance/widget-custom-api.go index 197ba68..6866c1e 100644 --- a/internal/glance/widget-custom-api.go +++ b/internal/glance/widget-custom-api.go @@ -10,6 +10,7 @@ import ( "log/slog" "math" "net/http" + "net/url" "time" "github.com/tidwall/gjson" @@ -19,13 +20,14 @@ var customAPIWidgetTemplate = mustParseTemplate("custom-api.html", "widget-base. type customAPIWidget struct { widgetBase `yaml:",inline"` - URL string `yaml:"url"` - Template string `yaml:"template"` - Frameless bool `yaml:"frameless"` - Headers map[string]string `yaml:"headers"` - APIRequest *http.Request `yaml:"-"` - compiledTemplate *template.Template `yaml:"-"` - CompiledHTML template.HTML `yaml:"-"` + URL string `yaml:"url"` + Template string `yaml:"template"` + Frameless bool `yaml:"frameless"` + Headers map[string]string `yaml:"headers"` + Parameters map[string]interface{} `yaml:"parameters"` + APIRequest *http.Request `yaml:"-"` + compiledTemplate *template.Template `yaml:"-"` + CompiledHTML template.HTML `yaml:"-"` } func (widget *customAPIWidget) initialize() error { @@ -51,6 +53,32 @@ func (widget *customAPIWidget) initialize() error { return err } + query := url.Values{} + + for key, value := range widget.Parameters { + switch v := value.(type) { + case string: + query.Add(key, v) + case int, int8, int16, int32, int64, float32, float64: + query.Add(key, fmt.Sprintf("%v", v)) + case []string: + for _, item := range v { + query.Add(key, item) + } + case []interface{}: + for _, item := range v { + switch item := item.(type) { + case string: + query.Add(key, item) + case int, int8, int16, int32, int64, float32, float64: + query.Add(key, fmt.Sprintf("%v", item)) + } + } + } + } + + req.URL.RawQuery = query.Encode() + for key, value := range widget.Headers { req.Header.Add(key, value) }