| 1 |
package generic |
| 2 |
|
| 3 |
import ( |
| 4 |
"fmt" |
| 5 |
"net/url" |
| 6 |
|
| 7 |
"github.com/nicholas-fedor/shoutrrr/pkg/format" |
| 8 |
"github.com/nicholas-fedor/shoutrrr/pkg/services/standard" |
| 9 |
"github.com/nicholas-fedor/shoutrrr/pkg/types" |
| 10 |
) |
| 11 |
|
| 12 |
// Config holds settings for the generic notification service. |
| 13 |
type Config struct { |
| 14 |
standard.EnumlessConfig |
| 15 |
|
| 16 |
// The webhook URL to send notifications to |
| 17 |
webhookURL *url.URL |
| 18 |
// Custom HTTP headers to include in requests |
| 19 |
headers map[string]string |
| 20 |
// Additional data to include in JSON payloads |
| 21 |
extraData map[string]string |
| 22 |
ContentType string `default:"application/json" desc:"The default value of the Content-Type header (dynamically set based on payload format)" key:"contenttype"` |
| 23 |
DisableTLS bool `default:"No" key:"disabletls"` |
| 24 |
Template string ` desc:"The template used for creating the request payload" key:"template" optional:""` |
| 25 |
Title string `default:"" key:"title"` |
| 26 |
TitleKey string `default:"title" desc:"The key that will be used for the title value" key:"titlekey"` |
| 27 |
MessageKey string `default:"message" desc:"The key that will be used for the message value" key:"messagekey"` |
| 28 |
RequestMethod string `default:"POST" key:"method"` |
| 29 |
} |
| 30 |
|
| 31 |
// Scheme identifies this service in configuration URLs. |
| 32 |
const ( |
| 33 |
Scheme = "generic" |
| 34 |
DefaultWebhookScheme = "https" |
| 35 |
) |
| 36 |
|
| 37 |
// DefaultConfig creates a new Config with default values and its associated PropKeyResolver. |
| 38 |
func DefaultConfig() (*Config, format.PropKeyResolver) { |
| 39 |
// Initialize empty config |
| 40 |
config := &Config{} |
| 41 |
// Create property key resolver |
| 42 |
pkr := format.NewPropKeyResolver(config) |
| 43 |
// Set default properties from struct tags |
| 44 |
if err := pkr.SetDefaultProps(config); err != nil { |
| 45 |
panic(fmt.Sprintf("setting default properties: %v", err)) |
| 46 |
} |
| 47 |
|
| 48 |
return config, pkr |
| 49 |
} |
| 50 |
|
| 51 |
// ConfigFromWebhookURL constructs a Config from a parsed webhook URL. |
| 52 |
func ConfigFromWebhookURL(webhookURL *url.URL) (*Config, format.PropKeyResolver, error) { |
| 53 |
// Get default config and resolver |
| 54 |
config, pkr := DefaultConfig() |
| 55 |
|
| 56 |
// Extract query parameters |
| 57 |
webhookQuery := webhookURL.Query() |
| 58 |
// Extract custom headers and extra data |
| 59 |
headers, extraData := stripCustomQueryValues(webhookQuery) |
| 60 |
|
| 61 |
// Set config properties from remaining query params |
| 62 |
_, err := format.SetConfigPropsFromQuery(&pkr, webhookQuery) |
| 63 |
if err != nil { |
| 64 |
return nil, pkr, fmt.Errorf("setting config properties from query: %w", err) |
| 65 |
} |
| 66 |
|
| 67 |
// Update URL with modified query |
| 68 |
webhookURL.RawQuery = webhookQuery.Encode() |
| 69 |
// Assign webhook URL |
| 70 |
config.webhookURL = webhookURL |
| 71 |
// Assign extracted headers |
| 72 |
config.headers = headers |
| 73 |
// Assign extracted extra data |
| 74 |
config.extraData = extraData |
| 75 |
// Set TLS based on scheme |
| 76 |
config.DisableTLS = webhookURL.Scheme == "http" |
| 77 |
|
| 78 |
return config, pkr, nil |
| 79 |
} |
| 80 |
|
| 81 |
// GetURL generates a URL from the current configuration values. |
| 82 |
func (c *Config) GetURL() *url.URL { |
| 83 |
// Create resolver for this config |
| 84 |
resolver := format.NewPropKeyResolver(c) |
| 85 |
|
| 86 |
// Generate URL using resolver |
| 87 |
return c.getURL(&resolver) |
| 88 |
} |
| 89 |
|
| 90 |
// SetURL updates the configuration from a service URL. |
| 91 |
func (c *Config) SetURL(serviceURL *url.URL) error { |
| 92 |
// Create resolver for this config |
| 93 |
resolver := format.NewPropKeyResolver(c) |
| 94 |
|
| 95 |
// Parse and set URL |
| 96 |
return c.setURL(&resolver, serviceURL) |
| 97 |
} |
| 98 |
|
| 99 |
// WebhookURL returns the configured webhook URL, adjusted for TLS settings. |
| 100 |
func (c *Config) WebhookURL() *url.URL { |
| 101 |
// Copy the URL to modify |
| 102 |
webhookURL := *c.webhookURL |
| 103 |
// Set default HTTPS scheme |
| 104 |
webhookURL.Scheme = DefaultWebhookScheme |
| 105 |
|
| 106 |
if c.DisableTLS { |
| 107 |
// Use HTTP if TLS is disabled |
| 108 |
webhookURL.Scheme = "http" |
| 109 |
} |
| 110 |
|
| 111 |
return &webhookURL |
| 112 |
} |
| 113 |
|
| 114 |
// getURL generates a service URL from the configuration using the provided resolver. |
| 115 |
func (c *Config) getURL(resolver types.ConfigQueryResolver) *url.URL { |
| 116 |
// Copy webhook URL |
| 117 |
serviceURL := *c.webhookURL |
| 118 |
// Get existing query params |
| 119 |
webhookQuery := c.webhookURL.Query() |
| 120 |
// Build query with config fields |
| 121 |
serviceQuery := format.BuildQueryWithCustomFields(resolver, webhookQuery) |
| 122 |
// Add custom headers and extra data |
| 123 |
appendCustomQueryValues(serviceQuery, c.headers, c.extraData) |
| 124 |
// Encode the query |
| 125 |
serviceURL.RawQuery = serviceQuery.Encode() |
| 126 |
// Set service scheme |
| 127 |
serviceURL.Scheme = Scheme |
| 128 |
|
| 129 |
return &serviceURL |
| 130 |
} |
| 131 |
|
| 132 |
// setURL updates the configuration from a service URL using the provided resolver. |
| 133 |
func (c *Config) setURL(resolver types.ConfigQueryResolver, serviceURL *url.URL) error { |
| 134 |
// Copy service URL |
| 135 |
webhookURL := *serviceURL |
| 136 |
// Extract query parameters |
| 137 |
serviceQuery := serviceURL.Query() |
| 138 |
// Extract custom headers and extra data |
| 139 |
headers, extraData := stripCustomQueryValues(serviceQuery) |
| 140 |
|
| 141 |
// Set config properties from query |
| 142 |
customQuery, err := format.SetConfigPropsFromQuery(resolver, serviceQuery) |
| 143 |
if err != nil { |
| 144 |
return fmt.Errorf("setting config properties from service URL query: %w", err) |
| 145 |
} |
| 146 |
|
| 147 |
// Update URL with remaining query |
| 148 |
webhookURL.RawQuery = customQuery.Encode() |
| 149 |
// Assign webhook URL |
| 150 |
c.webhookURL = &webhookURL |
| 151 |
// Assign extracted headers |
| 152 |
c.headers = headers |
| 153 |
// Assign extracted extra data |
| 154 |
c.extraData = extraData |
| 155 |
|
| 156 |
return nil |
| 157 |
} |