url_rewrite.go 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. // SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
  2. // SPDX-License-Identifier: Apache-2.0
  3. package rewrite // import "miniflux.app/v2/internal/reader/rewrite"
  4. import (
  5. "log/slog"
  6. "regexp"
  7. "strings"
  8. "miniflux.app/v2/internal/model"
  9. )
  10. var customReplaceRuleRegex = regexp.MustCompile(`^rewrite\("([^"]+)"\|"([^"]+)"\)$`)
  11. // IsValidURLRewriteRules reports whether the given URL rewrite rules string is
  12. // something RewriteEntryURL can actually apply. An empty or whitespace-only
  13. // string is valid and means "no rewriting".
  14. //
  15. // The only supported form is rewrite("search-regex"|"replacement"), and the
  16. // search term must be a compilable regular expression. Anything else — a bare
  17. // regex, an unknown function name, or a malformed rewrite() call — is rejected
  18. // so it is caught at save time instead of being silently ignored during feed
  19. // refresh (RewriteEntryURL just logs a debug line and returns the URL
  20. // unchanged for rules it cannot parse).
  21. func IsValidURLRewriteRules(rules string) bool {
  22. if strings.TrimSpace(rules) == "" {
  23. return true
  24. }
  25. parts := customReplaceRuleRegex.FindStringSubmatch(rules)
  26. if len(parts) != 3 {
  27. return false
  28. }
  29. _, err := regexp.Compile(parts[1])
  30. return err == nil
  31. }
  32. func RewriteEntryURL(feed *model.Feed, entry *model.Entry) string {
  33. if feed.UrlRewriteRules == "" {
  34. return entry.URL
  35. }
  36. var rewrittenURL = entry.URL
  37. parts := customReplaceRuleRegex.FindStringSubmatch(feed.UrlRewriteRules)
  38. if len(parts) == 3 {
  39. re, err := regexp.Compile(parts[1])
  40. if err != nil {
  41. slog.Error("Failed on regexp compilation",
  42. slog.String("url_rewrite_rules", feed.UrlRewriteRules),
  43. slog.Any("error", err),
  44. )
  45. return rewrittenURL
  46. }
  47. rewrittenURL = re.ReplaceAllString(entry.URL, parts[2])
  48. slog.Debug("Rewriting entry URL",
  49. slog.String("original_entry_url", entry.URL),
  50. slog.String("rewritten_entry_url", rewrittenURL),
  51. slog.Int64("feed_id", feed.ID),
  52. slog.String("feed_url", feed.FeedURL),
  53. )
  54. } else {
  55. slog.Debug("Cannot find search and replace terms for replace rule",
  56. slog.String("original_entry_url", entry.URL),
  57. slog.String("rewritten_entry_url", rewrittenURL),
  58. slog.Int64("feed_id", feed.ID),
  59. slog.String("feed_url", feed.FeedURL),
  60. slog.String("url_rewrite_rules", feed.UrlRewriteRules),
  61. )
  62. }
  63. return rewrittenURL
  64. }