implement webhook feature (#165)

TimothyYe · web-flow · commit 5621ec6b2bb3 · 2022-07-10T22:50:28.000+08:00
* move lib

* add webhook lib

* add webhook setting

* add webhook test case

* add webhook test case

* implement the webhook execute function

* update test case

* update webhook

* update test case

* update README

* update README

* update README

* update settings
diff --git a/README.md b/README.md
@@ -53,6 +53,7 @@ Currently supports updating A records for subdomains. Doesn't support updating o
     - [Slack](#slack)
     - [Discord](#discord)
     - [Pushover](#pushover)
+  - [Webhook](#webhook)
   - [Miscellaneous topics](#miscellaneous-topics)
     - [IPv6 support](#ipv6-support)
     - [Network interface IP address](#network-interface-ip-address)
@@ -645,6 +646,51 @@ The `message_template` property supports [html](https://pushover.net/api#html) i
 If the `device` and `title` parameters are left empty, Pushover will choose defaults [see](https://pushover.net/api#messages). More details on the priority parameter
 can be found on the Pushover [API description](https://pushover.net/api#priority).
 
+### Webhook
+
+Webhook is another feature that GoDNS provides to deliver notifications to the other applications while the IP is changed. GoDNS delivers a notification to the target URL via an HTTP `GET` or `POST` request.
+
+The configuration section `webhook` is used for customizing the webhook request. In general, there are 2 fields used for the webhook request:
+
+>* `url`: The target URL for sending webhook request.
+>* `request_body`: The content for sending `POST` request, if this field is empty, a HTTP GET request will be sent instead of the HTTP POST request.
+
+Available variables:
+>* `Domain`: The current domain.
+>* `IP`: The new IP address.
+>* `IPType`: The type of the IP: `IPV4` or `IPV6`.
+
+#### Webhook with HTTP GET reqeust
+
+```json
+"webhook": {
+  "enabled": true,
+  "url": "http://localhost:5000/api/v1/send?domain={{.Domain}}&ip={{.CurrentIP}}&ip_type={{.IPType}}",
+  "request_body": ""
+}
+```
+
+For this example, a webhook with query string parameters will be sent to the target URL:  
+```
+http://localhost:5000/api/v1/send?domain=ddns.example.com&ip=192.168.1.1&ip_type=IPV4
+```
+
+#### Webhook with HTTP POST request
+
+```json
+"webhook": {
+  "enabled": true,
+  "url": "http://localhost:5000/api/v1/send",
+  "request_body": "{ \"domain\": \"{{.Domain}}\", \"ip\": \"{{.CurrentIP}}\", \"ip_type\": \"{{.IPType}}\" }"
+}
+```
+
+For this example, a webhook will be triggered when the IP changes, the target URL `http://localhost:5000/api/v1/send` will receive an `HTTP POST` request with request body:
+
+```json
+{ "domain": "ddns.example.com", "ip": "192.168.1.1", "ip_type": "IPV4" }
+```
+
 ### Miscellaneous topics
 
 #### IPv6 support
diff --git a/configs/config_sample.json b/configs/config_sample.json
@@ -44,5 +44,10 @@
       "smtp_port": 25,
       "send_to": ""
     }
+  },
+  "webhook": {
+    "enabled": false,
+    "url": "http://localhost:5000/api/v1/send",
+    "request_body": "{ \"domain\": \"{{.Domain}}\", \"ip\": \"{{.CurrentIP}}\", \"ip_type\": \"{{.IPType}}\" }"
   }
 }
diff --git a/configs/config_sample.yaml b/configs/config_sample.yaml
@@ -30,4 +30,7 @@ notify:
     smtp_password:
     smtp_port: 25
     send_to:
-
+webhook:
+  enabled: false
+  url: "http://localhost:5000/api/v1/send"
+  request_body: "{ \"domain\": \"{{.Domain}}\", \"ip\": \"{{.CurrentIP}}\", \"ip_type\": \"{{.IPType}}\" }"
diff --git a/internal/handler/handler.go b/internal/handler/handler.go
@@ -11,6 +11,7 @@ import (
 
 	"github.com/TimothyYe/godns/internal/settings"
 	"github.com/TimothyYe/godns/internal/utils"
+	"github.com/TimothyYe/godns/pkg/lib"
 	"github.com/TimothyYe/godns/pkg/notification"
 )
 
@@ -90,6 +91,13 @@ func (handler *Handler) updateDNS(domain *settings.Domain, ip string) error {
 
 			successMessage := fmt.Sprintf("%s.%s", subdomainName, domain.DomainName)
 			handler.notificationManager.Send(successMessage, ip)
+
+			// execute webhook when it is enabled
+			if handler.Configuration.Webhook.Enabled {
+				if err := lib.GetWebhook(handler.Configuration).Execute(hostname, ip); err != nil {
+					return err
+				}
+			}
 		}
 	}
 
diff --git a/internal/provider/cloudflare/cloudflare_handler.go b/internal/provider/cloudflare/cloudflare_handler.go
@@ -124,7 +124,7 @@ func recordTracked(domain *settings.Domain, record *DNSRecord) bool {
 
 // Create a new request with auth in place and optional proxy.
 func (provider *DNSProvider) newRequest(method, url string, body io.Reader) (*http.Request, *http.Client) {
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	if client == nil {
 		log.Info("cannot create HTTP client")
 	}
diff --git a/internal/provider/dnspod/dnspod_provider.go b/internal/provider/dnspod/dnspod_provider.go
@@ -213,7 +213,7 @@ func (provider *DNSProvider) updateIP(domainID int64, subDomainID string, subDom
 
 // postData post data and invoke DNSPod API.
 func (provider *DNSProvider) postData(url string, content url.Values) (string, error) {
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 
 	if client == nil {
 		return "", errors.New("failed to create HTTP client")
diff --git a/internal/provider/dreamhost/dreamhost_handler.go b/internal/provider/dreamhost/dreamhost_handler.go
@@ -85,7 +85,7 @@ func (provider *DNSProvider) updateDNS(dns, ip, hostname, action string) error {
 		return fmt.Errorf("unknown action: %s", action)
 	}
 
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	req, _ := http.NewRequest("POST", URL, strings.NewReader(values.Encode()))
 	req.SetBasicAuth(provider.configuration.Email, provider.configuration.Password)
 
diff --git a/internal/provider/duck/duck_handler.go b/internal/provider/duck/duck_handler.go
@@ -39,7 +39,7 @@ func (provider *DNSProvider) updateIP(domainName, subdomainName, currentIP strin
 		ip = fmt.Sprintf("ipv6=%s", currentIP)
 	}
 
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 
 	// update IP with HTTP GET request
 	resp, err := client.Get(fmt.Sprintf(URL, subdomainName, provider.configuration.LoginToken, ip))
diff --git a/internal/provider/dynv6/dynv6_handler.go b/internal/provider/dynv6/dynv6_handler.go
@@ -29,7 +29,7 @@ func (provider *DNSProvider) Init(conf *settings.Settings) {
 
 func (provider *DNSProvider) UpdateIP(domainName, subdomainName, ip string) error {
 	hostname := subdomainName + "." + domainName
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	return provider.update(client, hostname, ip)
 }
 
diff --git a/internal/provider/google/google_handler.go b/internal/provider/google/google_handler.go
@@ -33,7 +33,7 @@ func (provider *DNSProvider) UpdateIP(domainName, subdomainName, ip string) erro
 
 // updateIP update subdomain with current IP.
 func (provider *DNSProvider) updateIP(domain, subDomain, currentIP string) error {
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	resp, err := client.Get(fmt.Sprintf(URL,
 		provider.configuration.Email,
 		provider.configuration.Password,
diff --git a/internal/provider/he/he_handler.go b/internal/provider/he/he_handler.go
@@ -43,7 +43,7 @@ func (provider *DNSProvider) updateIP(domain, subDomain, currentIP string) error
 	values.Add("password", provider.configuration.Password)
 	values.Add("myip", currentIP)
 
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 
 	req, _ := http.NewRequest("POST", URL, strings.NewReader(values.Encode()))
 	resp, err := client.Do(req)
diff --git a/internal/provider/noip/noip_handler.go b/internal/provider/noip/noip_handler.go
@@ -29,7 +29,7 @@ func (provider *DNSProvider) Init(conf *settings.Settings) {
 
 func (provider *DNSProvider) UpdateIP(domainName, subdomainName, ip string) error {
 	hostname := subdomainName + "." + domainName
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	return provider.update(client, hostname, subdomainName, ip)
 }
 
diff --git a/internal/provider/scaleway/scaleway_handler.go b/internal/provider/scaleway/scaleway_handler.go
@@ -111,7 +111,7 @@ func (provider *DNSProvider) updateIP(domain, subDomain, currentIP string) error
 		req.Header.Add("User-Agent", provider.configuration.UserAgent)
 	}
 
-	client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)
+	client := utils.GetHTTPClient(provider.configuration)
 	log.Debugf("Requesting update for '%s.%s': '%v'", subDomain, domain, reqBody)
 	resp, err := client.Do(req)
 	if err != nil {
diff --git a/internal/settings/settings.go b/internal/settings/settings.go
@@ -87,6 +87,13 @@ type Notify struct {
 	Pushover PushoverNotify `json:"pushover" yaml:"pushover"`
 }
 
+// Webhook struct.
+type Webhook struct {
+	Enabled     bool   `json:"enabled" yaml:"enabled"`
+	URL         string `json:"url" yaml:"url"`
+	RequestBody string `json:"request_body" yaml:"request_body"`
+}
+
 // Settings struct.
 type Settings struct {
 	Provider       string   `json:"provider" yaml:"provider"`
@@ -102,6 +109,7 @@ type Settings struct {
 	UserAgent      string   `json:"user_agent,omitempty" yaml:"user_agent,omitempty"`
 	Socks5Proxy    string   `json:"socks5_proxy" yaml:"socks5_proxy"`
 	Notify         Notify   `json:"notify" yaml:"notify"`
+	Webhook        Webhook  `json:"webhook,omitempty" yaml:"webhook,omitempty"`
 	IPInterface    string   `json:"ip_interface" yaml:"ip_interface"`
 	IPType         string   `json:"ip_type" yaml:"ip_type"`
 	Resolver       string   `json:"resolver" yaml:"resolver"`
diff --git a/internal/utils/http.go b/internal/utils/http.go
@@ -14,12 +14,12 @@ import (
 )
 
 // GetHTTPClient creates the HTTP client and return it.
-func GetHTTPClient(conf *settings.Settings, useProxy bool) *http.Client {
+func GetHTTPClient(conf *settings.Settings) *http.Client {
 	client := &http.Client{
 		Timeout: time.Second * defaultTimeout,
 	}
 
-	if useProxy && conf.Socks5Proxy != "" {
+	if conf.UseProxy && conf.Socks5Proxy != "" {
 		log.Debug("use socks5 proxy:" + conf.Socks5Proxy)
 		dialer, err := proxy.SOCKS5("tcp", conf.Socks5Proxy, nil, proxy.Direct)
 		if err != nil {
diff --git a/pkg/lib/safe_go.go b/pkg/lib/safe_go.go
diff --git a/pkg/lib/webhook.go b/pkg/lib/webhook.go
@@ -0,0 +1,143 @@
+package lib
+
+import (
+	"bytes"
+	"io/ioutil"
+	"net/http"
+	"strings"
+	"sync"
+	"text/template"
+
+	"github.com/TimothyYe/godns/internal/settings"
+	"github.com/TimothyYe/godns/internal/utils"
+	log "github.com/sirupsen/logrus"
+)
+
+type Webhook struct {
+	conf   *settings.Settings
+	client *http.Client
+}
+
+var (
+	instance *Webhook
+	once     sync.Once
+)
+
+func GetWebhook(conf *settings.Settings) *Webhook {
+	once.Do(func() {
+		instance = &Webhook{
+			conf:   conf,
+			client: utils.GetHTTPClient(conf),
+		}
+	})
+
+	return instance
+}
+
+func (w *Webhook) Execute(domain, currentIP string) error {
+	if w.conf.Webhook.URL == "" {
+		log.Debug("Webhook URL is empty, skip sending notification")
+		return nil
+	}
+
+	// set request method
+	method := http.MethodGet
+	if w.conf.Webhook.RequestBody != "" {
+		method = http.MethodPost
+	}
+
+	reqURL, reqBody := "", ""
+	var err error
+	// send HTTP get request
+	if method == http.MethodGet {
+		reqURL, err = w.buildReqURL(domain, currentIP, w.conf.IPType)
+		if err != nil {
+			return err
+		}
+	} else {
+		reqURL = w.conf.Webhook.URL
+		reqBody, err = w.buildReqBody(domain, currentIP, w.conf.IPType)
+		if err != nil {
+			return err
+		}
+	}
+
+	var req *http.Request
+	req, err = http.NewRequest(method, reqURL, strings.NewReader(reqBody))
+	if err != nil {
+		log.Error("Failed to create request:", err)
+		return err
+	}
+
+	if method == http.MethodPost {
+		req.Header.Add("Content-Type", "application/json")
+	}
+
+	resp, err := w.client.Do(req)
+	if err != nil {
+		log.Error("Failed to send request:", err)
+		return err
+	}
+
+	defer resp.Body.Close()
+	bytes, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		log.Error("Failed to read response body:", err)
+		return err
+	}
+
+	log.Debugf("Webhook response: %s", string(bytes))
+	return nil
+}
+
+func (w *Webhook) buildReqURL(domain, currentIP, ipType string) (string, error) {
+	t := template.New("req template")
+	if _, err := t.Parse(w.conf.Webhook.URL); err != nil {
+		log.Error("Failed to parse template:", err)
+		return "", err
+	}
+
+	data := struct {
+		CurrentIP string
+		Domain    string
+		IPType    string
+	}{
+		currentIP,
+		domain,
+		ipType,
+	}
+
+	var tpl bytes.Buffer
+	if err := t.Execute(&tpl, data); err != nil {
+		log.Error(err)
+		return "", err
+	}
+
+	return tpl.String(), nil
+}
+
+func (w *Webhook) buildReqBody(domain, currentIP, ipType string) (string, error) {
+	t := template.New("reqBody template")
+	if _, err := t.Parse(w.conf.Webhook.RequestBody); err != nil {
+		log.Error("Failed to parse template:", err)
+		return "", err
+	}
+
+	data := struct {
+		CurrentIP string
+		Domain    string
+		IPType    string
+	}{
+		currentIP,
+		domain,
+		ipType,
+	}
+
+	var tpl bytes.Buffer
+	if err := t.Execute(&tpl, data); err != nil {
+		log.Error(err)
+		return "", err
+	}
+
+	return tpl.String(), nil
+}
diff --git a/pkg/lib/webhook_test.go b/pkg/lib/webhook_test.go
diff --git a/pkg/notification/manager.go b/pkg/notification/manager.go
diff --git a/pkg/notification/pushover.go b/pkg/notification/pushover.go
diff --git a/pkg/notification/slack.go b/pkg/notification/slack.go
diff --git a/pkg/notification/telegram.go b/pkg/notification/telegram.go

Original file line number	Diff line number	Diff line change
`@@ -44,5 +44,10 @@`
`44`	`44`	`"smtp_port": 25,`
`45`	`45`	`"send_to": ""`
`46`	`46`	`}`
	`47`	`+ },`
	`48`	`+ "webhook": {`
	`49`	`+ "enabled": false,`
	`50`	`+ "url": "http://localhost:5000/api/v1/send",`
	`51`	`+ "request_body": "{ \"domain\": \"{{.Domain}}\", \"ip\": \"{{.CurrentIP}}\", \"ip_type\": \"{{.IPType}}\" }"`
`47`	`52`	`}`
`48`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ import (`
`11`	`11`
`12`	`12`	`"github.com/TimothyYe/godns/internal/settings"`
`13`	`13`	`"github.com/TimothyYe/godns/internal/utils"`
	`14`	`+ "github.com/TimothyYe/godns/pkg/lib"`
`14`	`15`	`"github.com/TimothyYe/godns/pkg/notification"`
`15`	`16`	`)`
`16`	`17`
`@@ -90,6 +91,13 @@ func (handler Handler) updateDNS(domain settings.Domain, ip string) error {`
`90`	`91`
`91`	`92`	`successMessage := fmt.Sprintf("%s.%s", subdomainName, domain.DomainName)`
`92`	`93`	`handler.notificationManager.Send(successMessage, ip)`
	`94`	`+`
	`95`	`+ // execute webhook when it is enabled`
	`96`	`+ if handler.Configuration.Webhook.Enabled {`
	`97`	`+ if err := lib.GetWebhook(handler.Configuration).Execute(hostname, ip); err != nil {`
	`98`	`+ return err`
	`99`	`+ }`
	`100`	`+ }`
`93`	`101`	`}`
`94`	`102`	`}`
`95`	`103`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func recordTracked(domain settings.Domain, record DNSRecord) bool {`
`124`	`124`
`125`	`125`	`// Create a new request with auth in place and optional proxy.`
`126`	`126`	`func (provider DNSProvider) newRequest(method, url string, body io.Reader) (http.Request, *http.Client) {`
`127`		`- client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)`
	`127`	`+ client := utils.GetHTTPClient(provider.configuration)`
`128`	`128`	`if client == nil {`
`129`	`129`	`log.Info("cannot create HTTP client")`
`130`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ func (provider *DNSProvider) updateDNS(dns, ip, hostname, action string) error {`
`85`	`85`	`return fmt.Errorf("unknown action: %s", action)`
`86`	`86`	`}`
`87`	`87`
`88`		`- client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)`
	`88`	`+ client := utils.GetHTTPClient(provider.configuration)`
`89`	`89`	`req, _ := http.NewRequest("POST", URL, strings.NewReader(values.Encode()))`
`90`	`90`	`req.SetBasicAuth(provider.configuration.Email, provider.configuration.Password)`
`91`	`91`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func (provider *DNSProvider) updateIP(domainName, subdomainName, currentIP strin`
`39`	`39`	`ip = fmt.Sprintf("ipv6=%s", currentIP)`
`40`	`40`	`}`
`41`	`41`
`42`		`- client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)`
	`42`	`+ client := utils.GetHTTPClient(provider.configuration)`
`43`	`43`
`44`	`44`	`// update IP with HTTP GET request`
`45`	`45`	`resp, err := client.Get(fmt.Sprintf(URL, subdomainName, provider.configuration.LoginToken, ip))`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ func (provider DNSProvider) Init(conf settings.Settings) {`
`29`	`29`
`30`	`30`	`func (provider *DNSProvider) UpdateIP(domainName, subdomainName, ip string) error {`
`31`	`31`	`hostname := subdomainName + "." + domainName`
`32`		`- client := utils.GetHTTPClient(provider.configuration, provider.configuration.UseProxy)`
	`32`	`+ client := utils.GetHTTPClient(provider.configuration)`
`33`	`33`	`return provider.update(client, hostname, ip)`
`34`	`34`	`}`
`35`	`35`