miniflux_v2/internal/reader/opml/serializer.go

// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package opml // import "miniflux.app/v2/internal/reader/opml"

import (
	"bufio"
	"bytes"
	"encoding/xml"
	"log/slog"
	"sort"
	"time"
)

// serialize returns a SubcriptionList in OPML format.
func serialize(subscriptions []subcription) string {
	var b bytes.Buffer
	writer := bufio.NewWriter(&b)
	writer.WriteString(xml.Header)

	opmlDocument := convertSubscriptionsToOPML(subscriptions)
	encoder := xml.NewEncoder(writer)
	encoder.Indent("", "    ")
	if err := encoder.Encode(opmlDocument); err != nil {
		slog.Error("Unable to serialize OPML document",
			slog.Any("error", err),
		)
		return ""
	}

	return b.String()
}

func convertSubscriptionsToOPML(subscriptions []subcription) *opmlDocument {
	opmlDocument := &opmlDocument{}
	opmlDocument.Version = "2.0"
	opmlDocument.MinifluxNamespace = minifluxOPMLNamespace
	opmlDocument.Header.Title = "Miniflux"
	opmlDocument.Header.DateCreated = time.Now().Format("Mon, 02 Jan 2006 15:04:05 MST")

	groupedSubs := groupSubscriptionsByFeed(subscriptions)
	categories := make([]string, 0, len(groupedSubs))
	for k := range groupedSubs {
		categories = append(categories, k)
	}
	sort.Strings(categories)

	for _, categoryName := range categories {
		category := opmlOutline{Text: categoryName, Outlines: make(opmlOutlineCollection, 0, len(groupedSubs[categoryName]))}
		for _, subscription := range groupedSubs[categoryName] {
			category.Outlines = append(category.Outlines, opmlOutline{
				Title:       subscription.Title,
				Text:        subscription.Title,
				FeedURL:     subscription.FeedURL,
				SiteURL:     subscription.SiteURL,
				Description: subscription.Description,

				ScraperRules:                subscription.ScraperRules,
				RewriteRules:                subscription.RewriteRules,
				UrlRewriteRules:             subscription.UrlRewriteRules,
				BlocklistRules:              subscription.BlocklistRules,
				KeeplistRules:               subscription.KeeplistRules,
				BlockFilterEntryRules:       subscription.BlockFilterEntryRules,
				KeepFilterEntryRules:        subscription.KeepFilterEntryRules,
				UserAgent:                   subscription.UserAgent,
				Crawler:                     subscription.Crawler,
				IgnoreHTTPCache:             subscription.IgnoreHTTPCache,
				FetchViaProxy:               subscription.FetchViaProxy,
				Disabled:                    subscription.Disabled,
				NoMediaPlayer:               subscription.NoMediaPlayer,
				HideGlobally:                subscription.HideGlobally,
				AllowSelfSignedCertificates: subscription.AllowSelfSignedCertificates,
				DisableHTTP2:                subscription.DisableHTTP2,
				IgnoreEntryUpdates:          subscription.IgnoreEntryUpdates,
			})
		}

		opmlDocument.Outlines = append(opmlDocument.Outlines, category)
	}

	return opmlDocument
}

func groupSubscriptionsByFeed(subscriptions []subcription) map[string][]subcription {
	groups := make(map[string][]subcription)

	for _, subscription := range subscriptions {
		groups[subscription.CategoryName] = append(groups[subscription.CategoryName], subscription)
	}

	return groups
}