File: ifttt_config.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,432 kB
  • sloc: sh: 74; makefile: 5
file content (107 lines) | stat: -rw-r--r-- 3,743 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
package ifttt

import (
	"errors"
	"fmt"
	"net/url"

	"github.com/nicholas-fedor/shoutrrr/pkg/format"
	"github.com/nicholas-fedor/shoutrrr/pkg/services/standard"
	"github.com/nicholas-fedor/shoutrrr/pkg/types"
)

const (
	Scheme              = "ifttt" // Scheme identifies this service in configuration URLs.
	DefaultMessageValue = 2       // Default value field (1-3) for the notification message
	DisabledValue       = 0       // Value to disable title assignment
	MinValueField       = 1       // Minimum valid value field (Value1)
	MaxValueField       = 3       // Maximum valid value field (Value3)
	MinLength           = 1       // Minimum length for required fields like Events and WebHookID
)

var (
	ErrInvalidMessageValue = errors.New(
		"invalid value for messagevalue: only values 1-3 are supported",
	)
	ErrInvalidTitleValue = errors.New(
		"invalid value for titlevalue: only values 1-3 or 0 (for disabling) are supported",
	)
	ErrTitleMessageConflict = errors.New("titlevalue cannot use the same number as messagevalue")
	ErrMissingEvents        = errors.New("events missing from config URL")
	ErrMissingWebhookID     = errors.New("webhook ID missing from config URL")
)

// Config holds settings for the IFTTT notification service.
type Config struct {
	standard.EnumlessConfig
	WebHookID         string   `required:"true" url:"host"`
	Events            []string `required:"true"            key:"events"`
	Value1            string   `                           key:"value1"       optional:""`
	Value2            string   `                           key:"value2"       optional:""`
	Value3            string   `                           key:"value3"       optional:""`
	UseMessageAsValue uint8    `                           key:"messagevalue"             default:"2" desc:"Sets the corresponding value field to the notification message"`
	UseTitleAsValue   uint8    `                           key:"titlevalue"               default:"0" desc:"Sets the corresponding value field to the notification title"`
	Title             string   `                           key:"title"                    default:""  desc:"Notification title, optionally set by the sender"`
}

// GetURL generates a URL from the current configuration values.
func (config *Config) GetURL() *url.URL {
	resolver := format.NewPropKeyResolver(config)

	return config.getURL(&resolver)
}

// SetURL updates the configuration from a URL representation.
func (config *Config) SetURL(url *url.URL) error {
	resolver := format.NewPropKeyResolver(config)

	return config.setURL(&resolver, url)
}

func (config *Config) getURL(resolver types.ConfigQueryResolver) *url.URL {
	return &url.URL{
		Host:     config.WebHookID,
		Path:     "/",
		Scheme:   Scheme,
		RawQuery: format.BuildQuery(resolver),
	}
}

func (config *Config) setURL(resolver types.ConfigQueryResolver, url *url.URL) error {
	if config.UseMessageAsValue == DisabledValue {
		config.UseMessageAsValue = DefaultMessageValue
	}

	config.WebHookID = url.Hostname()

	for key, vals := range url.Query() {
		if err := resolver.Set(key, vals[0]); err != nil {
			return fmt.Errorf("setting config property %q from URL query: %w", key, err)
		}
	}

	if config.UseMessageAsValue > MaxValueField || config.UseMessageAsValue < MinValueField {
		return ErrInvalidMessageValue
	}

	if config.UseTitleAsValue > MaxValueField {
		return ErrInvalidTitleValue
	}

	if config.UseTitleAsValue != DisabledValue &&
		config.UseTitleAsValue == config.UseMessageAsValue {
		return ErrTitleMessageConflict
	}

	if url.String() != "ifttt://dummy@dummy.com" {
		if len(config.Events) < MinLength {
			return ErrMissingEvents
		}

		if len(config.WebHookID) < MinLength {
			return ErrMissingWebhookID
		}
	}

	return nil
}