diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 00000000..2b17da01 Binary files /dev/null and b/.DS_Store differ diff --git a/xExtension-Webhook/README.md b/xExtension-Webhook/README.md index 5f3f7573..7c5ed4d9 100644 --- a/xExtension-Webhook/README.md +++ b/xExtension-Webhook/README.md @@ -12,9 +12,13 @@ A powerful FreshRSS extension that automatically sends webhook notifications whe - **Multiple HTTP Methods**: Supports GET, POST, PUT, DELETE, PATCH, OPTIONS, and HEAD - **Configurable Formats**: Send data as JSON or form-encoded - **Template System**: Customizable webhook payloads with placeholders -- **Comprehensive Logging**: Detailed logging for debugging and monitoring +- **Update-aware Filters**: Ignore updates to existing entries to avoid duplicate notifications +- **Two Matching Modes**: Keep simple global matching or switch to field-specific advanced matching +- **Comprehensive Logging**: Optional, privacy-aware logging for debugging and monitoring +- **Test Functionality**: Built-in “Save and send test request” button to verify configuration instantly +- **Thumbnail Placeholder**: Populate payloads with `__THUMBNAIL_URL__` for embeds and cards +- **Plaintext Content**: Use `__CONTENT_PLAINTEXT__` for trimmed, tag-free notifications - **Error Handling**: Robust error handling with graceful fallbacks -- **Test Functionality**: Built-in test feature to verify webhook configuration ## 📋 Requirements @@ -51,14 +55,26 @@ your-project-name - **Search in Feed**: Match keywords in feed names - **Search in Authors**: Match keywords in author names - **Search in Content**: Match keywords in article content +- **Ignore Updated Entries**: Skip webhooks when an existing entry is updated +- **Mark as Read**: Automatically mark matched entries as read after the webhook is sent + +#### Matching Modes + +- **Basic Matching**: One keyword list, plus shared search scopes (title/feed/authors/content) +- **Advanced Matching**: Four dedicated keyword lists so each field has its own patterns #### Webhook Settings - **Webhook URL**: Your webhook endpoint URL -- **HTTP Method**: Choose from GET, POST, PUT, DELETE, etc. +- **HTTP Method**: Choose from GET, POST, PUT, DELETE, PATCH, OPTIONS, or HEAD - **Body Type**: JSON or Form-encoded - **Headers**: Custom HTTP headers (one per line) +### Logging & Testing + +- **Enable Logging**: Toggle HTTP request/response logging (writes to FreshRSS logs) +- **Save and Send Test Request**: Saves the configuration and immediately sends a test payload using the provided settings + ### Webhook Body Template Customize the webhook payload using placeholders: @@ -84,10 +100,12 @@ Customize the webhook payload using placeholders: | `__FEED__` | Feed name | | `__URL__` | Article URL | | `__CONTENT__` | Article content | +| `__CONTENT_PLAINTEXT__` | HTML-free excerpt (trimmed to ~360 characters) | | `__DATE__` | Publication date | | `__DATE_TIMESTAMP__` | Unix timestamp | | `__AUTHORS__` | Article authors | | `__TAGS__` | Article tags | +| `__THUMBNAIL_URL__` | First enclosure thumbnail or article thumbnail | ## 🎯 Use Cases @@ -205,6 +223,20 @@ Enable logging in the extension settings to see detailed information about: ## 📝 Changelog +### Version 0.3.0 + +- Added matching modes: `Basic` (existing behavior) and `Advanced` (field-specific keyword lists) +- Added advanced keyword groups for title, feed, authors, and content +- Improved configuration model to support both matching strategies cleanly +- Updated configuration UI and documentation for the new matching workflow + +### Version 0.2.0 + +- Added `__CONTENT_PLAINTEXT__` placeholder (HTML stripped and length-limited for notifications) +- Added support for `__THUMBNAIL_URL__` placeholder +- Improved webhook request handling for headers, methods, and body encoding +- Added options for "Ignore updated entries" and explicit logging toggle + ### Version 0.1.1 - Initial release diff --git a/xExtension-Webhook/configure.phtml b/xExtension-Webhook/configure.phtml index 824f0099..f25e2ad3 100644 --- a/xExtension-Webhook/configure.phtml +++ b/xExtension-Webhook/configure.phtml @@ -10,8 +10,26 @@ declare(strict_types=1);
⚙️ -
- +
+ + +
+ +
+ +
+ +
+
+ +

@@ -25,8 +43,8 @@ declare(strict_types=1);
-
- +
+
@@ -52,17 +70,57 @@ declare(strict_types=1);
+
-
-
- +

+ + +
+ +
+ +
+
+ +
+ +
+ +
+
+ +
+ +
+ +
+
+ +
+ +
+ +
+
+ +
+
attributeBool('mark_as_read') ? 'checked="checked"' : '' ?> />
+
+ +
+ attributeBool('ignore_updated') ? 'checked="checked"' : '' ?> /> + +
+
+
@@ -78,9 +136,8 @@ declare(strict_types=1);
@@ -120,6 +177,10 @@ declare(strict_types=1); __CONTENT__ + + __CONTENT_PLAINTEXT__ + + __DATE__ @@ -182,6 +243,15 @@ declare(strict_types=1);
+ +
+ +
+ attributeBool('enable_logging') ? 'checked="checked"' : '' ?> /> + +
+
@@ -192,7 +262,9 @@ declare(strict_types=1);
- +
diff --git a/xExtension-Webhook/extension.php b/xExtension-Webhook/extension.php index 598a989a..4b87118d 100644 --- a/xExtension-Webhook/extension.php +++ b/xExtension-Webhook/extension.php @@ -2,452 +2,1051 @@ declare(strict_types=1); -include __DIR__ . "/request.php"; +include __DIR__ . '/request.php'; /** - * Enumeration for HTTP request body types - * - * Defines the supported content types for webhook request bodies. + * Enumeration for HTTP request body types. */ enum BODY_TYPE: string { - case JSON = "json"; - case FORM = "form"; + case JSON = 'json'; + case FORM = 'form'; } /** - * Enumeration for HTTP methods - * - * Defines the supported HTTP methods for webhook requests. + * Enumeration for HTTP methods. */ enum HTTP_METHOD: string { - case GET = "GET"; - case POST = "POST"; - case PUT = "PUT"; - case DELETE = "DELETE"; - case PATCH = "PATCH"; - case OPTIONS = "OPTIONS"; - case HEAD = "HEAD"; + case GET = 'GET'; + case POST = 'POST'; + case PUT = 'PUT'; + case DELETE = 'DELETE'; + case PATCH = 'PATCH'; + case OPTIONS = 'OPTIONS'; + case HEAD = 'HEAD'; } /** * FreshRSS Webhook Extension * - * This extension allows sending webhook notifications when RSS entries match - * specified keywords. It supports pattern matching in titles, feeds, authors, - * and content, with configurable HTTP methods and request formats. + * Sends configurable webhook requests whenever new entries match the + * configured keyword filters. * - * @author Lukas Melega, Ryahn - * @version 0.1.1 + * @author Lukas Melega, Ryahn, onlymykazari + * @version 0.3.0 * @since FreshRSS 1.20.0 */ -class WebhookExtension extends Minz_Extension { - /** - * Whether logging is enabled for this extension - * - * @var bool - */ - public bool $logsEnabled = false; - - /** - * Default HTTP method for webhook requests - * - * @var HTTP_METHOD - */ - public HTTP_METHOD $webhook_method = HTTP_METHOD::POST; - - /** - * Default body type for webhook requests - * - * @var BODY_TYPE - */ - public BODY_TYPE $webhook_body_type = BODY_TYPE::JSON; - - /** - * Default webhook URL - * - * @var string - */ - public string $webhook_url = "http://"; - - /** - * Default HTTP headers for webhook requests - * - * @var string[] - */ - public array $webhook_headers = ["User-Agent: FreshRSS", "Content-Type: application/x-www-form-urlencoded"]; - - /** - * Default webhook request body template - * - * Supports placeholders like __TITLE__, __FEED__, __URL__, etc. - * - * @var string - */ - public string $webhook_body = '{ + final class WebhookExtension extends Minz_Extension { + private const DEFAULT_URL = 'http://'; + /** @var list */ + private const DEFAULT_HEADERS = [ + 'User-Agent: FreshRSS', + 'Content-Type: application/json', + ]; + private const DEFAULT_BODY_TEMPLATE = '{ "title": "__TITLE__", "feed": "__FEED__", "url": "__URL__", "created": "__DATE_TIMESTAMP__" }'; + private const DEFAULT_METHOD = HTTP_METHOD::POST; + private const DEFAULT_BODY_TYPE = BODY_TYPE::JSON; + private const MATCH_MODE_BASIC = 'basic'; + private const MATCH_MODE_ADVANCED = 'advanced'; + private const JSON_LOG_FLAGS = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE; + private const PLAINTEXT_MAX_LENGTH = 360; + + private bool $logsEnabled = false; - /** - * Initialize the extension - * - * Registers translation files and hooks into FreshRSS entry processing. - * - * @return void - */ #[\Override] public function init(): void { $this->registerTranslates(); - $this->registerHook("entry_before_insert", [$this, "processArticle"]); + $this->ensureConfigurationDefaults(); + $this->registerHook('entry_before_insert', [$this, 'processArticle']); } /** - * Handle configuration form submission - * - * Processes configuration form data, saves settings, and optionally - * sends a test webhook request. - * - * @return void * @throws Minz_PermissionDeniedException */ + #[\Override] public function handleConfigureAction(): void { $this->registerTranslates(); - if (Minz_Request::isPost()) { - $conf = [ - "keywords" => array_filter(Minz_Request::paramTextToArray("keywords")), - "search_in_title" => Minz_Request::paramString("search_in_title"), - "search_in_feed" => Minz_Request::paramString("search_in_feed"), - "search_in_authors" => Minz_Request::paramString("search_in_authors"), - "search_in_content" => Minz_Request::paramString("search_in_content"), - "mark_as_read" => Minz_Request::paramBoolean("mark_as_read"), - "ignore_updated" => Minz_Request::paramBoolean("ignore_updated"), - - "webhook_url" => Minz_Request::paramString("webhook_url"), - "webhook_method" => Minz_Request::paramString("webhook_method"), - "webhook_headers" => array_filter(Minz_Request::paramTextToArray("webhook_headers")), - "webhook_body" => html_entity_decode(Minz_Request::paramString("webhook_body")), - "webhook_body_type" => Minz_Request::paramString("webhook_body_type"), - "enable_logging" => Minz_Request::paramBoolean("enable_logging"), - ]; - $this->setSystemConfiguration($conf); - $logsEnabled = $conf["enable_logging"]; - $this->logsEnabled = $conf["enable_logging"]; - - logWarning($logsEnabled, "saved config: ✅ " . json_encode($conf)); - - if (Minz_Request::paramString("test_request")) { - try { - sendReq( - $conf["webhook_url"], - $conf["webhook_method"], - $conf["webhook_body_type"], - $conf["webhook_body"], - $conf["webhook_headers"], - $conf["enable_logging"], - "Test request from configuration" - ); - } catch (Throwable $err) { - logError($logsEnabled, "Test request failed: {$err->getMessage()}"); - } - } + if (!Minz_Request::isPost()) { + return; + } + + $userConf = $this->getUserConf(); + if ($userConf === null) { + throw new Minz_PermissionDeniedException('Webhook configuration requires an authenticated user.'); + } + + $config = $this->collectConfigurationFromRequest(); + + foreach ($config as $key => $value) { + $userConf->_attribute($key, $value); + } + + $userConf->save(); + + $this->logsEnabled = $config['enable_logging']; + + $loggable = $config; + $loggable['webhook_body'] = '[redacted]'; + logWarning( + $this->logsEnabled, + 'Webhook configuration saved: ' . json_encode($loggable, self::JSON_LOG_FLAGS) + ); + + if ($this->shouldSendTestRequest()) { + $this->sendTestRequestSafely($config); } } /** - * Process article and send webhook if patterns match - * - * Analyzes RSS entries against configured keyword patterns and sends - * webhook notifications for matching entries. Supports pattern matching - * in titles, feeds, authors, and content. - * - * @param FreshRSS_Entry $entry The RSS entry to process - * - * @throws FreshRSS_Context_Exception - * @throws Minz_PermissionDeniedException - * - * @return FreshRSS_Entry The processed entry (potentially marked as read) + * Process article and send webhook if patterns match. */ - public function processArticle($entry): FreshRSS_Entry { - if (!is_object($entry)) { + public function processArticle(FreshRSS_Entry $entry): FreshRSS_Entry { + $config = $this->getSnapshot(); + if ($config === null) { return $entry; } - if (FreshRSS_Context::userConf()->attributeBool('ignore_updated') && $entry->isUpdated()) { - logWarning(true, "⚠️ ignore_updated: " . $entry->link() . " ♦♦ " . $entry->title()); + $this->logsEnabled = $config['enable_logging']; + + if ($config['ignore_updated'] && $entry->isUpdated()) { + logWarning( + $this->logsEnabled, + 'Ignoring updated entry: ' . $entry->link() . ' ♦ ' . $entry->title() + ); return $entry; } - $searchInTitle = FreshRSS_Context::userConf()->attributeBool('search_in_title') ?? false; - $searchInFeed = FreshRSS_Context::userConf()->attributeBool('search_in_feed') ?? false; - $searchInAuthors = FreshRSS_Context::userConf()->attributeBool('search_in_authors') ?? false; - $searchInContent = FreshRSS_Context::userConf()->attributeBool('search_in_content') ?? false; + if (!$this->hasConfiguredKeywords($config)) { + logWarning($this->logsEnabled, 'No keywords defined in Webhook extension settings.'); + return $entry; + } - $patterns = FreshRSS_Context::userConf()->attributeArray('keywords') ?? []; - $markAsRead = FreshRSS_Context::userConf()->attributeBool('mark_as_read') ?? false; - $logsEnabled = FreshRSS_Context::userConf()->attributeBool('enable_logging') ?? false; - $this->logsEnabled = $logsEnabled; + $matchLog = $config['match_mode'] === self::MATCH_MODE_ADVANCED + ? $this->findMatchLogAdvanced($entry, $config) + : $this->findMatchLogBasic($entry, $config); - // Validate patterns - if (!is_array($patterns) || empty($patterns)) { - logError($logsEnabled, "❗️ No keywords defined in Webhook extension settings."); + if ($matchLog === null) { return $entry; } - $title = "❗️NOT INITIALIZED"; - $link = "❗️NOT INITIALIZED"; - $additionalLog = ""; + if ($config['mark_as_read']) { + $entry->_isRead(true); + } - try { - $title = $entry->title(); - $link = $entry->link(); - - foreach ($patterns as $pattern) { - $matchFound = false; - - if ($searchInTitle && $this->isPatternFound("/{$pattern}/", $title)) { - logWarning($logsEnabled, "matched item by title ✔️ \"{$title}\" ❖ link: {$link}"); - $additionalLog = "✔️ matched item with pattern: /{$pattern}/ ❖ title \"{$title}\" ❖ link: {$link}"; - $matchFound = true; - } - - if (!$matchFound && $searchInFeed && is_object($entry->feed()) && $this->isPatternFound("/{$pattern}/", $entry->feed()->name())) { - logWarning($logsEnabled, "matched item with pattern: /{$pattern}/ ❖ feed \"{$entry->feed()->name()}\", (title: \"{$title}\") ❖ link: {$link}"); - $additionalLog = "✔️ matched item with pattern: /{$pattern}/ ❖ feed \"{$entry->feed()->name()}\", (title: \"{$title}\") ❖ link: {$link}"; - $matchFound = true; - } - - if (!$matchFound && $searchInAuthors && $this->isPatternFound("/{$pattern}/", $entry->authors(true))) { - logWarning($logsEnabled, "✔️ matched item with pattern: /{$pattern}/ ❖ authors \"{$entry->authors(true)}\", (title: {$title}) ❖ link: {$link}"); - $additionalLog = "✔️ matched item with pattern: /{$pattern}/ ❖ authors \"{$entry->authors(true)}\", (title: {$title}) ❖ link: {$link}"; - $matchFound = true; - } - - if (!$matchFound && $searchInContent && $this->isPatternFound("/{$pattern}/", $entry->content())) { - logWarning($logsEnabled, "✔️ matched item with pattern: /{$pattern}/ ❖ content (title: \"{$title}\") ❖ link: {$link}"); - $additionalLog = "✔️ matched item with pattern: /{$pattern}/ ❖ content (title: \"{$title}\") ❖ link: {$link}"; - $matchFound = true; - } - - if ($matchFound) { - break; - } + $this->sendArticle($entry, $matchLog, $config); + + return $entry; + } + + /** + * Try to find a pattern that matches this entry in basic mode. + * + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config + */ + private function findMatchLogBasic(FreshRSS_Entry $entry, array $config): ?string { + $patterns = $config['keywords']; + if ($patterns === []) { + return null; + } + + $title = $entry->title(); + $link = $entry->link(); + $feed = $entry->feed(); + $feedName = $feed instanceof FreshRSS_Feed ? $feed->name() : ''; + $authors = trim($entry->authors(true)); + $content = $entry->content(); + + foreach ($patterns as $pattern) { + $normalizedPattern = $this->normalizePattern($pattern); + if ($normalizedPattern === null) { + continue; + } + + if ($config['search_in_title'] && $this->isPatternFound($normalizedPattern, $title, $pattern)) { + return "Matched by title ⮕ pattern: {$pattern} ♦ title: {$title} ♦ link: {$link}"; } - if ($markAsRead) { - $entry->_isRead($markAsRead); + if ( + $config['search_in_feed'] + && $feedName !== '' + && $this->isPatternFound($normalizedPattern, $feedName, $pattern) + ) { + return "Matched by feed ⮕ pattern: {$pattern} ♦ feed: {$feedName} ♦ link: {$link}"; } - // Only send webhook if a pattern was matched - if (!empty($additionalLog)) { - $this->sendArticle($entry, $additionalLog); + if ( + $config['search_in_authors'] + && $authors !== '' + && $this->isPatternFound($normalizedPattern, $authors, $pattern) + ) { + return "Matched by authors ⮕ pattern: {$pattern} ♦ authors: {$authors} ♦ link: {$link}"; } - } catch (Throwable $err) { - logError($logsEnabled, "Error during processing article ({$link} ❖ \"{$title}\") ERROR: {$err->getMessage()}"); + if ( + $config['search_in_content'] + && $content !== '' + && $this->isPatternFound($normalizedPattern, $content, $pattern) + ) { + return "Matched by content ⮕ pattern: {$pattern} ♦ title: {$title} ♦ link: {$link}"; + } } - return $entry; + return null; } /** - * Send article data via webhook - * - * Prepares and sends webhook notification with article data. - * Replaces template placeholders with actual entry values. + * Try to find a pattern that matches this entry in advanced mode. * - * @param FreshRSS_Entry $entry The RSS entry to send - * @param string $additionalLog Additional context for logging - * - * @throws Minz_PermissionDeniedException + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config + */ + private function findMatchLogAdvanced(FreshRSS_Entry $entry, array $config): ?string { + $title = $entry->title(); + $link = $entry->link(); + $feed = $entry->feed(); + $feedName = $feed instanceof FreshRSS_Feed ? $feed->name() : ''; + $authors = trim($entry->authors(true)); + $content = $entry->content(); + + foreach ($config['keywords_title'] as $pattern) { + $normalizedPattern = $this->normalizePattern($pattern); + if ($normalizedPattern !== null && $this->isPatternFound($normalizedPattern, $title, $pattern)) { + return "Matched by title ⮕ pattern: {$pattern} ♦ title: {$title} ♦ link: {$link}"; + } + } + + foreach ($config['keywords_feed'] as $pattern) { + $normalizedPattern = $this->normalizePattern($pattern); + if ( + $normalizedPattern !== null + && $feedName !== '' + && $this->isPatternFound($normalizedPattern, $feedName, $pattern) + ) { + return "Matched by feed ⮕ pattern: {$pattern} ♦ feed: {$feedName} ♦ link: {$link}"; + } + } + + foreach ($config['keywords_authors'] as $pattern) { + $normalizedPattern = $this->normalizePattern($pattern); + if ( + $normalizedPattern !== null + && $authors !== '' + && $this->isPatternFound($normalizedPattern, $authors, $pattern) + ) { + return "Matched by authors ⮕ pattern: {$pattern} ♦ authors: {$authors} ♦ link: {$link}"; + } + } + + foreach ($config['keywords_content'] as $pattern) { + $normalizedPattern = $this->normalizePattern($pattern); + if ( + $normalizedPattern !== null + && $content !== '' + && $this->isPatternFound($normalizedPattern, $content, $pattern) + ) { + return "Matched by content ⮕ pattern: {$pattern} ♦ title: {$title} ♦ link: {$link}"; + } + } + + return null; + } + + /** + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config + */ + private function hasConfiguredKeywords(array $config): bool { + if ($config['match_mode'] === self::MATCH_MODE_ADVANCED) { + return $config['keywords_title'] !== [] + || $config['keywords_feed'] !== [] + || $config['keywords_authors'] !== [] + || $config['keywords_content'] !== []; + } + + return $config['keywords'] !== []; + } + + /** + * Send article data via webhook. * - * @return void + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config */ - private function sendArticle(FreshRSS_Entry $entry, string $additionalLog = ""): void { + private function sendArticle(FreshRSS_Entry $entry, string $additionalLog, array $config): void { try { - $bodyStr = FreshRSS_Context::userConf()->attributeString('webhook_body'); - - // Replace placeholders with actual values - $replacements = [ - "__TITLE__" => $this->toSafeJsonStr($entry->title()), - "__FEED__" => $this->toSafeJsonStr($entry->feed()->name()), - "__URL__" => $this->toSafeJsonStr($entry->link()), - "__CONTENT__" => $this->toSafeJsonStr($entry->content()), - "__DATE__" => $this->toSafeJsonStr($entry->date()), - "__DATE_TIMESTAMP__" => $this->toSafeJsonStr($entry->date(true)), - "__AUTHORS__" => $this->toSafeJsonStr($entry->authors(true)), - "__TAGS__" => $this->toSafeJsonStr($entry->tags(true)), - ]; - - $bodyStr = str_replace(array_keys($replacements), array_values($replacements), $bodyStr); + $bodyTemplate = $config['webhook_body']; + $replacements = $this->buildReplacements($entry); + $body = str_replace(array_keys($replacements), array_values($replacements), $bodyTemplate); sendReq( - FreshRSS_Context::userConf()->attributeString('webhook_url'), - FreshRSS_Context::userConf()->attributeString('webhook_method'), - FreshRSS_Context::userConf()->attributeString('webhook_body_type'), - $bodyStr, - FreshRSS_Context::userConf()->attributeArray('webhook_headers'), - FreshRSS_Context::userConf()->attributeBool('enable_logging'), + $config['webhook_url'], + $config['webhook_method'], + $config['webhook_body_type'], + $body, + $config['webhook_headers'], + $config['enable_logging'], $additionalLog, ); - } catch (Throwable $err) { - logError($this->logsEnabled, "ERROR in sendArticle: {$err->getMessage()}"); + } catch (RuntimeException|InvalidArgumentException|JsonException $err) { + logError($this->logsEnabled, 'sendArticle error: ' . $err->getMessage()); } } /** - * Convert string/int to safe JSON string + * Send a manual test request using configuration data. * - * Sanitizes input values for safe inclusion in JSON payloads - * by removing quotes and decoding HTML entities. + * @throws InvalidArgumentException + * @throws JsonException + * @throws RuntimeException * - * @param string|int $str Input value to sanitize + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config + */ + private function sendTestRequest(array $config): void { + sendReq( + $config['webhook_url'], + $config['webhook_method'], + $config['webhook_body_type'], + $config['webhook_body'], + $config['webhook_headers'], + $config['enable_logging'], + 'Test request from configuration', + ); + } + + /** + * Keep configuration save path resilient even when test webhook fails. * - * @return string Sanitized string safe for JSON inclusion + * @param array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } $config */ - private function toSafeJsonStr(string|int $str): string { - if (is_numeric($str)) { - return (string)$str; + private function sendTestRequestSafely(array $config): void { + try { + $this->sendTestRequest($config); + } catch (RuntimeException|InvalidArgumentException|JsonException $err) { + logError($this->logsEnabled, 'Test webhook request failed: ' . $err->getMessage()); } - - // Remove quotes and decode HTML entities - return str_replace('"', '', html_entity_decode((string)$str)); } /** - * Check if pattern is found in text - * - * Attempts regex matching first, then falls back to simple string search. - * Handles regex errors gracefully and logs issues. - * - * @param string $pattern Search pattern (may include regex delimiters) - * @param string $text Text to search in + * Build placeholder replacements for the configured template. * - * @return bool True if pattern is found, false otherwise + * @return array */ - private function isPatternFound(string $pattern, string $text): bool { - if (empty($text) || empty($pattern)) { - return false; + private function buildReplacements(FreshRSS_Entry $entry): array { + $feed = $entry->feed(); + $feedName = $feed instanceof FreshRSS_Feed ? $feed->name() : ''; + + return [ + '__TITLE__' => $this->toSafeJsonStr($entry->title()), + '__FEED__' => $this->toSafeJsonStr($feedName), + '__URL__' => $this->toSafeJsonStr($entry->link()), + '__CONTENT__' => $this->toSafeJsonStr($entry->content()), + '__DATE__' => $this->toSafeJsonStr($entry->date()), + '__DATE_TIMESTAMP__' => $this->toSafeJsonStr($entry->date(true)), + '__AUTHORS__' => $this->toSafeJsonStr($entry->authors(true)), + '__TAGS__' => $this->toSafeJsonStr($entry->tags(true)), + '__THUMBNAIL_URL__' => $this->toSafeJsonStr($this->getEntryThumbnail($entry)), + '__CONTENT_PLAINTEXT__' => $this->toSafeJsonStr($this->getPlainTextContent($entry)), + ]; + } + + /** + * Convert a mixed value to a JSON-safe string. + */ + private function toSafeJsonStr(mixed $value): string { + if ($value === null) { + return ''; } - try { - // Try regex match first - if (preg_match($pattern, $text) === 1) { - return true; + if ($value instanceof DateTimeInterface) { + return $value->format(DateTimeInterface::ATOM); + } + + if (is_array($value)) { + $items = []; + foreach ($value as $item) { + $items[] = $this->normalizeScalarToString($item); } + $value = implode(', ', $items); + } elseif (is_object($value)) { + if (method_exists($value, '__toString')) { + $value = (string) $value; + } else { + return ''; + } + } - // Fallback to string search (remove regex delimiters) - $cleanPattern = trim($pattern, '/'); - return str_contains($text, $cleanPattern); + $string = html_entity_decode($this->normalizeScalarToString($value), ENT_QUOTES | ENT_HTML5, 'UTF-8'); + $string = preg_replace('/\s+/u', ' ', $string) ?? ''; - } catch (Throwable $err) { - logError($this->logsEnabled, "ERROR in isPatternFound: (pattern: {$pattern}) {$err->getMessage()}"); + return addcslashes(trim($string), "\"\\"); + } + + private function normalizeScalarToString(mixed $value): string { + if ($value === null) { + return ''; + } + if (is_scalar($value)) { + return (string) $value; + } + if ($value instanceof DateTimeInterface) { + return $value->format(DateTimeInterface::ATOM); + } + if (is_object($value) && method_exists($value, '__toString')) { + return (string) $value; + } + + return ''; + } + + /** + * Ensure configuration defaults exist for the current user. + */ + private function ensureConfigurationDefaults(): void { + $userConf = $this->getUserConf(); + if ($userConf === null) { + return; + } + + $needsSave = $this->migrateLegacyConfiguration($userConf); + + if ($userConf->attributeArray('keywords') === null) { + $userConf->_attribute('keywords', []); + $needsSave = true; + } + if ($userConf->attributeString('match_mode') === null) { + $userConf->_attribute('match_mode', self::MATCH_MODE_BASIC); + $needsSave = true; + } + if ($userConf->attributeArray('keywords_title') === null) { + $userConf->_attribute('keywords_title', []); + $needsSave = true; + } + if ($userConf->attributeArray('keywords_feed') === null) { + $userConf->_attribute('keywords_feed', []); + $needsSave = true; + } + if ($userConf->attributeArray('keywords_authors') === null) { + $userConf->_attribute('keywords_authors', []); + $needsSave = true; + } + if ($userConf->attributeArray('keywords_content') === null) { + $userConf->_attribute('keywords_content', []); + $needsSave = true; + } + + $needsSave = $this->ensureBoolDefault($userConf, 'search_in_title', true) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'search_in_feed', false) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'search_in_authors', false) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'search_in_content', false) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'mark_as_read', false) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'ignore_updated', false) || $needsSave; + $needsSave = $this->ensureBoolDefault($userConf, 'enable_logging', false) || $needsSave; + + if ($userConf->attributeString('webhook_url') === null) { + $userConf->_attribute('webhook_url', self::DEFAULT_URL); + $needsSave = true; + } + + if ($userConf->attributeString('webhook_method') === null) { + $userConf->_attribute('webhook_method', self::DEFAULT_METHOD->value); + $needsSave = true; + } + + if ($userConf->attributeArray('webhook_headers') === null) { + $userConf->_attribute('webhook_headers', self::DEFAULT_HEADERS); + $needsSave = true; + } + + if ($userConf->attributeString('webhook_body') === null) { + $userConf->_attribute('webhook_body', self::DEFAULT_BODY_TEMPLATE); + $needsSave = true; + } + + if ($userConf->attributeString('webhook_body_type') === null) { + $userConf->_attribute('webhook_body_type', self::DEFAULT_BODY_TYPE->value); + $needsSave = true; + } + + if ($needsSave) { + $userConf->save(); + } + } + + /** + * Attempt to migrate settings stored via the legacy system configuration. + */ + private function migrateLegacyConfiguration(FreshRSS_UserConfiguration $userConf): bool { + $legacy = $this->getSystemConfiguration(); + if ($legacy === []) { return false; } + + $needsSave = false; + $map = [ + 'keywords' => ['type' => 'array'], + 'match_mode' => ['type' => 'string'], + 'keywords_title' => ['type' => 'array'], + 'keywords_feed' => ['type' => 'array'], + 'keywords_authors' => ['type' => 'array'], + 'keywords_content' => ['type' => 'array'], + 'search_in_title' => ['type' => 'bool'], + 'search_in_feed' => ['type' => 'bool'], + 'search_in_authors' => ['type' => 'bool'], + 'search_in_content' => ['type' => 'bool'], + 'mark_as_read' => ['type' => 'bool'], + 'ignore_updated' => ['type' => 'bool'], + 'webhook_url' => ['type' => 'string'], + 'webhook_method' => ['type' => 'string'], + 'webhook_headers' => ['type' => 'array'], + 'webhook_body' => ['type' => 'string'], + 'webhook_body_type' => ['type' => 'string'], + 'enable_logging' => ['type' => 'bool'], + ]; + + foreach ($map as $key => $meta) { + if (!array_key_exists($key, $legacy)) { + continue; + } + + if ($this->hasAttributeValue($userConf, $key, $meta['type'])) { + continue; + } + + $userConf->_attribute($key, $legacy[$key]); + $needsSave = true; + } + + if ($needsSave) { + logWarning(true, 'Webhook settings migrated from system scope to per-user scope.'); + } + + return $needsSave; + } + + private function hasAttributeValue(FreshRSS_UserConfiguration $userConf, string $key, string $type): bool { + /** @var non-empty-string $key */ + return match ($type) { + 'array' => $userConf->attributeArray($key) !== null, + 'bool' => $userConf->attributeBool($key) !== null, + default => $userConf->attributeString($key) !== null, + }; + } + + private function ensureBoolDefault(FreshRSS_UserConfiguration $userConf, string $key, bool $default): bool { + /** @var non-empty-string $key */ + if ($userConf->attributeBool($key) === null) { + $userConf->_attribute($key, $default); + return true; + } + + return false; + } + + private function getUserConf(): ?FreshRSS_UserConfiguration { + try { + if (!FreshRSS_Context::hasUserConf()) { + return null; + } + + return FreshRSS_Context::userConf(); + } catch (FreshRSS_Context_Exception $exception) { + return null; + } } /** - * Get keywords configuration as formatted string - * - * Returns the configured keywords as a newline-separated string - * for display in the configuration form. - * - * @throws FreshRSS_Context_Exception + * Collect configuration values from the current request payload. * - * @return string Keywords separated by newlines + * @return array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * } */ - public function getKeywordsData(): string { - $keywords = FreshRSS_Context::userConf()->attributeArray('keywords') ?? []; - return implode(PHP_EOL, $keywords); + private function collectConfigurationFromRequest(): array { + $keywords = $this->normalizeListInput(Minz_Request::paramTextToArray('keywords')); + $keywordsTitle = $this->normalizeListInput(Minz_Request::paramTextToArray('keywords_title')); + $keywordsFeed = $this->normalizeListInput(Minz_Request::paramTextToArray('keywords_feed')); + $keywordsAuthors = $this->normalizeListInput(Minz_Request::paramTextToArray('keywords_authors')); + $keywordsContent = $this->normalizeListInput(Minz_Request::paramTextToArray('keywords_content')); + $headers = $this->normalizeListInput(Minz_Request::paramTextToArray('webhook_headers')); + $headers = $headers === [] ? self::DEFAULT_HEADERS : $headers; + + $methodValue = HTTP_METHOD::tryFrom(strtoupper(Minz_Request::paramString('webhook_method'))); + $bodyTypeValue = BODY_TYPE::tryFrom(strtolower(Minz_Request::paramString('webhook_body_type'))); + $matchMode = Minz_Request::paramString('match_mode'); + if (!in_array($matchMode, [self::MATCH_MODE_BASIC, self::MATCH_MODE_ADVANCED], true)) { + $matchMode = self::MATCH_MODE_BASIC; + } + + return [ + 'keywords' => $keywords, + 'match_mode' => $matchMode, + 'keywords_title' => $keywordsTitle, + 'keywords_feed' => $keywordsFeed, + 'keywords_authors' => $keywordsAuthors, + 'keywords_content' => $keywordsContent, + 'search_in_title' => Minz_Request::paramBoolean('search_in_title'), + 'search_in_feed' => Minz_Request::paramBoolean('search_in_feed'), + 'search_in_authors' => Minz_Request::paramBoolean('search_in_authors'), + 'search_in_content' => Minz_Request::paramBoolean('search_in_content'), + 'mark_as_read' => Minz_Request::paramBoolean('mark_as_read'), + 'ignore_updated' => Minz_Request::paramBoolean('ignore_updated'), + 'webhook_url' => trim(Minz_Request::paramString('webhook_url')), + 'webhook_method' => ($methodValue ?? self::DEFAULT_METHOD)->value, + 'webhook_headers' => $headers, + 'webhook_body' => html_entity_decode(Minz_Request::paramString('webhook_body'), ENT_QUOTES | ENT_HTML5), + 'webhook_body_type' => ($bodyTypeValue ?? self::DEFAULT_BODY_TYPE)->value, + 'enable_logging' => Minz_Request::paramBoolean('enable_logging'), + ]; + } + + private function shouldSendTestRequest(): bool { + return Minz_Request::paramBoolean('test_request'); } /** - * Get webhook headers configuration as formatted string - * - * Returns the configured HTTP headers as a newline-separated string - * for display in the configuration form. + * Return the configuration snapshot for the current user. * - * @throws FreshRSS_Context_Exception - * - * @return string HTTP headers separated by newlines + * @return array{ + * keywords: list, + * match_mode: 'basic'|'advanced', + * keywords_title: list, + * keywords_feed: list, + * keywords_authors: list, + * keywords_content: list, + * search_in_title: bool, + * search_in_feed: bool, + * search_in_authors: bool, + * search_in_content: bool, + * mark_as_read: bool, + * ignore_updated: bool, + * webhook_headers: list, + * webhook_url: string, + * webhook_method: string, + * webhook_body: string, + * webhook_body_type: string, + * enable_logging: bool + * }|null */ - public function getWebhookHeaders(): string { - $headers = FreshRSS_Context::userConf()->attributeArray('webhook_headers'); - return implode( - PHP_EOL, - is_array($headers) ? $headers : ($this->webhook_headers ?? []), - ); + private function getSnapshot(): ?array { + $userConf = $this->getUserConf(); + if ($userConf === null) { + return null; + } + + return [ + 'keywords' => $this->getArrayAttribute($userConf, 'keywords', []), + 'match_mode' => $this->normalizeMatchMode($userConf->attributeString('match_mode')), + 'keywords_title' => $this->getArrayAttribute($userConf, 'keywords_title', []), + 'keywords_feed' => $this->getArrayAttribute($userConf, 'keywords_feed', []), + 'keywords_authors' => $this->getArrayAttribute($userConf, 'keywords_authors', []), + 'keywords_content' => $this->getArrayAttribute($userConf, 'keywords_content', []), + 'search_in_title' => $this->getBoolAttribute($userConf, 'search_in_title', true), + 'search_in_feed' => $this->getBoolAttribute($userConf, 'search_in_feed', false), + 'search_in_authors' => $this->getBoolAttribute($userConf, 'search_in_authors', false), + 'search_in_content' => $this->getBoolAttribute($userConf, 'search_in_content', false), + 'mark_as_read' => $this->getBoolAttribute($userConf, 'mark_as_read', false), + 'ignore_updated' => $this->getBoolAttribute($userConf, 'ignore_updated', false), + 'webhook_headers' => $this->getArrayAttribute($userConf, 'webhook_headers', self::DEFAULT_HEADERS), + 'webhook_url' => $this->getStringAttribute($userConf, 'webhook_url', self::DEFAULT_URL), + 'webhook_method' => $this->normalizeMethodValue($userConf->attributeString('webhook_method')), + 'webhook_body' => $this->getStringAttribute($userConf, 'webhook_body', self::DEFAULT_BODY_TEMPLATE), + 'webhook_body_type' => $this->normalizeBodyTypeValue($userConf->attributeString('webhook_body_type')), + 'enable_logging' => $this->getBoolAttribute($userConf, 'enable_logging', false), + ]; + } + + private function normalizeMethodValue(?string $method): string { + $methodValue = $method ?? ''; + return (HTTP_METHOD::tryFrom(strtoupper($methodValue)) ?? self::DEFAULT_METHOD)->value; + } + + private function normalizeBodyTypeValue(?string $bodyType): string { + $bodyTypeValue = $bodyType ?? ''; + return (BODY_TYPE::tryFrom(strtolower($bodyTypeValue)) ?? self::DEFAULT_BODY_TYPE)->value; } /** - * Get configured webhook URL - * - * Returns the configured webhook URL or the default if none is set. - * - * @throws FreshRSS_Context_Exception - * - * @return string The webhook URL + * @return 'basic'|'advanced' */ - public function getWebhookUrl(): string { - return FreshRSS_Context::userConf()->attributeString('webhook_url') ?? $this->webhook_url; + private function normalizeMatchMode(?string $matchMode): string { + if ($matchMode === self::MATCH_MODE_ADVANCED) { + return self::MATCH_MODE_ADVANCED; + } + + return self::MATCH_MODE_BASIC; } /** - * Get configured webhook body template - * - * Returns the configured webhook body template or the default if none is set. - * - * @throws FreshRSS_Context_Exception - * - * @return string The webhook body template + * @param non-empty-string $key + * @param list $default + * @return list */ - public function getWebhookBody(): string { - $body = FreshRSS_Context::userConf()->attributeString('webhook_body'); - return ($body === null || $body === '') ? $this->webhook_body : $body; + private function getArrayAttribute(FreshRSS_UserConfiguration $userConf, string $key, array $default): array { + $value = $userConf->attributeArray($key); + if ($value === null) { + return $default; + } + + $normalized = []; + foreach ($value as $item) { + $trimmed = trim($this->normalizeScalarToString($item)); + if ($trimmed !== '') { + $normalized[] = $trimmed; + } + } + + return $normalized; + } + + /** @param non-empty-string $key */ + private function getBoolAttribute(FreshRSS_UserConfiguration $userConf, string $key, bool $default): bool { + $value = $userConf->attributeBool($key); + return $value ?? $default; + } + + /** @param non-empty-string $key */ + private function getStringAttribute(FreshRSS_UserConfiguration $userConf, string $key, string $default): string { + $value = $userConf->attributeString($key); + return ($value === null || $value === '') ? $default : $value; } /** - * Get configured webhook body type + * Normalize a list input (textarea) into trimmed values. * - * Returns the configured body type (json/form) or the default if none is set. - * - * @throws FreshRSS_Context_Exception - * - * @return string The webhook body type + * @param array|null $values + * @return list */ + private function normalizeListInput(?array $values): array { + if (!is_array($values)) { + return []; + } + + $result = []; + foreach ($values as $value) { + $trimmed = trim((string) $value); + if ($trimmed !== '') { + $result[] = $trimmed; + } + } + + return $result; + } + + private function normalizePattern(string $pattern): ?string { + $pattern = trim($pattern); + if ($pattern === '') { + return null; + } + + if ($pattern[0] === '/' && strrpos($pattern, '/', 1) !== false) { + return $pattern; + } + + return '/' . preg_quote($pattern, '/') . '/i'; + } + + private function isPatternFound(string $pattern, string $text, string $fallback): bool { + if ($pattern === '' || $text === '') { + return false; + } + + $result = @preg_match($pattern, $text); + if ($result === 1) { + return true; + } + + if ($result === false) { + logError($this->logsEnabled, 'Invalid regex pattern: ' . $pattern); + } + + $fallbackNeedle = $fallback !== '' ? $fallback : $pattern; + return str_contains($text, $fallbackNeedle); + } + + private function getEntryThumbnail(FreshRSS_Entry $entry): string { + $thumbnail = $entry->thumbnail(); + if ($thumbnail !== null && $thumbnail['url'] !== '') { + return $thumbnail['url']; + } + + $enclosures = $entry->enclosures(); + foreach ($enclosures as $enclosure) { + $url = $this->extractEnclosureUrl($enclosure); + if ($url !== '') { + return $url; + } + } + + return ''; + } + + private function getPlainTextContent(FreshRSS_Entry $entry): string { + $content = $entry->content(); + if ($content === '') { + return ''; + } + + $text = strip_tags($content); + $text = html_entity_decode($text, ENT_QUOTES | ENT_HTML5, 'UTF-8'); + $text = preg_replace('/\s+/u', ' ', $text) ?? ''; + $text = trim($text); + + if ($text === '') { + return ''; + } + + if (function_exists('mb_strlen') && function_exists('mb_substr')) { + if (mb_strlen($text) > self::PLAINTEXT_MAX_LENGTH) { + return rtrim(mb_substr($text, 0, self::PLAINTEXT_MAX_LENGTH - 1)) . '…'; + } + return $text; + } + + if (strlen($text) > self::PLAINTEXT_MAX_LENGTH) { + return rtrim(substr($text, 0, self::PLAINTEXT_MAX_LENGTH - 1)) . '…'; + } + + return $text; + } + + private function extractEnclosureUrl(mixed $enclosure): string { + $url = $this->getEnclosureValue($enclosure, 'url'); + if ($url === '') { + return ''; + } + + $type = $this->getEnclosureValue($enclosure, 'type'); + if ($type === '' || stripos($type, 'image/') === 0) { + return $url; + } + + return ''; + } + + private function getEnclosureValue(mixed $enclosure, string $name): string { + if (is_array($enclosure)) { + if (!array_key_exists($name, $enclosure)) { + return ''; + } + return $this->normalizeScalarToString($enclosure[$name]); + } + + if (!is_object($enclosure)) { + return ''; + } + + if ($name === 'url') { + if (method_exists($enclosure, 'get_link')) { + return $this->normalizeScalarToString($enclosure->get_link()); + } + if (method_exists($enclosure, 'link')) { + return $this->normalizeScalarToString($enclosure->link()); + } + } + + if ($name === 'type') { + if (method_exists($enclosure, 'get_type')) { + return $this->normalizeScalarToString($enclosure->get_type()); + } + if (method_exists($enclosure, 'type')) { + return $this->normalizeScalarToString($enclosure->type()); + } + } + + return ''; + } + + public function getKeywordsData(): string { + $config = $this->getSnapshot(); + if ($config === null) { + return ''; + } + + return implode(PHP_EOL, $config['keywords']); + } + + public function getKeywordDataByField(string $field): string { + $config = $this->getSnapshot(); + if ($config === null) { + return ''; + } + + return match ($field) { + 'title' => implode(PHP_EOL, $config['keywords_title']), + 'feed' => implode(PHP_EOL, $config['keywords_feed']), + 'authors' => implode(PHP_EOL, $config['keywords_authors']), + 'content' => implode(PHP_EOL, $config['keywords_content']), + default => '', + }; + } + + public function getMatchMode(): string { + $config = $this->getSnapshot(); + return $config === null ? self::MATCH_MODE_BASIC : $config['match_mode']; + } + + public function getWebhookHeaders(): string { + $config = $this->getSnapshot(); + if ($config === null) { + return implode(PHP_EOL, self::DEFAULT_HEADERS); + } + + return implode(PHP_EOL, $config['webhook_headers']); + } + + public function getWebhookUrl(): string { + $config = $this->getSnapshot(); + return $config === null ? self::DEFAULT_URL : $config['webhook_url']; + } + + public function getWebhookBody(): string { + $config = $this->getSnapshot(); + return $config === null ? self::DEFAULT_BODY_TEMPLATE : $config['webhook_body']; + } + public function getWebhookBodyType(): string { - return FreshRSS_Context::userConf()->attributeString('webhook_body_type') ?? $this->webhook_body_type->value; + $config = $this->getSnapshot(); + return $config === null ? self::DEFAULT_BODY_TYPE->value : $config['webhook_body_type']; } } -/** - * Backward compatibility alias for logWarning function - * - * @deprecated Use logWarning() instead - * @param bool $logEnabled Whether logging is enabled - * @param mixed $data Data to log - * - * @throws Minz_PermissionDeniedException - * - * @return void - */ -function _LOG(bool $logEnabled, $data): void { +function _LOG(bool $logEnabled, mixed $data): void { logWarning($logEnabled, $data); } -/** - * Backward compatibility alias for logError function - * - * @deprecated Use logError() instead - * @param bool $logEnabled Whether logging is enabled - * @param mixed $data Data to log - * - * @throws Minz_PermissionDeniedException - * - * @return void - */ -function _LOG_ERR(bool $logEnabled, $data): void { +function _LOG_ERR(bool $logEnabled, mixed $data): void { logError($logEnabled, $data); } diff --git a/xExtension-Webhook/i18n/en/ext.php b/xExtension-Webhook/i18n/en/ext.php index ced0e41d..71cdec5b 100644 --- a/xExtension-Webhook/i18n/en/ext.php +++ b/xExtension-Webhook/i18n/en/ext.php @@ -9,6 +9,17 @@ 'save_and_send_test_req' => 'Save and send test request', 'description' => 'Webhooks allow external services to be notified when certain events happen.\nWhen the specified events happen, we\'ll send a HTTP request (usually POST) to the URL you provide.', 'keywords' => 'Keywords in the new article', + 'match_mode' => 'Matching mode', + 'match_mode_basic' => 'Basic matching', + 'match_mode_advanced' => 'Advanced matching', + 'match_mode_description' => 'Basic mode uses one keyword list with shared scopes. Advanced mode uses dedicated keyword lists per field.', + 'basic_matching' => 'Basic matching', + 'advanced_matching' => 'Advanced matching (field-specific)', + 'advanced_matching_description' => 'These lists are used only when matching mode is set to Advanced.', + 'advanced_title' => 'Title keywords', + 'advanced_feed' => 'Feed keywords', + 'advanced_authors' => 'Author keywords', + 'advanced_content' => 'Content keywords', 'search_in' => 'Search in article\'s:', 'search_in_title' => 'title', 'search_in_feed' => 'feed', @@ -23,6 +34,8 @@ 'mark_as_read' => 'Mark as read', 'mark_as_read_description' => 'Mark the article as read after sending the webhook.', 'mark_as_read_label' => 'Mark as read', + 'ignore_updated' => 'Ignore updated entries', + 'ignore_updated_description' => 'Skip webhook delivery when FreshRSS updates an existing entry.', 'http_body' => 'HTTP Body', 'http_body_description' => 'Must be valid JSON or form data (x-www-form-urlencoded)', 'http_body_placeholder_summary' => 'You can use special placeholders that will be replaced by the actual values:', @@ -31,6 +44,7 @@ 'http_body_placeholder_title_description' => 'Article title', 'http_body_placeholder_url_description' => 'HTML-encoded link of the article', 'http_body_placeholder_content_description' => 'Content of the article (HTML format)', + 'http_body_placeholder_plaintext_description' => 'Plaintext excerpt with HTML removed (trimmed for notifications)', 'http_body_placeholder_authors_description' => 'Authors of the article', 'http_body_placeholder_feed_description' => 'Feed of the article', 'http_body_placeholder_tags_description' => 'Article tags (string, separated by " #")', @@ -40,6 +54,8 @@ 'webhook_headers' => 'HTTP Headers
(one per line)', 'http_body_type' => 'HTTP Body type', 'more_info' => 'More info:', - 'more_info_description' => 'When header contains Content-type: application/x-www-form-urlencoded the keys and values are encoded in key-value tuples separated by "&", with a "=" between the key and the value. Non-alphanumeric characters in both keys and values are URL encoded' + 'more_info_description' => 'When header contains Content-type: application/x-www-form-urlencoded the keys and values are encoded in key-value tuples separated by "&", with a "=" between the key and the value. Non-alphanumeric characters in both keys and values are URL encoded', + 'enable_logging' => 'Enable logging', + 'enable_logging_description' => 'Write webhook requests and responses to the FreshRSS logs (includes URLs and HTTP status codes).' ), ); diff --git a/xExtension-Webhook/metadata.json b/xExtension-Webhook/metadata.json index 6cba9dde..78fa0172 100644 --- a/xExtension-Webhook/metadata.json +++ b/xExtension-Webhook/metadata.json @@ -1,8 +1,8 @@ { "name": "Webhook", - "author": "Lukas Melega, Ryahn", + "author": "Lukas Melega, Ryahn, onlymykazari", "description": "Send custom webhook when new article appears (and matches custom criteria)", - "version": "0.1.1", + "version": "0.3.0", "entrypoint": "Webhook", "type": "system" } diff --git a/xExtension-Webhook/request.php b/xExtension-Webhook/request.php index 5a4143d1..977545f7 100644 --- a/xExtension-Webhook/request.php +++ b/xExtension-Webhook/request.php @@ -18,7 +18,6 @@ * * @throws InvalidArgumentException When invalid parameters are provided * @throws JsonException When JSON encoding/decoding fails - * @throws Minz_PermissionDeniedException * @throws RuntimeException When cURL operations fail * * @return void @@ -33,12 +32,13 @@ function sendReq( string $additionalLog = "", ): void { // Validate inputs - if (empty($url) || !filter_var($url, FILTER_VALIDATE_URL)) { + if ($url === '' || filter_var($url, FILTER_VALIDATE_URL) === false) { throw new InvalidArgumentException("Invalid URL provided: {$url}"); } + $normalizedMethod = strtoupper($method); $allowedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD']; - if (!in_array(strtoupper($method), $allowedMethods, true)) { + if (!in_array($normalizedMethod, $allowedMethods, true)) { throw new InvalidArgumentException("Invalid HTTP method: {$method}"); } @@ -54,20 +54,20 @@ function sendReq( try { // Configure HTTP method - configureHttpMethod($ch, strtoupper($method)); + configureHttpMethod($ch, $normalizedMethod); // Process and set HTTP body - $processedBody = processHttpBody($body, $bodyType, $method, $logEnabled); - if ($processedBody !== null && $method !== 'GET') { - curl_setopt($ch, CURLOPT_POSTFIELDS, $processedBody); - } + $processedBody = processHttpBody($body, $bodyType, $normalizedMethod, $logEnabled); + if ($processedBody !== null && $normalizedMethod !== 'GET') { + curl_setopt($ch, CURLOPT_POSTFIELDS, $processedBody); + } // Configure headers $finalHeaders = configureHeaders($headers, $bodyType); curl_setopt($ch, CURLOPT_HTTPHEADER, $finalHeaders); // Log the request - logRequest($logEnabled, $additionalLog, $method, $url, $bodyType, $processedBody, $finalHeaders); + logRequest($logEnabled, $additionalLog, $normalizedMethod, $url, $bodyType, $processedBody, $finalHeaders); // Execute request executeRequest($ch, $logEnabled); @@ -86,28 +86,23 @@ function sendReq( * Sets the appropriate cURL options based on the HTTP method. * * @param CurlHandle $ch The cURL handle - * @param string $method HTTP method in uppercase + * @param non-empty-string $method HTTP method in uppercase * * @return void */ function configureHttpMethod(CurlHandle $ch, string $method): void { curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); switch ($method) { case 'POST': curl_setopt($ch, CURLOPT_POST, true); break; - case 'PUT': - curl_setopt($ch, CURLOPT_PUT, true); - break; case 'GET': - curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); + curl_setopt($ch, CURLOPT_HTTPGET, true); break; - case 'DELETE': - case 'PATCH': - case 'OPTIONS': case 'HEAD': - curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); + curl_setopt($ch, CURLOPT_NOBODY, true); break; } } @@ -125,21 +120,20 @@ function configureHttpMethod(CurlHandle $ch, string $method): void { * * @throws JsonException When JSON processing fails * @throws InvalidArgumentException When unsupported body type is provided - * @throws Minz_PermissionDeniedException - * * @return string|null Processed body content or null if no body needed */ function processHttpBody(string $body, string $bodyType, string $method, bool $logEnabled): ?string { - if (empty($body) || $method === 'GET') { + if ($body === '' || $method === 'GET' || $method === 'HEAD') { return null; } try { $bodyObject = json_decode($body, true, 256, JSON_THROW_ON_ERROR); + $formData = is_array($bodyObject) ? $bodyObject : []; return match ($bodyType) { - 'json' => json_encode($bodyObject, JSON_THROW_ON_ERROR), - 'form' => http_build_query($bodyObject ?? []), + 'json' => json_encode($bodyObject, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), + 'form' => http_build_query($formData), default => throw new InvalidArgumentException("Unsupported body type: {$bodyType}") }; } catch (JsonException $err) { @@ -157,18 +151,39 @@ function processHttpBody(string $body, string $bodyType, string $method, bool $l * @param string[] $headers Array of custom headers * @param string $bodyType Content type ('json' or 'form') * - * @return string[] Final array of headers to use + * @return list Final array of headers to use */ function configureHeaders(array $headers, string $bodyType): array { - if (empty($headers)) { + $normalized = []; + foreach ($headers as $header) { + $trimmed = trim((string) $header); + if ($trimmed !== '') { + $normalized[] = $trimmed; + } + } + + if ($normalized === []) { return match ($bodyType) { 'form' => ['Content-Type: application/x-www-form-urlencoded'], - 'json' => ['Content-Type: application/json'], - default => [] + default => ['Content-Type: application/json'], }; } - return $headers; + $hasContentType = false; + foreach ($normalized as $header) { + if (stripos($header, 'content-type:') === 0) { + $hasContentType = true; + break; + } + } + + if (!$hasContentType) { + $normalized[] = $bodyType === 'form' + ? 'Content-Type: application/x-www-form-urlencoded' + : 'Content-Type: application/json'; + } + + return $normalized; } /** @@ -185,8 +200,6 @@ function configureHeaders(array $headers, string $bodyType): array { * @param string|null $body Processed request body * @param string[] $headers Array of HTTP headers * - * @throws Minz_PermissionDeniedException - * * @return void */ function logRequest( @@ -203,7 +216,7 @@ function logRequest( } $cleanUrl = urldecode($url); - $cleanBody = $body ? str_replace('\/', '/', $body) : ''; + $cleanBody = $body !== null ? str_replace('\/', '/', $body) : ''; $headersJson = json_encode($headers); $logMessage = trim("{$additionalLog} ♦♦ sendReq ⏩ {$method}: {$cleanUrl} ♦♦ {$bodyType} ♦♦ {$cleanBody} ♦♦ {$headersJson}"); @@ -221,7 +234,6 @@ function logRequest( * @param bool $logEnabled Whether logging is enabled * * @throws RuntimeException When cURL execution fails - * @throws Minz_PermissionDeniedException * * @return void */ @@ -249,13 +261,15 @@ function executeRequest(CurlHandle $ch, bool $logEnabled): void { * @param bool $logEnabled Whether logging is enabled * @param mixed $data Data to log (will be converted to string) * - * @throws Minz_PermissionDeniedException - * * @return void */ -function logWarning(bool $logEnabled, $data): void { +function logWarning(bool $logEnabled, mixed $data): void { if ($logEnabled && class_exists('Minz_Log')) { - Minz_Log::warning("[WEBHOOK] " . $data); + try { + Minz_Log::warning('[WEBHOOK] ' . toLogString($data)); + } catch (Throwable) { + return; + } } } @@ -268,13 +282,15 @@ function logWarning(bool $logEnabled, $data): void { * @param bool $logEnabled Whether logging is enabled * @param mixed $data Data to log (will be converted to string) * - * @throws Minz_PermissionDeniedException - * * @return void */ -function logError(bool $logEnabled, $data): void { +function logError(bool $logEnabled, mixed $data): void { if ($logEnabled && class_exists('Minz_Log')) { - Minz_Log::error("[WEBHOOK]❌ " . $data); + try { + Minz_Log::error('[WEBHOOK]❌ ' . toLogString($data)); + } catch (Throwable) { + return; + } } } @@ -285,11 +301,9 @@ function logError(bool $logEnabled, $data): void { * @param bool $logEnabled Whether logging is enabled * @param mixed $data Data to log * - * @throws Minz_PermissionDeniedException - * * @return void */ -function LOG_WARN(bool $logEnabled, $data): void { +function LOG_WARN(bool $logEnabled, mixed $data): void { logWarning($logEnabled, $data); } @@ -300,10 +314,26 @@ function LOG_WARN(bool $logEnabled, $data): void { * @param bool $logEnabled Whether logging is enabled * @param mixed $data Data to log * - * @throws Minz_PermissionDeniedException - * * @return void */ -function LOG_ERR(bool $logEnabled, $data): void { +function LOG_ERR(bool $logEnabled, mixed $data): void { logError($logEnabled, $data); } + +function toLogString(mixed $data): string { + if ($data === null) { + return ''; + } + if (is_scalar($data)) { + return (string) $data; + } + if ($data instanceof DateTimeInterface) { + return $data->format(DateTimeInterface::ATOM); + } + if (is_object($data) && method_exists($data, '__toString')) { + return (string) $data; + } + + $encoded = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); + return is_string($encoded) ? $encoded : '[unserializable]'; +}