Add generic webhook integration

internal/crypto/crypto.go

@@ -4,6 +4,7 @@
 package crypto // import "miniflux.app/v2/internal/crypto"
 
 import (
+	"crypto/hmac"
 	"crypto/rand"
 	"crypto/sha256"
 	"encoding/base64"
@@ -48,3 +49,9 @@ func HashPassword(password string) (string, error) {
 	bytes, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
 	return string(bytes), err
 }
+
+func GenerateSHA256Hmac(secret string, data []byte) string {
+	h := hmac.New(sha256.New, []byte(secret))
+	h.Write(data)
+	return hex.EncodeToString(h.Sum(nil))
+}

internal/database/migrations.go

@@ -758,4 +758,13 @@ var migrations = []func(tx *sql.Tx) error{
 		`)
 		return err
 	},
+	func(tx *sql.Tx) (err error) {
+		sql := `
+			ALTER TABLE integrations ADD COLUMN webhook_enabled bool default 'f';
+			ALTER TABLE integrations ADD COLUMN webhook_url text default '';
+			ALTER TABLE integrations ADD COLUMN webhook_secret text default '';
+		`
+		_, err = tx.Exec(sql)
+		return err
+	},
 }

internal/integration/integration.go

@@ -19,6 +19,7 @@ import (
 	"miniflux.app/v2/internal/integration/shiori"
 	"miniflux.app/v2/internal/integration/telegrambot"
 	"miniflux.app/v2/internal/integration/wallabag"
+	"miniflux.app/v2/internal/integration/webhook"
 	"miniflux.app/v2/internal/logger"
 	"miniflux.app/v2/internal/model"
 )
@@ -168,45 +169,55 @@ func SendEntry(entry *model.Entry, integration *model.Integration) {
 	}
 }
 
-// PushEntries pushes an entry array to third-party providers during feed refreshes.
-func PushEntries(entries model.Entries, integration *model.Integration) {
-	if integration.MatrixBotEnabled {
-		logger.Debug("[Integration] Sending %d entries for User #%d to Matrix", len(entries), integration.UserID)
+// PushEntries pushes a list of entries to activated third-party providers during feed refreshes.
+func PushEntries(feed *model.Feed, entries model.Entries, userIntegrations *model.Integration) {
+	if userIntegrations.MatrixBotEnabled {
+		logger.Debug("[Integration] Sending %d entries for User #%d to Matrix", len(entries), userIntegrations.UserID)
 
-		err := matrixbot.PushEntries(entries, integration.MatrixBotURL, integration.MatrixBotUser, integration.MatrixBotPassword, integration.MatrixBotChatID)
+		err := matrixbot.PushEntries(entries, userIntegrations.MatrixBotURL, userIntegrations.MatrixBotUser, userIntegrations.MatrixBotPassword, userIntegrations.MatrixBotChatID)
 		if err != nil {
 			logger.Error("[Integration] push entries to matrix bot failed: %v", err)
 		}
 	}
-}
 
-// PushEntry pushes an entry to third-party providers during feed refreshes.
-func PushEntry(entry *model.Entry, feed *model.Feed, integration *model.Integration) {
-	if integration.TelegramBotEnabled {
-		logger.Debug("[Integration] Sending Entry %q for User #%d to Telegram", entry.URL, integration.UserID)
+	if userIntegrations.WebhookEnabled {
+		logger.Debug("[Integration] Sending %d entries for User #%d to Webhook URL: %s", len(entries), userIntegrations.UserID, userIntegrations.WebhookURL)
 
-		err := telegrambot.PushEntry(entry, integration.TelegramBotToken, integration.TelegramBotChatID)
-		if err != nil {
-			logger.Error("[Integration] push entry to telegram bot failed: %v", err)
+		webhookClient := webhook.NewClient(userIntegrations.WebhookURL, userIntegrations.WebhookSecret)
+		if err := webhookClient.SendWebhook(entries); err != nil {
+			logger.Error("[Integration] sending entries to webhook failed: %v", err)
 		}
 	}
-	if integration.AppriseEnabled {
-		logger.Debug("[Integration] Sending Entry %q for User #%d to apprise", entry.URL, integration.UserID)
-
-		var appriseServiceURLs string
-		if len(feed.AppriseServiceURLs) > 0 {
-			appriseServiceURLs = feed.AppriseServiceURLs
-		} else {
-			appriseServiceURLs = integration.AppriseServicesURL
-		}
-
-		client := apprise.NewClient(
-			appriseServiceURLs,
-			integration.AppriseURL,
-		)
 
-		if err := client.SendNotification(entry); err != nil {
-			logger.Error("[Integration] push entry to apprise failed: %v", err)
+	// Integrations that only support sending individual entries
+	if userIntegrations.TelegramBotEnabled || userIntegrations.AppriseEnabled {
+		for _, entry := range entries {
+			if userIntegrations.TelegramBotEnabled {
+				logger.Debug("[Integration] Sending Entry %q for User #%d to Telegram", entry.URL, userIntegrations.UserID)
+
+				err := telegrambot.PushEntry(entry, userIntegrations.TelegramBotToken, userIntegrations.TelegramBotChatID)
+				if err != nil {
+					logger.Error("[Integration] push entry to telegram bot failed: %v", err)
+				}
+			}
+
+			if userIntegrations.AppriseEnabled {
+				logger.Debug("[Integration] Sending Entry %q for User #%d to apprise", entry.URL, userIntegrations.UserID)
+
+				appriseServiceURLs := userIntegrations.AppriseURL
+				if feed.AppriseServiceURLs != "" {
+					appriseServiceURLs = feed.AppriseServiceURLs
+				}
+
+				client := apprise.NewClient(
+					userIntegrations.AppriseServicesURL,
+					appriseServiceURLs,
+				)
+
+				if err := client.SendNotification(entry); err != nil {
+					logger.Error("[Integration] push entry to apprise failed: %v", err)
+				}
+			}
 		}
 	}
 }

internal/integration/webhook/webhook.go

@@ -0,0 +1,64 @@
+// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package webhook // import "miniflux.app/v2/internal/integration/webhook"
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"time"
+
+	"miniflux.app/v2/internal/crypto"
+	"miniflux.app/v2/internal/model"
+	"miniflux.app/v2/internal/version"
+)
+
+const defaultClientTimeout = 10 * time.Second
+
+type Client struct {
+	webhookURL    string
+	webhookSecret string
+}
+
+func NewClient(webhookURL, webhookSecret string) *Client {
+	return &Client{webhookURL, webhookSecret}
+}
+
+func (c *Client) SendWebhook(entries model.Entries) error {
+	if c.webhookURL == "" {
+		return fmt.Errorf(`webhook: missing webhook URL`)
+	}
+
+	if len(entries) == 0 {
+		return nil
+	}
+
+	requestBody, err := json.Marshal(entries)
+	if err != nil {
+		return fmt.Errorf("webhook: unable to encode request body: %v", err)
+	}
+
+	request, err := http.NewRequest(http.MethodPost, c.webhookURL, bytes.NewReader(requestBody))
+	if err != nil {
+		return fmt.Errorf("webhook: unable to create request: %v", err)
+	}
+
+	request.Header.Set("Content-Type", "application/json")
+	request.Header.Set("User-Agent", "Miniflux/"+version.Version)
+	request.Header.Set("X-Miniflux-Signature", crypto.GenerateSHA256Hmac(c.webhookSecret, requestBody))
+
+	httpClient := &http.Client{Timeout: defaultClientTimeout}
+	response, err := httpClient.Do(request)
+	if err != nil {
+		return fmt.Errorf("webhook: unable to send request: %v", err)
+	}
+	defer response.Body.Close()
+
+	if response.StatusCode >= 400 {
+		return fmt.Errorf("webhook: incorrect response status code: url=%s status=%d", c.webhookURL, response.StatusCode)
+	}
+
+	return nil
+}

internal/locale/translations/de_DE.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API-Schlüsselbezeichnung",
     "form.submit.loading": "Lade...",
     "form.submit.saving": "Speichern...",

internal/locale/translations/el_EL.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Ετικέτα κλειδιού API",
     "form.submit.loading": "Φόρτωση...",
     "form.submit.saving": "Αποθήκευση...",

internal/locale/translations/en_US.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API Key Label",
     "form.submit.loading": "Loading…",
     "form.submit.saving": "Saving…",

internal/locale/translations/es_ES.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Etiqueta de clave API",
     "form.submit.loading": "Cargando...",
     "form.submit.saving": "Guardando...",

internal/locale/translations/fi_FI.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API Key Label",
     "form.submit.loading": "Ladataan...",
     "form.submit.saving": "Tallennetaan...",

internal/locale/translations/fr_FR.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Sauvegarder les articles vers Shaarli",
     "form.integration.shaarli_endpoint": "URL de l'API de Shaarli",
     "form.integration.shaarli_api_secret": "Clé d'API de Shaarli API",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Libellé de la clé d'API",
     "form.submit.loading": "Chargement...",
     "form.submit.saving": "Sauvegarde en cours...",

internal/locale/translations/hi_IN.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "एपीआई कुंजी लेबल",
     "form.submit.loading": "लोड हो रहा है...",
     "form.submit.saving": "सहेजा जा रहा है...",

internal/locale/translations/id_ID.json

@@ -386,6 +386,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Label Kunci API",
     "form.submit.loading": "Memuat...",
     "form.submit.saving": "Menyimpan...",

internal/locale/translations/it_IT.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Etichetta chiave API",
     "form.submit.loading": "Caricamento in corso...",
     "form.submit.saving": "Salvataggio in corso...",

internal/locale/translations/ja_JP.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API キーラベル",
     "form.submit.loading": "読み込み中…",
     "form.submit.saving": "保存中…",

internal/locale/translations/nl_NL.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API-sleutellabel",
     "form.submit.loading": "Laden...",
     "form.submit.saving": "Opslaag...",

internal/locale/translations/pl_PL.json

@@ -391,6 +391,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Etykieta klucza API",
     "form.submit.loading": "Ładowanie...",
     "form.submit.saving": "Zapisywanie...",

internal/locale/translations/pt_BR.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Etiqueta da chave de API",
     "form.submit.loading": "Carregando...",
     "form.submit.saving": "Salvando...",

internal/locale/translations/ru_RU.json

@@ -391,6 +391,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "Описание API-ключа",
     "form.submit.loading": "Загрузка…",
     "form.submit.saving": "Сохранение…",

internal/locale/translations/tr_TR.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API Anahtar Etiketi",
     "form.submit.loading": "Yükleniyor...",
     "form.submit.saving": "Kaydediliyor...",

internal/locale/translations/uk_UA.json

@@ -392,6 +392,9 @@
   "form.integration.shaarli_activate": "Save articles to Shaarli",
   "form.integration.shaarli_endpoint": "Shaarli URL",
   "form.integration.shaarli_api_secret": "Shaarli API Secret",
+  "form.integration.webhook_activate": "Enable Webhook",
+  "form.integration.webhook_url": "Webhook URL",
+  "form.integration.webhook_secret": "Webhook Secret",
   "form.api_key.label.description": "Назва ключа API",
   "form.submit.loading": "Завантаження...",
   "form.submit.saving": "Зберігаю...",

internal/locale/translations/zh_CN.json

@@ -387,6 +387,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API密钥标签",
     "form.submit.loading": "载入中…",
     "form.submit.saving": "保存中…",

internal/locale/translations/zh_TW.json

@@ -389,6 +389,9 @@
     "form.integration.shaarli_activate": "Save articles to Shaarli",
     "form.integration.shaarli_endpoint": "Shaarli URL",
     "form.integration.shaarli_api_secret": "Shaarli API Secret",
+    "form.integration.webhook_activate": "Enable Webhook",
+    "form.integration.webhook_url": "Webhook URL",
+    "form.integration.webhook_secret": "Webhook Secret",
     "form.api_key.label.description": "API金鑰標籤",
     "form.submit.loading": "載入中…",
     "form.submit.saving": "儲存中…",

internal/model/entry.go

@@ -39,6 +39,13 @@ type Entry struct {
 	Tags        []string      `json:"tags"`
 }
 
+func NewEntry() *Entry {
+	return &Entry{
+		Enclosures: make(EnclosureList, 0),
+		Tags:       make([]string, 0),
+	}
+}
+
 // Entries represents a list of entries.
 type Entries []*Entry
 

internal/model/integration.go

@@ -64,4 +64,7 @@ type Integration struct {
 	ShaarliEnabled       bool
 	ShaarliURL           string
 	ShaarliAPISecret     string
+	WebhookEnabled       bool
+	WebhookURL           string
+	WebhookSecret        string
 }